🎽 인프런 워밍업 클럽 0기 백엔드 첫 번째 과제

출처
https://inf.run/XKQg

1. 어노테이션을 사용하는 이유(효과)는 무엇일까?

어노테이션은 클래스, 메소드, 필드 및 매개변수와 같은 코드 요소에 추가할 수 있는 메타 데이터의 형태이며, @ 로 시작하고 그 뒤에 어노테이션 이름이 있다.
어노테이션은 코드에 대한 추가 정보를 제공하며 반복적인 코드를 작성하지 않아도 된다.
또한, 런타임에 코드의 동작에 직접적인 영향을 주지 않으며, 다양한 툴과 프레임워크와의 통합을 개선할 수 있다.

예시로 스프링 어노테이션에 대해 설명하고자 한다.
스프링 어노테이션에는 @Configuration , @Bean, @Component, @Autowired 등의 많은 어노테이션이 있다.

스프링 어노테이션을 사용하면 개발 프로세스를 간소화하고 코드 가독성을 높이며 보일러플레이트 configuration을 줄여주는 이점이 있다.

• 과거에 Spring에서 Bean과 dependencies를 관리하기 위해 xml configuration 파일에 크게 의존했다. 하지만 현재에는 어노테이션을 사용하여 자바 코드에 직접 동일한 configuration을 수행할 수 있으므로 xml 파일의 필요성이 줄어들게 되었고 가독성이 향상되었다.
• @Autowired 와 같은 어노테이션을 사용함에 따라 수동으로 DI 코드를 작성할 필요 없이 Spring이 자동으로 필요한 곳에 DI를 해준다.
• Spring은 특정 동작이나 configuration을 캡슐화하고 애플리케이션의 고유한 요구 사항에 맞게 커스텀 어노테이션을 만들 수 있다.

2. 나만의 어노테이션은 어떻게 만들 수 있을까?

자바에서 커스텀 어노테이션은 클래스, 메소드, 필드와 같은 다양한 프로그램 요소에 적용할 수 있는 사용자 정의 메타데이터 마커이다.

컴파일 타임 또는 런타임에 툴과 프레임워크에 코드에 대한 정보를 제공할 수 있다.
커스텀 어노테이션은 자바의 기본 제공 어노테이션(e.g. @Override, Deprecated, SuppressWarnings )과 유사한 방식으로 작동하지만, 개발자는 특정 요구 사항에 맞게 어노테이션을 정의할 수 있다.

메타 데이터는 구현 세부 사항을 자세히 살펴보지 않고도 코드의 목적, 동작, 제약조건을 이해하는데 도움이 되므로 코드 가독성과 유지 보수성을 개선하고 오류 발생 가능성을 줄여준다.

커스텀 어노테이션은 코드에 메타 데이터를 추가하는데 중요한 역할을 한다.

@Animal(name= "FuBao", birth_date="2020-07-20")
public class Zoo{
}

@Animal 라는 커스텀 어노테이션을 만들어서 Zoo 클래스에 적용하면, 동물 이름과 태어난 날짜에 대한 메타 데이터를 제공한다.

이 코드를 읽은 사람은 정보를 빠르게 수집하여 코드 베이스에 대한 이해를 높일 수 있다.

커스텀 어노테이션 만드는 방법

1. 어노테이션 정의하기

@interface 키워드 뒤에 어노테이션 이름을 적는다.

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyCustomAnnotation {
    String value() default "xxx";
    int count() default 1;
}

@Retention(RetentionPolicy.RUNTIME): 리플렉션을 통해 런타임에 어노테이션을 사용할 수 있도록 보장한다.
@Target(ElementType.METHOD): 해당 커스텀 어노테이션을 메소드에 적용할 수 있도록 지정한다.

2. Elements 및 Attributes 추가

커스텀 어노테이션 내에서 elements와 attributes를 추가할 수 있다.

String value() default "Default Value"; 는 기본값이 “xxx”인 value라는 이름의 어노테이션 멤버와 int count() default 1; 는 기본값이 1인 count라는 이름의 어노테이션 멤버를 정의한 것이다.

3. 커스텀 어노테이션 사용

정의가 완료되면 커스텀 어노테이션을 메소드나 클래스에 사용할 수 있게 된다.

public class MyService {

    @MyCustomAnnotation(value = "book", count = 5)
    public void customMethod() {
        // Method implementation
    }
}

@MyCustomAnnotation 의 value에는 “book”, count에는 5라는 값을 지정하고 해당 어노테이션을 사용하면, 런타임 시점에 어노테이션 정보를 읽을 수 있게 된다.

📚 참고자료
Why use Spring Annotations ?
Custom Spring Annotations, How To And Why?