Spring - @mvc - Validator

SPRING 2014. 3. 25. 06:17
728x90
반응형



Validator

Spring MVC에서는 Validator를 구현하기 위해 ValidatorUtils를 이용한 입력 필드의 값 존재 여부의 validation 체크나 errors 객체를 통해 property파일 메시지를 출력해주는 validation 체크 방법을 지원한다. 이것은 jsp 페이지 에서form:errors를 태그를 통해 간단히 에러 메시지를 출력할 수 있으며 SimpleFormController를 사용하면 입력페이지에 에러 메시지를 출력해 줄 수 있다.

Validator 생성

  • ValidatorUtils 사용
  • Validator를 생성할 때 required 속성값의 validation을 체크하고 에러메시지를 프로퍼티 파일 없이 사용자가 지정해준 메시지로 출력 할 수 있도록 지원한다. 간단히 ValidatorUtils를 사용하여 구현할 수 있다. 다음은 validator를 구현한 UserValidator.java 의 일부이다.
    public class UserValidator implements Validator {
    
    	public boolean supports(Class clazz) {
    		return UserVO.class.isAssignableFrom(clazz);
    	}
    
    	public void validate(Object object, Errors errors) {
    
    		// validationUtils를 이용하여 입력값이 비었는지 체크
    		ValidationUtils.rejectIfEmptyOrWhitespace(errors, "userName",
    				"required", new Object[] { "userName" }, "Enter your name");
    		ValidationUtils.rejectIfEmptyOrWhitespace(errors, "password",
    				"required", new Object[] { "password" }, "Enter your password");
    ValidationUtils 클래스에 대한 API 는 여기를 참고한다.
  • Property 파일 사용
  • validation을 체크할 때 errors 인터페이스를 사용하여 properties 파일을 참조하여 에러 메시지를 출력할 수 있는데 그 예는 다음과 같다.
    public class UserValidator implements Validator {
    	public boolean supports(Class clazz) {
    		return HelloVO.class.isAssignableFrom(clazz);
    	}
    
    	public void validate(Object object, Errors errors) {
    		
    		HelloVO helloVO = (HelloVO) object;
    		if (helloVO.getPassword().length() < 6)
    			errors.rejectValue("password", "error.password.tooshort");
    
    		if (!helloVO.getPassword().equals(helloVO.getConfirmPassword()))
    			errors.rejectValue("confirmPassword", "error.confirm");
    	}
    }
    해당 조건에 만족하지 않는 입력 값이 있으면 properties파일에 미리 정의된 error.password.tooshort, error.confirm등의 메시지가 출력될 것이다. messageSource 정의 방법은Spring MVC 다국어 지원 기능 을 참고하고 errors 클래스의 API는 여기 를 참고한다.

    Validator 등록

    위에서 처럼 생성한 validator를 컨트롤러에도 추가해 주어야 한다. 다음은 UserController 빈 정의가 작성되어 있는 user-servlet.xml 파일의 일부이다.
    <bean name="/getUser.do"
    	class="anyframe.sample.springmvc.web.controller.basic.UserController">
    	<property name="userService" ref="userService" />
    	<property name="validator" ref="userValidator"/>
    </bean>
    <bean name="userValidator" class="anyframe.sample.springmvc.web.validator.UserValidator"/>
    이는 해당 Controller 클래스 내의 생성자 안에서 setValidator를 사용해 정의해줄 수도 있다.

    form:errors 태그 사용

    validatior에서 얻어진 메시지를 JSP페이지에서 쉽게 출력할 수 있도록 Spring MVC에서 제공하는 태그 라이브러리 중 form 태그의 form:errors태그를 사용할 수 있다. 이 태그를 사용하기 위해서는 다음과 같은 절차를 따른다.
    • 태그 라이브러리 등록

    • spring의 form 태그 라이브러리를 사용하기 위해서는 spring-form.tld파일이 필요하고 이는 spring-webmvc-2.5.2.jar 파일에 포함되어 있다. 이 폼 태그를 사용하기 위해서는 JSP 페이지에 taglib을 추가해줘야한다.
      <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
    • form:form 태그 사용

    • 일단 form 태그를 사용하려면 commandName 속성을 지정해야 하는데 이 속성은 폼 이름과 트랜스퍼 오브젝트의 빈들과 1:1로 매핑시켜준다. commandName의 속성값을 지정해 주지 않을 경우 기본값은 command이고 이값은 request로 셋팅해 줘야 한다. 이값은 SimpleFormController를 사용할 경우 컨트롤러의 fomBackingObject를 통해 컨트롤러 내에서 지정해 줄 수도 있다. 자세한 방법은 본 매뉴얼 >> Spring MVC >> Basic >> Controller >> SimpleFormController 부분을 참고한다. form 태그는 여러가지 폼 입력 태그들을 갖는다. 각 타입에 따라 text타입은 <form:input> 기타 나머지 타입은 <form:password>와 같은 형태로 나타난다. 기타 폼 태그의 자세한 사항은 본 매뉴얼 >> Spring MVC >> Basic >> View >> Tag Library 를 참고한다. 이러한 입력 폼 태그는 path라는 속성에 이름을 지정해주는데 이는 반드시 트랜스퍼 오브젝트의 빈 이름과 같아야 한다. 또한 form태그에는 웹단에서 validator에서 발생시킨 에러 메시지를 출력해주는 <form:errors>태그를 갖고 이 태그 역시 path값을 지정해 줘야한다. path값에 "*" 값을 주게 되면 모든 error메시지를 출력한다. 다음은 form:errors 태그가 정의되어 있는 getUser.jsp 파일의 일부이다.
      <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>
      <tr>
      	<td> Name :</td>
      	<td><form:input path="userName" />(required)</td>
      	<td><form:errors path="userName" /></td>
      </tr>
      <tr>
      	<td>password :</td>
      	<td><form:password path="password" />(required, 6자이상입력)</td>
      	<td><form:errors path="password" /></td>
      </tr>

    Resources

    • 다운로드
    • 이클립스 프로젝트 형태의 샘플 웹 어플리케이션을 포함하고 있는 anyframe-springmvc-sample-basic.zip 파일을 다운받은 후, 테스트 환경 설정 을 참조하여 위에서 제시한 예제 코드를 실행해 볼 수 있다.
      Name
      Download
      anyframe-springmvc-sample-basic.zip
      Download

    • 참고자료


    출처 - http://dev.anyframejava.org/anyframe/doc/web/3.2.0/webfw/springmvc/basic/validator.html


     


    ===================================================================================

     

     

     

    입력값 검증을 위한 Validation 기능은 Valang, Jakarta Commons, Spring 등에서 제공한다.
    여기서는 Jakarta Commons Validator Spring Framework과 연동하여 사용하는 방법에 대해서 설명하고자 한다.
    Jakarta Commons Validator
    는 필수값, 각종 primitive type(int,long,float), 최대-최소길이, 이메일, 신용카드번호등의 값 체크등을 할 수 있도록 Template이 제공된다.
    Template Java 뿐 아니라 Javascript로도 제공되어 client-side, server-side의 검증을 함께 할 수 있으며, 
    Configuration
    과 에러메시지를 client-side, server-side 별로 따로 하지 않고 한곳에 같이 쓰는 관리상의 장점이 있다.
    Struts
    에서는 Commons Validator를 사용하기 위한 org.apache.struts.validator.ValidatorPlugIn 같은 플러그인 클래스를 제공하는데, 
    Spring
    에서는 Spring Modules 프로젝트에서 연계 모듈을 제공한다.
    여기서는 server-side, client-side validation을 위해, 
    설치방법, Spring Module에서 제공하는 핵심 클래스인 DefaultValidatorFactory, DefaultValidator와 설정파일인 validator-rules.xml, validator.xml 에 대한 간략한 설명과 
    예제 프로젝트인 easycompany에 적용하는 과정을 설명한다.

    <!--[if !supportLists]-->1. <!--[endif]-->commons-validator : Ver 1.3.1 아래 4개의 파일에 대한 dependency가 있다.

    <!--[if !supportLists]-->                           I.   <!--[endif]-->commons-beanutils : Ver 1.7.0

    <!--[if !supportLists]-->                          II.   <!--[endif]-->commons-digester : Ver 1.8

    <!--[if !supportLists]-->                         III.   <!--[endif]-->commons-logging : Ver 1.0.4

    <!--[if !supportLists]-->                        IV.   <!--[endif]-->oro : Ver 2.0.8

    <!--[if !supportLists]-->2. <!--[endif]-->spring modules : Ver 0.9 다운 받고 압축을 풀어 보면 여러 파일들이 있으나 여기서 필요한 건 spring-modules-validation.jar 뿐이다. 예제를 보려면 \samples\sources\spring-modules-validation-commons-samples-src.zip도 필요하다.

    <!--[if !supportLists]-->3. <!--[endif]-->위에서 언급한 라이브러리들을 설치한다.

    Spring Validator Commons Validator의 연계를 위해 중요한 역활을 하는 클래스인 DefaultValidatorFactory, DefaultBeanValidator에 대해 간략하게 설명하자면 아래 표와 같다.

    DefaultValidatorFactory

    DefaultBeanValidator

    프로퍼티 'validationConfigLocationsApache'에 정의된 Validation rule을 기반으로 
    Commons Validator
    들의 인스턴스를 얻는다.

    DefaultBeanValidator org.springframework.validation.Validator implements하고 있지만,
    DefaultValidatorFactory
    가 가져온 Commons Validator의 인스턴스를 이용해 validation을 수행한다.
    Controller
    validation 수행할때 이 DefaultBeanValidator를 참조하면 된다.

    아래 코드를 참조해 빈 정의 파일(예제에는 easycompany-servlet.xml)에 다음과 같이 ValidatorFactory,Validator,validator-rules.xml,validation.xml 파일을 등록한다.

    ...
    <!-- Integration Apache Commons Validator by Spring Modules -->                                             
        <bean id="beanValidator" class="org.springmodules.validation.commons.DefaultBeanValidator">
                <property name="validatorFactory" ref="validatorFactory"/>
        </bean>
     
        <bean id="validatorFactory" class="org.springmodules.validation.commons.DefaultValidatorFactory">
                <property name="validationConfigLocations">
                            <list>
                          <!-- validator-rules.xml, validator.xml의 위치-->
                                         <value>/WEB-INF/conf/validator-rules.xml</value>
                                         <value>/WEB-INF/conf/validator.xml</value>
                            </list>
                </property>
        </bean>
    ...

    validator-rules.xml application에서 사용하는 모든 validation rule에 대해 정의하는 파일이다. 
    예제에 있는 validator-rules.xml의 필수값 체크 부분을 보면 아래와 같이 작성되어 있다.

          <validator name="required"
                classname="org.springmodules.validation.commons.FieldChecks"
                   method="validateRequired"
             methodParams="java.lang.Object,
                           org.apache.commons.validator.ValidatorAction,
                           org.apache.commons.validator.Field,
                           org.springframework.validation.Errors"
                      msg="errors.required">
             <javascript><![CDATA[
             .....
                ]]>
             </javascript>
          </validator>

    name

    validation rule(required,mask,integer,email…)

    classname

    validation check를 수행하는 클래스명(org.springmodules.validation.commons.FieldChecks)

    method

    validation check를 수행하는 클래스의 메소드명(validateRequired,validateMask…)

    methodParams

    validation check를 수행하는 클래스의 메소드의 파라미터

    msg

    에러 메시지 key

    javascript

    client-side validation을 위한 자바스크립트 코드

    Spring Modules에서 제공하는 validation rule에 따라 구성해보자.

    Spring Modules (0.9 기준)에서 제공하는 validation rule들은 아래와 같다. 

    name(validation rule)

    FieldCheck 클래스

    FieldCheck 클래스의 메소드

    기능

    required

    org.springmodules.validation.commons.FieldChecks

    validateRequired

    필수값 체크

    minlength

    org.springmodules.validation.commons.FieldChecks

    validateMinLength

    최소 길이 체크

    maxlength

    org.springmodules.validation.commons.FieldChecks

    validateMaxLength

    최대 길이 체크

    mask

    org.springmodules.validation.commons.FieldChecks

    validateMask

    정규식 체크

    byte

    org.springmodules.validation.commons.FieldChecks

    validateByte

    Byte형 체크

    short

    org.springmodules.validation.commons.FieldChecks

    validateShort

    Short형 체크

    integer

    org.springmodules.validation.commons.FieldChecks

    validateInteger

    Integer형 체크

    long

    org.springmodules.validation.commons.FieldChecks

    validateLong

    Long형 체크

    float

    org.springmodules.validation.commons.FieldChecks

    validateFloat

    Float형 체크

    double

    org.springmodules.validation.commons.FieldChecks

    validateDouble

    Double형 체크

    date

    org.springmodules.validation.commons.FieldChecks

    validateDate

    Date형 체크

    range

    org.springmodules.validation.commons.FieldChecks

    validateIntRange

    범위 체크

    intRange

    org.springmodules.validation.commons.FieldChecks

    validateIntRange

    int형 범위 체크

    floatRange

    org.springmodules.validation.commons.FieldChecks

    validateFloatRange

    Float형 범위체크

    creditCard

    org.springmodules.validation.commons.FieldChecks

    validateCreditCard

    신용카드번호체크

    email

    org.springmodules.validation.commons.FieldChecks

    validateEmail

    이메일체크

    validator-rules.xml을 직접 작성하는것 보다는 예제에 있는 파일을 참고하거나 copy해서 사용하면 편리하다.
    spring-modules-0.9.zip
    을 압축을 풀어보면 예제코드가 있다.(\samples\sources\spring-modules-validation-commons-samples-src.zip) 
    예제코드의 validator-rules.xml(\webapp\WEB-INF\validator-rules.xml)에는 모든 validation rule이 이미 정의되어 있다.

    org.springmodules.validation.commons.FieldChecks 클래스에는 필수값 체크, primitive 타입 체크등 여러 validation을 수행하는 메소드들이 있다. 
    FieldChecks
    클래스 소스를 열어 보면 실제 validation 처리는 Commons Validator에 위임하고 있다. 
    따라서 주의 할점은 Commons Validator에서 제공하는 validation rule중에, FieldChecks 클래스가 제공하지 않는 rule도 있다는 것이다. 
    예를 들어 Commons Validator 1.3.1 에서는 URL이나 IP 관련 Validator를 제공하지만, Spring Modules FieldChecks 클래스에 해당 메소드가 없기 때문에, 
    새로운 FieldCheck 클래스를 추가한 후 validation-rules.xml에 클래스와 메소드를 등록해야 사용할 수 있다.
    Spring Modules
    가 제공하는 validation rule외에 rule을 추가하는 방법에 대해서는 주민등록번호 validation rule 추가하기 를 참고하라. 

    validator.xml validation rule validation Form을 매핑한다. 
    form name
    field property name-rule Server-side Client-side인 경우에 따라 다르다.

    Server-side validation의 경우는,
    form name
    field property validation할 폼 클래스의 이름, 필드과 각각 매핑된다.(camel case) 
    폼 클래스가 Employee employee, DepartmentForm 이면 departmentForm form name으로 지정하라. 

    Client-side의 경우는, 
    form name
    JSP에서 설정한 <validator:javascript formName=employee” …/> 태그의 formName와 매핑되고, field property는 각각의 폼 필드의 이름과 일치하면 된다.

    따라서, Server-side, Client-side 둘 다 수행하려면,
    JSP
    <validator:javascript formName=employee” …/> 태그의 formName은 폼 클래스의 이름이 되어야 하고, JSP의 폼 필드들은 폼 클래스의 필드와 일치해야 한다.

    depends는 해당 필드에 적용할 (validator-rules.xml에 정의된 rule name) validator를 의미한다. 
    < arg key
    >는 메시지 출력시 파라미터를 지정하는 값이다. 
    아래와 같이 작성했다면, Employee 클래스의 name 필드에 대해서 필수값 체크를, age 필드에 대해서 integer 체크를, email 필드에 대해선 필수값과 email 유효값 체크를 하겠다는 의미이다.

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE form-validation PUBLIC 
        "-//Apache Software Foundation//DTD Commons Validator Rules Configuration 1.1//EN" 
        "http://jakarta.apache.org/commons/dtds/validator_1_1.dtd">
     
    <form-validation>
     
        <formset>
     
            <form name="employee">
             <field property="name" depends="required">
                         <arg0 key="employee.name" />
                            </field>
                            <field property="age" depends="integer">
                         <arg0 key="employee.age" />
                            </field>
                            <field property="email" depends="required,email">
                         <arg0 key="employee.email" />
                            </field>              
            </form>
     
        </formset>
     
    </form-validation>

    Controller

    Server-Side Validation을 위해 Controller validation 로직을 추가해 보자.
    위 설정 파일에서 등록한 DefaultBeanValidator Controller에서 validation을 수행한다.
    DefaultBeanValidator
    Commons Validator의 기능을 사용하지만 자신은 Spring Validator이기 때문에,
    사용자는 Spring Validator를 사용하듯이 Controller에서 validation 코딩을 하면 된다.

    package com.easycompany.controller.annotation;
    ...
    import org.springmodules.validation.commons.DefaultBeanValidator;
    ...
     
    @Controller
    public class UpdateEmployeeController {        
                ...
                @Autowired
                private DefaultBeanValidator beanValidator;
            ...
                @RequestMapping(value = "/updateEmployee.do", method = RequestMethod.POST)
                public String updateEmployee(@ModelAttribute("employee") Employee employee,                            
                                         BindingResult bindingResult, Model model) {
     
                            beanValidator.validate(employee, bindingResult); //validation 수행
                            if (bindingResult.hasErrors()) { //만일 validation 에러가 있으면...
                                         .....
                                         return "modifyemployee";
                            }
                            employeeManageService.updateEmployee(employee);
                            return "changenotify";
                }        
    }

    JSP

    Validation을 적용할 JSP를 작성한다.(modifyemployee.jsp) 
    form submit
    을 하면 이름, 나이, 이메일등의 입력값이 Employee 클래스에 바인딩이 되서 Controller에 전달이 되고, 
    Controller
    validation 수행 로직이 있으면 validator.xml 내용에 따라 validation이 이루어 진다. 
    만일 에러가 발생하면 <form:error/>에 에러에 해당하는 메시지를 출력한다. 에러 메시지에 관련해서는 아래 에러 메시지 등록을 참고하라.

    <form:form commandName="employee">
    <table>
            ....
                <tr>
                            <th>이름</th>
                            <td><form:input path="name" size="20"/><form:errors path="name" /></td>
                </tr>
                <tr>
                            <th>비밀번호</th>
                            <td><form:input path="password" size="10"/></td>
                </tr>
                <tr>
                            <th>나이</th>
                            <td><form:input path="age" size="10"/><form:errors path="age" /></td>
                </tr>
                <tr>
                            <th>이메일</th>
                            <td><form:input path="email" size="50"/><form:errors path="email" /></td>
                </tr>
    </table>
    <table width="80%" border="1">
                <tr>
                            <td>
                            <input type="submit"/>
                            <input type="button" value="LIST" onclick="location.href='/easycompany/employeeList.do'"/>
                            </td>
                </tr>
    </table>
     
    </form:form>

    에러 메시지 등록

    메시지 파일에 에러 메시지를 등록한다.
    validation
    에러가 발생하면 validator-rules.xml에서 정의했던 msg값으로 에러메시지의 key값을 찾아 해당하는 메시지를 출력해준다.
    예를 들어, email validation에서 에러가 발생하면 msg값이 errors.email 이므로, “유효하지 않은 이메일 주소입니다.”라는 에러 메시지를 JSP에 있는 <form:errors path=email /> 부분에 출력하게 된다.

    employee.name=이름
    employee.email=이메일
    employee.age=나이
    employee.password=비밀번호
     
    # -- validator errors --
    errors.required={0}은 필수 입력값입니다.
    errors.minlength={0} {1}자 이상 입력해야 합니다.
    errors.maxlength={0} {1}자 이상 입력할수 없습니다.
    errors.invalid={0}은 유효하지 않은 값입니다.
     
    errors.byte={0}  byte타입이어야 합니다.
    errors.short={0}  short타입이어야 합니다.
    errors.integer={0} integer 타입이어야 합니다.
     
    ....
     
    errors.email=유효하지 않은 이메일 주소입니다.

    TEST

    이름 필드에 값을 비우고 submit하면, name에 필수값(required) validation rule이 설정되어 있으므로 
    아래와 같이 이름 필드 옆에 에러 메시지가 출력 될 것이다. 
    <!--[if !vml]-->설명: http://www.egovframe.org/wiki/lib/exe/fetch.php?media=egovframework:rte:ptl:security:server-validate.jpg<!--[endif]-->

    validator.jsp 추가

    아래와 같은 내용의 validator.jsp를 작성한다.

    <%@ page language="java" contentType="javascript/x-javascript" %>
    <%@ taglib prefix="validator" uri="http://www.springmodules.org/tags/commons-validator" %>
    <validator:javascript dynamicJavascript="false" staticJavascript="true"/>

    /validator.do로 호출하도록 Controller에서 메소드를 추가하고 requestmapping 한다. 
    validator.jsp
     http://localhost:8080/easycompany/validator.do 브라우져에서 호출해보면, validator-rules.xml에서 정의한 javascript 함수들이 다운로드 되거나 화면에 print 되는 걸 확인할 수 있을 것이다.
    validator.jsp
    client-validation을 위해 validator-rules.xml에서 정의한 javascript 함수들을 로딩한다. 
    따라서 client-validation을 할 페이지에서는 이 validator.jsp 
    <script type=
    text/javascript src=<c:url value=/validator.do/>></script> 
    같이 호출한다.

    JSP 설정(taglib,javascript) 추가

    client-validation을 위해서는 해당 JSP에 아래와 같은 작업이 추가 되어야 한다.

    <!--[if !supportLists]-->1. <!--[endif]-->commons-validator taglib를 선언한다.
    <%@ taglib prefix=
    validator uri=http://www.springmodules.org/tags/commons-validator %>

    <!--[if !supportLists]-->2. <!--[endif]-->필요한 자바 스크립트 함수를 generate 하기 위한 코드를 추가 한다. validation-rules.xml에서 선언한 함수를 불러 오기 위해, 위에서 작성한 validator.jsp를 아래와 같이 호출한다. 
    <script type=
    text/javascript src=<c:url value=/validator.do/>></script>

    <!--[if !supportLists]-->3. <!--[endif]-->위의 자바 스크립트 함수를 이용해 필요한 validation과 메시지 처리를 위한 자바 스크립트를 generate 하기 위한 코드를 추가 한다. formName에는 validator.xml에서 정의한 form의 이름을 써준다. 
    <validator:javascript formName=
    employee staticJavascript=false xhtml=true cdata=false/>

    <!--[if !supportLists]-->4. <!--[endif]-->form submit시에 validateVO클래스명() 함수를 호출한다. 
    onsubmit=return validateEmployee(this)” ”>

    따라서 앞의 server-side validation에서 작성한 modifyemployee.jsp은 아래와 같이 변경된다.

    <!-- commons-validator tag lib 선언-->
    <%@ taglib prefix="validator" uri="http://www.springmodules.org/tags/commons-validator" %>
     
    ....
    <!--for including generated Javascript Code(in validation-rules.xml)-->
    <script type="text/javascript" src="<c:url value="/validator.do"/>"></script>
    <!--for including generated Javascript Code(validateEmployee(), formName:validator.xml에서 정의한 form의 이름)-->
    <validator:javascript formName="employee" staticJavascript="false" xhtml="true" cdata="false"/>
    <script type="text/javascript">
                function save(form){         
                            if(!validateEmployee(form)){
                                         return;
                            }else{
                                         form.submit();
                            }
                }
    </script>
    ....
    <form:form commandName="employee">
    <table>
            ....
                <tr>
                            <th>이름</th>
                            <td><form:input path="name" size="20"/><form:errors path="name" /></td>
                </tr>
                <tr>
                            <th>비밀번호</th>
                            <td><form:input path="password" size="10"/></td>
                </tr>
                <tr>
                            <th>나이</th>
                            <td><form:input path="age" size="10"/><form:errors path="age" /></td>
                </tr>
                <tr>
                            <th>이메일</th>
                            <td><form:input path="email" size="50"/><form:errors path="email" /></td>
                </tr>
    </table>
    <table width="80%" border="1">
                <tr>
                            <td>
                            <!--<input type="submit"/>-->
                    <input type="button" value="SAVE" onclick="save(this.form)"/> <!-- client-validation을 위해 바로 submit하지 않고 먼저 validateEmployee 함수를 호출-->
                            <input type="button" value="LIST" onclick="location.href='/easycompany/employeeList.do'"/>
                            </td>
                </tr>
    </table> 
    </form:form>
    ....

    TEST

    이번에도 이름 필드의 값을 지우고 저장 버튼을 누르면 아래와 같은 alert 메시지가 보일 것이다.
    <!--[if !vml]-->설명: http://www.egovframe.org/wiki/lib/exe/fetch.php?media=egovframework:rte:ptl:security:client-validate.jpg<!--[endif]-->

    <!--[if !supportLists]-->§  <!--[endif]-->Spring Modules Reference Documentation v 0.9, Chapter 17.Validation, P133~136

     

    출처 - http://www.egovframe.org/wiki/doku.php?id=egovframework:rte:ptl:security:jakarta_commons_validator&s[]=validator

     

     

    Commons Validator validation rule 추가하기

    개요

    Commons Validator primitive type, 필수값, 이메일등 흔히 사용되는 유형에 대한 validation rule template으로 제공하지만, 
    프로젝트의 특성에 따라 공통으로 사용되는 validation rule이 발생되고 이를 추가해야할 필요가 생길 수 있다. 
    공공프로젝트에서 흔히 사용되는 주민등록번호 validator를 추가해 봄으로써, validation rule을 추가하는 방법을 알아보고자 한다. 
    예제는 easycompany를 이용했다. 

    설명

    Spring Module을 이용해서 Commons Validator를 사용한다면 아래와 같은 내용을 validation rule 정의 파일(validator-rules.xml 같은)에서 보았을 것이다. 

          <!--필수값 체크 validation rule-->
          <validator name="required"
                classname="org.springmodules.validation.commons.FieldChecks"
                   method="validateRequired"
             methodParams="java.lang.Object,
                           org.apache.commons.validator.ValidatorAction,
                           org.apache.commons.validator.Field,
                           org.springframework.validation.Errors"
                      msg="errors.required">
             <javascript><![CDATA[
                ...
                ]]>
             </javascript>
          </validator>

    validator 태그의 각각의 attribute는 다음과 같은 의미를 같는다.

    name

    validation rule(required,mask,integer,email…)

    classname

    validation check를 수행하는 클래스명

    method

    validation check를 수행하는 클래스의 메소드명

    methodParams

    validation check를 수행하는 클래스의 메소드의 파라미터

    msg

    에러 메시지 key

    javascript

    client-side validation을 위한 자바스크립트 코드

    주민등록번호 rule을 아래와 같이 추가한다고 하면,

          <validator name="ihidnum"
                classname="egovframework.rte.ptl.mvc.validation.RteFieldChecks"
                   method="validateIhIdNum"
             methodParams="java.lang.Object,
                           org.apache.commons.validator.ValidatorAction,
                           org.apache.commons.validator.Field,
                           org.springframework.validation.Errors"                       
                  depends=""
                      msg="errors.ihidnum">
               <javascript><![CDATA[
                ...
                ]]>
             </javascript>
          </validator>

    필요한 작업은 아래와 같다. 

    <!--[if !supportLists]-->1. <!--[endif]-->FieldCheck class(RteFieldChecks) 작성

    <!--[if !supportLists]-->2. <!--[endif]-->Validator class(RteGenericValidator) 작성

    <!--[if !supportLists]-->3. <!--[endif]-->validator-rules.xml 설정

    <!--[if !supportLists]-->4. <!--[endif]-->validator.xml 설정

    <!--[if !supportLists]-->5. <!--[endif]-->에러메시지 설정

    <!--[if !supportLists]-->6. <!--[endif]-->TEST

    org.springmodules.validation.commons.FieldChecks를 상속 받는 RteFieldChecks 클래스를 생성한다. 
    그리고 주민등록번호 validation을 담당할 validateIhIdNum 메소드를 추가한다. 
    주민등록번호 validation 로직이 RteFieldChecks.validateIhIdNum() 안에 있어도 되지만, org.springmodules.validation.commons.FieldChecks와 같은 방식으로 다른 Validator에 위임했다.

    package egovframework.rte.ptl.mvc.validation;
     
    import org.apache.commons.validator.Field;
    import org.apache.commons.validator.ValidatorAction;
    import org.springframework.validation.Errors;
    import org.springmodules.validation.commons.FieldChecks;
     
    public class RteFieldChecks extends FieldChecks{
     
                public static boolean validateIhIdNum(Object bean, ValidatorAction va,
                Field field, Errors errors){
                            //bean에서 해당 field 값을 추출
                            String ihidnum = FieldChecks.extractValue(bean, field); 
     
                    //주민등록번호 유효성 검사 알고리즘은 RteGenericValidator가 가지고 있다.
                            if(!RteGenericValidator.isValidIdIhNum(ihidnum)){ //유효한 주민등록번호가 아니면
                                         FieldChecks.rejectValue(errors, field, va); //에러 처리
                                         return false;
                            }else{
                                         return true;
                            }
                }
    }

    주민등록번호 유효성체크 로직이 있는 RteGenericValidator 클래스를 작성해 보자. 
    유효성 체크 기준은

    <!--[if !supportLists]-->1. <!--[endif]-->값의 길이가 13자리이며, 7번째 자리가 1,2,3,4 중에 하나인가?

    <!--[if !supportLists]-->2. <!--[endif]--> 6자리의 값이 유효한 날짜인가?

    <!--[if !supportLists]-->3. <!--[endif]-->주민등록번호 마지막 자리를 이용한 check

    로 했다.

    package egovframework.rte.ptl.mvc.validation;
    import java.io.Serializable;
    import org.apache.commons.validator.GenericTypeValidator;
     
    public class RteGenericValidator implements Serializable {          
                public static boolean isValidIdIhNum(String value) {                   
                            //값의 길이가 13자리이며, 7번째 자리가 1,2,3,4 중에 하나인지 check.
                            String regex = "\\d{6}[1234]\\d{6}";
                            if (!value.matches(regex)) {
                                         return false;
                            }
     
                            // 6자리의 값이 유효한 날짜인지 check.
                            try {
                                         String strDate = value.substring(0, 6);
                                         strDate = ((value.charAt(6) == '1' || value.charAt(6) == '2') ? "19":"20") + strDate;
                                         strDate = strDate.substring(0, 4) + "/" + strDate.substring(4, 6)
                                                                 + "/" + strDate.substring(6, 8);
     
                                         SimpleDateFormat dateformat = new SimpleDateFormat("yyyy/MM/dd");
                                         Date date = dateformat.parse(strDate);
                                         String resultStr = dateformat.format(date);
     
                                         if (!resultStr.equalsIgnoreCase(strDate)) {
                                                     return false;
                                         }
     
                            } catch (ParseException e) {
                                         // TODO Auto-generated catch block
                                         e.printStackTrace();
                                         return false;
                            }
     
                            //주민등록번호 마지막 자리를 이용한 check.
                            char[] charArray = value.toCharArray();
                            long sum = 0;
                            int[] arrDivide = new int[] { 2, 3, 4, 5, 6, 7, 8, 9, 2, 3, 4, 5 };
                            for (int i = 0; i < charArray.length - 1; i++) {
                                         sum += Integer.parseInt(String.valueOf(charArray[i]))
                                                                 * arrDivide[i];
                            }
     
                            int checkdigit = (int) ((int) (11 - sum % 11)) % 10;
                            return (checkdigit == Integer.parseInt(String.valueOf(charArray[12]))) ? true
                                                     : false;
                }
    }

    validator-rules.xml 설정

    이제 주민등록번호 validation rule을 추가해 보자. 
    rule
    이름은 ihidnum으로 하고 위에서 작성한 코드를 바탕으로 설정하면, (이미 위 개요에 나온 대로) 아래와 같다. 
    client-validation
    을 위해서 자바스크립트 코드도 추가했다. 

          <validator name="ihidnum"
                classname="egovframework.rte.ptl.mvc.validation.RteFieldChecks"
                   method="validateIhIdNum"
             methodParams="java.lang.Object,
                           org.apache.commons.validator.ValidatorAction,
                           org.apache.commons.validator.Field,
                           org.springframework.validation.Errors"                       
                  depends=""
                      msg="errors.ihidnum">
               <javascript><![CDATA[
               function validateIhIdNum(form) {
                    var bValid = true;
                    var focusField = null;
                    var i = 0;
                    var fields = new Array();
                    oIhidnum = new ihidnum();                
                    for (x in oIhidnum) {
                      var field = form[oIhidnum[x][0]];
                      if (field.type == 'text' ||
                                 field.type == 'hidden' ||
                            field.type == 'textarea') {
                            if (trim(field.value).length==0 || !checkIhIdNum(field.value)) {
                                if (i == 0) {
                                    focusField = field;
                                }
                                fields[i++] = oIhidnum[x][1];
                                bValid = false;
                            }
                        }
                    }
                    if (fields.length > 0) {
                        alert(fields.join('\n'));
                    }
                    return bValid;
                }
     
                /**
                 * Reference: JS Guide
                 * http://jsguide.net/ver2/articles/frame.php?artnum=002
                 */             
                function checkIhIdNum(ihidnum){
     
                        fmt = /^\d{6}[1234]\d{6}$/;
                        if(!fmt.test(ihidnum)){
                                    return false;
                        }
     
                        birthYear = (ihidnum.charAt(7) <= "2") ? "19" : "20";
                                                     birthYear += ihidnum.substr(0, 2);
                                                     birthMonth = ihidnum.substr(2, 2) - 1;
                                                     birthDate = ihidnum.substr(4, 2);
                                                     birth = new Date(birthYear, birthMonth, birthDate);
     
                                                     if( birth.getYear() % 100 != ihidnum.substr(0, 2) ||
                                                         birth.getMonth() != birthMonth ||
                                                         birth.getDate() != birthDate) {
                                                         return false;
                                                     }
     
                        var arrDivide = [2, 3, 4, 5, 6, 7, 8, 9, 2, 3, 4, 5];                
                        var checkdigit = 0;                    
                        for(var i=0;i<ihidnum.length-1;i++){
                                    checkdigit += parseInt(ihidnum.charAt(i)) * parseInt(arrDivide[i]);
                        }
                        checkdigit = (11 - (checkdigit%11))%10;
                        if(checkdigit != ihidnum.charAt(12)){
                                    return false;
                        }else{
                                    return true;
                        }
                }
                ]]>
             </javascript>
          </validator>

    validator.xml 설정

    ihidnum이란 필드에 주민등록번호 validation 체크를 해보자. 
    validator.xml
    에 필요한 내용을 추가하고. 

    <form-validation>
        <formset>
            <form name="employee">
             ...
                            <field property="ihidnum" depends="ihidnum"/>
                    ... 
            </form>
        </formset>
    </form-validation>

    messages 프로퍼티에 에러메시지를 추가하자.

    errors.ihidnum=유효하지 않은 주민등록번호입니다.

    TEST

    주민등록번호 server-side,client-side validatin을 위한 환경은 다 갖추어졌다. 
    이제 EmployeeController validation을 추가하고,(이미 추가되어 있다면 pass) 

    package com.easycompany.controller.annotation;
    ...
    import org.springmodules.validation.commons.DefaultBeanValidator;
    ...
     
    @Controller
    public class EmployeeController {     
                ...
                @Autowired
                private DefaultBeanValidator beanValidator;
            ...
                @RequestMapping(value = "/updateEmployee.do", method = RequestMethod.POST)
                public String updateEmployee(@ModelAttribute("employee") Employee employee,                            
                                         BindingResult bindingResult, Model model) {
     
                            beanValidator.validate(employee, bindingResult); //validation 수행
                            if (bindingResult.hasErrors()) { //만일 validation 에러가 있으면...
                                         .....
                                         return "modifyemployee";
                            }
                            employeeManageService.updateEmployee(employee);
                            return "changenotify";
                }        
    }

    VO Class(com.easycompany.model.Employee.java)에 주민등록번호 필드를 추가하고,

    package com.easycompany.model;
    public class Employee {
            ....
                private String ihidnum;
                private String ihidnum1;
                private String ihidnum2;
            ...
                public String getIhidnum() {
                            return ihidnum1+ihidnum2;
                }
                public String getIhidnum1() {                        
                            return ihidnum1;
                }
                public void setIhidnum1(String ihidnum1) {
                            this.ihidnum1 = ihidnum1;
                }
                public String getIhidnum2() {
                            return ihidnum2;
                }
                public void setIhidnum2(String ihidnum2) {
                            this.ihidnum2 = ihidnum2;
            }
    }

    JSP(/easycompany/webapp/jsp/modifyemployee.jsp)에 주민등록번호 입력 필드를 추가하자.

    ...
                <tr>
                            <th>주민번호</th>
                            <td>
                                         <form:input path="ihidnum1" size="10"/> - <form:input path="ihidnum2" size="10"/><form:errors path="ihidnum" />
                                         <form:hidden path="ihidnum"/>
                            </td>
                </tr>
    ...

    주민등록번호를 입력하지 않거나, 틀린번호를 입력시엔 아래와 같은 경고창이 뜬다. 
    <!--[if !vml]-->설명: http://www.egovframe.org/wiki/lib/exe/fetch.php?media=egovframework:rte:ptl:validation:ihidnum-validation.jpg<!--[endif]--> 
    틀린 입력값으로 client를 통과하더라도 Controller에서 validation이 추가로 동작하므로, server-side에서 validation error가 일어날것이다.

    <!--[if !supportLists]-->§  <!--[endif]-->Spring Modules Reference Documentation v 0.9, Chapter 17.Validation, P133~136

     

    출처 - http://www.egovframe.org/wiki/doku.php?id=egovframework:rte:ptl:security:jakarta_commons_validator&s[]=validator

     

    728x90
    반응형
    블로그 이미지

    nineDeveloper

    안녕하세요 현직 개발자 입니다 ~ 빠르게 변화하는 세상에 뒤쳐지지 않도록 우리모두 열심히 공부합시다 ~! 개발공부는 넘나 재미있는 것~!

    ,