어노테이션 정리 @

어노테이션이란?

• @ 사인 하나로 많은 컨텍스트들을 제공 받을 수 있게 한다.

• @ 사인으로 시작하는 것을 어노테이션 이라고 한다.

 

Spring으로 개발할 때  어노테이션 없이 개발하는 것은 거의 볼 수 없다. Controller 등록이나 Service, Repository, Test 등 안쓰이는 곳이 없을 정도다.

 

많이 쓰임에도 개발하다가 가끔 생각이 안나거나 까먹을 때가 있기에 지금이라도 조금씩 정리할 생각이다.

 

포스트잇 처럼 계속 추가할 예정 ✏️

 

@AfterEach

: 각 테스트가 종료될 때마다 실행

 

1)  Test Case를 작성하는 경우  : 메모리 DB에 남아있는 저장된 데이터를 삭제한다. (직전 데이터를 삭제해줌)

 

clearStore 메서드 

public void clearStore(){
    store.clear();
}

 

test case에 추가 

@AfterEach
public void afterEach(){
    repository.clearStore();
}

@BeforeEach

: 각 테스트 실행 전에 호출

 

1)  새로운 객체를 생성하고, 의존관계도 새로 맺어줌

@BeforeEach
public void beforeEach(){
    memberRepository = new MemoryMemberRepository(); 
    memberService = new MemberService(memberRepository);
}

 

@AfterEach, @BeforeEach 모두 테스트케이스 작성 시 발생가능한 오류를 최소화시키기 위해 사용 

@ComponentScan

: @Component, @Service, @Repository, @Controller, @Configuration 등등 우리가 등록하고 싶다고 설정한 빈들을 찾아서 빈으로 만들어주는 것

: 해당 @ComponentScan이 작성된 패키지 이하의 클래스들을 순회하며 빈으로 등록될 객체들을 탐색한다.

 

** 탐색할 패키지의 시작위치를 지정하는 방법

** 권장사항은 아니다. 설정 정보 클래스의 위치를 프로젝트 최상단에 두는 것을 권장

@ComponentScan(
	basePackages = "hello.core", basePackageClasses = AutoAppConfig.class,
)

•  basePackages : 탐색할 패키지의 시작 위치를 지정한다. 이 패키지를 포함해서 하위 패키지를 모두 탐색

    •  basePackages = {"hello.core", "hello.service"} 여러 위치를 지정할 수도 있다.

•  basePackageClasses : 지정한 클래스의 패키지를 탐색 위치로 지정한다.

만약 지정하지 않으면 @ComponentScan이 붙은 설정 정보 클래스의 패키지가 시작 위치가 된다.

 

** @ComponentScan으로 등록하는 빈의 기본이름은 클래스 명을 사용하되 맨 앞글자만 소문자를 사용한다 **

•  빈 이름 기본 전략 : MemberServiceImpl 클래스 => memberServiceImpl

•  빈 이름 직접 지정 : 만약 스프링 빈의 이름을 직접 지정하고 싶다면 @Component("memberService2") 이런식으로 이름을 부여하면 된다.

 

** filter 옵션 **

•  includeFilters : 컴포넌트 스캔 대상을 추가로 지정 

    •  추가할 클래스는 @MyIncludeComponent로 지정해 스프링 빈에 등록된다.

•   excludeFilters : 컴포넌트 스캔에서 제외할 대상을 지정 

    •   제외할 클래스는 @MyExcludeComponent로 지정해 스프링 빈에 등록하지 않는다.

 @Configuration
 @ComponentScan(
 	includeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyIncludeComponent.class),
 	excludeFilters = @Filter(type = FilterType.ANNOTATION, classes = MyExcludeComponent.class)
 ) static class ComponentFilterAppConfig {
 
 }

** filter type 옵션 **

•  ANNOTATION : 기본 값, 애노테이션을 인식해 동작

•  ASSIGNABLE_TYPE : 지정한 타입과 자식 타입을 인식해서 동작

•  ASPECTJ : AspectJ 패턴 사용

•  REGEX : 정규 표현식

•  CUSTOM : TypeFilter 이라는 인터페이스를 구현해 처리 

@Configuration

: 스프링 설정 정보에서 사용. 스프링 설정 정보로 인식하고, 스프링 빈이 싱글톤을 유지하도록 추가처리를 한다.

@Autowired

: 각 상황의 타입에 맞는 Ioc 컨테이너 안에 존재하는 Bean을 자동으로 주입해 준다. ( DI  의존성 주입 )

: 생성자에 지정하면, 스프링 컨테이너가 자동으로 해당 스프링 빈을 찾아서 주입하고, 생성자에서 여러 의존관계도 한번에 주입받을 수 있다. 

: 'getBean(MemberRepository.class)'와 동일하다고 이해하면 됨

: @Autowired의 기본동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게 하려면

   @Autowired( required = false )로 지정하면 된다.

@Autowired(required = false)
public void setNoBean1(Member noBean1){ // Member는 빈으로 등록되지 않았음
	System.out.println("noBean1 = " +noBean1);
}

** @Autowired( required = false ) **  와 같이 자동주입 대상을 옵션으로 처리하는 다른 방법 

org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력

Optional< > : 자동 주입할 대상이 없으면 Optional.empty 가 입력

@Autowired
public void setNoBean2(@Nullable Member noBean2){ 
	System.out.println("noBean1 = " +noBean2);
}

@Autowired
public void setNoBean3(Optional<Member> noBean3){
	System.out.println("noBean1 = " +noBean3);
}

•  @Autowired는 빈을 자동으로 주입해주고 Type으로 조회( ac.getBean(DiscountPolicy.class)와 유사 )하기 때문에 타입 조회 시 선택된 빈이 2개 이상일 때 문제가 발생한다.  ( 즉 조회 빈이 2개 이상일 때 문제가 발생 )

 

.NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.discount.DiscountPolicy' available: expected single matching bean but found 2: fixDiscountPolicy,rateDiscountPolicy

 

해결방법

1.   @Autowired 필드 명 매칭

    : @Autowired는 타입 매칭을 시도하고, 이 때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

    : 필드명을 빈 이름으로 변경 

    : 필드명 매칭은 타입매칭을 먼저 시도한 후에 그 결과 여러 빈이 있는 경우 추가로 동작하는 기능 

2.   @Qualifier @Qualifier끼리 매칭 빈 이름 매칭

3.   @Primary 사용 

@Qualifier 

: 빈 등록 시 명시적으로 이름을 지정할 수 있다.

:  추가 구분자를 붙여주어 빈을 매칭하는 방법 

: 빈을 주입 받을 때 모든 코드에 @Qualifier을 붙여주어야 한다.

: 매우 상세하게 동작한다. 

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
 						@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
 	this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
}

@Primary 

:  우선순위를 정하는 방법으로 @Autowired 시 여러 빈이 매칭되면 @Primary로 지정된 빈이 우선권을 가진다.

:  @Qualifier지정 없이 편리하게 조회 가능하다. 기본 값처럼 동작.

@RequiredArgsConstructor

: 생성자 주입 시 Lombok 플러그인을 활용하여 간단한 방법으로 생성자 주입을 할 수 있다. 

: final or @NotNull이 붙은 필드의 생성자를 자동 생성해주는 Lombok @

: 의존성 주입의 편의성을 위해 사용되곤 한다.

@ResponseBody 

:  자바 객체를 HTTP 요청의 body 내용으로 직접 매핑

:  viewResolver 사용하지 않음

: 기본 문자 처리 StringHttpMessageConverter

: 기본 객체 처리 : MappingJackson2HttpMessageConverter

: byte 처리 등 기타 여러 HttpMessageConverter가 기본 등록 

@RequestBody

: @RequestBody에 붙은 파라미터는 HTTP 요청의 본문 body부분이 자바 객체 그대로 전달 

: json 형태로 받은 HTTP Body 데이터를 MessageConverter를 통해 Java Object로 변환시킴

: 그렇기 때문에 Body가 존재하지 않는 HTTP Get 메소드에 @RequestBody를 활용하면 Error

: 값을 주입하지 않고 변환을 시키므로 변수들의 생성자나 Setter 함수가 없어도 정상적으로 값이 할당됨

@ModelAttribute

: 클라리언트가 전송하는 multipart/form-data 형태의 HTTP Body 내용과 HTTP 파라미터의 값들을 생성자나 Setter를 통해 주입하기 위해 사용됨

: @ModelAttribute에는 매핑시키는 파라미터의 타입이 객체의 타입과 일치하는지를 포함한 다양한 검증작업이 추가적으로 진행된다. 

: 사용자가 요청 시 전달하는 값을 오브젝트 형태로 매핑해준다.

: 객체 매핑

: Json이나 XML과 같은 형태의 데이터를 MessageConverter를 통해 변환시키는 @RequestBody와 달리, @ModelAttribute는 multipart/form-data 형태의 HTTP Body와 HTTP 파라미터들을 생성자나 수정자로 주입시킨다는 차이가 있다.

@RequestParam

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

: 1개의 HTTP 요청 파라미터를 받기 위해 사용 

: @RequestParma은 필수 여부가 True이기 때문에 기본적으로 반드시 해당 파라미터가 전송되어야 함

: 해당 파라미터가 전송되지 않으면 404 Error 

: 반드시 필요한 변수가 아니라면 required 값을 false

@RequestMapping

: @RequestMapping 어노테이션은 Spring 웹 애플리케이션에서 가장 자주 사용 

: http request로 들어오는 url 특정 controller 클래스나 메서드로 연결시키는 역할

: controller에 class에 적용할 수 있고 특정 method에 적용 가능 

@Controller

: 전통적인 Spring MVC의 컨트롤러, 주로 View를 반환하기 위해 사용. 

: 프레젠테이션 레이어, 웹 요청과 응답을 처리 

: 핸들러가 스캔할 수 있는 빈(Bean) 객체가 되어 서블릿용 컨테이너에 생성 ( @Repository, @service 도 마찬가지로 해당 클래스를 루트 컨테이너 Bean 객체로 생성해준다. )

@Service

: 스프인 비즈니스 로직에서 사용. 서비스 레이어, 내부에서 자바 로직을 처리함 

: 특별한 처리를 하기보다는 개발자들이 핵심 비즈니스 계층을 인식하는데 도움 

@Repository

: 스프링 데이터 접근 계층에서 사용.

: 데이터 계층의 예외를 스프링 예외로 변환

: 외부 I/O 처리, 퍼시스턴트 레이어, DB나 파일 같은 외부 I/O 작업을 처리함 

@GetMapping

: HTTP GET 요청을 특정 핸들러 메소드에 매핑, 주소에 파라미터가 노출 

: 메소드에만 적용 

@RestController
public class UserController {
 
    @Autowired
    UserService userService;
 
    @GetMapping("users")
    public ResponseEntity<List<User>> getAll() {
        return new ResponseEntity<>(userService.getAll(), HttpStatus.OK);
    }
 
    @GetMapping("users/{id}")
    public ResponseEntity<User> getById(@PathVariable long id) {
        Optional<User> user = userService.getById(id);
        if (user.isPresent()) {
            return new ResponseEntity<>(user.get(), HttpStatus.OK);
        } else {
            throw new RecordNotFoundException();
        }
    }
}

@PathVariable

: 경로의 특정 위치 값이 고정되지 않고 달라질 때 사용한다.

: URL경로에 변수를 넣어주는 것 

@PostMapping

: HTTP POST 요청을 처리하는 특수화된 주석 버전. 주소창에 파라미터가 노출되지 않음 

:  @RequestMapping(method = RequestMethod.POST) 의 단축키 역할

@PostMapping(path = "users", 
        consumes = MediaType.APPLICATION_JSON_VALUE, 
        produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<User> create(@RequestBody User newUser) {
    User user = userService.save(newUser);
    if (user == null) {
        throw new ServerException();
    } else {
        return new ResponseEntity<>(user, HttpStatus.CREATED);
    }
}

@SpringBootTest

: 스프링 컨테이너와 테스트를 함께 실행한다.

@Transactional

: TestCase에 @Transactional이 있으면 테스트 시작 전에 트랜잭션을 시작, 완료 후에는 항상 RollBack 

: 다음 Test에 영향을 주지 않는다.

---

객체와 테이블 매핑  @Entity, @Table 

@Entity

: JPA 를 사용해서 테이블과 매핑할 클래스는 @Entity 필수적

: @Entity가 붙은 클래스는 JPA가 관리하는 것으로, 엔티티라고 불림 

 

• 속성

- name : JPA에서 사용할 엔티티 이름을 지정, 보통 기본 값인 클래스 이름을 사용

 

• 주의사항 

- 기본 생성자는 필수 ( JPA가 엔티티 객체 생성시 기본 생성자를 사용, 파라미터가 없는 public 또는 protected  생성자 )

- final 클래스, enum, interface, inner class에는 사용 불가 

- 저장할 필드에 final 사용 불가 

@Table

: 엔티티와 매핑할 테이블을 지정

: 생략 시 매핑한 엔티티 이름을 테이블 이름으로 사용

 

• 속성

- name : 매핑할 테이블 이름 ( default 엔티티 이름을 사용)

- catalog : catalog 기능이 있는 DB에서 catalog 매핑 ( default  DB명 )

- schema : schema 기능이 있는 DB에서 schema를 매핑

- uniqueConstraints : DDL 생성 시 유니크 제약조건을 만듦 , 스키마 자동생성 기능을 사용해 DDL을 만들 때만 사용

 

필드와 컬럼 매핑  @Column

@Column

: 객체 필드를 테이블 컬럼에 매핑

: 속성 중 name, nullable이 주로 사용되고 나머지는 잘 사용되지 않음

 

• 속성

- name :  필드와 매핑할 테이블 컬럼 이름 (default. 객체의 필드 이름)

- nullable (DDL) : null 값의 허용 여부 설정, false 설정 시 not null (default. true) 

                            @Colunm 사용 시 nullable = false 로 설정하는 것이 안전 

- unique (DDL) : @Table의 uniqueConstraints와 같지만 한 컬럼에 간단히 유니크 제약조건을 적용

- columnDefinition (DDL) : 데이터베이스 컬럼 정보를 직접 줄 수 있음.

                                            (default. 필드의 자바 타입과 정보를 사용해 적절한 컬럼 타입을 생성)

- length (DDL) : 문자 길이 제약조건, String 타입에만 사용 (default. 255)

- precistion, scale(DDL) : BigDecimal, BigInteger 타입에서 사용, 아주 큰 숫자나 정밀한 소수를 다룰 때만 사용

(default. precistion= 19, scale = 2 )

@JoinColumn

: 외래 키를 매핑할 때 사용

 

• 속성

- name :  매핑할 외래 키 이름 (default. 참조하는 테이블의 기본 키 컬럼명)

- foreignKey (DDL) : 외래키 제약 조건을 직접 지정할 수 있다. 이 속성은 테이블을 생성할 때만 사용한다.

- referencedColumnName : 외래 키가 참조하는 대상 테이블의 컬럼명 ( 참조하는 테이블의 기본키 컬럼명 )

unique nullable insertable updatable columnDefinition table 은 @Column 속성과 같다.

@Temporal

: 날짜 타입 매핑(java.util.Date, java.util.Calendar)

: LocalDate, LocalDateTime을 사용할 때는 생략가능 (최신 하이버네이트 지원)

• 속성

value 

TemporalType.DATE : 날짜, 데이터베이스 date 타입과 매핑 (ex:2013-10-11)

TemporalType.TIME : 시간, 데이터베이스 time 타입과 매핑 (ex:11:11:11)

TemporalType.TIMESTAMP : 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (ex:2013-10-11 11:11:11)

@Enumerated

: 자바 enum 타입 매핑

 

• 속성

value (ORDINAL 사용하면 안된다)

EnumType.ORDINAL : enum 순서를 데이터베이스에 저장한다. (default)

EnumType.STRING : enum 이름을 데이터베이스에 저장한다. 

@Lob

: CLOB(매핑하는 필드 타입이 문자 String, char[], java.sql.CLOB), BLOB(byte[], java.sql.BLOB) 매핑

: @Lob에는 지정할 수 있는 속성이 없다.

@Transient

: 특정 필드를 컬럼에 매핑하지 않음 (매핑무시)

: 데이터베이스에 저장, 조회 하지 않음

: 주로 메모리 상에서 임시로 값을 보관하고 싶을 때 사용

@Transient
private Integer temp;

 

기본 키 매핑  @Id @GeneratedValue

@Id @GeneratedValue(strategy=GenerationType.AUTO)
private Long id;

@Id

: JPA 엔티티 객체의 식별자로 사용할 필드에 적용

 

 • 직접 할당 : 기본키를 애플리케이션에 직접 할당

     - em.persist()를 호출하기 전 애플리케이션에서 직접 식별자 값을 할당해야 함. 식별자 값이 없을 경우 에러 발생 

@GeneratedValue

기본 키 생성 전략 

   

    • 자동 생성 : 대리키 사용방식 

       - IDENTITY : 기본 키 생성을 데이터 베이스에 위임, MYSQL (=AUTO_INCREMENT)

                           : em.persist() 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자 조회

@Entity
public class Member{
	
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
}

       - SEQUENCE: 데이터베이스 시퀀스를 사용해서 기본 키를 할당,  @SequenceGenerator 

                                데이터베이스 시퀀스에서 식별자 값을 획득한 후 영속성 컨텍스트에 저장 

                                 유일한 값을 순서대로 생성 (Oracle, PostgreSQL, DB2, H2)

       - TABLE: 키 생성 테이블을 사용 @TableGenerator

                       키 생성 전용 테이블 하나 만들고 여기에 이름과 값으로 사용할 컬럼을 만들어 

                       데이터베이스 시퀀스를 흉내내는 전략, 테이블을 사용하므로 모든 데이터베이스에 적용 가능 

       - AUTO : 선택한 데이터베이스에 따라 방식을 자동으로 선택 (Default)

                      Ex) Oracle 선택 시 SEQUNCE, MySQL  선택 시 IDENTITY 사용 

 

연관관계 매핑  @ManyToOne @OneToMany

@ManyToOne

: 다대일 관계 매핑

 

• 속성

optional : false로 설정하면 연관된 엔티티가 항상 있어야 한다. (default. TRUE)

fetch : 글로벌 패치 전략을 설정한다. ( @ManyToOne=FetchType.EAGER  @OneToMany=FetchType.LAZY )

cascade : 영속성 전이 기능

targetEntity : 연관된 엔티티 타입 정보를 설정, 거의 사용하지 않는다. 컬렉션을 사용해도 제네릭으로 타입 정보를 알 수 O

@OneToMany

: 일대다 관계 매핑

 

• 속성

mappedBy : 연관관계의 주인 필드를 선택한다.

---

@Aspect

: 해당 클래스가 Aspect를 나타내는 클래스 임을 명시 

 

    • Aspect : 흩어진 관심사를 모듈화 한 것. 주로 부가 기능을 모듈화 함 

@PersistenceContext

: 엔티티 메니저( EntityManager ) 주입

@PersistenceUnit

: 엔티티 메니터 팩토리( EntityManagerFactory ) 주입