Spring에서 RESTful API구현 시, 주로 사용되는 @ResponseBody와 @RequestBody 어노테이션의 개념에 대해 알아보겠습니다.
@RequestBody
- HTTP 요청의 body내용을 자바 객체로 매핑하는 역할을 합니다.
@ResponseBody
- 자바 객체를 HTTP요청의 body 내용으로 매핑하는 역할을 합니다.
@RestController
public class LoginWebController
{
//HTTP요청의 내용을 Member객체에 매핑하기 위해 @RequestBody 어노테이션을 설정
@RequestMapping(value = "/member/login" method = RequestMethod.POST)
public MemberResultDto login(@RequestBody Member member) {
MemberResultDto memberResultDto memberService.login(member);
return memberResultDto;
}
}
위의 예제소스에서는 HTTP요청의 body안에 member 데이터를 파라미터로 받기 위해, @RequestBody를 사용하였습니다.
@ResponseBody를 사용하지 않은 이유는 @RestController를 사용하였기 때문입니다. @Controller와는 다르게 @RestController는 리턴값에 자동으로 @ResponseBody를 붙게되어 HTTP응답데이터(body)에 자바 객체가 매핑되어 전달됩니다.
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
String name() default "Gyu"; //name값을 설정할 수 있으며, 아무런 값을 넣지 않으면 Gyu가 들어갑니다.
String value(); //value값을 설정할 수 있으며, 아무런 값을 넣지 않으면 Syntax error가 발생합니다.
int count() default 1; //기본 자료형도 사용할 수 있습니다
String[] arrName() default "first Index"; //배열값을 넣을 수 있습니다. { }안에 값을 넣어 삽입.
TestEnumType[] testEnumType() default TestEnumType.FIRST; //enum타입의 값을 설정할 수 있습니다.
AnnoDateTime annoDateTime(); //Annotation안에 또 다른 Annotation값을 넣을 수 있습니다.
}
@Retention(RetentionPolicy.RUNTIME)
@interface AnnoDateTime {
String yymmdd();
String hhmmss();
}
enum TestEnumType {
FIRST, FINAL
}
Custom Annotation을 작성하기 위해 몇 가지 규칙이 존재합니다.
1. 요소의 타입은 기본형, String, enum, 어노테이션, Class만 허용된다.
2. 요소의 ()안에 매개변수를 선언할 수 없다.
3. 예외를 선언할 수 없다.
4. 요소를 타입 매개변수로 정의할 수 없다.
5. 어노테이션의 각 요소는 기본값을 가질 수 있다.
위 규칙을 생각하며 어노테이션을 작성하면 됩니다.
※ Custom Annotation 적용
- 클래스에 선언
@MyAnnotation(value = "First Text", annoDateTime = @AnnoDateTime(yymmdd = "190924", hhmmss = "101147"))
public class AnnotationHandler {
public String myField = null;
public void doThis() {
}
public void doThat() {
}
}
- 클래스 필드에 선언
public class AnnotationHandler {
@MyAnnotation(value = "First Text", annoDateTime = @AnnoDateTime(yymmdd = "190924", hhmmss = "101147"))
public String myField = null;
public void doThis() {
}
public void doThat() {
}
}
- 메서드에 선언
public class AnnotationHandler {
public String myField = null;
@MyAnnotation(value = "First Text", annoDateTime = @AnnoDateTime(yymmdd = "190924", hhmmss = "101147"))
public void doThis() {
}
@MyAnnotation(value = "First Text", annoDateTime = @AnnoDateTime(yymmdd = "190924", hhmmss = "101147"))
public void doThat() {
}
}
※ 자바 리플렉션으로 커스텀 어노테이션 사용하기
@Retention(RetentionPolicy.RUNTIME)값으로 설정한 Custom Annotation은 런타임 시점에 어노테이션 정보를 이용하여 코드를 생성합니다.
이러한 이유로 RUNTIME옵션을 설정한 Custom Annotation은 자바 리플렉션을 사용하여 선언한 어노테이션 값을 가져옵니다.
프로그램 구동 시, Custom Annotation에서 어떤 값이 넘어오는지 확인해보는 테스트를 해보겠습니다.
MyAnnotation.java
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
String name() default "Gyu"; //name값을 설정할 수 있으며, 아무런 값을 넣지 않으면 Gyu가 들어갑니다.
String value(); //value값을 설정할 수 있으며, 아무런 값을 넣지 않으면 Syntax error가 발생합니다.
int count() default 1; //기본 자료형도 사용할 수 있습니다
String[] arrName() default "first Index"; //배열값을 넣을 수 있습니다. { }안에 값을 넣어 삽입.
TestEnumType[] testEnumType() default TestEnumType.FIRST; //enum타입의 값을 설정할 수 있습니다.
AnnoDateTime annoDateTime(); //Annotation안에 또 다른 Annotation값을 넣을 수 있습니다.
}
@Retention(RetentionPolicy.RUNTIME)
@interface AnnoDateTime {
String yymmdd();
String hhmmss();
}
enum TestEnumType {
FIRST, FINAL
}
위 소스를 보면 알다시피, RUNTIME에서 동작하는 어노테이션들은 전부 리플렉션을 사용해서 객체의 정보를 얻고, 어노테이션의 정보도 얻습니다.
커스텀 어노테이션을 생성해서 사용하면 반복적으로 코딩해야 하는 부분들도 많이 줄일 수 있고 더 비지니스로직에 집중할 수 있는 장점이 있습니다.
@RequestMapping 들여다 보기
Custom Annotation을 만들어봤으면, java 또는 Spring에서 제공하는 Annotation은 어떻게 생겼는지, 어떤식으로 구성되어 있는지 궁금하실 겁니다.
사실, Annotation내용을 포스팅하는 이유의 80%이상이 Annotation의 동작방식과 구성요소들을 알아보고, 직접 만들어보며 아무런 생각없이 사용하던 Annotation을 이해하자는 취지이기 때문에 @RequestMapping을 확인해보면 좀 더 친숙하게 다가갈 수 있을꺼라 생각합니다.
※ 구성 요소
@RequestMapping annotation 사용
위 소스는 @ReqeustMapping을 사용한 모습입니다. 익숙한 value값과 method값을 볼 수 있을 것 입니다.
실제 사용에 있어서 annotation의 인수가 하나뿐이면 value값을 지칭하지 않고 사용할 수 있습니다.
즉, @RequestMapping(value = "/cmm/cmmPlayer.do") 대신 @RequestMapping("/cmm/cmmPlayer.do")처럼 사용할 수 있습니다. (annotation 변수명이 value인 값만 가능)
그렇다면 세부적으로 어떻게 동작할까요?
@RequestMapping annotation 구조
위 소스는 직접 @RequestMapping 어노테이션을 타고 들어가서 본 내용입니다. 이젠 익숙한 내용들이 보일 것 입니다.
@Target({ElementType.METHOD, ElementType.TYPE})
해당 annotation은 매서드와 클래스, 인터페이스, enum에서 사용하도록 Target을 설정하겠다는 의미입니다.
@Retention(RetentionPolicy.RUNTIME)
해당 어노테이션을 런타임 시점에서 실행시키겠다는 의미입니다.
@RequestMapping annotation 구조-2
@RequestMapping의 핵심 요소인 String value() default { };와 RequestMethod[] method() defalut { };를 확인할 수 있습니다. value에 Mapping할 주소를 넣어주면 런타임 시점에 해당 주소와 URI는 서로 연결되게 됩니다.
또한, Request방식을 설정할 때 method = RequestMethod.GET 과 같이 GET호출 POST호출 등을 설정할 수 있습니다.
자료형인 RequestMethod[]를 확인해보면 GET, POST, PUT, PATCH 등과 같이 다양한 옵션이 enum으로 설정되어 있습니다.
RequestMethod enum 내부구조
이제 어느정도 Annotation의 구조가 눈에 파악될 것 입니다. 하지만, 더 깊은 세부 로직까지 아직은 알 필요가 없다고 생각하여 이정도로 정리하겠습니다.
@Inherited // 상속
@Documented // 문서에 정보가 표현
@Retention(RetentionPolicy.RUNTIME) // 컴파일 이후에도 JVM에 의해서 참조가 가능합니다
@Retention(RetentionPolicy.CLASS) // Compiler가 클래스를 참조할 때까지 유효합니다
@Retention(RetentionPolicy.SOURCE) // 컴파일 이후 이후 사라집니다
@Target({
ElementType.PACKAGE, // 패키지 선언시
ElementType.TYPE, // 타입 선언시
ElementType.CONSTRUCTOR, // 생성자 선언시
ElementType.FIELD, // 멤버 변수 선언시
ElementType.METHOD, // 메소드 선언시
ElementType.ANNOTATION_TYPE, // 어노테이션 타입 선언시
ElementType.LOCAL_VARIABLE, // 지역 변수 선언시
ElementType.PARAMETER, // 매개 변수 선언시
ElementType.TYPE_PARAMETER, // 매개 변수 타입 선언시
ElementType.TYPE_USE // 타입 사용시
})
public @interface NesoyAnnotation{
/* enum 타입을 선언할 수 있습니다. */
public enum Quality {
BAD, GOOD, VERYGOOD
}
/* String은 기본 자료형은 아니지만 사용 가능합니다. */
String value() default "NesoyAnnotation : Default String Value";
/* 배열 형태로도 사용할 수 있습니다. */
int[] values();
/* enum 형태를 사용하는 방법입니다. */
Quality quality() default Quality.GOOD;
}
