[Spring] Annotation

어노테이션이란

 사전적으로는 주석이라는 의미를 가지고 있으나, 자바에서 사용될때의 어노테이션은 코드 사이에 주석처럼 사용하여 특별한 의미를 부여해준다.

즉, 프로그램에게 추가적인 정보를 제공해주는 메타데이터(데이터를 위한 데이터)라고 볼 수 있다.

 

자주 사용하는 어노테이션

@Component

 개발자가 생성한 Class를 Spring의 Bean으로 등록할 때 사용하는 어노테이션. Spring은 해당 어노테이션을 보고 Spring의 Bean으로 등록한다.

@Component(value="myman")
public class Man {
    public Man() {
        System.out.println("hi");
    }
}

 

@ComponentScan

Spring Framework는 @Component, @Service, @Repository, @Controller, @Configuration 중 1개라도 등록된 클래스를 찾으면, Context에 bean으로 등록한다. @ComponentScan Annotation이 있는 클래스의 하위 Bean을 등록 될 클래스들을 스캔하여 Bean으로 등록해준다.

 

@Bean

@Bean 어노테이션은 개발자가 제어가 불가능한 외부 라이브러리와 같은 것들을 Bean으로 만들 때 사용합니다.

 

@Controller

Spring에게 해당 Class가 Controller의 역할을 한다고 명시해준다.

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

 

@RequestHeader

Request의 header값을 가져올 수 있으며, 해당 Annotation을 쓴 메소드의 파라미터에 사용한다.

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    // 헤더의 Accept-Language 값을 String 변수에 담는다.
    public String getUser(@RequestHeader(value="Accept-Language") String acceptLanguage) {
    }
}

 

@RequestMapping

@RequestMapping(value=”“)와 같은 형태로 작성하며, 요청 들어온 URI의 요청과 Annotation value 값이 일치하면 해당 클래스나 메소드가 실행된다. Controller 객체 안의 메서드와 클래스에 적용 가능하다.

• Class 단위에 사용하면 하위 메소드에 모두 적용된다.
• 메소드에 적용되면 해당 메소드에서 지정한 방식으로 URI를 처리한다.

// 이 Class는 Controller 역할을 한다.
@Controller
// 이 Class는 /user로 들어오는 요청을 모두 처리한다.
@RequestMapping("/user")
public class UserController {
    //  GET 방식의 /user 요청을 처리
    @RequestMapping(method = RequestMethod.GET)
    public String getUser(Model model) {
    }
    //  POST 방식의 /user 요청을 처리
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(Model model) {
    }
    //  GET 방식의 /user/info 요청을 처리
    @RequestMapping(value = "/info", method = RequestMethod.GET)
    public String addUser(Model model) {
    }
}

 

@RequestParam

URL에 전달되는 파라미터를 메소드의 인자와 매칭시켜, 파라미터를 받아서 처리할 수 있는 Annotation으로 아래와 같이 사용한다. Json 형식의 Body를 MessageConverter를 통해 Java 객체로 변환시킨다.

@Controller
@RequestMapping("/user")
public class UserController {
	// GET 방식의 /user 요청을 처리
    @RequestMapping(method = RequestMethod.GET)
    public String getUser(@RequestParam String nickname, @RequestParam(name="old") String age {
        // https://naver.com?nickname=dog&old=10
        String sub = nickname + "_" + age;
        ...
    }
}

 

@RequestBody

Body에 전달되는 데이터를 메소드의 인자와 매칭시켜, 데이터를 받아서 처리할 수 있는 Annotation으로 아래와 같이 사용한다. 클라이언트가 보내는 HTTP 요청 본문(JSON 및 XML 등)을 Java 오브젝트로 변환한다.

 

클라이언트가 body에 json or xml 과 같은 형태로 형태로 값(주로 객체)를 전송하면, 해당 내용을 Java Object로 변환한다.

@Controller
@RequestMapping("/user")
public class UserController {
	//  POST 방식의 /user 요청을 처리
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(@RequestBody User user) {
        String sub_name = user.name;
        String sub_old = user.old;
    }
}

 

@ModelAttribute

클라이언트가 전송하는 HTTP parameter, Body 내용을 Setter 함수를 통해 1:1로 객체에 데이터를 연결(바인딩)한다. RequestBody와 다르게 HTTP Body 내용은 multipart/form-data 형태를 요구한다. @RequestBody가 json을 받는 것과 달리 @ModenAttribute 의 경우에는 json을 받아 처리할 수 없다.

 

@ResponseBody

@ResponseBody은 메소드에서 리턴되는 값이 View 로 출력되지 않고 HTTP Response Body에 직접 쓰여지게 된다. return 시에 json, xml과 같은 데이터를 return 한다.

@Controller
@RequestMapping("/user")
public class UserController {
	// GET 방식의 /user 요청을 처리
    @RequestMapping(method = RequestMethod.GET)
    @ResponseBody
    public String getUser(@RequestParam String nickname, @RequestParam(name="old") String age {
        User user = new User();
        user.setName(nickname);
        user.setAge(age);
        return user;
    }
}

 

@Autowired

Spring Framework에서 Bean 객체를 주입받기 위한 방법은 크게 아래의 3가지가 있다.

• @Autowired
• 생성자 (@AllArgsConstructor 사용)
• setter

@Autowired 어노테이션은 그 중 하나로, Spring Framework가 Class를 보고 Type에 맞게(Type을 먼저 확인 후, 없으면 Name 확인) Bean을 주입한다.

 

@GetMapping

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

@Controller
@RequestMapping("/user")
public class UserController {
    @GetMapping("/")
    public String getUser(Model model) {
    }
    
    ////////////////////////////////////
    // 위와 아래 메소드는 동일하게 동작.//
    ////////////////////////////////////

    @RequestMapping(method = RequestMethod.GET)
    public String getUser(Model model) {
    }
}

 

@PostMapping

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

@Controller
@RequestMapping("/user")
public class UserController {
    @RequestMapping(method = RequestMethod.POST)
    public String addUser(Model model) {
    }

    ////////////////////////////////////
    // 위와 아래 메소드는 동일하게 동작.//
    ////////////////////////////////////

    @PostMapping('/')
    public String addUser(Model model) {
    }
}