📘[Spring] 스프링 애노테이션에 대해서…

스프링 애노테이션에 대해서…

스프링에는 애노테이션이라는게 있다.
이게 뭘까?
Annotation: 주석의 뜻을 가지고 있지만, 어떤 역할을 하는지 명시하는 기능 이외에 다양한 기능들이 있다.
앞으로 공부를 하다가 처음보거나 모르는 애노테이션은 여기에 수시로 업로드하여 기록할거임!

자주 사용하는 애노테이션

@Component

객체를 스프링 컨테이너에 스프링 빈으로 등록할 때 사용한다.
스프링은 동작 시에 @Component애노테이션을 보고 자동으로 스프링 빈으로 등록한다.

다양한 애노테이션들이 @Component를 상속받는다.

참고: 자바에는 원래 애노테이션 간의 상속 기능을 지원하지 않는다. 이는 스프링에서 지원하는 기능이다!

• @Component
  • @Service
  • @Repository
  • @Controller
  • @Configuration 상속받는지 확인해보고 싶으면 위 애노테이션의 인터페이스에 들어가서 확인해보자!

@ComponentScan

컴포넌트 스캔은 위에서 확인한 컴포넌트 애노테이션 혹은 상속받은 애노테이션들 중 1개라도 등록된 클래스를 찾으면 Context에 빈으로 등록한다.
말 그대로 컴포넌트 애노테이션이 붙은 클래스를 스캔하고 빈으로 등록해준다.

@Bean

@Bean애노테이션은 객체를 스프링 빈으로 등록하기 위해 사용한다.

@Controller

이 애노테이션이 붙은 클래스가 “컨트롤러의 역할을 한다”라고 명시해줌.

@Autowired

스프링에서 빈 객체를 주입받기 위한 방식이 3가지가 존재한다.

1. @Autowired
2. 생성자
3. setter

위 3가지 방법 중 하나로, @Autowired가 붙은 클래스를 타입을 확인하고(없으면 빈 이름을 확인) 빈을 주입한다.

@GetMapping

RequestMapping(Method=RequestMethod.GET)과 똑같은 역할이다.

@Controller                   // 이 Class는 Controller 역할을 합니다
@RequestMapping("/user")      // 이 Class는 /user로 들어오는 요청을 모두 처리합니다.
public class UserController {
    @GetMapping("/")
    public String getUser(Model model) {
        //  GET method, /user 요청을 처리
    }
    // 생략
}

위와 같이 동작하고, Flask에서 @app.route(‘/’, methods=[‘GET’])과 유사한 것 같다.

@PostMapping

RequestMapping(Method=RequestMethod.POST)과 똑같은 역할이다.

@Controller                   // 이 Class는 Controller 역할을 합니다
@RequestMapping("/user")      // 이 Class는 /user로 들어오는 요청을 모두 처리합니다.
public class UserController {
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(Model model) {
        //  POST method, /user 요청을 처리
    }
    // 생략
}

위와 같이 동작하며, Flask에서 @app.route(‘/’, methods=[‘POST’])와 비슷한 것 같다.

@Test

JUnit에서 테스트 코드를 작성할 때 사용한다.

@RequestBody

이 어노테이션이 붙은 파라미터에는 http요청의 본문(body)이 그대로 전달된다.
일반적인 GET/POST의 요청 파라미터라면 @RequestBody를 사용할 일이 없을 것이다.
반면에 xml이나 json기반의 메시지를 사용하는 요청의 경우에 이 방법이 매우 유용하다. HTTP 요청의 바디내용을 통째로 자바객체로 변환해서 매핑된 메소드 파라미터로 전달해준다.

즉, 클라이언트에서 서버로 필요한 데이터를 요청하기 위해 JSON 데이터를 요청 본문에 담아서 서버로 보내면, 서버에서는 @RequestBody 어노테이션을 사용하여 HTTP 요청 본문에 담긴 값들을 자바객체로 변환시켜, 객체에 저장한다.

@ResponseBody

자바객체를 HTTP요청의 바디내용으로 매핑하여 클라이언트로 전송한다.
@ResponseBody 가 붙은 파라미터가 있으면 HTTP요청의 미디어타입과 파라미터의 타입을 먼저 확인한다.
즉, @Responsebody 애노테이션을 사용하면 http요청 body를 자바 객체로 전달받을 수 있다.

서버에서 클라이언트로 응답 데이터를 전송하기 위해 @ResponseBody 어노테이션을 사용하여 자바 객체를 HTTP 응답 본문의 객체로 변환하여 클라이언트로 전송한다.

@RestController

@Controller + @ResponseBody와 같은 개념이다.
또, @RestController가 있으면 return "문자열";로 하면 웹브라우저에 문자열이 출력된다.
Flask에서 @app.route(‘/’)이 붙은 함수 리턴값에 return “hello”를 입력하면 웹 브라우저에 “hello”가 출력되는 것과 비슷해보임.

@RequestParam

@ReuqestParam 어노테이션은 HttpServletRequest 객체와 같은 역할을 한다.
HttpServletRequest에서는 getParameter() 메소드를 이용했지만, @RequestParam을 이용해서 받아오는 방법도 있다.

[형식]

@RequestParam("가져올 데이터의 이름") [데이터타입] [가져온데이터를 담을 변수]

LomBok 사용 시, 애노테이션

@RequiredArgsConstructor

final이 붙거나 @NotNull 이 붙은 필드의 생성자를 자동 생성해주는 롬복 어노테이션이다.
이 애노테이션을 사용하지 않으면, 생성자 주입 코드를 직접 작성해야 하는데 좀 번거롭다.

    @Service
    @RequiredArgsConstructor
    public class BannerServiceImpl implements BannerService {
    
        private final BannerRepository bannerRepository;
    
        private final CommonFileUtils commonFileUtils;
        // 생략

위와 같이 동작하고, final이 붙은 필드의 생성자를 자동으로 생성해준다.

참고자료

@RequestParam