@Valid 사용 유효성 처리

어노테이션 종류

Anotation	제약조건
@NotNull	Null 불가
@Null	Null만 입력 가능
@NotEmpty	Null, 빈 문자열 불가
@NotBlank	Null, 빈 문자열, 스페이스만 있는 문자열 불가
@Size(min=,max=)	문자열, 배열등의 크기가 만족하는가?
@Pattern(regex=)	정규식을 만족하는가?
@Max(숫자)	지정 값 이하인가?
@Min(숫자)	지정 값 이상인가
@Future	현재 보다 미래인가?
@Past	현재 보다 과거인가?
@Positive	양수만 가능
@PositiveOrZero	양수와 0만 가능
@Negative	음수만 가능
@NegativeOrZero	음수와 0만 가능
@Email	이메일 형식만 가능
@Digits(integer=, fraction = )	대상 수가 지정된 정수와 소수 자리 수 보다 작은가?
@DecimalMax(value=)	지정된 값(실수) 이하인가?
@DecimalMin(value=)	지정된 값(실수) 이상인가?
@AssertFalse	false 인가?
@AssertTrue	true 인가?

이와 같은 Annotation을 객체 또는 변수에 붙여 손쉽게 값에 대한 유효성을 검사할 수 있으며, 유효성 문제가 발생시 Exception 처리를 통해 에러 메시지를 리턴할 수 있다.
또한 @NotBlank(message = "")와 같은 형태로 유효성 문제 발생시 출력할 message를 작성할 수 있다.

발생 예외

- BindException
@ModelAttribute로 객체를 전달받을때 발생한다.
- MethodArgumentNotValidException
@ResponseBody로 데이터를 전달 받을때 발생한다. 또한 BindException을 상속받는 Exception Class 이다.

BindingResult

BindingResult 객체는 검증 오류가 발생한 경우 오류 정보를 저장하는 객체이다. 해당 객체를 통해 필드명, 객체명, 에러 메시지등 을 확인, 사용할 수 있다.
Exception에서 전달받은 BindingResult 객체의 fieldError 에서 파라미터, 전달받은 값, 에러 코드(사용 어노테이션), 설정한 message 등을 추출하여 사용할 수 있다.

POST Method API 구현 및 @Valid 를 통한 유효성 검증

프로젝트 환경설정

Framework : SpringBoot 2.7.12 | JDK : JAVA 11 | IDE : IntelliJ | DB : OracleDB | build Tool : Gradle

	implementation 'org.springframework.boot:spring-boot-starter-security'
	implementation 'org.springframework.boot:spring-boot-starter-validation'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.3.1'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'com.oracle.database.jdbc:ojdbc8'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.springframework.security:spring-security-test'
	implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
	runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5'
	runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5'
	implementation group: 'com.auth0', name: 'java-jwt', version: '4.0.0'

#Application.properties

spring.datasource.url=jdbc:oracle:thin:@localhost:1521:XE
spring.datasource.username=C##APITEST
spring.datasource.password=APITEST
spring.datasource.driver-class-name=oracle.jdbc.OracleDriver

mybatis.mapper-locations=mapper/*.xml
mybatis.type-aliases-package=com.newbie.training
mybatis.configuration.map-underscore-to-camel-case=true

게시글 테이블(POST_TBL)에 데이터를 추가하는 코드다.
POST /posts 를 통해 postSubject와 postContent, postWriter를 Post 객체로 전달받아 Service > Repository를 통해
DB에 insert 한다. 만약 postSubject 또는 postContent,postWriter 가 null 이거나 스페이스 값인 경우와 postWriter가 이메일 형식을 따르지 않은 경우 @Valid 어노테이션을 통해 MethodArgumentNotValidException을 발생시켜 해당하는 해당하는 HTTP 상태 코드와 에러 메시지를 출력한다.
GlobalExceptionHandler에서 MethodArgumentNotValidException을 처리하고 해당 하는 상태 코드와 에러메시지를 ErrorResponse 객체를 통해 만들어 리턴한다.

결과

정상 작동시 DB에 데이터 insert와 결과 201, 생성 완료 문구 확인

400 : Bad Request 와 함께 에러에 대한 내용 출력되는 것을 확인했다.

필수 값이 스페이싱 값일 경우 동일하게 400 : Bad Request 에러를 발생 시킴을 확인했다.

만약 2개의 파라미터에서 예외를 발생시킬 경우 2개의 에러 메시지를 리턴한다.