@Valid 로 DTO 검증

🤔 검증이 필요한 이유 ?!

컨트롤러의 중요한 역할 중 하나는 HTTP 요청이 정상인지 검증하는 것이다.

클라이언트 검증은 조작이 가능하기 때문에 보안에 취약하다.

서버에서도 잘못된 요청을 검증하는 로직을 필요로 한다.

 

Bean Validation

특정한 구현체가 아니라 Bean Validation 2.x 기술 표준이다.

검증 어노테이션과 여러 인터페이스의 모음이다.

Bean Validation을 잘 활용하면 어노테이션 하나로 검증 로직을 편리하게 적용할 수 있다.

//build.gradle
implementation 'org.springframework.boot:spring-boot-starter-validation'

 

 

 

@AssertFalse : false 값 통과

@AssertTrue : true 값 통과

@DecimalMax(value=, inclusive=) : 지정된 값 이하의 실수 통과

@DecimalMin(value=, inclusive=) : 지정된 값 이상의 실수 통과

@Digits(integer=, fraction=) : 대상 수가 지정된 정수와 자릿수보다 적을 경우 통과

@Email : 이메일 형식 통과

@Future : 대상 날짜가 현재보다 미래일 경우 통과

@Past : 대상 날짜가 현재보다 과거일 경우만 통과

@Max(value=) : 지정된 값보다 아래일 경우만 통과

@Min(value=) : 지정된 값보다 이상일 경우만 통과

@NotNull : null 값이 아닐 경우만 통과

@NotEmpty : null, "" 이 아닌 경우 통과

@NotBlank : null, "", " " 이 아닌 경우 통과

@Null : null일 경우만 통과

@Pattern(regex=, flag=, message=) : 해당 정규식을 만족할 경우만 통과

@Size(min=, max=) : 문자열 또는 배열이 지정된 값 사이일 경우 통과

 

문자열의 공백까지 체크 -> @NotBlank

 

@NotEmpty -> Collection, @NotNull -> 객체

 

//valiation 어노테이션을 사용하려면 컨트롤러에 메서드 매개변수에 @Valid 어노테이션을 붙여야 한다.
@PostMapping("...")
public RespnseEntity<> getDiary(@RequestBody @Valid ...)

//DTO에 적용하기
@Builder
@Getter
@AllArgsConstructor
@NoArgsConstructor
public class diaryReqeust {
	@NotNull(message = "지출 비용 입력")
    @Min(value = 0, message = "지출 비용 최소 0")
    @Max(value = 99, message = "지출 비용 최대 99")
    private Long price;
    
    @NotBlank(message = "지출 명 입력")
    @Size(min = 1, max = 16, message = "지출 명은 16자 이하")
    private String title;
    
    @NotBlank(message = "내용을 입력하셈")
    @Size(min = 1, max = 80, message = "내용은 80자 이하")
    private String context
    ......
    
    //@Email(message = "올바르지 않은 이메일 형식: ${validatedValue}")

Spring MVC 구조

김영한님 강의 중

@Valid는 핸들러 어댑터가 핸들러를 호출하는 과정에서 동작한다.(컨트롤러에서만 동작)

RequestMappingHadlerAdapter 동작 방식

김영한님 강의 중

Controller Test Code

컨트롤러로 들어오는 입력 값에 대한 검증이 제대로 이루어지는지 테스트 코드

title은 @NotBlank기 때문에 공백을 입력하면 예외처리가 되야 된다.

@Test
@DisplayName("exception test")
@NullAndEmptySource
void test() throw Exception {
	DiaryRequest diary = 
    	DiaryRequest.builder()
        .price(3000)
        .title(" ")
        .content("i like it")
        .imgUrl("")
        .evaluation(1)
        .build();
        
	MockHttpServletRequestBuilder requestBuilder =
    	MockMvcRequestBuilders.post("...", 1)
        	.with(csrf())
            .content(objectMapper.writeValueAsString(diary))
            .contentType(MediaType.APPLICATION_JSON)
            .accept(MediaType.APPLICATION_JSON);
            
    mockMvc.perform(requestBuilder)
    	.andDo(print())
        .andExpect(
        	result -> {
            	Exception exception = result.getResolvedException();
                Objects.requireNonNull(exception);
                assertTrue(
                	exception.getClass()
                    .isAssignableFrom(
                    	MethodArgumentNotValidException.class));
            });
}

 

☑️ 최근에 3.3 과제를 보았고 JUnit으로 테스트 코드 작성하는 것이 마지막 마무리였는데 완성하지 못했던 기억이 있다.

서비스의 안정성을 위해서는 잘못된 요청에 대한 검증이 필수인 것같다.

DTO에서 제약조건으로 잘못된 요청을 검증하는 것은 컨트롤러 단에서 막을 수 있기 때문에 효과적이다.

---

참고 자료 : https://github.com/devSquad-study/2023-CS-Study/blob/main/Spring/spring_%40valid.md