[Spring Boot] 자주 쓰이는 Spring Boot Annotation (Controller, Service, Model)

🚀 Controller Annotation

Annotation	영역	Description
@RestController	Class	Spring의 컴포넌트 스캔 대상이 되도록 하고 HTTP 요청과 응답을 자동으로 매핑되도록 하는 등 Spring에서 Controller로 동작할 수 있도록 기본적인 동작을 담고있는 어노테이션입니다. @Controller와 @RequestBody가 합쳐진 어노테이션으로 RESTful 웹 서비스에서 주로 사용됩니다.
@RequiredArgsConstructor	Class	Spring 4.3부터는 @Autowired를 통한 의존성 주입보다 생성자를 통한 의존성 주입을 권장하고 있습니다. @RequiredArgsConstructor를 사용하면 생성자 코드를 따로 적지 않아도 됩니다. 'private final Service service'와 같이 사용됩니다.
@RequestMapping	Class	함수 레벨에 사용할 수 있지만 함수 레벨에는 @GetMapping과 같은 HTTP 메소드 레벨의 어노테이션을 사용하고 클래스 레벨에는 @RequestMapping을 사용합니다. Controller에 포함된 모든 함수에 공통 적용할 공통 경로와 같은 내용을 적습니다.
@Api, @Tag	Class	Swagger를 사용할 때 사용하는 어노테이션입니다.
@ApiOperation, @Operation	Method	Swagger를 사용할 때 사용하는 어노테이션입니다.
@GetMapping @PostMapping @PutMapping @DeleteMapping @PatchMapping	Method	@RequestMapping의 하위 어노테이션으로 각 함수마다 사용하는 HTTP 메소드에 따라 지정해서 사용합니다. path : 각 API의 하위 경로 produces, consumes : 요청과 응답의 형식을 지정할 때 사용합니다. 주로 JSON 형태로 통신하기 때문에 'MediaType.APPLICATION_JSON_VALUE'를 사용합니다.
@PathVariable	Param	Method : 'GET' URL 경로에서 변수를 추출하는 데 사용됩니다. 주로 RESTful 웹 서비스에서 경로 매개변수를 추출하는 데 쓰입니다. '/products/{id}'와 같은 경로에서 id를 추출할 때 사용합니다.
@RequestParam	Param	Method : 'GET' 요청의 쿼리 매개변수(파라미터)를 추출하는 데 사용됩니다. URL의 ? 뒤에 오는 매개변수를 읽어옵니다. 쿼리 매개변수를 추출할 때 사용합니다. '/products?id=123'와 같이 URL에서 id를 추출할 때 사용합니다. 전달되는 파라미터가 많을 경우 VO 클래스를 사용하면 클래스 내 필드와 자동으로 맵핑해줍니다. (데이터 바인딩) 'POST', 'PUT', 'PATCH'에도 Request가 form 데이터 형식으로 온다면 (URL 뒤에 Query String 형태로 온다면) 사용할 수 있지만 JSON 형태는 수용하지 못하기 때문에 주로 'GET'에서만 사용합니다.)
@RequestBody	Param	Method : 'POST', 'PUT', 'PATCH' HTTP 요청의 본문(body) 부분을 특정 자바 객체로 매핑하도록 지시합니다. 주로 POST나 PUT 요청과 함께 사용되며, 클라이언트가 JSON 또는 XML 형식으로 데이터를 전송할 때 사용됩니다. - 예를 들어, 클라이언트가 JSON으로 데이터를 보내고 이를 자바 객체로 변환하려면 @RequestBody를 사용합니다
@Valid	Param	요청 파라미터를 데이터 바인딩 할 때 객체의 유효성을 검사합니다. @NotNull, @NotEmpty, @Size, @Pattern와 같은 Hibernate Validator로 정의된 어노테이션과 같이 사용됩니다. VO 클래스를 사용할 경우 각 필드에 필요한 유효성 검사 어노테이션을 붙여서 요청을 손쉽게 필터링할 수 있습니다.

@RestController
@RequestMapping("/vl")
@Api(tags = {"Simple"})
@RequiredArgsConstructor
public class SimpleController {
 
    private final SimpleService simpleService;
 
    @ApiOperation(value = "", httpMethod = "GET", notes = "")
    @GetMapping(path = "/simple", produces = MediaType.APPLICATION_JSON_VALUE)
    public ResponseEntity<CommonResponseVO> method(@Valid SimpleRequestVO, simpleRequestVO){
        return ResponseUtil.createSuccessResponse(simpleService.method(simpleRequestVO));
    }
}

🚀 Service Annotation

Annotation	영역	Description
@Service	Class	@Controller와 비슷한 역할을 합니다. 컴포넌트 스캔 대상이 되고 Spring Container에 Bean으로 등록됩니다. 해당 클래스가 비지니스 로직을 처리하는 Service 클래스라는 것을 나타내기도 합니다.
@RequiredArgsConstructor	Class	Controller에서 사용되는 이유와 같습니다. 생성자 의존성 주입을 위해서 사용되며 'private final Repository repository'와 같이 사용됩니다.
@Transactional	Method	DB의 트랜잭션을 만들고 관리하기 위해서 사용합니다. 단순히 @Transactional만 적어주면 실행되는 함수가 하나의 트랜잭션으로 묶여서 중간에 에러가 발생하면 DB에 Rollback을 실행합니다. readOnly, rollbackFor, noRollbackFor, propagation, isolation, timeout와 같은 옵션으로 트랜잭션을 나눌 수 있습니다.

@Service
@RequiredArgsConstructor
public class Service {
    private final Repository repository;
    private final SecondService secondService;
     
    @Transactional
    @HystrixCommand(fallbackMethod = "fallbackService")
    public PaginationResponseVO method(RequestVO requestVO) {
        ...
        return new PaginationResponseVO();
    }
 
    public PaginationResponseVO fallbackService(RequestVO requestVO) {
        return secondService.method(requestVO);
    }
}

 

🚀 Model Annotation

📌@NoArgsConstrutor, @AllArgsConstrutor, @RequiredArgsConstructor 사용 여부는 필수인지 아닌지 확인이 더 필요!

Annotation	영역	Description
@NoArgsConstrutor @AllArgsConstrutor (access = AccessLevel.PRIVATE)	Class	기본 생성자와 모든 필드를 포함한 생성자를 자동으로 생성해줍니다. 필드가 많을 경우 생성자로 객체를 생성하면 필드 순서와 타입을 모두 맞춰줘야 하기 때문에 휴먼에러를 만들어낼 가능성이 높아지게 됩니다. 따라서 VO는 Builder로 생성하는 것을 추천하며 외부에서 생성자를 사용할 수 없도록 AccessLevel을 설정하기도 합니다. Bulder 패턴이 갖는 장점 가독성과 유지보수성 향상 : 생성자에 많은 매개변수가 있을 때, 인자의 순서와 의미를 혼동할 수 있습니다. Builder 패턴을 사용하면 각각의 설정 메서드에 의미 있는 이름을 부여하고, 가독성이 향상됩니다. 필수 및 선택적 매개변수 지원 : 일부 필드는 필수이고, 일부는 선택적일 때 Builder 패턴은 특히 유용합니다. 필요한 필드만 설정하고 나머지는 기본값으로 초기화할 수 있습니다. 인자 순서에 구애받지 않음 : 생성자의 인자 순서에 구애받지 않아도 되므로, 새로운 필드를 추가하거나 기존 필드를 변경해도 기존 코드에 영향을 덜 주면서 객체 생성을 확장할 수 있습니다. 가변성을 감소시켜 객체의 일관성 강화 : Builder 패턴을 사용하면 가변성을 감소시킴으로써 객체의 일관성을 강화할 수 있습니다. 객체 생성 이후에는 더 이상 변경할 수 없게 되어 객체의 상태를 안정적으로 유지할 수 있습니다.
@Data	Class	@Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor 를 합친 Annotation @RequiredArgsConstructor은 초기화 되지 않은 모든 final 필드, @NonNull과 같이 제약조건이 설정되어있는 모든 필드들에 대한 생성자를 자동으로 생성한다.
@Builder	Class	Builder 패턴을 자동으로 생성해줍니다.
@SuperBuilder	Class	VO를 상속 받아서 사용하는 경우 부모의 필드를 Builder에서 사용할 수 있도록 해줍니다.
@Builder.Default	Field	Builder로 생성할 때 기본값을 지정해주기 위해서 사용합니다.
@ApiModelProperty	Field	Swagger를 사용할 때 사용하는 어노테이션입니다.
@Min(1) @Max(50)	Field	@Vaild와 같이 사용되며 VO 안에 있는 필드 값의 유효성 검사를 해줍니다. @Min, @Max 이외에도 @Positive, @PositiveOrZero 등 여러 종류의 Annotation을 사용할 수 있습니다.
@NotNull @NotEmpty @NotBlank	Field	Null 여부 체크 Null 여부 체크, 빈 문자열(""), 빈 객체(List) 체크 Null 여부 체크, 빈 문자열(""), 빈 객체(List) 체크, 공백 문자열(" ")인지 체크

@Getter
@ToString
@SuperBuilder
@NoArgsConstructor
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@EqualsAndHashCode(callSuper = false)
public class RequestVO extends PaginationRequestVO {
    @Builder.Default
    @Enum(enumClass = DefaultBlogSortType.class)
    @ApiModelProperty(value = "블로그를 조회하는 정렬 기준 (기본값: ACCURACY)", notes = "블로그 조회 정렬 기준", example = "RECENCY", allowableValues = "ACCURACY, RECENCY")
    private String sortType = DefaultBlogSortType.ACCURACY.name();
 
    @ApiModelProperty(value = "특정 블로그 URL", notes = "특정 블로그 글만 검색하고 싶은 경우")
    private String blogUrl;
 
    @ApiModelProperty(value = "블로그를 검색하는 기준 키워드", notes = "블로그 검색 키워드", required = true)
    @NotEmpty
    private String keyword;
 
    @Min(1)
    @Max(50)
    @Builder.Default
    @ApiModelProperty(value = "Page 단위로 조회 시 한 번에 가져올 Page의 크기 (기본값: 10)", notes = "1~50 사이의 정수", example = "10")
    private Integer pageSize = 10;
 
    @Min(1)
    @Max(50)
    @Builder.Default
    @ApiModelProperty(value = "Page 단위로 조회 시 데이터 조회 시작 건 수 (기본값: 1)", notes = "1~50 사이의 정수", example = "1")
    private Integer start = 1;
 
    public GetVO toGetVO() {
        String query = ObjectUtils.isEmpty(blogUrl) ? keyword : blogUrl + " " + keyword;
        String sort = sortType.toLowerCase();
        return GetVO.builder()
                .query(query)
                .sort(sort)
                .page(this.start)
                .size(this.pageSize)
                .build();
    }
}