Annotation?

Mention : @❓

Annotation

• 사전적 의미로는 주석이라는 뜻이다.
• 주석처럼 프로그래밍 언어에 영향을 미치지 않으며, 유용한 정보를 제공
  • 프로그램에게 추가적인 정보를 제공해주는 메타데이터라고 볼 수 있다.
  • meta data : 데이터를 위한 데이터

Annotation 사용 순서

• 애노테이션을 정의한다.
• 클래스에 애노테이션을 배치한다.
• 코드가 실행되는 중에 Reflection을 이용하여 추가 정보를 획득하여 기능을 실시한다.

Reflection?

• Reflection이란 프로그램이 실행 중에 자신의 구조와 동작을 검사, 조사, 수정하는 것
• 객체를 통해 클래스의 정보를 분석해내는 프로그램 기법
  • 자바에서 제공하는 API
• ref) https://upperleaf.tistory.com/2

Annotation 종류

@ComponentScan

• @Component와 @Service, @Repository, @Controller, @Configuration이 붙은 클래스 Bean들을 찾아서 Context에 bean등록을 해주는 Annotation이다.
• @Component Annotation이 있는 클래스에 대하여 bean 인스턴스를 생성
• ApplicationContext.xml에 과 같이 xml에 bean을 직접등록하는 방법도 있고 위와 같이 Annotation을 붙여서 하는 방법도 있다.
• base-package를 넣으면 해당 패키지 아래에 있는 컴포넌트들을 찾고 그 과정을 spring-context-버전(4.3.11.RELEASE).jar에서 처리한다.
• Spring에서 @Component로 다 쓰지 않고 @Repository, @Service, @Controller등을 사용하는 이유는, 예를들어 @Repository는 DAO의 메소드에서 발생할 수 있는 unchecked exception들을 스프링의 DataAccessException으로 처리할 수 있기 때문이다.
• 또한 가독성에서도 해당 애노테이션을 갖는 클래스가 무엇을 하는지 단 번에 알 수 있다.
• 자동으로 등록되는 Bean의 이름은 클래스의 첫문자가 소문자로 바뀐 이름이 자동적용된다.HomeController -> homeController

@Component

• @Component 은 개발자가 직접 작성한 Class를 Bean으로 등록하기 위한 Annotation이다.
• Component에 대한 추가 정보가 없다면 Class의 이름을 camelCase로 변경한 것이 Bean id로 사용된다.
• @Component는 @Bean과 다르게 name이 아닌 value를 이용해 Bean의 이름을 지정한다.

@Bean

• @Bean은 개발자가 직접 제어가 불가능한 외부 라이브러리등을 Bean으로 만들려할 때 사용되는 Annotation이다.
• ArrayList같은 라이브러리등을 Bean으로 등록하기 위해서는 별도로 해당 라이브러리 객체를 반환하는 Method를 만들고 @Bean Annotation을 사용하면 된다.
• @Bean에 name이라는 값을 이용하면 자신이 원하는 id로 Bean을 등록할 수 있다.

@Autowired

• 속성(field), setter method, constructor(생성자)에서 사용하며 Type에 따라 알아서 Bean을 주입 해준다.
• 무조건적인 객체에 대한 의존성을 주입시킨다.
• @Autowired를 사용할 시, 스프링이 자동적으로 값을 할당한다.
• Controller 클래스에서 DAO나 Service에 관한 객체들을 주입 시킬 때 많이 사용한다.
• 필드, 생성자, 입력 파라미터가 여러 개인 메소드(@Qualifier는 메소드의 파라미터)에 적용 가능하다.
• Type을 먼저 확인한 후 못 찾으면 Name에 따라 주입한다.

Bean을 주입받는 방식 (3가지)

1. @Autowired
2. setter
3. 생성자 (@AllArgsConstructor 사용) -> 권장방식

@Inject

• @Autowired 어노테이션과 비슷한 역할을 한다.

@Controller

• Spring의 Controller를 의미한다.
• Spring MVC에서 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

Service Class에서 쓰인다.

• 비즈니스 로직을 수행하는 Class라는 것을 나타내는 용도이다.

@Repository

• DAO class에서 쓰인다.
• DataBase에 접근하는 method를 가지고 있는 Class에서 쓰인다.

@EnableAutoConfiguration

• Spring Application Context를 만들 때 자동으로 설정하는 기능을 켠다.
• classpath의 내용에 기반해서 자동으로 생성해준다.
• 만약 tomcat-embed-core.jar가 존재하면 톰캣 서버가 setting된다.

@Configuration

• @Configuration을 클래스에 적용하고 @Bean을 해당 Class의 method에 적용하면 @Autowired로 Bean을 부를 수 있다.

@Required

• setter method에 적용해주면 Bean 생성시 필수 프로퍼티 임을 알린다.
• Required Annotation을 사용하여 optional 하지 않은, 꼭 필요한 속성들을 정의한다.
• 영향을 받는 bean property를 구성할 시에는 XML 설정 파일에 반드시 property를 채워야 한다.

@Qualifier(“id123”)

• @Autowired와 같이 쓰이며, 같은 타입의 Bean 객체가 있을 때 해당 아이디를 적어 원하는 Bean이 주입될 수 있도록 하는 Annotation이다.같은 타입이 존재하는 경우 ex) 동물 = 원숭이, 닭, 개, 돼지
• 같은 타입의 Bean이 두 개 이상이 존재하는 경우에 Spring이 어떤 Bean을 주입해야 할지 알 수 없어서 Spring Container를 초기화하는 과정에서 예외를 발생시킨다.
• 이 경우 @Qualifier을 @Autowired와 함께 사용하여 정확히 어떤 bean을 사용할지 지정하여 특정 의존 객체를 주입할 수 있도록 한다.
• xml 설정에서 bean의 한정자 값(qualifier value)을 설정한다.
• @Autowired 어노테이션이 적용된 주입 대상에 @Qualifier 어노테이션을 설정한다.

@Resource

• @Autowired와 마찬가지로 Bean 객체를 주입해주는데 차이점은 Autowired는 타입으로, Resource는 이름으로 연결해준다.
• javax.annotation.Resource 표준 자바(JSR-250 표준) Annotation으로, Spring Framework 2.5.* 부터 지원 가능한 Annotation이다.
• Annotation 사용으로 인해 특정 Framework에 종속적인 어플리케이션을 구성하지 않기 위해서는 @Resource를 사용할 것을 권장한다.
• @Resource를 사용하기 위해서는 class path 내에 jsr250-api.jar 파일을 추가해야 한다.필드, 입력 파라미터가 한 개인 bean property setter method에 적용 가능하다.

@PostConstruct, @PreConstruct

• 의존하는 객체를 생성한 이후 초기화 작업을 위해 객체 생성 전/후에(pre/post) 실행해야 할 method 앞에 붙인다.

@PreDestroy

• 객체를 제거하기 전(pre)에 해야할 작업을 수행하기 위해 사용한다.

@PropertySource

• 해당 프로퍼티 파일을 Environment로 로딩하게 해준다.
• 클래스에 @PropertySource(“classpath:/settings.properties”)라고 적고 클래스 내부에 @Resource를 Environment타입의 멤버 변수앞에 적으면 매핑된다.

@ConfigurationProperties

• yaml파일 읽는다.
• default로 classpath:application.properties 파일이 조회된다.
• 속성 클래스를 따로 만들어두고 그 위에 (prefix=”mail”)을 써서 프로퍼티의 접두사를 사용할 수 있다.

@Lazy

• 지연로딩을 지원한다.
• @Component나 @Bean Annotation과 같이 쓰는데 Class가 로드될 때 스프링에서 바로 bean등록을 마치는 것이 아니라 실제로 사용될 때 로딩이 이뤄지게 하는 방법이다.

@Value

• properties에서 값을 가져와 적용할 때 사용한다.
• private String valueFromFile; 이라고 구성되어 있으면 value.from.file의 값을 가져와서 해당 변수에 주입해준다.
• spEL을 이용해서 조금 더 고급스럽게 쓸 수 있다.

@SpringBootApplication

• @Configuration, @EnableAutoConfiguration, @ComponentScan 3가지를 하나의 애노테이션으로 합친 것이다.

@RequestMapping

• 요청 URL을 어떤 method가 처리할지 mapping해주는 Annotation이다.
• Controller나 Controller의 method에 적용한다.
• 요청을 받는 형식인 GET, POST, PATCH, PUT, DELETE 를 정의하기도 한다.
• 요청 받는 형식을 정의하지 않는다면, 자동적으로 GET으로 설정된다.
• @RequestMapping에 대한 모든 매핑 정보는 Spring에서 제공하는 HandlerMapping Class가 가지고 있다.

@CookieValue

• 쿠키 값을 parameter로 전달 받을 수 있는 방법이다.
• 해당 쿠키가 존재하지 않으면 500 에러를 발생시킨다.
• 속성으로 required가 있는데 default는 true다.
• false를 적용하면 해당 쿠키 값이 없을 때 null로 받고 에러를 발생시키지 않는다.### @CrossOrigin
• CORS 보안상의 문제로 브라우저에서 리소스를 현재 origin에서 다른 곳으로의 AJAX요청을 방지하는 것이다.
• @RequestMapping이 있는 곳에 사용하면 해당 요청은 타 도메인에서 온 ajax요청을 처리해준다.

@ModelAttribute

• view에서 전달해주는 parameter를 Class(VO/DTO)의 멤버 변수로 binding 해주는 Annotation이다.
• binding 기준은 처럼 어떤 태그의 name값이 해당 Class의 멤버 변수명과 일치해야하고 setmethod명도 일치해야한다.

@GetMapping

• @RequestMapping(Method=RequestMethod.GET)과 같다.
• @PostMapping, @PutMapping, @PatchMapping, @DeleteMapping 등 도 있다.

@SessionAttributes

• Session에 data를 넣을 때 쓰는 Annotation이다.
• @SessionAttributes(“name”)이라고 하면 Model에 key값이 “name”으로 있는 값은 자동으로 세션에도 저장되게 한다.

@Valid

• 유효성 검증이 필요한 객체임을 지정한다.

@InitBinder

• @Valid 애노테이션으로 유효성 검증이 필요하다고 한 객체를 가져오기전에 수행해야할 method를 지정한다.

@RequestAttribute

• Request에 설정되어 있는 속성 값을 가져올 수 있다.

@RequestBody

• 요청이 온 데이터(JSON이나 XML형식)를 바로 Class나 model로 매핑하기 위한 Annotation이다.
• POST나 PUT, PATCH로 요청을 받을때에, 요청에서 넘어온 body 값들을 자바 타입으로 파싱해준다.
• HTTP POST 요청에 대해 request body에 있는 request message에서 값을 얻어와 매핑한다.
• RequestData를 바로 Model이나 클래스로 매핑한다.
• 이를테면 JSON 이나 XML같은 데이터를 적절한 messageConverter로 읽을 때 사용하거나 POJO 형태의 데이터 전체로 받는 경우에 사용한다.

@RequestHeader

• Request의 header값을 가져올 수 있다. 메소드의 파라미터에 사용한다.

@RequestParam

• @PathVariable과 비슷하다.
• request의 parameter에서 가져오는 것이다. method의 파라미터에 사용된다.
• ?moviename=thepurge 와 같은 쿼리 파라미터를 파싱해준다.
• HTTP GET 요청에 대해 매칭되는 request parameter 값이 자동으로 들어간다.
• url 뒤에 붙는 parameter 값을 가져올 때 사용한다.
• @RequestParam 어노테이션의 괄호 안의 문자열이 전달 인자 이름(실제 값을 표시)이다.

@RequestPart

• Request로 온 MultipartFile을 바인딩해준다.

@ResponseBody

• HttpMessageConverter를 이용하여 JSON 혹은 xml 로 요청에 응답할수 있게 해주는 Annotation이다.
• view가 아닌 JSON 형식의 값을 응답할 때 사용하는 Annotation으로 문자열을 리턴하면 그 값을 http response header가 아닌 response body에 들어간다.
• 이미 RestController Annotation이 붙어 있다면, 쓸 필요가 없다.
• 허나 그렇지 않은 단순 컨트롤러라면, HttpResponse로 응답 할 수 있게 해준다.
• 만약 객체를 return하는 경우 JACKSON 라이브러리에 의해 문자열로 변환되어 전송된다.
• context에 설정된 viewResolver를 무시한다고 보면된다.

@PathVariable

• method parameter 앞에 사용하면서 해당 URL에서 {특정값}을 변수로 받아 올 수 있다.
• HTTP 요청에 대해 매핑되는 request parameter 값이 자동으로 Binding 된다.
• uri에서 각 구분자에 들어오는 값을 처리해야 할 때 사용한다.
• REST API에서 값을 호출할 때 주로 많이 사용한다.

@ExceptionHandler(ExceptionClassName.class)

• 해당 클래스의 예외를 캐치하여 처리한다.

@ControllerAdvice

• Class 위에 ControllerAdvice를 붙이고 어떤 예외를 잡아낼 것인지는 각 메소드 상단에 + @ExceptionHandler(예외클래스명.class)를 붙여서 기술한다.

@RestControllerAdvice

• @ControllerAdvice + @ResponseBody다.

@ResponseStatus

• 사용자에게 원하는 response code와 reason을 return해주는 Annotation이다.
• @ResponseStatus(value = HttpStatus.NOT_FOUND, reason = “my page URL + changed..”) => 예외처리 함수 앞에 사용한다.

@EnableEurekaServer

• Eureka 서버로 만들어준다.

@EnableDiscoveryClient

• Eureka 서버에서 관리될 수 있는 클라이언트 임을 알려주기위한 Annotation이다.

@Transactional

• 데이터베이스 트랜잭션을 설정하고 싶은 method에 Annotation을 적용하면 method 내부에서 일어나는 데이터베이스 로직이 전부 성공하게되거나 데이터베이스 접근중 하나라도 실패하면 다시 롤백할 수 있게 해주는 Annotation이다.
• @Transaction(readOnly=true, rollbackFor=Exception.class)에서 readOnly는 읽기전용임을 알리고 rollbackFor는 해당 Exception이 생기면 롤백하라는 뜻이다.
• @Transaction(noRollbackFor=Exception.class)는 해당 Exception이 나타나도 롤백하지 말라는 뜻이다.
• @Transaction(timeout = 10)은 10초안에 해당 로직을 수행하지 못하면 롤백하라는 뜻이다.
• 메소드 내에서 Exception이 발생하면 해당 메소드에서 이루어진 모든 DB 작업을 초기화한다.
• save 메소드를 통해서 10개를 등록해야 하는데 5번째에서 Exception이 발생하면 앞에 저장된 4개 까지 모두 롤백한다.
• 정확히 얘기하면, 이미 넣은걸 롤백시키는건 아니며, 모든 처리가 정상적으로 됐을때만 DB에 커밋하며 그렇지 않은 경우엔 커밋하지 않는 것이다.
• 비지니스 로직과 트랜잭션 관리는 대부분 Service에서 관리한다.
• 따라서 일반적으로 DB 데이터를 등록/수정/삭제 하는 Service 메소드는 @Transactional를 필수적으로 가져간다.

@Cacheable

• method 앞에 지정하면 해당 method를 최초에 호출하면 캐시에 적재하고 다음부터는 동일한 method 호출이 있을 때 캐시에서 결과를 가져와서 return하므로 method 호출 횟수를 줄여주는 Annotation이다.
• 주의할 점은 입력이 같으면 항상 출력이 같은 method(=순수 함수)에 적용해야한다.
• 그런데 또 항상 같은 값만 뱉어주는 메서드에 적용하려면 조금 아쉬울 수 있다.
• 따라서 메서드 호출에 사용되는 자원이 많고 자주 변경되지 않을 때 사용하고 나중에 수정되면 캐시를 없애는 방법을 선택할 수 있다.

@CachePut

• 캐시를 업데이트하기 위해서 method를 항상 실행하게 강제하는 Annotation 이다.
• 해당 Annotation이 있으면 method 호출을 항상한다. 그러므로 @Cacheable과 상충되어 같이 사용하면 안된다.

@CacheEvict

• 캐시에서 데이터를 제거하는 트리거로 동작하는 method에 붙이는 Annotation이다.
• 캐시된 데이터는 언제가는 지워져야한다. 그러지 않으면 결과값이 변경이 일어났는데도 기존의 데이터(캐시된 데이터)를 불러와서 오류가 발생할 수 있다.
• 물론 캐시 설정에서 캐시 만료시간을 줄 수도 있다.
• allEntries는 전체 캐시를 지울지 여부를 선택하는 것이다.

@CacheConfig

• 클래스 레벨에서 공통의 캐시설정을 공유하는 기능이다.

@Scheduled

• Linux의 crontab처럼 정해진 시간에 실행해야하는 경우에 사용한다.
• @Scheduled(cron = “0 0 07 * * ?”) : “초 분 시 일 월 요일 년(선택)에 해당 메서드 호출

Lombok Annotation

@NoArgsConstructor

• 기본생성자를 자동으로 추가한다.
• 기본생성자의 접근 권한을 protected로 제한한다.
• 생성자로 protected Posts() {}와 같은 효과
• Entity Class를 프로젝트 코드상에서 기본생성자로 생성하는 것은 금지하고, JPA에서 Entity 클래스를 생성하는것은 허용하기 위해 추가한다.

@AllArgsConstructor

• 모든 필드 값을 파라미터로 받는 생성자를 추가한다.

@RequiredArgsConstructor

• final이나 @NonNull인 필드 값만 파라미터로 받는 생성자를 추가한다.
• final: 값이 할당되면 더 이상 변경할 수 없다.

@Getter

• Class 내 모든 필드의 Getter method를 자동 생성한다.

@Setter

• Class 내 모든 필드의 Setter method를 자동 생성한다.
• Controller에서 @RequestBody로 외부에서 데이터를 받는 경우엔 기본생성자 + set method를 통해서만 값이 할당된다.
• 그래서 이때만 setter를 허용한다.
• Entity Class에는 Setter를 설정하면 안된다.
• 차라리 DTO 클래스를 생성해서 DTO 타입으로 받도록 하자

@ToString

• Class 내 모든 필드의 toString method를 자동 생성한다.
• 특정 필드를 toString() 결과에서 제외한다.
• 클래스명(필드1이름=필드1값, 필드2이름=필드2값, …) 식으로 출력된다.

@EqualsAndHashCode

• equals와 hashCode method를 오버라이딩 해주는 Annotation이다.
• allSuper 속성을 통해 equals와 hashCode 메소드 자동 생성 시 부모 클래스의 필드까지 감안할지 안 할지에 대해서 설정할 수 있다.
• 즉, callSuper = true로 설정하면 부모 클래스 필드 값들도 동일한지 체크하며, callSuper = false로 설정(기본값)하면 자신 클래스의 필드 값들만 고려한다.

@Builder

• 빌더에 포함된다.

@Data

• @Getter, @Setter, @EqualsAndHashCode, @AllArgsConstructor을 포함한 Lombok에서 제공하는 필드와 관련된 모든 코드를 생성한다.
• 실제로 사용하지 않는것이 좋다.
• 전체적인 모든 기능 허용으로 위험 존재

JPA Annotation

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

@Entity

• 실제 DB의 테이블과 매칭될 Class임을 명시한다.
• 즉, 테이블과 링크될 클래스임을 나타낸다.

Entity Class

• 가장 Core한 클래스로 클래스 이름을 언더스코어 네이밍(_)으로 테이블 이름을 매칭한다.

Controller에서 쓸 DTO 클래스란??

• Request와 Response용 DTO는 View를 위한 클래스로, 자주 변경이 필요한 클래스이다.
• Entity 클래스와 DTO 클래스를 분리하는 이유는 View Layer와 DB Layer를 철저하게 역할 분리하기 위해서다.
• 테이블과 매핑되는 Entity 클래스가 변경되면 여러 클래스에 영향을 끼치게 되는 반면 View와 통신하는 DTO 클래스(Request/ Response 클래스)는 자주 변경되므로 분리해야 한다.

@Table

• Entity Class에 매핑할 테이블 정보를 알려준다.
• Annotation을 생략하면 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) 등의 경우에 사용
• Summary
  • Annotation은 코드 사이에 주석처럼 쓰이며 특별한 의미를 제공하고, reflection을 이용하여 기능을 수행하도록 하는 기술입니다. Annotation을 활용하면 코드가 깔끔해지고 재사용에 용이합니다. Spring framework에서 제공하는 @ComponentScan는 하위 @Component 또는 직접 등록할 Bean 예를 들면 @Controller, @Service, @Repository 등을 스캐닝하여 Bean 등록합니다. @Autowired 같은 Annotation은 각 상황의 타입에 맞는 IoC 컨테이너 안에 존재하는 Bean을 자동으로 주입해줍니다. 또 다른 예로 Lombok 라이브러리에서 제공하는 Annotaion @Setter, @Getter 등은 코드를 줄여 가독성을 높여주는 역할을 합니다.

Reference 📚

https://velog.io/@ruinak_4127/Annotation이란