Spring MVC Form Validation - Maven

김진서·2024년 2월 22일
Spring
1

Spring MVC

목록 보기
3/9
post-thumbnail

준비물: Intellij, Tomcat, Maven

파일구조

- src
  - main
    - java
      - org
        - example
          - config
            - MVCConfig.java
            - SpringMvcDispatcherServletInitializer.java
          - controller
            - CustomerController.java
          - model
            - Customer.java
		- resources
    - webapp
      - WEB-INF
        - views
          - customer-confirmation.jsp
		  - customer-form.jsp
	  - index.jsp
- .gitignore
- pom.xml

주의: Spring MVC에서는 /WEB-INF/views/ 안에 있는 JSP 파일들을 찾기를 기본으로 기대하기 때문에 src/main/webapp/WEB-INF/views/ 경로 만들어줘야 함

pom.xml 세팅 - 원문 예시에서 dependencies, build만 가져옴

<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 httpsv://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.example</groupId>
  <artifactId>Spring_Study_7</artifactId>
  <packaging>war</packaging>

  <version>1.0-SNAPSHOT</version>
  <name>Spring_Study_7 Maven Webapp</name>
  <url>https://maven.apache.org</url>

  <dependencies>
	<!-- org.springframework:spring-webmvc: Spring Framework의 Web MVC 모듈은 Spring 기반의 웹 애플리케이션을 구축하는 데 사용되며, -->
	<!-- 웹 애플리케이션의 컨트롤러, 뷰 및 모델을 지원. -->
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.1.0.RELEASE</version>
    </dependency>
	<!-- Hibernate Validator: 객체 유효성 검증(Validation)을 위한 라이브러리. -->
	<!-- Java Bean Validation(JSR 380) 스펙을 구현. -->
	<!-- 애플리케이션에서 간단하게 객체의 유효성 검증 가능. -->
	<!-- 주로 사용자 입력 폼의 데이터나 API 요청 뎅터의 유효성을 검사하는 데 사용. -->
    <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-validator</artifactId>
      <version>5.4.1.Final</version>
    </dependency>

	<!-- JSTL Dependency: JSP 페이지에서 사용할 수 있는 JSTL(JSP Standard Tag Library) API와 구현을 제공. -->
    <dependency>
      <groupId>javax.servlet.jsp.jstl</groupId>
      <artifactId>javax.servlet.jsp.jstl-api</artifactId>
      <version>1.2.1</version>
    </dependency>
    <dependency>
      <groupId>taglibs</groupId>
      <artifactId>standard</artifactId>
      <version>1.1.2</version>
    </dependency>

    <!-- Servlet Dependency: Java Servlet API는 웹 서버에서 동작하는 서블릿 및 JSP 페이지를 작성하기 위한 API를 제공. -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>

    <!-- JSP Dependency: JavaServer Pages (JSP)는 동적 웹 페이지를 생성하기 위한 표준화된 서버 측 스크립팅 언어 및 스팩을 제공. -->
    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>javax.servlet.jsp-api</artifactId>
      <version>2.3.1</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <!-- build: Maven 빌드 설정을 지정하는 섹션. -->
  <build>
	<!-- sourceDirectory: 소스 코드 디렉토리를 지정. -->
    <sourceDirectory>src/main/java</sourceDirectory>
	<!-- plugins: Maven 플러그인 설정을 지정하는 섹션 -->
    <plugins>
	  <!-- maven-compiler-plugin: Maven 컴파일러 플러그인을 설정. -->
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.5.1</version>
        <configuration>
		  <!-- source: 컴파일 소스 코드의 버전을 지정. -->
          <source>1.8</source>
		  <!-- target: 생성된 바이트 코드의 버전을 지정. -->
          <target>1.8</target>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

코드

CustomerController.java

package org.example.controller;

import org.example.model.Customer;
import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.validation.Valid;

@Controller
@RequestMapping("/customer")
public class CustomerController {
	// InitBinder: 해당 컨트롤러에 대한 RequestMapping 전에 데이터 바인딩을 초기화하는 데 사용.
	// WebDataBinder를 커스터마이징하여 데이터 바인딩 프로세스를 제어할 수 있다.
    @InitBinder
    public void initBinder(WebDataBinder dataBinder) {
		// StringTrimmerEditor를 사용하여 좌우 공백을 제거하는 데이터 바인더를 등록.
        StringTrimmerEditor stringTrimmerEditor = new StringTrimmerEditor(true);
        dataBinder.registerCustomEditor(String.class, stringTrimmerEditor);
    }

    @RequestMapping("/showForm")
    public String showForm(Model theModel) {
        theModel.addAttribute("customer", new Customer());
        return "customer-form";
    }

    @RequestMapping("/processForm")
    public String processForm(
            @Valid @ModelAttribute("customer") Customer theCustomer,
			// BindingResult: 스프링 MVC에서 데이터 바인딩 및 유효성 검사 결과를 저장하는 객체.
			// 주로 컨트롤러 메소드의 인자로 사용되며,
			// 해당 메소드에서 데이터 바인딩 및 유효성 검사 후에 발생한 오류를 저장하고 이를 처리하는 데에 활용.
            BindingResult theBindingResult
    ) {
        if (theBindingResult.hasErrors()) {
            return "customer-form";
        } else {
            return "customer-confirmation";
        }
    }
}

Customer.java

package org.example.model;

import org.hibernate.validator.constraints.Email;

import javax.validation.constraints.*;

public class Customer {
    private String firstName;

    @NotNull(message = "is required")
    @Size(min = 1, message = "is required")
    private String lastName;

    @NotNull(message = "is required")
    @Min(value = 0, message = "must be greater than or equal to zero")
    @Max(value = 10, message = "must be less than or equal to ten")
    private String freePasses;

    @Pattern(regexp = "^[a-zA-Z0-9]{5}", message = "only 5 chars/digits")
    private String postalCode;

    @NotNull(message = "is required")
    @Email(message = "Invalid email! Please enter valid email")
    private String email;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getFreePasses() {
        return freePasses;
    }

    public void setFreePasses(String freePasses) {
        this.freePasses = freePasses;
    }

    public String getPostalCode() {
        return postalCode;
    }

    public void setPostalCode(String postalCode) {
        this.postalCode = postalCode;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

customer-form.jsp

<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>

<html>

<head>
    <title>Customer Registration Form</title>

    <style>
        .error {
            color: red
        }
    </style>
</head>

<body>
<h1> Spring MVC 5 - Form Validation Example</h1>
<i>Fill out the form. Asterisk (*) means required.</i>
<br><br>

<form:form action="processForm" modelAttribute="customer">

    First name:
    <form:input path="firstName" />

    <br><br> Last name (*):
    <form:input path="lastName" />
	// <form:errors>: 스프링 폼 태그 라이브러리에서 제공하는 태그 중 하나로,
	// 폼 입력 요소의 유효성 검사 결과에 따라 오류 메시지를 표시하는 데 사용.
	// 보통 입력 필드 옆에 오류 메시지를 표시하는데 활용.
	// 유효성 검사를 수행한 후에 해당 입력 필드에 대한 오류가 발생하면 이 태그를 사용하여 오류 메시지를 표시.
    <form:errors path="lastName" cssClass="error" />

    <br><br> Free passes (*):
    <form:input path="freePasses" />
    <form:errors path="freePasses" cssClass="error" />

    <br><br> Email (*):
    <form:input path="email" />
    <form:errors path="email" cssClass="error" />

    <br><br> Postal Code:
    <form:input path="postalCode" />
    <form:errors path="postalCode" cssClass="error" />

    <br><br>

    <input type="submit" value="Submit" />

</form:form>

</body>

</html>

customer-confirmation.jsp

<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>

<!DOCTYPE html>

<html>

<head>
    <title>Customer Confirmation</title>
</head>

<body>

The customer is confirmed: ${customer.firstName} ${customer.lastName}

<br><br> Free passes: ${customer.freePasses}

<br><br> Email: ${customer.email}

<br><br> Postal Code: ${customer.postalCode}

</body>

</html>

결과 화면



localhost:8080/customer/processForm으로 url이 같지만, 화면이 다른 이유?

  • Controller의 processForm 메소드에서 theBindingResult의 error 여부에 따라 다른 화면을 return하기 때문.
  • RequestMapping이 “/processForm” 하나.
@RequestMapping("/processForm")
    public String processForm(
            @Valid @ModelAttribute("customer") Customer theCustomer,
            BindingResult theBindingResult
    ) {
        if (theBindingResult.hasErrors()) {
            return "customer-form";
        } else {
            return "customer-confirmation";
        }
    }

소스코드

https://github.com/eunoia-jason/Spring_Study_7.git

원문참고

Spring MVC Form Validation using Annotations - Hibernate Validator

profile
김진서
PAy IT forwaRD를 실천하는 프론트엔드 개발자. 근데 이제 백엔드를 곁들인..
이전 포스트

Spring MVC Form Tags - Maven

다음 포스트

[Spring] web.xml?

0개의 댓글