[내일배움캠프_Spring Boot 숙련주차] 데이터 검증하기(Validation)

Validation

Validation은 프로그래밍을 하는데에 있어서 가장 중요한 부분 중 하나임

• Java는 null 값에 대한 접근에 대해 NullPointerException 오류가 발생하기 때문에 이러한 부분을 예방하기 위해 Validation 즉, 검증 과정이 필요함
• Spring에서는 null 확인 뿐 아니라 문자의 길이 측정과 같은 다른 검증 과정도 쉽게 처리할 수 있도록 Bean Validation 제공하고 있음

Bean Validation

@NotNull	null 불가
@NotEmpty	null, "" 불가
@NotBlank	null, "", " " 불가
@Size	문자 길이 측정
@Max	최대값
@Min	최소값
@Positive	양수
@Negative	음수
@Email	E-mail 형식
@Pattern	정규 표현식

 

﹡Validation을 사용하기 위해 dependencies에 라이브러리 추가해야함

implementation 'org.springframework.boot:spring-boot-starter-validation'

DTO에 Bean Validation 설정

package com.sparta.springauth.dto;

import jakarta.validation.constraints.*;
import lombok.Getter;

@Getter
public class ProductRequestDto {
    @NotBlank
    private String name;
    @Email
    private String email;
    @Positive(message = "양수만 가능합니다.")
    private int price;
    @Negative(message = "음수만 가능합니다.")
    private int discount;
    @Size(min=2, max=10)
    private String link;
    @Max(10)
    private int max;
    @Min(2)
    private int min;
}

Valid 동작 이해

• Controller 내 데이터 검증을 하고 싶은 DTO 앞에 @Valid 어노테이션 추가

@PostMapping("/validation")
@ResponseBody
public ProductRequestDto testValid(@RequestBody @Valid ProductRequestDto requestDto) {
    return requestDto;
}

 

정확한 입력값을 보냈을 경우

결과

잘못된 입력값을 보냈을 경우

---

Validation 예외처리

회원가입 DTO Validation 적용

package com.sparta.springauth.dto;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class SignupRequestDto {
    @NotBlank
    private String username;
    @NotBlank
    private String password;
    @Email
    @NotBlank
    private String email;
    private boolean admin = false;
    private String adminToken = "";
}

 

Controller 단에서 Validation 예외처리하기

- BindingResult는 Validation에서 예외가 발생하면 BindingResult 객체에 오류에 대한 정보가 담겨서 들어옴

@PostMapping("/user/signup")
// BindingResult: Validation에서 예외가 발생하면 BindingResult 객체에 오류에 대한 정보 담겨서 들어옴
public String signup(@Valid SignupRequestDto requestDto, BindingResult bindingResult) {
    // Validation 예외처리
    List<FieldError> fieldErrors = bindingResult.getFieldErrors(); // 오류가 난 필드 가져오기
    if(fieldErrors.size() > 0) {
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            // 오류가 난 필드 가져오기
            log.error(fieldError.getField() + " 필드 : " + fieldError.getDefaultMessage());
        }
        return "redirect:/api/user/signup";
    }

    userService.signup(requestDto);

    return "redirect:/api/user/login-page";
}

예외 발생

정규 표현식(Regular Expression; Regex, Regexp)

정규 표현식은 특정한 규칙을 가진 문자열의 집합을 표현하기 위해 쓰이는 형식 언어로,

어떤 텍스트 내에서 '특정한 형태나 규칙을 가진 문자열'을 찾기 위해 그 형태나 규칙을 나타내는 패턴을 정의하는 식을 뜻함

 

정규 표현식 기본 문법

1. 패턴 그대로를 매칭하는 경우: 단어 그대로를 패턴으로 사용해 매칭되는 영역을 찾는 방법
2. 메타문자 및 수량 한정자를 사용하는 경우: 정규식 패턴에 쓰이는 문자 중에는 특별한 의미를 지니는 메타 문자들이 있는데, 이러한 메타문자와 그 메타문자의 개수를 지정(수량 한정자의 역할)하여 폭넓은 패턴을 매칭하는 방법
3. 그룹 및 Look around(전, 후방 탐색) 기능을 사용하는 경우: 패턴의 일부를 그룹으로 묶거나, 특정 패턴의 앞 또는 뒤로 다른 패턴이 오는 조건을 더하는 경우

정규 표현식 메타 문자

메타 문자는 특정한 문자 혹은 문자 계열을 대신해 표시하는 문자로, 메타 문자를 이용하면 특정한 규칙을 가진 여러 단어를 하나의 패턴으로 함축할 수 있음
- 메타문자에서 대소문자는 서로 반대되는 의미를 지니는 경우가 많음!

 

메타 문자 정리 참고 사이트

정규표현식(Regex)의 개념과 기초 문법

 

정규 표현식을 사용해 이메일 Validation 설정

@Pattern(regexp = "^(.+)@(.+)$") // '@'기호만 확인
@Pattern(regexp = "[A-Za-z0-9+_.-]+@(.+)$") // 앞 부분만 규칙 설정(A-Z, a-z, 0-9, _, . 모두 허용)
@Pattern(regexp = "[A-Za-z0-9_!#$%&'*+/=?`{|}~^.-]+@[A-Za-z0-9.-]+$") // 앞 뒤 모두 검증(앞은 이메일에서 허용하는 것들 모두 추가해봄)