[Spring] @Valid 로 exception 처리하기 검증하기

 

개요

API 를 개발하거나, 특정 파라미터를 제어하기 위해 필수 값을 지정해야하는 경우가 있다. (파라미터에 대한 유효성)

따로 Rule 이 없다면 방법은 무궁무진하다. 모든 요청에 if를 걸어 검사하거나.. 공통으로 하나의 Class 를 만들어서 경유하게 하거나..

 

이 글에서는 깔끔한 코드를 위해 프로젝트 내에서 공통적으로 사용할 Exception 처리를 하고자 한다. 그래야 깔끔하다.

 

기존 Spring 이나 Spring Boot에서 오류가 발생하면 아래와 같은 내용으로 발생했다.

 

우리는 Spring Boot에서 제공하는 기본 에러 메시지를 우리가 원하는 메시지로 제어할 예정이다.

 

*아래 글에서는 쿠폰을 발행하기 위한 내용을 시나리오로 @Valid 를 넣어 구현하였다.

1. 사전준비

📝Maven 을 기준으로 Validator 를 사용하기 위한 Lib 를 미리 받아두도록 한다.

아래는 pom.xml 의 dependency 내용이다.

<!-- pom.xml -->
<dependency>
	<groupId>org.hibernate.validator</groupId>
	<artifactId>hibernate-validator</artifactId>
	<version>6.2.0.Final</version>
</dependency>

---

2. 공통 Exception Contoller 생성

📝Exception Controller

@Slf4j
@ControllerAdvice
public class ExceptionController {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<ErrorModule> methodValidException(MethodArgumentNotValidException e, HttpServletRequest request){
        log.error("MethodArgumentNotValidException url:{}, trace:{}",request.getRequestURI(), e.getStackTrace());
        return new ResponseEntity<>(errorResponse(e.getBindingResult()), HttpStatus.BAD_REQUEST);
    }

    private ErrorModule errorResponse(BindingResult bindingResult){
        //bindingResult.getFieldError().getCode(); : model 에서 설정한 annotation
        //bindingResult.getFieldError().getField()); : model 에서 발생한 Error 위치
        //bindingResult.getFieldError().getDefaultMessage(); : model 에서 설정한 message
        return new ErrorModule(
                bindingResult.getFieldError().getField(),
                bindingResult.getFieldError().getDefaultMessage());
    }

}

---

3. 공통 ErrorModule 생성

📝ErrorModule

import lombok.Data;

@Data
public class ErrorModule {
    String code;		//enum 으로 제어할 목적
    String requestType; //확장성을 고려, 요청한 기능이 어떤 것인지 확인하기 위함
    String field;		//문제가 발생한 field 확인
    String description;	//설명
    String message;		//출력하는 메시지

//TODO: 지금은 이걸로..
    public ErrorModule(String field, String message) {
        this.field = field;
        this.message = message;
    }
    public ErrorModule(String requestType, String description, String message) {
        this.requestType = requestType;
        this.description = description;
        this.message = message;
    }

    public ErrorModule(String code, String requestType, String field, String description, String message) {
        this.code = code;
        this.requestType = requestType;
        this.field = field;
        this.description = description;
        this.message = message;
    }

 

 

 

4. @Valid 선언

📝제어를 하고 싶은 Parameter에 @Valid를 붙여준다.

 

Controller

👨‍💻💻⌨

	@ApiOperation(value = "쿠폰 발행 API", notes = "쿠폰 발행 API 기능 (건별)")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "token", value = "API 토큰값", dataType = "string", paramType = "header", required = true),
            @ApiImplicitParam(name = "company", value = "API 소속값", dataType = "string", paramType = "header", required = true),
            @ApiImplicitParam(name = "group", value = "API 그룹값", dataType = "string", paramType = "header", required = true),
            @ApiImplicitParam(name = "type", value = "GIFT: 1회권 / RUSE: 다회권", dataType = "string", paramType = "query", required = true),
            @ApiImplicitParam(name = "amount", value = "type.equals('GIFT') ? 쿠폰금액 : 0", dataType = "long", paramType = "query", required = true),
            @ApiImplicitParam(name = "phone", value = "연락처 (-) 포함하여 전송", dataType = "string", paramType = "query", required = true),
    })
    @PostMapping(value = "/issuance")
    @Transactional(timeout = 5)
    public ResponseEntity<JSONObject> couponIssuance(
            @RequestHeader("token") String token,
            @RequestHeader("company") String company,
            @RequestHeader("group") String group,
            //파라미터를 Model 로 받고, Model 안에서 제어하고자 한다.
            @RequestBody @Valid CouponModel couponModel            
            ) {
        try {
            
        } catch (Exception e) {            
            e.printStackTrace();            
        }

        if (true) {
            return new ResponseEntity<>(new JSONObject(), HttpStatus.OK);
        } else {
            return new ResponseEntity<>(new JSONObject(), HttpStatus.NOT_FOUND);
        }
    }

---

5. 실행결과

📝일부러 파라미터인 phone 을 비우고 요청을 전송한 결과이다.

원하는 응답 값으로 잘 뿌려주고 있다.

 

 

마지막에 확장성을 생각하여 enum 으로 관리할 생각으로 변수를 추가하였다.

'오류 코드'와 '코드에 따른 문구' 추가한다면 더욱 깔끔한 구조를 확립할 수 있을 것 같기에..

 

---