어노테이션(Annotation) - @Override, @Deprecated, @SuppressWarnings, @Target, @Retention, @Documented, @Inherited, @interface

 

 

안녕하세요🐿️

오늘은 어노테이션에 대해 공부해보겠습니다.

해당 내용은 자바의 신 chapter 17을 기반으로 정리한 것입니다 :)

 

어노테이션이란?

---

어노테이션은 클래스나 메소드 등의 선언시에 @를 사용하는 것을 말합니다. 어노테이션은 영어로 Annotation이며, 메타데이터(Metadata)라고 불리기도 합니다. 어노테이션은 JDK5부터 등장했습니다 :)

 

어노테이션은 다음과 같은 경우에 사용합니다.

- 컴파일러에게 어떤 정보를 알려주는 경우
- 컴파일할 때 설치(deployment) 시의 작업을 지정하는 경우
- 실행할 때 별도의 처리가 필요한 경우

 

어노테이션은 왜 나왔는가?

---

기존의 자바 웹 애플리케이션에서는 구성과 설정값을 XML 설정 파일을 통해 명시하고 관리하였습니다. 이는 변경될 수 있는 데이터들을 코드가 아닌 외부 파일로 분리함으로써 컴파일 없이 변경사항을 적용하기 위함이었는데, 이런 방법이 프로그램 작성 때마다 많은 설정을 작성해야 하는 불편함을 낳게 되었습니다. 웹 애플리케이션이 커짐에 따라 이는 더 극대화되었고 결국 이를 해결하기 위한 방법이 필요하게 되었습니다. 그리고 그 방법으로 나온 것이 바로 어노테이션이라고 합니다.

어노테이션을 사용하게 될 경우 데이터에 대한 유효성 검사 조건을 보다 쉽게 파악할 수 있고, 코드가 깔끔해지게 됩니다. 또한 어노테이션과 리플랙션을 같이 이용하면 원하는 클래스를 주입하는 것도 가능해진다.

[출처] 온라인 자바 스터디#12- 어노테이션(@retention, @target, @documented, 어노테이션 프로세서)

 

 

미리 정해져 있는 3개의 어노테이션

---

자바 언어에는 사용하기 위해서 정해져 있는 3가지 어노테이션이 있습니다. (JDK6까지)

- @Override
- @Deprecated
- @SuppressWarnings

 

@Override

해당 메소드가 부모 클래스에 있는 메소드를 Override했다는 것을 명시적으로 선언합니다. 자식 클래스에 여러 메소드가 있을 때, 어떤 메소드가 Override 되었는지 쉽게 알 수 없을 수도 있고, 제대로 메소드를 Override 했다고 생각했는데, 매개 변수가 하나 빠졌을 수도 있습니다. 따라서 명확하게 "이 메소드는 Override 된 거니까 만약에 내가 잘못 코딩했으면 컴파일러 니가 알려줘야 해~~" 라고 지정해 주는 것이라고 생각하면 됩니다.

 

 

@Deprecated

package c.annotation;

public class AnnotationDeprecated {
   @Deprecated
    public void noMoreUse() {
    }
}

 

미리 만들어져 있는 클래스나 메소드가 더 이상 사용되지 않는 경우가 있습니다. 그런 것을 deprecated라고 하는데, 컴파일러에게 "얘는 더 이상 사용하지 않으니까 그렇게 알아줘. 그리고 나중에 누가 이거 쓰면 경고 한 번 해주고..."라고 일러 주는 것이라고 생각하면 됩니다.

 

"그냥 지워버리지 왜 이렇게 Deprecated라고 표시를 해야 하는거지?" 라고 생각 할 수도 있습니다. 그런데, 만약 여러분들이 다른 사람들과 같이 개발하고 있는데, 어떤 클래스나 메소드를 불필요하다고 생각해서 지워버리면 어떻게 될까요? 만약 지워버린 메소드나 클래스를 참조하고 있는 부분이 있는데, 그 개발자가 이러한 변경사항을 모르고 있다면, 컴파일할 때 에러가 발생할 것입니다. 그러므로, 하위 호환성을 위해서 Deprecated로 선언하는 것은 꼭 필요하며, 가장 좋은 방법으로는 계도 기간을 거쳐 알림을 준 후에 지우는 것이 바람직하겠습니다.

 

 

@SuppressWarnings

간혹 코딩을 하다 보면 컴파일러에서 경고(Warning)를 알리는 경우가 있습니다. 프로그램에는 문제가 없는데, 내가 잘 알아서 하는데 이러한 경고가 나타나면 웬지 마음이 불편하기도 합니다. 그럴 때 컴파일러에게 "얘는 일부러 이렇게 코딩한 거니까 니가 경고를 해 줄 필요가 없어"라고 이야기 해주는 것입니다.

 

이 어노테이션은 다른 어노테이션과 다르게 소괄호 속에 문자열을 넘겨줍니다.

 

package c.annotation;
public class AnnotationSample {
   @SuppressWarnings("deprecation")
    public void useDeprecated() {
    	AnnotationDeprecated child = new AnnotationDeprecated();
        child.noMoreUse();
    }
}

 

예를 들어, @SuppressWarnings("deprecation") 이렇게 선언할 수 있습니다. 원래는 deprecated에 대한 경고가 떠야 하지만, 이런식으로 선언하고 나면, 컴파일을 해도 아무런 메세지가 나타나지 않습니다. 하지만, 이 어노테이션을 너무 남용할 경우에는 Deprecated된 메소드를 사용해도 모르고 넘어갈 수도 있으니 유의하기바랍니다. 

 

 

 

어노테이션을 선언하기 위한 메타 어노테이션

---

메타 어노테이션(Meta Annotation)이라는 것은 어노테이션을 직접 선언할 때 사용합니다. 메타 어노테이션은 다음과 같이 4개가 존재합니다. 어노테이션을 선얼할 때 꼭 이 4개를 모두 사용해야하는 것은 아닙니다.

- @Target
- @Retention
- @Documented
- @Inherited

 

@Target

어노테이션을 어떤 것에 적용할지를 선언할 때 사용합니다. 적용 방법은 다음과 같습니다.

@Target(ElementType.METHOD)

 

이처럼 @Target() 괄호 안에 적용 대상을 지정하는데, 그 대상 목록은 다음과 같습니다.

요소 타입	대상
CONSTRUCTOR	생성자 선언시
FIELD	enum 상수를 포함한 필드(field) 값 선언시
LOCAL_VARIABLE	지역 변수 선언 시
METHOD	메소드 선언시
PACKAGE	패키지 선언시
PARAMETER	매개 변수 선언시
TYPE	클래스, 인터페이스, enum 등 선언시

 

@Retention

얼마나 오래 어노테이션 정보가 유지되는지를 다음과 같이 선언합니다.

@Retention(RetentionPolicy.RUNTIME)

@Target처럼 괄호 안에 지정하는 적용 가능한 대상은 다음과 같습니다.

	대상
SOURCE	어노테이션 정보가 컴파일시 사라짐
CLASS	클래스 파일에 있는 어노테이션 정보가 컴파일러에 의해서 참조 가능함. 하지만, 가상 머신(Virtual Machine)에서는 사라짐
RUNTIME	실행시 어노테이션 정보가 가상 머신에 의해서 참조 가능

 

@Documented

해당 "어노테이션에 대한 정보가 Javadocs(API) 문서에 포함된다는 것"을 선언합니다.

 

@Inherited

모든 자식 클래스에서 부모 클래스의 어노테이션을 사용 가능하다는 것을 선언합니다.

 

@interface

어노테이션을 선언할 때 사용합니다. 예를 들어, 클래스를 public @interface UserAnnotation {} 이런식으로 선언하면, @UserAnnotation 으로 어노테이션이 사용 가능해집니다.

 

추가로, 어노테이션은 상속이 되지 않습니다. 또한 롬복(lombok)이라는 것이 있는데, https://projectlombok.org/ 가 홈페이지며, 개발자가 필요한 작업을 어노테이션 선언만으로도 편하게 처리할 수 있도록 도와줍니다. 나중에 필요할 때 확인해보시면 좋겠습니다.

 

 

마무리

---

사실상 어노테이션을 개발자가 직접 선언하여 개발할 일은 거의 없습니다. 하지만, 이미 만들어져 있는 어노테이션을 사용하는 방법은 알고 있어야겠습니다. 오늘은 어노테이션 전부를 공부한 것은 아니지만, 꼭 알고 있어야하는 것들을 위주로 살펴보았습니다. 

 

최근에 만들어진 많은 자바 기반의 프레임웍들은 어노테이션을 사용하여 코드의 양을 매우 많이 줄이고, 단순 반복적인 작업도 줄이는 데 도움을 줍니다. 하지만, 단순하게 어노테이션을 사용하는 방법만 알면 실력이 늘지 않습니다. 어노테이션을 지정하면 코드가 내부적으로 어떻게 변환되는지에 대해서 살펴보는 습관을 가지는 것이 좋습니다.

 

 

감사합니다 :)