[Spring] @Valid를 이용한 @RequestBody 검증 / Exception Handling / 정규 표현식

 

🚀 @Valid

    🔽  개요

Spring을 이용하여 `Controller`를 만들고, 게시판, 회원 가입 등 Client에서 입력값을 받을 때는 항상 유효성 검사(Validation)을 해야 하는 것이에요.

이 유효성 검사는 Client (Front End)에서도 해야 하지만, Server (Back End)에서도 꼭 진행을 해줘야 하는데, 그 이유는 악의적인 이용자가 우회 방법을 통해 Server에게 입력값을 입력하려는 시도를 통해 Client의 유효성 검사를 무력화 시킬 수 있기 때문인 것이에요.

이를 통해 `SQL Injection`, `XSS(Cross Site Scripting)` 등의 공격 방어를 위해 꼭! 입력값에 대한 유효성 검사를 실시해주어 의도하지 않은 값이 들어오지 않게 방어 해줘야 하는 것이에요.

`@Valid`를 이용하면 `Service` 단이 아닌 객체(Entity, VO, DTO)안에서 Client에서 들어오는 값에 대해 검증을 할 수 있는 것이에요.

`Jakarata Bean Validation API Packages`에 있는 `javax.validation.constraints` Package에 있는 기본적인 검증 Annotaion을 이용할 것이에요.

`javax.validation.constraints`Package 안에는 아주 많은 Annotaion이 존재하는데, `@Valid`를 이용한 객체 검증 시 기본적으로 이 Annotaion을 이용한답니다.

 

💡 참고 사항
`SpringBoot`가 Version Update를 하면서 `web` 의존성 안에 있던 `constraints package`가 아예 Module로 빠짐

 

 

 

 

    🔽  의존성 추가

        📦  Maven

pom.xml

 

 

        📦  Gradle

build.gradle

 

 

 

 

 

 

    🔽  @Valid 사용

위의 그림을 보면 50번째 줄 매개변수 입력란에 `@Valid`를 선언한 것을 볼 수 있는 것이에요.
이렇게 하면 RequestBody로 들어오는 객체에 대한 유효성 검사를 실시하라고 지시를 내려준 것이에요.

어떤 것을 검사를 할 것인지는 Entity, VO, DTO 등에 작성을 해 주어야 합니다!

 

DuplicateByUserIDDTO.java

주니하랑은 위 그림과 같이 DTO 객체를 정의하고, username(ID) 필드에 어떻게 값을 받을지에 대해 정의해 준 것이에요.

● @NotBlank : Null이 아닌 값만 허용하며, 공백이 아닌 문자 하나 이상을 포함해야 허용한다.
● @Size(min = x, max = x) : min 보다 크거나, 같고, max 보다 작거나, 같은 문자열 길이 내의 값만 서용한다.
● @Pattern(regex = xxx) : regex에 입력된 정규 표현식에 맞는 값만 입력 허용한다.

 

일단 위와 같이 허용된 값을 넣어서 요청을 보내게 되면 허용이 되는 것을 확인할 수 있는 것이에요.

 

공백 문자 입력 시

{
    "timestamp": 1648444363174,
    "status": 400,
    "error": "Bad Request",
    "trace": "org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.devcommunity.junyharang.common.constant.DefaultResponse com.devcommunity.junyharang.controller.member.UserController.duplicateUserID(com.devcommunity.junyharang.model.dto.user.DuplicateByUserIDDTO) with 2 errors: [Field error in object 'duplicateByUserIDDTO' on field 'username': rejected value [ ]; codes [NotBlank.duplicateByUserIDDTO.username,NotBlank.username,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [duplicateByUserIDDTO.username,username]; arguments []; default message [username]]; default message [공백일 수 없습니다]] [Field error in object 'duplicateByUserIDDTO' on field 'username': rejected value [ ]; codes [Pattern.duplicateByUserIDDTO.username,Pattern.username,Pattern.java.lang.String,Pattern]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [duplicateByUserIDDTO.username,username]; arguments []; default message [username],[Ljavax.validation.constraints.Pattern$Flag;@3bf02bec,^[0-9a-zA-Z]+$]; default message [\"^[0-9a-zA-Z]+$\"와 일치해야 합니다]] \n\tat org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:141)\n\tat org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:122)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:179)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:146)\n\tat org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)\n\tat org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)\n\tat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067)\n\tat org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)\n\tat org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)\n\tat org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:681)\n\tat org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:764)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:327)\n\tat org.springframework.security.web.access.intercept.FilterSecurityInterceptor.invoke(FilterSecurityInterceptor.java:115)\n\tat org.springframework.security.web.access.intercept.FilterSecurityInterceptor.doFilter(FilterSecurityInterceptor.java:81)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:122)\n\tat org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:116)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:126)\n\tat org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:81)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.authentication.AnonymousAuthenticationFilter.doFilter(AnonymousAuthenticationFilter.java:109)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter.doFilter(SecurityContextHolderAwareRequestFilter.java:149)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.savedrequest.RequestCacheAwareFilter.doFilter(RequestCacheAwareFilter.java:63)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:103)\n\tat org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:89)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.header.HeaderWriterFilter.doHeadersAfter(HeaderWriterFilter.java:90)\n\tat org.springframework.security.web.header.HeaderWriterFilter.doFilterInternal(HeaderWriterFilter.java:75)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:110)\n\tat org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:80)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter.doFilterInternal(WebAsyncManagerIntegrationFilter.java:55)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.FilterChainProxy.doFilterInternal(FilterChainProxy.java:211)\n\tat org.springframework.security.web.FilterChainProxy.doFilter(FilterChainProxy.java:183)\n\tat org.springframework.web.filter.DelegatingFilterProxy.invokeDelegate(DelegatingFilterProxy.java:354)\n\tat org.springframework.web.filter.DelegatingFilterProxy.doFilter(DelegatingFilterProxy.java:267)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:197)\n\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)\n\tat org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:540)\n\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135)\n\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)\n\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)\n\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:359)\n\tat org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399)\n\tat org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)\n\tat org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:889)\n\tat org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1735)\n\tat org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\n\tat org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)\n\tat org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)\n\tat org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\n\tat java.base/java.lang.Thread.run(Thread.java:829)\n",
    "message": "Validation failed for object='duplicateByUserIDDTO'. Error count: 2",
    "errors": [
        {
            "codes": [
                "NotBlank.duplicateByUserIDDTO.username",
                "NotBlank.username",
                "NotBlank.java.lang.String",
                "NotBlank"
            ],
            "arguments": [
                {
                    "codes": [
                        "duplicateByUserIDDTO.username",
                        "username"
                    ],
                    "arguments": null,
                    "defaultMessage": "username",
                    "code": "username"
                }
            ],
            "defaultMessage": "공백일 수 없습니다",
            "objectName": "duplicateByUserIDDTO",
            "field": "username",
            "rejectedValue": " ",
            "bindingFailure": false,
            "code": "NotBlank"
        },
        {
            "codes": [
                "Pattern.duplicateByUserIDDTO.username",
                "Pattern.username",
                "Pattern.java.lang.String",
                "Pattern"
            ],
            "arguments": [
                {
                    "codes": [
                        "duplicateByUserIDDTO.username",
                        "username"
                    ],
                    "arguments": null,
                    "defaultMessage": "username",
                    "code": "username"
                },
                [],
                {
                    "arguments": null,
                    "defaultMessage": "^[0-9a-zA-Z]+$",
                    "codes": [
                        "^[0-9a-zA-Z]+$"
                    ]
                }
            ],
            "defaultMessage": "\"^[0-9a-zA-Z]+$\"와 일치해야 합니다",
            "objectName": "duplicateByUserIDDTO",
            "field": "username",
            "rejectedValue": " ",
            "bindingFailure": false,
            "code": "Pattern"
        }
    ],
    "path": "/api/user/duplicate/userid"
}

 

위 그림은 공백을 입력 했을 때 모습인 것이에요.

 

특수문자를 섞어 입력 했을 경우

 

{
    "timestamp": 1648444453061,
    "status": 400,
    "error": "Bad Request",
    "trace": "org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.devcommunity.junyharang.common.constant.DefaultResponse com.devcommunity.junyharang.controller.member.UserController.duplicateUserID(com.devcommunity.junyharang.model.dto.user.DuplicateByUserIDDTO): [Field error in object 'duplicateByUserIDDTO' on field 'username': rejected value [#$%junyharang]; codes [Pattern.duplicateByUserIDDTO.username,Pattern.username,Pattern.java.lang.String,Pattern]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [duplicateByUserIDDTO.username,username]; arguments []; default message [username],[Ljavax.validation.constraints.Pattern$Flag;@3bf02bec,^[0-9a-zA-Z]+$]; default message [\"^[0-9a-zA-Z]+$\"와 일치해야 합니다]] \n\tat org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor.resolveArgument(RequestResponseBodyMethodProcessor.java:141)\n\tat org.springframework.web.method.support.HandlerMethodArgumentResolverComposite.resolveArgument(HandlerMethodArgumentResolverComposite.java:122)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.getMethodArgumentValues(InvocableHandlerMethod.java:179)\n\tat org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:146)\n\tat org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)\n\tat org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)\n\tat org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)\n\tat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067)\n\tat org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963)\n\tat org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)\n\tat org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:681)\n\tat org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)\n\tat javax.servlet.http.HttpServlet.service(HttpServlet.java:764)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:327)\n\tat org.springframework.security.web.access.intercept.FilterSecurityInterceptor.invoke(FilterSecurityInterceptor.java:115)\n\tat org.springframework.security.web.access.intercept.FilterSecurityInterceptor.doFilter(FilterSecurityInterceptor.java:81)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:122)\n\tat org.springframework.security.web.access.ExceptionTranslationFilter.doFilter(ExceptionTranslationFilter.java:116)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:126)\n\tat org.springframework.security.web.session.SessionManagementFilter.doFilter(SessionManagementFilter.java:81)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.authentication.AnonymousAuthenticationFilter.doFilter(AnonymousAuthenticationFilter.java:109)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter.doFilter(SecurityContextHolderAwareRequestFilter.java:149)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.savedrequest.RequestCacheAwareFilter.doFilter(RequestCacheAwareFilter.java:63)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:103)\n\tat org.springframework.security.web.authentication.logout.LogoutFilter.doFilter(LogoutFilter.java:89)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.header.HeaderWriterFilter.doHeadersAfter(HeaderWriterFilter.java:90)\n\tat org.springframework.security.web.header.HeaderWriterFilter.doFilterInternal(HeaderWriterFilter.java:75)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:110)\n\tat org.springframework.security.web.context.SecurityContextPersistenceFilter.doFilter(SecurityContextPersistenceFilter.java:80)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter.doFilterInternal(WebAsyncManagerIntegrationFilter.java:55)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)\n\tat org.springframework.security.web.FilterChainProxy$VirtualFilterChain.doFilter(FilterChainProxy.java:336)\n\tat org.springframework.security.web.FilterChainProxy.doFilterInternal(FilterChainProxy.java:211)\n\tat org.springframework.security.web.FilterChainProxy.doFilter(FilterChainProxy.java:183)\n\tat org.springframework.web.filter.DelegatingFilterProxy.invokeDelegate(DelegatingFilterProxy.java:354)\n\tat org.springframework.web.filter.DelegatingFilterProxy.doFilter(DelegatingFilterProxy.java:267)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)\n\tat org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)\n\tat org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)\n\tat org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)\n\tat org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:197)\n\tat org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)\n\tat org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:540)\n\tat org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135)\n\tat org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)\n\tat org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)\n\tat org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:359)\n\tat org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399)\n\tat org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)\n\tat org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:889)\n\tat org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1735)\n\tat org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)\n\tat org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)\n\tat org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)\n\tat org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)\n\tat java.base/java.lang.Thread.run(Thread.java:829)\n",
    "message": "Validation failed for object='duplicateByUserIDDTO'. Error count: 1",
    "errors": [
        {
            "codes": [
                "Pattern.duplicateByUserIDDTO.username",
                "Pattern.username",
                "Pattern.java.lang.String",
                "Pattern"
            ],
            "arguments": [
                {
                    "codes": [
                        "duplicateByUserIDDTO.username",
                        "username"
                    ],
                    "arguments": null,
                    "defaultMessage": "username",
                    "code": "username"
                },
                [],
                {
                    "arguments": null,
                    "defaultMessage": "^[0-9a-zA-Z]+$",
                    "codes": [
                        "^[0-9a-zA-Z]+$"
                    ]
                }
            ],
            "defaultMessage": "\"^[0-9a-zA-Z]+$\"와 일치해야 합니다",
            "objectName": "duplicateByUserIDDTO",
            "field": "username",
            "rejectedValue": "#$%junyharang",
            "bindingFailure": false,
            "code": "Pattern"
        }
    ],
    "path": "/api/user/duplicate/userid"
}

이렇게 정해 놓은 규칙에 맞지 않는 입력값이 나오면 HTTP Status Code 400(Bad Request - 나쁜 요청)이라고 알려주면서 입력을 받지 않는 것을 볼 수 있는 것이에요.

지금 위에서 보이는 `Response` 내용은 `Spring`이 자동으로 일정 규격에 맞춰 생성한 `Exception` 틀에 맞춰 응답을 해주는 것이에요.

따.라.서 `@Valid`와 검증 Annotaion만 잘 써준다면 입력값에 대한 문제를 해결할 수 있다는 것이에요.

 

 

 

 

 

    🔽  검증용 Annotaion

        📦  문자열 유무 검증(@NotBlank, @NotEmpty, @NotNull)

종 류	null 허용 여부	"" 허용 여부	" " 허용 여부	내  용
@NotNull	허용 안함	허용	허용	- type : 어떤 Type이든 허용. - null이 아닌 값만 허용. -반드시 값이 존재해야 한다.
@NotEmpty	허용 안함	허용 안함	허용	- type : CharSequence(length of character) Collection (collection size) Map (map size Array (array length) - null이거나, empty(빈 문자열)이 아니어야 허용. - 반드시 값이 존재해야 하고, 길이 혹은 크기가 0보다 커야 한다.
@NotBlank	허용 안함	허용 안함	허용 안함	- null이 아닌 값만 허용. - 공백이 아닌 문자 하나 이상 포함해야 허용. - 반드시 값이 존제하고, 공백 문자를 제외한 길이가 0보다 커야 한다.

 

        📦  최대 최소에 대한 검증

SupportType

● BigDecimal, BitInteger, CharSequence byte, short, int, long에 대응하는 Wrapper Class.
● double, float는 rounding Error로 인해 미지원.
● null 또한 허용으로 간주.

 

예시 코드

 

 

        📦  범위 값에 대한 검증

SupportType

● BigDecimal, BitInteger, CharSequence byte, short, int, long, double, float에 대응하는 Wrapper Class.
● null 또한 허용으로 간주.

 

종      류	내    용
@Posive	양수인 값만 허용.
@PosiveOrZero	0이거나, 양수인 값만 허용.
@Negative	음수인 값만 허용.
@NegativeOrZero	0이거나, 음수인 값만 허용.

 

예시 코드

 

 

        📦  시간 값에 대한 검증

SupportType

● java.util.Date, java.util.Calendar, java.time.instant, java.time.LocalDate, java.time.LocalDateTime, java.time.LocalTime, java.time.MonthDay, java.time.OffsetDateTime, java.time.OffsetTime, java.time.Year, java.time.YearMonty, java.time.ZonedDateTime, java.time.chrono.HijrahDate, java.time.chrono.JapaneseDate java.time.chrono.MinguoDate, java.time.chrono.ThaiBuddhistDate

● null 또한 허용으로 간주.

 

`Now`의 기준

`ClockProvider`의 `Virtual Machine`에 따라 현재 시간을 정의. 필요한 경우 `default time zone`을 적용.

 

예시 코드

 

 

        📦  Email 검증

SupportType

● null 또한 허용으로 간주.

 

Validation

● @Email : 올바른 형식의 Email 주소여야 하며, (`@`가 꼭 들어가야하고, Domain에 '.'는 검사하지 않음)

 

예시 코드

 

 

        📦  자릿수 검증

SupportType

● BigDecimal, BigInteger, CharSequence byte, short, int, long에 대응하는 Wrapper Class.
● null도 허용으로 간주

 

Validation

● @Digits : 허용된 범위 내 숫자값
   - Require : int integer = 이 숫자에 허용되는 최대 정수 자릿수
   - Require : int fraction = 이 숫자에 허용되는 최대 소수 자릿수 

 

 

예시 코드

 

 

 

        📦  참과 거짓(Boolean) 검증

SupportType

● Boolean, boolean

 

Validation

종   류	내   용
@AssertTure	값이 항상 `Ture`만 허용
@AssertFalse	값이 항상 `False`만 허용

 

 

예시 코드

 

 

 

        📦  크기 검증

SupportType

● CharSequence (length of character sequence), Collection (collection size), Map (map size), Array(array length)

● null도 허용으로 간주

 

Validation

종   류	내   용	Option
@Size	이 크기가 지정된 경계(포함) 사이에 있는 값만 허용	int max : element의 크기가 작거나 같다. int min : element의 크기가 크거나 같다.

 

 

예시 코드

 

 

 

        📦  정규식 검증

SupportType

● CharSequence
● null도 허용으로 간주

 

Validation

종   류	내   용	Option
@Pattern	지정한 정규식과 대응되는 문자열만 허용. JAVA의 Pattern Package의 Convention을 따름.	String regxp : 정규식 문자열 지정.

 

 

예시 코드

 

 

 

        📦  그 밖의 @Valid 정리

종   류	지원 Type	내   용
@Future	Time Class	Now 보다 미래의 날짜와 시간만 허용.
@FutureOrPresent	Time Class	Now의 시간이거나, 미래의 날짜, 시간만 허용.
@Past	Time Class	Now보다 과거의 날짜, 시간만 허용.
@PastOrPrensent	Time Class	Now의 시간이거나, 과거의 날짜, 시간만 허용.

 

 

 

 

 

 

 

🚀 @Valid Exception Handling

우리는 바로 위에서 `Spring`이 스스로 만들어서 규칙에 맞지 않았을 때, Exception을 던지는 모습을 본 것이에요.
근데, 너무 길고, 복잡한 것이 너무 마음에 들지 않는 것이에요. 이럴 때, 개발자는 개발자가 원하는 Exception을 던질 수 있도록 `Exception Handling`을 해 줄 수 있답니다.

 

2022-03-28 14:12:43.166  WARN 3432 --- [nio-8080-exec-2] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.devcommunity.junyharang.common.constant.DefaultResponse com.devcommunity.junyharang.controller.member.UserController.duplicateUserID(com.devcommunity.junyharang.model.dto.user.DuplicateByUserIDDTO) with 2 errors: [Field error in object 'duplicateByUserIDDTO' on field 'username': rejected value [ ]; codes [NotBlank.duplicateByUserIDDTO.username,NotBlank.username,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [duplicateByUserIDDTO.username,username]; arguments []; default message [username]]; default message [공백일 수 없습니다]] [Field error in object 'duplicateByUserIDDTO' on field 'username': rejected value [ ]; codes [Pattern.duplicateByUserIDDTO.username,Pattern.username,Pattern.java.lang.String,Pattern]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [duplicateByUserIDDTO.username,username]; arguments []; default message [username],[Ljavax.validation.constraints.Pattern$Flag;@3bf02bec,^[0-9a-zA-Z]+$]; default message ["^[0-9a-zA-Z]+$"와 일치해야 합니다]] ]

반응형

 

잘못된 입력값이 들어왔을 때, 위와 같이 `MethodArgumentNotValidException`이 발생하는 것을 볼 수 있는 것이에요. 이것을 이용하여 Custom 하게 Exception을 처리할 수 있답니다.

이 Exception을 Handling 하고자 하는 `Controller`에서 정의해도 되지만, 주니하랑은 전역적 사용을 위해 아래와 같이 `@ControllerAdvice`를 정의해서 이용할 것이에요.

ExceptionAdvisor.java

 

먼저 매개변수로`MethodArgumentNotValidException`을 받아 `@Valid`에 대한 유효성 검사가 실패 했을 때, 해당 Method가 호출되게 한 것이에요.

`BindingResult`에 `FiedError`에서 검증이 실패한 Field 이름(Member 변수 이름), 실패에 대한 Message, 유효성 검사가 실패한 입력값을 가져와 출력될 Message를 만들어 주고 있는 것이에요.

그리고 나서 `Return Type`을 보면 `ResponseEntity<DefaultResponse<String>>`으로 해 두었는데,

 

DefaultResponse.java

주니하랑은 응답(Reponse)가 나갈 때, 보다 정갈하고, 편리하게 응답을 보내기 위해 위와 같은 Class 하나를 미리 만들어 둔 것이에요. 이것에 맞추어 응답값을 보내게 하기 위해 Return Type을 위와 같이 해 준 것이랍니다. 

`ExceptionAdvisor.java`의 return문은 그렇기 때문에 처음에 HTTP Status Code (400)의 value(Bad Request)를 입력되게 해 주었고, 한글로 무슨 문제가 발생했는지 알려주게 입력을 해 주고, 문제에 대한 상세 내용이 출력되게 해주고, Http Status Code 400을 입력해 주어 Exception이 나갈 수 있게 해 준 것이에요.

이렇게 해서 다시 틀린 요청을 보내게 되면 아래와 같이 정리된 Exception이 응답되는 것을 확인할 수 있답니다.

 

특수 문자를 섞어 입력 했을 때

 

 

 

 

 

 

 

🚀 정규 표현식(Regualr Expression)

    🔽  정규 표현식 정리표

표  현  식	설      명
^	문자열의 시작을 의미
$	문자열의 종료를 의미
.	임의의 한 문자 (문자의 종류 상관 없으나, \ 는 넣을 수 없다.)
*	앞 문자가 없을 수도 있고, 무한정으로 많을 수도 있음을 의미
+	앞 문자가 하나 이상을 의미
?	앞 문자가 없거나, 하나 있음음 의미
[]	문자의 집합이나, 범위를 의미하며, 두 문자 사이는 - 기호를 통해 범위를 표현. [] 안에서 ^가 먼저 존재하면 `not`을 의미 [a-zA-Z] a~z, A~z 중 하나의 문자 의미 []는 한개의 문자를 의미하기도 함. [abc] a,b,c 중 하나의 문자 의미 [^abc] a,b,c 외에 하나의 문자 의미
{}	횟수 또는 범위를 의미
{n}	정확히 n개
{n,}	최소한 n개
{n,m}	n개 부터 m개까지
()	소괄호 안의 문자를 하나의 문자로 인식하겠다는 의미
|	Pattern 안에서 or 연산 수행을 하고자 할 때 사용
\s	공백 문자 의미
\S	공백 문자가 아닌 나머지 문자 의미
\w	Alphabet 또는 숫자 또는 `언더바(_)`를 의미
\W	Alphabet 또는 숫자 또는 `언더바(_)`를 제외한 문자를 의미
\d	정수 [0-9]와 똑같은 의미
\D	숫자를 제외한 모든 문자
\	정규표현식 역슬래시( \ )는 확장 문자를 의미. 역슬래시 다음에 일반 문자가 오면 특수문자로 취급하고, 역슬래시 다음에 특수문자가 오면 그 문자 자체를 의미(일반 문자로 취급)
(?i)	앞 부분 (?i)라는 Option을 넣어주면 대, 소문자를 구분하지 않겠다는 의미

 

 

 

 

    🔽  자주 쓰이는 정규식 Pattern

분   류	정 규 식  Pattern
숫자	^[0-9]+$
영(소, 대)문자	^[a-zA-Z]+$
한글	^[가-힣]+$
영어, 숫자 조합	^[a-zA-Z0-9]+$
비밀번호 (숫자, 영(소, 대)문자 포함 6 ~ 12자리 이내)	^[a-zA-Z0-9]{6,12}$
비밀번호 (숫자, 영(소, 대)문자, 특수문자 포함 8~15자리 이내)	^.*(?=^.{8,15}$)(?=.*\d)(?=.*[a-zA-Z])(?=.*[!@#$%^&+=].*$
E-mail	^[0-9a-zA-Z]+@[0-9a-zA-Z]+\\.([a-z]+)*$
휴대전화 번호	^01(?:0|1|[6-9])?(\\d{3}|\\d{4})?(\\d{4})$
일반전화 번호	^0(?:2-9)?(?:2-9)?(\\d{3}|\\d{4})?(\\d{4})$
주민등록 번호	^\d{6}\-[1-4]\d{6}$
File 확장자	^\\S+(?i)(txt|pdf|hwp|xls|png|jpg)&
이 중 File 확장자	^(.+?)(\\.tar)?\\.gz)$

 

        📦  한글 포함 여부 확인

● `matches()`는 `String`에 사용할 수 있는 Method.
● `*`은 맨 앞에 올 수 없기 때문에 앞에 `.`을 선언.
● `[ㄱ-ㅎ]` 은 ㄱ 부터 ㅎ 까지 의미.
● '[ㅏ-ㅣ]`는 ㅏ 부터 ㅣ 까지 의미.
● '[가-힣]`은 한글 자, 모음을 조합하여 만들 수 있는 모든 한글 의미.
● `+`는 한글이 하나 이상 반복됨을 의미.
● `.*`은 한 글자 또는 문자열 의미.

 

 

        📦  핸드폰 번호 Pattern 만들기

대한민국에서 사용하는 핸드폰 번호 Pattern을 한번 만들어 볼 것이에요.

우리나라의 핸드폰 번호는 3개로 구분되어 사용하고 있는 것이에요.

첫번째 자리에는 아래와 같은 번호들이 올 수 있답니다.

010
011
016
017
018
019

지금은 `010`만 이용되고 있지만, 업무로 인해 핸드폰 번호를 바꾸지 못하셨던 분들은 어쩌면 아직도 옛날 `Pattern`을 이용하고 계실지 모르는 것이에요.

 

두번째 자리는 3 ~ 4자리의 임의의 숫자가 오면 되는 것이에요.

세번째 자리는 일반적으로 4자리를 지정하고 있으니 그것을 따르도록 할 것이에요.

자릿수 사이에 아무 표기도 사용하지 않거나 `-`혹은 `.`으로 구분하는 것을 허용하는 걸로 작성해 볼 것이에요.

예를 들자면

01012345678
010-1234-5678
010.1234.5678

이렇게 말이에요.

 

► 첫번째 자리의 세 자리

`^01`

정규 표현식 `Pattern`을 의미하는 `^`를 시작으로 `01`을 추가한 것이에요.
문자열의 시작을 `01`로 시작할거야! 라고 알려준 것이에요.

`01(?:0|1|[6-9])`

`01` 다음에 오는 값으로 0, 1 또는 6 ~ 9 사이 값이 허용되도록 한 것이에요.

 

► 두번째 자리

`01(?:0|1|[6-9])(\\d{3}|\\d{4})`

3자리 또는 4자리의 임의의 숫자를 허용되도록 한 것이에요.

 

► 세번째 자리

`01(?:0|1|[6-9])(\\d{3}|\\d{4})(\\d{4})$`

마지막 4자리의 숫자를 지정한 것이에요. 그리고, 표현식의 종료를 알리는 `$`로 마무리 해준 것이에요.

 

 

► 구분값 추가

핸드폰 번호를 입력시 `-`, `.`을 추가해서 입력하는 경우가 종종 있는 것이에요.
아무런 표기를 하지 않고, 숫자만 입력 받거나, 위의 특수문자를 허용하도록 해 볼 것이에요.

`01(?:0|1|[6-9])[.-]?(\\d{3}|\\d{4})[.-]?(\\d{4})$`

`[.-]?`

이 뜻은 `.`,  `-` 값이 없거나, 단 한개만 존재하는 것을 의미하는 것이에요.

 

 

 

 

 

    🔽  Pattern Class

● 정규 표현식에 대한 문자열 검증.
● 공개된 생성자 미 제공.
● `Pattern` 생성 시 `Pattern` 객체를 반환하는 정적 `compile` Method 호출.
● 'matches()`를 활용하여 검증
● regex
  - 정규 표현식
● input
 - 검증할 문자열

 

예시 코드

 

 

 

    🔽  Matcher Class

● `Pattern`을 해석하고, 입력 문자열에 대해 일치 작업을 수행하는 엔진.
● `Pattern` Class와 동일하게 공개된 생성자 미 정의.
● `Pattern` 객체의 `matcher()`를 호출해서 결과값을 얻는다.
● 'matches()`활용하여 검증
● regex
  - 정규 표현식
● input
 - 검증할 문자열

 

 

 

예시 코드