📒목표

@Valid와 @Validated의 차이점 및 동작 흐름에 대해 알아본다.

• Spring Boot: 3.3.5
  • Spring MVC
  • Data JPA: MySQL(latest)

📒도커 컴포즈로 MySQL 실행

프로젝트 루트 경로에 다음과 같이 docker-compose.yml 파일을 작성해준다.

services:
  mysql:
    image: mysql
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=test
      - MYSQL_DATABASE=validation
      - MYSQL_USER=alsry
      - MYSQL_PASSWORD=alsry
    ports:
      - "3306:3306"
    volumes:
      - ./mysql-data:/var/lib/mysql
    command:
      - --character-set-server=utf8mb4
      - --collation-server=utf8mb4_unicode_ci

TZ 같은 리눅스 표준 환경변수에 대한 값도 environment 필드에 작성 가능하다. 여기선 별도로 작성하지 않았다.

표준 환경변수에 대한 내용은 gnu, posix docs 같은 곳에 찾아보면 잘 나와있다.

docker compose up -d

명령어를 실행하여 컨테이너를 띄운다.

연결 테스트도 성공하였다.

📒Spring boot와 MySQL 연결

spring:
  application:
    name: validation
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/validation?useSSL=false&characterEncoding=UTF-8
    username: alsry
    password: alsry
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true
    properties:
      hibernate:
        format_sql: true

application.yml 파일을 작성하고 스프링 애플리케이션을 실행해본다.

jdbc url의 프로퍼티 종류들은 mysql connectorJ 공식 문서에서 확인 가능하며, com.mysql.cj.conf 패키지의 PropertyKey enum 에섣 확인 가능하다.

참고로 url 프로퍼티 중에 serverTimezone 프로퍼티 설정을 하면 com.mysql.cj.protocol.a.NativeProtocol#configureTimeZone에서 타임존 설정을 진행한다. 나중에 참고하면 좋다.

실행 성공했으면 준비 끝

📒Member Entity 작성

@Entity
@Getter
@Table(uniqueConstraints = {@UniqueConstraint(name = "USERNAME_UNIQUE", columnNames = {"username"})})
public class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column
    private String username;

    @Column(nullable = false, length = 24)
    private String password;

    @Enumerated(value = EnumType.STRING)
    private MemberRole role;

    @CreatedDate
    private LocalDateTime createdDate;

    @LastModifiedDate
    private LocalDateTime modifiedDate;
}

딱히 제약조건이 필요한 건 아니지만 그냥 구색 맞추기 용으로 좀 써봤다.

📒Controller, Service, Repository 작성

@RequestMapping("/member")
@RestController
@RequiredArgsConstructor
public class MemberController {
    private final MemberService memberService;

    @GetMapping
    public String getMembers() {
        return "getMembers";
    }

    @GetMapping("/{id}")
    public String getMember(@PathVariable Long id) {
        return "getMember";
    }

    @PostMapping
    public String postMembers() {
        return "postMembers";
    }

    @PatchMapping
    public String patchMembers() {
        return "patchMembers";
    }

    @DeleteMapping
    public String deleteMembers() {
        return "deleteMembers";
    }
}

@Service
@RequiredArgsConstructor
public class MemberService {
    private final MemberRepository memberRepository;
}

public interface MemberRepository extends JpaRepository<Member, Long> {
}

테스트를 위해 컨틀롤러, 서비스, 리포지토리도 일단 적어둔다.

✔️포스트맨으로 api가 잘 동작하는지 확인

여기까지 오케이

✔️POST /members api를 위한 DTO를 만들고 검증하기

MemberPostDto

@Getter
public class MemberPostDto {
    @NotBlank
    @Length(min = 3, max = 20)
    private String username;

    @Length(min = 8, max = 24)
    @Pattern(regexp = "^(?=.*[!@#$%^&*(),.?\":{}|<>])(?=.*[a-zA-Z])(?=.*\\d)\\S+$",
            message = "특수문자 하나를 반드시 포함해야 하고, 공백이 없어야 합니다.")
    private String password;
}

📌@Validated로 @RequestBody 검증 및 디버깅

{
    "username": "aa",
    "password": "1a2s3d4f"
}

위 데이터로 @Validated로 검증해보자

응답 메세지

"message": "Validation failed for object='memberPostDto'. Error count: 2",
"errors": [
  {
    "codes": [
      "Length.memberPostDto.username",
      "Length.username",
      "Length.java.lang.String",
      "Length"
    ],
    "arguments": [
      {
        "codes": [
          "memberPostDto.username",
          "username"
        ],
        "arguments": null,
        "defaultMessage": "username",
        "code": "username"
      },
      20,
      3
    ],
    "defaultMessage": "길이가 3에서 20 사이여야 합니다",
    "objectName": "memberPostDto",
    "field": "username",
    "rejectedValue": "aa",
    "bindingFailure": false,
    "code": "Length"
  }
  ...
]

발생 에러는 MethodArgumentNotValidException이고 응답 메세지는 대충 요런식이다.

codes 필드를 살펴보면 "Length.memberPostDto.username" 형식인데
1. 코드
2. 매핑할 객체
3. 필드
이런식으로 구성되어 있다.

나머지도 비슷하다.

디버깅으로 어디서 에러를 발생시키는지 따라가보자.

👉디버깅

RequestResponseBodyMethodProcessor(HandlerMethodArgumentResolver)의 resolveArgument 메소드가 실행된다.

AbstractMessageConverterMethodArgumentResolver#validateIfApplicable이 실행되면서 파라미터에 붙은 어노테이션들을 파악한다.

ValidationAnnotationUtils#determineValidationHints가 실행되면서 검증 어노테이션이 @Validated인지 @Valid인지 파악하고 @Validated라면 어노테이션에 전달된 파라미터(어노테이션 힌트)목록들을 반환한다.

위 메소드에서 반환된 값이 null이 아니라면 WebDataBinder#validate가 실행된다.

DataBinder#validate에서 실제 검증작업을 하는데 메소드의 파라미터 validatorHints가 비어있지 않고(@Validated 어노테이션에 그룹이 적용되는 부분을 말하는 것으로 보임), 적용된 검증기가 SmartValidator면
if 조건에 해당되며 ConstrationViolationException 이 발생하고,

그게 아니라면 else if 조건에 해당되어 MethodArgumentNotValidException이 발생한다.

📒결론

MethodArugmentNotValidException이 발생하는 이유는, HandlerMethodArgumentResolver인 RequestResponseBodyMethodProcessor에서 검증을 진행하고 여기서 해당 예외를 발생시키기 때문이다.

이 과정에서의 @Valid나 @Validated나 같은 예외를 발생시키며, 예외가 있다면 group 적용을 통해 @Validated를 적용하였다면 ConstraintViolationException이 발생한다.

ConstraintViolationException은 @Validated를 클래스 레벨에 적용하여 AOP가 동작하면서, MethodValidationInterceptor가 동작하는데, 이 때 발생시키는 예외가 ConstraintViolationException 예외이다.

즉 HandlerMethodArgumentResolver에서 동작하는 경우면 MethodArgumentNotValidException이 발생하는 거고, @Validated로 AOP를 통해 검증기가 동작하는 경우 ConstraintViolationException이 발생하는 거로 이해할 수 있다.

좀 더 많은 테스트 과정을 포스팅하면서 글을 마무리하고 싶었지만 시간이 없어서 줄이고, 나중에 좀 더 보충하도록 해야할 것 같다.