spring framework

★스프링 프레임워크 #4 - Chapter03 : Spring MVC 실습, 유효성 검사, 예외 처리, 정규식 등

letsDoDev 2023. 9. 14. 02:12

◎ 참고 서적  |  Mastering Spring 5

 

[★스프링 MVC 애플리케이션 설정★ : 실습 1 기준]

설정해야할 파일 : pom.xml / web.xml / user-web-context.xml(이 파일은 실습마다 파일명 바뀔 수도 있음)

● pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.mastering.spring</groupId>
	<artifactId>mastering-spring-chapter3-springmvc</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>

	<properties>
		<spring.version>5.1.3.RELEASE</spring.version>
	</properties>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework</groupId>
				<artifactId>spring-framework-bom</artifactId>
				<version>${spring.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

	<dependencies>
		<!-- 별도 추가임  -->
		<dependency>
		    <groupId>javax.xml.bind</groupId>
		     <artifactId>jaxb-api</artifactId>
		    <version>2.3.0</version>
		</dependency>
	
		<dependency>
			<groupId>javax</groupId>
			<artifactId>javaee-web-api</artifactId>
			<version>7.0</version>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>jstl</artifactId>
			<version>1.2</version>
		</dependency>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.security</groupId>
			<artifactId>spring-security-web</artifactId>
			<version>5.1.2.RELEASE</version>
		</dependency>

		<dependency>
			<groupId>org.springframework.security</groupId>
			<artifactId>spring-security-config</artifactId>
			<version>5.1.2.RELEASE</version>
		</dependency>

		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-validator</artifactId>
			<version>5.0.2.Final</version>
		</dependency>

		<dependency>
			<groupId>org.webjars</groupId>
			<artifactId>bootstrap</artifactId>
			<version>3.3.6</version>
		</dependency>

		<dependency>
			<groupId>org.webjars</groupId>
			<artifactId>jquery</artifactId>
			<version>1.9.1</version>
		</dependency>

		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
			<version>2.9.0.pr3</version>
		</dependency>

		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.17</version>
		</dependency>

		<!-- Unit Test Dependencies -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.12</version>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>javax.servlet-api</artifactId>
			<version>3.1.0</version>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.mockito</groupId>
			<artifactId>mockito-core</artifactId>
			<version>1.9.0-rc1</version>
			<scope>test</scope>
		</dependency>

	</dependencies>

	<build>
		<pluginManagement>
			<plugins>
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-compiler-plugin</artifactId>
					<version>3.2</version>
					<configuration>
						<verbose>true</verbose>
						<source>1.8</source>
						<target>1.8</target>
						<showWarnings>true</showWarnings>
					</configuration>
				</plugin>
				<plugin>
					<groupId>org.apache.tomcat.maven</groupId>
					<artifactId>tomcat7-maven-plugin</artifactId>
					<version>2.2</version>
					<configuration>
						<path>/</path>
						<contextReloadable>true</contextReloadable>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>

	<repositories>
		<repository>
			<id>spring-snapshots</id>
			<name>Spring Snapshots</name>
			<url>https://repo.spring.io/snapshot</url>
			<snapshots>
				<enabled>true</enabled>
			</snapshots>
		</repository>
		<repository>
			<id>spring-milestones</id>
			<name>Spring Milestones</name>
			<url>https://repo.spring.io/milestone</url>
			<snapshots>
				<enabled>false</enabled>
			</snapshots>
		</repository>
	</repositories>

	<pluginRepositories>
		<pluginRepository>
			<id>spring-snapshots</id>
			<name>Spring Snapshots</name>
			<url>https://repo.spring.io/snapshot</url>
			<snapshots>
				<enabled>true</enabled>
			</snapshots>
		</pluginRepository>
		<pluginRepository>
			<id>spring-milestones</id>
			<name>Spring Milestones</name>
			<url>https://repo.spring.io/milestone</url>
			<snapshots>
				<enabled>false</enabled>
			</snapshots>
		</pluginRepository>
	</pluginRepositories>
</project>

 web.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- webapp/WEB-INF/web.xml -->
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" version="3.0">
  <display-name>To do List</display-name>
  <servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>
                org.springframework.web.servlet.DispatcherServlet
            </servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>/WEB-INF/user-web-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <url-pattern>*.action</url-pattern>
  </servlet-mapping>
<!--   
  <filter>
    <filter-name>springSecurityFilterChain</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>springSecurityFilterChain</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
  <error-page>
    <location>/WEB-INF/views/common/error.jsp</location>
  </error-page>
  --> 
</web-app>

● user-web-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">

	<context:component-scan base-package="com.mastering.spring.springmvc" />
 	<mvc:annotation-driven />
<!--  
	<mvc:resources mapping="/webjars/**" location="/webjars/" />

	<bean id="messageSource"
		class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
		<property name="basename" value="classpath:messages" />
		<property name="defaultEncoding" value="UTF-8" />
	</bean>

	<bean id="localeResolver"
		class="org.springframework.web.servlet.i18n.SessionLocaleResolver">
		<property name="defaultLocale" value="en" />
	</bean>

	<mvc:interceptors>
		<bean id="localeChangeInterceptor"
			class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor">
			<property name="paramName" value="language" />
		</bean>
		<bean
			class="com.mastering.spring.springmvc.controller.interceptor.HandlerTimeLoggingInterceptor" />
	</mvc:interceptors>

 -->	

 	
</beans>

 

<<실습>>

① 뷰가 없는 컨트롤러

② 뷰가 있는 컨트롤러(jsp)

③ 뷰가 있고 ModelMap을 사용하는 컨트롤러

④ 뷰가 있고 ModelAndView를 사용하는 컨트롤러

⑤ 간단한 형태의 컨트롤러

⑥ 유효성 검사가 포함된 간단한 형태의 컨트롤러

 

[ 1. 뷰가 없는 컨트롤러 ]

- 컨트롤러

package com.mastering.spring.springmvc.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class BasicController {

    @RequestMapping(value = "/welcome.action")
    @ResponseBody
    public String welcome() {
        return "Welcome to Spring MVC";
    }

}

- 실행용 공파일 : welcome.action

   or

- 실행용 도메인 : http://localhost:8090(포트번호)/Example3(프로젝트명)/welcome.action

- 실행 화면


[ 2. 뷰 (JSP) ]가 있는 컨트롤러 ]

- 컨트롤러

※※※※※뷰 리졸버 (실습 1 과 달리 추가해야될 점) ※※※※※
  <!-- 뷰 리졸버  --> 
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> 
<property name="prefix"> 
<value>/WEB-INF/views/</value> 
</property><property name="suffix">
<value>.jsp</value>
</property>  
</bean>
파트를 web.xml 에 추가 한 후 진행하여야함
package com.mastering.spring.springmvc.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class BasicViewController {
	@RequestMapping(value="/welcome-view.action")
	public String welcome() {
		// 뷰 리졸버(InternalResourceViewResolver) 설정에 의해 return "/WEB-INF/welcome.jsp" 와 같다! ★★★
		return "welcome";
	}
}

- 뷰(welcome.jsp)

<%@ page language="java" contentType="text/html; charset=EUC-KR"
    pageEncoding="EUC-KR"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="EUC-KR">
<title>Welcome</title>
</head>
<body>
	<p>Welcome! This is coming from a view - a JSP</p>
</body>
</html>

- 실행 화면 (도메인 : http://localhost:8090/Example3/welcome.action)


[ 3. 모델이 있는 뷰로 전환하는 컨트롤러]

- 컨트롤러 & 모델(ModelMap)

package com.mastering.spring.springmvc.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class BasicModelMapController {
	
	@RequestMapping(value="/welcome-model-map.action")
	public String welcome(ModelMap model) {
		
		// 모델에 name 이라는 속성 이름과 XYZ 값을 추가
		model.put("name", "abc");
		
		// = return "/WEB-INF/views/welcome-model-map.jsp"
		return "welcome-model-map";
	}
	
}

모델(ModelMap) 에 key 를 지정하여 value 값 담은 후 return으로 뷰 url로 넘겨주면

뷰(welcome-model-view.jsp)에서 값을 넘겨 받을 수 있다.

- 뷰

<%@ page language="java" contentType="text/html; charset=EUC-KR"
    pageEncoding="EUC-KR"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="EUC-KR">
<title>Insert title here</title>
</head>
<body>
// ${}안에 컨트롤러 모델에서 지정한 key 를 넘겨주면 사용자에게 출력시 key name에 담긴 value 값을
// 전달한다.
Welcome ${name }! This is coming from a model-map - a JSP

</body>
</html>

- 실행결과


[ 4. ModelAndView를 사용해 뷰로 전환하는 컨트롤러]

- 컨트롤러 모델과 ModelAndView

package com.mastering.spring.springmvc.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class BasicModelViewController {
	@RequestMapping(value="/welcome-model-view.action")
	public ModelAndView welcome(ModelMap model) {
		model.put("name","ABC");
		
		// put 시킨 모델 자체를 그래도 담아서 "welcome-model-view(.jsp) 뷰로 넘긴다. 
		return new ModelAndView("welcome-model-view", model);
	}
	
}

- 뷰

<%@ page language="java" contentType="text/html; charset=EUC-KR"
    pageEncoding="EUC-KR"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="EUC-KR">
<title>Insert title here</title>
</head>
<body>

welcome ${name }! This is coming from a model-view - a JSP

</body>
</html>

- 실행 결과

 


[ 5. 폼이 있는 뷰로 전환하는 컨트롤러 ]

- User.java (dto 역할의 POJO)

package com.mastering.spring.springmvc.pojo;

public class User {

	private String guid;
	private String name;
	private String userId;
	private String password;
	private String password2;
	// 생성자
	// Getter와 Setters
	// toString	
}

- 뷰(user.jsp)

<%@ page language="java" contentType="text/html; charset=EUC-KR"
    pageEncoding="EUC-KR"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>
<%@ taglib uri="http://www.springframework.org/tags" prefix="spring" %>
 
<!DOCTYPE html>
<html>
<head>
<meta charset="EUC-KR">
<title>Insert title here</title>
</head>
<body>

<!-- 아래 폼은 post 방식으로 데이터를 넘김
modelAttribute -> 폼 백업 객체로 동작하는 모델의 속성을 지정,
모델에서 이름이 user인 속성을 지정
★즉 아래 fireldset 하위의 form:label 과 form:input은, dto 처럼 만든 User.java 파일의 name, userId 변수에 값을 지정해서 넘기는 것을 의미함★ -->
<form:form method="post" modelAttribute="user">
	<fieldset>
	<!--레이블을 표시하는 스프링 폼 태그. path 속성은 입력 필드가 매핑될 빈 필드 이름 지정하는 것  -->
		<form:label path="name">Name</form:label>
		<form:input path="name" type="text" required="required" />
	</fieldset>
	<fieldset>
		<form:label path="userId">User Id</form:label>
		<form:input path="userId" type="text" required="required" />
	</fieldset>
	<!-- password and password2 fields not shown for brewity  -->

<input class="btn btn-success" type="submit" value="Submit" />
</form:form>


</body>
</html>

- 컨트롤러(UserController.java)

package com.mastering.spring.springmvc.controller;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import com.mastering.spring.springmvc.pojo.User;

@Controller
public class UserController {
	private Log logger = LogFactory.getLog(UserController.class);
	
	
	// 폼을 표시하는 컨트롤러 메소드
	@RequestMapping(value="/create-user", method= RequestMethod.GET)
	public String showCreateUserPage(ModelMap model) {
		model.addAttribute("user", new User());
		return "user";
	}
	
	// 컨트롤러가 폼 제출을 처리하는 메소드 가져오기
	@RequestMapping(value="/create-user", method = RequestMethod.POST)
	public String addTodo(User user) {
		logger.info("user details"+user);
		return "redirect:list-users";
	}
	
	//사용자 리스트를 위한 코드
	@RequestMapping(value="/list-users", method = RequestMethod.GET)
	public String showAllUSers() {
		return "list-users";
	}
	
}

폼의 결과 값 처리 및 확인은 아래 플로우 6에서 진행

 

 

[ 6. 이전 플로우에 유효성 검사 추가]

유효성 검사를 위해 - pom.xml 프로젝트에 하이버 네이트 밸리데이터를 추가

	<!-- chapter 3  플로우 6 추가 파트 -> 유효성 검사 하이버네이트 밸리데이터  -->
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-validator</artifactId>
			<version>5.0.2.Final</version>
		</dependency>

유효성 검사를 위해

- user.jsp 에 유효성 검사 Annotation 추가

package com.mastering.spring.springmvc.pojo;

import javax.validation.constraints.Size;

public class User {

	private String guid;
	// 최소한 6자 이상
	@Size(min = 6, message = "Enter at least 6 characters")
	private String name;
	
	@Size(min = 6, message = "Enter at least 6 characters")
	private String userId;
	
	// 최소한 8자 이상
	@Size(min = 8, message = "Enter at least 8 characters")
	private String password;
	
	@Size(min = 8, message = "Enter at least 8 characters")
	private String password2;
	// 생성자
	// Getter와 Setters
	// toString	
}

빈 유효성 검사를 사용해 수행할 수 있는 다른 유효성 검사는 다음과 같다.

  • @NotNull : null 방지
  • @Size(min=, max=)
  • @Past : only 과거 날짜
  • @Future : only 미래 날찌
  • @Pattern : 제공된 정규식과 일치
  • @Max : 필드 최대값
  • @Min : 필드 최솟값

유효성 검사를 위해

- UserController.java 에 추가해야 할 메소드

	// 폼의 유효성 검사
	@RequestMapping(value="/create-user-witj-validation", method = RequsetMethod.POST)
	public String addTodo(@Valid User user, BindingResult result) {
		
		if (result.hasErrors()) {
			return "user";
		}
		
		logger.info("user details " + user);
		
		return "redirect:list-users";
	}

@Valid 어노테이션 → 스프링 MVC 빈의 유혀성 검증 → 유효성 검사 결과는 BindingResult 인스턴스 결과 사용 가능

 

- user.jsp도 수정해주어햐 한다. 아래는 수정된 전체 jsp

<%@ page language="java" contentType="text/html; charset=EUC-KR"
    pageEncoding="EUC-KR"%>
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ taglib uri="http://java.sun.com/jsp/jstl/fmt" prefix="fmt" %>
<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>
<%@ taglib uri="http://www.springframework.org/tags" prefix="spring" %>
 
<!DOCTYPE html>
<html>
<head>
<meta charset="EUC-KR">
<title>Insert title here</title>
</head>
<body>

<!-- 아래 폼은 post 방식으로 데이터를 넘김
modelAttribute -> 폼 백업 객체로 동작하는 모델의 속성을 지정,
모델에서 이름이 user인 속성을 지정
★즉 아래 fireldset 하위의 form:label 과 form:input은, dto 처럼 만든 User.java 파일의 name, userId 변수에 값을 지정해서 넘기는 것을 의미함★ -->
<form:form method="post" modelAttribute="user">
	<fieldset>
	<!--레이블을 표시하는 스프링 폼 태그. path 속성은 입력 필드가 매핑될 빈 필드 이름 지정하는 것  -->
		<form:label path="name">Name</form:label>
		<form:input path="name" type="text" required="required" />
		<!-- 유효성 검사를 위해 추가한 부분  -->
		<form:errors path="name" cssClass="text-warning"/>
	</fieldset>
	<fieldset>
		<form:label path="userId">User Id</form:label>
		<form:input path="userId" type="text" required="required" />
	</fieldset>
	<!-- password and password2 fields not shown for brewity  -->

<input class="btn btn-success" type="submit" value="Submit" />
</form:form>


</body>
</html>

 

- user.java 도 수정

package com.mastering.spring.springmvc.dto;

import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.Size;

public class User {

	private String guid;
	// 최소한 6자 이상
	@Size(min = 6, message = "Enter at least 6 characters")
	private String name;
	
	@Size(min = 6, message = "Enter at least 6 characters")
	private String userId;
	
	// 최소한 8자 이상
	@Size(min = 8, message = "Enter at least 8 characters")
	private String password;
	
	@Size(min = 8, message = "Enter at least 8 characters")
	private String password2;
	
	// 유효성 검사에 실패하였을 때
	@AssertTrue(message = "PassWord fields don't match")
	private boolean isValid() {
		return this.password.equals(this.password2);
	}
		
	
	// 생성자
	// Getter와 Setters
	// toString	
}

플로우  5, 6 은 실행 결과는 다루지 않고 방법만 논의하고 넘어간다.