[10] Spring Boot 어노테이션 정리

Annotation이란?

• 사전적 의미로는 주석이라는 뜻이다.
• 자바에서 Annotation은 코드 사이에 주석처럼 쓰이며 특별한 의미, 기능을 수행하도록 하는 기술이다.
• 프로그램에게 추가적인 정보를 제공해주는 메타데이터라고 볼 수 있다

 

Anotation	제약조건
@ComponentScan	@Component와 @Service, @Repository, @Controller, @Configuration이 붙은 클래스 Bean들을 찾아서 Context에 bean등록을 해주는 Annotation이다. @Component Annotation이 있는 클래스에 대하여 bean 인스턴스를 생성 Spring에서 @Component로 다 쓰지 않고 @Repository, @Service, @Controller등을 사용하는 이유는, 예를들어 @Repository는 DAO의 메소드에서 발생할 수 있는 unchecked exception들을 스프링의 DataAccessException으로 처리할 수 있기 때문이다.
@Component	@Component 은 개발자가 직접 작성한 Class를 Bean으로 등록하기 위한 Annotation이다. Component에 대한 추가 정보가 없다면 Class의 이름을 camelCase로 변경한 것이 Bean id로 사용된다. @Component는 @Bean과 다르게 name이 아닌 value를 이용해 Bean의 이름을 지정한다.
@Bean	@Bean은 개발자가 직접 제어가 불가능한 외부 라이브러리등을 Bean으로 만들려할 때 사용되는 Annotation이다.
@Autowired	무조건적인 객체에 대한 의존성을 주입시킨다. @Autowired를 사용할 시, 스프링이 자동적으로 값을 할당한다. Controller 클래스에서 DAO나 Service에 관한 객체들을 주입 시킬 때 많이 사용한다.
@Controller	Spring MVC에서 Controller클래스에 쓰인다. Spring의 Controller를 의미한다.
@RestController	Spring에서 Controller 중 View로 응답하지 않는, Controller를 의미한다. method의 반환 결과를 JSON 형태로 반환한다. 이 Annotation이 적혀있는 Controller의 method는 HttpResponse로 바로 응답이 가능하다. @ResponseBody 역할을 자동적으로 해주는 Annotation이다. @Controller + @ResponseBody를 사용하면 @ResponseBody를 모든 메소드에서 적용한다.
@Controller 와 @RestController 의 차이 @Controller API와 view를 동시에 사용하는 경우에 사용한다. 대신 API 서비스로 사용하는 경우는 @ResponseBody를 사용하여 객체를 반환한다. view(화면) return이 주목적이다. @RestController view가 필요없는 API만 지원하는 서비스에서 사용한다. Spring 4.0.1부터 제공 @RequestMapping 메서드가 기본적으로 @ResponseBody 의미를 가정한다. data(json, xml 등) return이 주목적이다. 즉 @RestController = @Controller + @ResponseBody 이다.
@Service	비즈니스 로직을 수행하는 Class라는 것을 나타내는 용도이다.
@Repository	DataBase에 접근하는 method를 가지고 있는 Class에서 쓰인다.
@SpringBootApplication	@Configuration, @EnableAutoConfiguration, @ComponentScan 3가지를 하나의 애노테이션으로 합친 것이다.
@RequestMapping	요청 URL을 어떤 method가 처리할지 mapping해주는 Annotation이다. Controller나 Controller의 method에 적용한다. 요청을 받는 형식인 GET, POST, PATCH, PUT, DELETE 를 정의하기도 한다. 요청 받는 형식을 정의하지 않는다면, 자동적으로 GET으로 설정된다.
@GetMapping	@RequestMapping(Method=RequestMethod.GET)과 같다. @PostMapping, @PutMapping, @PatchMapping, @DeleteMapping 등 도 있다.
@Valid	유효성 검증이 필요한 객체임을 지정한다.
@RequestAttribute	Request에 설정되어 있는 속성 값을 가져올 수 있다.
@RequestBody	요청이 온 데이터(JSON이나 XML형식)를 바로 Class나 model로 매핑하기 위한 Annotation이다.
@RequestHeader	Request의 header값을 가져올 수 있다. 메소드의 파라미터에 사용한다.
@RequestParam	url 뒤에 붙는 parameter 값을 가져올 때 사용한다. ?moviename=thepurge 와 같은 쿼리 파라미터를 파싱해준다.
@ResponseBody	HttpMessageConverter를 이용하여 JSON 혹은 xml 로 요청에 응답할수 있게 해주는 Annotation이다.
@PathVariable	method parameter 앞에 사용하면서 해당 URL에서 {특정값}을 변수로 받아 올 수 있다. REST API에서 값을 호출할 때 주로 많이 사용한다.

 

Lombok Annotation

Anotation	제약조건
@NoArgsConstructor	기본생성자를 자동으로 추가한다. Entity Class를 프로젝트 코드상에서 기본생성자로 생성하는 것은 금지하고, JPA에서 Entity 클래스를 생성하는것은 허용하기 위해 추가한다.
@AllArgsConstructor	모든 필드 값을 파라미터로 받는 생성자를 추가한다.
@RequiredArgsConstructor	final이나 @NonNull인 필드 값만 파라미터로 받는 생성자를 추가한다.
@Getter	Class 내 모든 필드의 Getter method를 자동 생성한다.
@Setter	Class 내 모든 필드의 Setter method를 자동 생성한다. Controller에서 @RequestBody로 외부에서 데이터를 받는 경우엔 기본생성자 + set method를 통해서만 값이 할당된다. 그래서 이때만 setter를 허용한다. Entity Class에는 Setter를 설정하면 안된다. 차라리 DTO 클래스를 생성해서 DTO 타입으로 받도록 하자
@Builder	빌더에 포함된다.

 

JPA Annotation

• JPA를 사용하면 DB 데이터에 작업할 경우 실제 쿼리를 사용하지 않고 Entity 클래스의 수정을 통해 작업한다

Anotation	제약조건
@Entity	실제 DB의 테이블과 매칭될 Class임을 명시한다.
@Table	Entity Class에 매핑할 테이블 정보를 알려준다.
@Id	해당 테이블의 PK 필드를 나타낸다.
@GeneratedValue	PK의 생성 규칙을 나타낸다. 가능한 Entity의 PK는 Long 타입의 Auto_increment를 추천 스프링 부트 2.0에선 옵션을 추가하셔야만 auto_increment가 된다. 기본값은 AUTO로, MySQL의 auto_increment와 같이 자동 증가하는 정수형 값이 된다.
@Column	테이블의 컬럼을 나타내며, 굳이 선언하지 않더라도 해당 Class의 필드는 모두 컬럼이 된다. @Column을 생략하면 필드명을 사용해서 컬럼명과 매핑 @Column을 사용하는 이유는, 기본값 외에 추가로 변경이 필요한 옵션이 있을 경우 사용한다. 문자열의 경우 VARCHAR(255)가 기본값인데, 사이즈를 500으로 늘리고 싶거나(ex: title), 타입을 TEXT로 변경하고 싶거나(ex: content) 등의 경우에 사용

 

Validation Annotation ( @Valid)

Anotation	제약조건
@NotNull	Null 불가
@Null	Null만 입력 가능
@NotEmpty	Null, 빈 문자열 불가
@NotBlank	Null, 빈 문자열, 스페이스만 있는 문자열 불가
@Size(min=,max=)	문자열, 배열등의 크기가 만족하는가?
@Pattern(regex=)	정규식을 만족하는가?
@Max(숫자)	지정 값 이하인가?
@Min(숫자)	지정 값 이상인가
@Future	현재 보다 미래인가?
@Past	현재 보다 과거인가?
@Positive	양수만 가능
@PositiveOrZero	양수와 0만 가능
@Negative	음수만 가능
@NegativeOrZero	음수와 0만 가능
@Email	이메일 형식만 가능
@Digits(integer=, fraction = )	대상 수가 지정된 정수와 소수 자리 수 보다 작은가?
@DecimalMax(value=)	지정된 값(실수) 이하인가?
@DecimalMin(value=)	지정된 값(실수) 이상인가?
@AssertFalse	false 인가?
@AssertTrue	true 인가?

 

 

---

참고자료:

https://velog.io/@ruinak_4127/Annotation%EC%9D%B4%EB%9E%80

@ Annotation이란?

https://bamdule.tistory.com/35

[Spring Boot] @Valid 어노테이션으로 Parameter 검증하기