Spring boot 정리 #4 - Annotation(1)

April 18, 2023

@Controller, @Service, @Repository

@Component —구체화—> @Controller, @Service, @Repository
bean으로 등록
해당 클래스가 Controller/Service/Repository로 사용됨을 Spring Framework에 알린다.

@RestController

@RestController는 @Controller에 @ResponseBody가 추가된 것. RestController는 Json 형태로 객체 데이터를 반환하기 위해 사용된다. REST API를 개발할 때 주로 사용하며 객체를 ResponseEntity로 감싸서 반환한다. @Controller에 @ResponseBody를 붙여 똑같이 구현할 수 있다.

@Controller + @ResponseBody 예시

@Controller
@RequiredArgsConstructor
public class UserController {
    private final UserService userService;


    @GetMapping("/user/{userId}")
    public @ResponseBody String getUser(@PathVariable final Long userId) {
        System.out.println("요청 유저 아이디: " + userId);

        return "유저 조회 성공";
    }
}

@AllArgsConstructor

클래스의 모든 필드에 대한 생성자를 자동으로 생성한다.
access : 접근제한자를 지정한다.

@AllArgsConstructor 적용 전

@Getter
public class EditRequestDto {
    private String title;
    private String content;

    public EditRequestDto(String title, String content) {
        this.title = title;
        this.content = content;
    }
}

@AllArgsConstructor 적용 후

@Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public class EditRequestDto {
    private String title;
    private String content;
}

@RequiredArgsConstructor

클래스의 final 필드에 대한 생성자를 자동으로 생성한다.
final 필드는 클래스에서 초기화를 하던지 객체 생성 시 생성자를 이용해 꼭 초기화해줘야 한다.

다음 예시는 생성자 주입 대신 @RequiredArgsConstructor을 사용한 예시이다.

@RequiredArgsConstructor 적용 전

@RestController
public class UserController {
    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }
}

@RequiredArgsConstructor 적용 후

@RestController
@RequiredArgsConstructor
public class UserController {
    private final UserService userService;
}

@GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping

위의 어노테이션들은 request와 핸들러를 매핑하는 어노테이션들이다.

위의 어노테이션들은 모두 @RequestMapping으로도 대신할 수 있다. 예를 들어 @GetMapping("/post/search")은 @RequestMapping(value = "/post/search", method = RequestMethod.GET)을 대신하는 것이다. 하지만 @GetMapping, @PostMapping이 조금 더 직관적이고 어떤 메소드의 핸들러인지 파악하기 더 쉽다.

@RequestMapping은 클래스 레벨, 메소드 레벨 모두에서 사용가능하고 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping은 메소드 레벨에서만 사용가능하다는 차이가 있다.

+ PUT과 PATCH의 차이

PUT과 PATCH 메소드는 모두 리소스를 업데이트하는 메소드이지만 PUT 메소드는 리소스 전체를 PATCH는 리소스의 일부만을 수정한다.

{
  "title": "게시물 1",
  "content": "내용 어쩌구",
  "date": "2023-04-18"
}

위와 같이 게시물 리소스가 있고 title만 수정하길 원한다면,
PUT은 title만 수정하고 나머지 필드는 이전 데이터를 유지한채 title, content, date를 모두 받아 수정한다. 만약 한가지라고 비어있는 필드가 있다면 해당 필드는 null값으로 채운다.

RequestBody

{
  "title": "게시물 2",
  "content": "내용 어쩌구",
  "date": "2023-04-18"
}

반면 PATCH는 title 필드만 RequestBody로 받는다면 content, date의 데이터는 유지하고 title만 수정한다.

{
  "title": "게시물 2"
}

@PathVariable

@PathVariable은 요청 URI에서 parameter를 받아 처리하는 것이다.

@GetMapping("/post/{postId}")

위와 같이 path에서 {}로 감싼 부분은 변수로 사용된다. 만약 post/123이런 식으로 요청이 들어왔다면 postId는 123으로 맵핑되는 것이다.

@GetMapping("/post/{postId}")
public String getPost(@PathVariable final Long postId) {
    System.out.println("요청 게시물 아이디: " + postId);

    return postService.getDetail(postId);
}

위의 예제와 같이 핸들러의 매개변수 이름을 path에서 정의된 변수 이름(postId)과 동일하게 정의하면 path variable이 사용가능하다.

@RequestParam

@RequestParam은 요청 URI에서 query params 형식으로 전달 받게 된다.

@GetMapping("/post/search")
public List<Post> search(@RequestParam final String title) {
    System.out.println("게시물 제목 검색 인자: " + title);

    return postService.search(title);
}

위와 같은 GET api가 있다면 요청이 /post/search?title=게시물1 형식으로 들어오게 되는 것이다. /post/search?title=게시물1&content=어쩌구 이렇게 여러 개의 parameter를 받을 수도 있다.

public List<Post> search(@RequestParam(required = true, defaultValue = "") final String title) {
    System.out.println("게시물 제목 검색 인자: " + title);

    return postService.search(title);
}

위와 같이 required 여부, default value도 설정할 수 있다. required=true가 default이기 때문에 요청에서 title이 없다면 400 Bad Request 에러가 발생한다.

@RequestBody

@RequestBody는 HTTP 요청에서 body에 담겨져 오는 데이터를 받아올 때 사용된다.

@RequestBody는 클라이언트가 전송하는 JSON(application/json) 형태의 HTTP Body 내용을 Java Object로 변환시켜주는 역할을 한다. 가장 큰 특징은 바인딩이 아닌 변환을 시키는 것이기 때문에 변수들의 Setter 함수가 없어도 정상적으로 저장된다.

 @PostMapping("/post")
    public String register(@RequestBody final RegisterRequestDto request) {
        // 서비스 계층에 유저를 등록하는 메서드를 호출
        Long postId = postService.register(request);
        System.out.println(request.getId() + request.getContent() + request.getTitle());
    }

위의 코드에서와 같이 @RequestBody로 받아온 데이터는 RegisterRequestDto라는 Java Object로 변환하여 getter와 같은 메소드를 사용할 수 있게 되는 것이다.

@Getter

@Getter를 사용하면 get[멤버변수명]()으로 getter를 만들어준다. 예제에서는 사용하진 않았지만 @Setter를 사용하면 set[멤버변수명]()으로 setter를 만들어준다.

@PutMapping("/post/{postId}")
public String editPost(@PathVariable final Long postId, @RequestBody final EditRequestDto request) {
    System.out.println(request.getTitle() + request.getContent());

    return postService.edit(postId, request);
}

위의 예시는 EditRequestDto에서 @Getter를 사용했기 때문에 멤버 메소드를 따로 정의하지 않고도 getTitle(),getContent()를 사용한 예시이다.

Written by@Chaerin

Tech Blog📕

GitHub LinkedIn