<div id="readability-page-1" class="page"><div itemprop="articleBody">
 

 

 

 <img src="https://i.ytimg.com/vi/peEXNN-oob4/maxresdefault.jpg">
<ul>
<li><a href="#annotation">애노테이션 정의하는 방법</a></li>
<li><a href="#java-annotation">자바 표준 애노테이션</a><ul>
<li><a href="#override">@Override</a></li>
<li><a href="#deprecated">@Deprecated</a></li>
<li><a href="#suppresswarnings">@SuppressWarnings</a></li>
<li><a href="#functionalinterface">@FunctionalInterface</a></li>
<li><a href="#safevarargs">@SafeVarargs</a></li>
<li><a href="#native">@Native</a></li>
<li><a href="#target">@Target</a></li>
<li><a href="#retention">@Retention</a></li>
<li><a href="#documented">@Documented</a></li>
<li><a href="#inherited">@Inherited</a></li>
</ul>
</li>
<li><a href="#annotation-processor">애노테이션 프로세서</a></li>
</ul>
 

<h2 id="애노테이션-정의하는-방법"><a href="#애노테이션-정의하는-방법" title="애노테이션 정의하는 방법"></a><a name="annotation"></a>애노테이션 정의하는 방법</h2>Enum과 함께 Java 1.5에 추가된 기능이다.
애노테이션이란 프로그램의 소스코드 안에 다른 프로그램을 위한 정보를 미리 약속된 형식으로 포함시켜주는 역할을한다.
주석처럼 프로그래밍 언어에 영향을 미치지 않으면서 정보를 제공할 수 있는 장점이 있다.
<h3 id="애노테이션-정의"><a href="#애노테이션-정의" title="애노테이션 정의"></a>애노테이션 정의</h3>아래는 흔히 사용하는 <code>@Override</code> 애노테이션이 정의된 코드이다.
<figure><table><tbody><tr><td><pre>1 2 3 </pre></td><td><pre>@Target(ElementType.METHOD) @Retention(RetentionPolicy.SOURCE) public @interface Override { } </pre></td></tr></tbody></table></figure>

애노테이션은 반환타입에 <code>@interface</code>를 입력하면 애노테이션으로 사용할 수 있다.
<code>@Target</code>, <code>@Retention</code>은 애노테이션을 위한 애노테이션이다. 이를 메타 애노테이션이라 한다.
 

<h2 id="애노테이션-사용"><a href="#애노테이션-사용" title="애노테이션 사용"></a>애노테이션 사용</h2>클래스나 메서드 위에 애노테이션을 작성하여 컴파일러에게 알려준다.
<figure><table><tbody><tr><td><pre>1 2 </pre></td><td><pre>@Test public void LiveStudyTest() { } </pre></td></tr></tbody></table></figure>

 

<h2 id="표준-애노테이션"><a href="#표준-애노테이션" title="표준 애노테이션"></a><a name="java-annotations"></a>표준 애노테이션</h2>자바에서 기본적으로 제공하는 애노테이션이다.
<h2 id="Override"><a href="#Override" title="@Override"></a><a name="override"></a>@Override</h2>컴파일러에게 오버라이딩하는 메서드임을 알리는 애노테이션이다.
생략해도 문제는 없지만, <code>@Override</code>를 사용함으로써 오버라이딩이 제대로 적용되었는지를 컴파일러로부터 체크받을수 있기때문에 사용하는것이 좋다.
<h2 id="Deprecated"><a href="#Deprecated" title="@Deprecated"></a><a name="deprecated"></a>@Deprecated</h2>앞으로 사용하지 않은 대상이라고 알리는 애노테이션이다. 
<h2 id="SuppressWarnings"><a href="#SuppressWarnings" title="@SuppressWarnings()"></a><a name="suppresswarnings"></a>@SuppressWarnings()</h2>컴파일러의 경고메세지가 나타나지 않게 해주는 애노테이션이다. 작은 범위에서 사용해야 한다.
<code>@SuppressWarnings()</code> 애노테이션으로 억제할 수 있는 경고 메세지의 종류는 다음과 같다.
<table>
<thead>
<tr>
<th>경고 메세지</th>
<th>설명</th>
</tr>
</thead>
<tbody><tr>
<td>deprecation</td>
<td>@Deprecated 애노테이션이 붙은 대상(필드, 메서드)를 사용해서 발생하는 경고를 억제한다.</td>
</tr>
<tr>
<td>unchecked</td>
<td>제네릭으로 타입 지정을 하지 않았을때 발생하는 경고를 억제한다.</td>
</tr>
<tr>
<td>rawtypes</td>
<td>제네릭을 사용하지 않아서 발생하는 경고를 억제한다.</td>
</tr>
<tr>
<td>varargs</td>
<td>가변인자의 타입이 제네릭 타입일때 발생하는 경고를 억제한다.</td>
</tr>
</tbody></table>
<blockquote>
 가변인자란, 파라미터를 가변적으로 조정할 수 있는 기술을 의미한다. 가변인자를 사용해서 인자로 들어오는 int형 배열의 요소 합을 반환하는 메서드 예제코드이다.
<figure><table><tbody><tr><td><pre>1 2 3 4 5 6 7 </pre></td><td><pre>public int addNumbers(int[] ... numbers){ int result = 0; for(int num : numbers){ result += num; } return result; } </pre></td></tr></tbody></table></figure>
</blockquote>
여러개의 경고 메세지를 억제하고 싶다면, 배열처럼 파라미터에 경고 메세지를 담으면 된다.
<figure><table><tbody><tr><td><pre>1 </pre></td><td><pre>@SuppressWarnings({"deprecation", "unchecked"}) </pre></td></tr></tbody></table></figure>

<h2 id="FunctionalInterface"><a href="#FunctionalInterface" title="@FunctionalInterface"></a><a name="functionalinterface"></a>@FunctionalInterface</h2>함수형 인터페이스라는 것을 알린다. 애노테이션을 사용함으로써 컴파일러가 함수형 인터페이스를 올바르게 선언했는지 체크해준다.
이 애노테이션을 사용하기 위해서는 대상이 되는 추상메서드가 반드시 하나뿐이어야 한다.
<figure><table><tbody><tr><td><pre>1 2 3 4 </pre></td><td><pre>@FuntionalInterface public interfcae Runnable { public abstract void run(); } </pre></td></tr></tbody></table></figure>

<h2 id="SafeVarargs"><a href="#SafeVarargs" title="@SafeVarargs"></a><a name="safevarargs"></a>@SafeVarargs</h2>가변 이자의 타입이 non-reliable 타입일 경우, 해당 메서드를 선언하는 부분과 호출하는 부분에서 unchecked 경고가 발생한다. 이 때 이 코드가 문제가 없다면 이 경고를 억제하기 위해 <code>@SafeVarargs</code>를 사용한다.
<img src="https://user-images.githubusercontent.com/33862991/109913580-9b560300-7cf1-11eb-9301-9c74b8af0164.png">
<h2 id="Native"><a href="#Native" title="@Native"></a><a name="native"></a>@Native</h2>native 메서드에서 참조되는 상수 앞에 붙힌다.
<blockquote>
Native Method란 C, C++같은 네이티브 언어로 작성된 메서드를 말한다. 이런 native 메서드를 호출하는 기술을 JIN(Java Native Interface)라고 한다.
</blockquote>
출처 : <a target="_blank" rel="noopener" href="https://madplay.github.io/post/use-native-methods-judiciously">Kimtaeng - [이펙티브 자바 3판] 아이템 66. 네이티브 메서드는 신중히 사용하라</a>
<hr>

여기부터는 메타 에노테이션 목록이다. 
메타 애노테이션이란, 애노테이션을 위한 애노테이션을 의미한다. 애노테이션의 대상(target)이나 유지기간(retention)을 지정하는데 사용된다.
<h2 id="Target"><a href="#Target" title="@Target"></a><a name="target"></a>@Target</h2>애노테이션이 적용가능한 대상을 지정하는데 사용한다.
<code>@SuppressWarnings</code>를 정의한 코드이다.
<figure><table><tbody><tr><td><pre>1 2 3 4 5 </pre></td><td><pre>@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) @Retention(RetentionPolicy.SOURCE) public @interface SuppressWarnings { String[] value(); } </pre></td></tr></tbody></table></figure>

<h2 id="Retention"><a href="#Retention" title="@Retention"></a><a name="retention"></a>@Retention</h2>애노테이션이 유지되는 기간을 지정할때 사용한다.
<table>
<thead>
<tr>
<th>유지정책</th>
<th>의미</th>
</tr>
</thead>
<tbody><tr>
<td>SOURCE</td>
<td>소스 파일에만 존재, 클래스 파일에는 존재하지 않는다. 컴파일러에서 사용하는 애노테이션의 유지 정책이다.</td>
</tr>
<tr>
<td>CLASS</td>
<td>클래스 파일에 존재, 실행시에 사용불가하다. 기본값이다. 컴파일러가 애노테이션의 정보를 클래스 파일에 저장할 수 있게하지만, 클래스 파일이 JVM에 로딩될때 애노테이션의 정보가 무시되어 실행 시에 애노테이션에 대한 정보를 얻을 수 없다.</td>
</tr>
<tr>
<td>RUNTIME</td>
<td>클래스 파일에 존재, 실행시에 사용가능하다. 실행시에 리플렉션(reflection)을 통해 클래스 파일에 저장된 애노테이션의 정보를 읽어서 처리할 수 있다.</td>
</tr>
</tbody></table>
<figure><table><tbody><tr><td><pre>1 2 3 </pre></td><td><pre>@Target(ElementType.METHOD) @Retention(RetenPolicy.SOURCE) public @interface Override { } </pre></td></tr></tbody></table></figure>

<code>@Override</code>는 소스 파일에만 존재하고, 클래스 파일에는 존재하지 않는다. 클래스 파일이 없다는건 JVM에서 관리하지 않는다는 것으로 이해하고 있다. 이와같은 애노테이션으로는 <code>@SuppressWarnings</code>가 있다.
지역변수에 붙는 애노테이션은 컴파일러만 인식하므로 유지정책이 <code>RUNTIME</code> 이어도 실행시에 유지되지 않는다.
<h2 id="Documented"><a href="#Documented" title="@Documented"></a><a name="documented"></a>@Documented</h2>애노테이션에 대한 정보가 javadoc으로 작성한 문서에 포함되도록 한다. 자바에서 제공하는 기본 애노테이션 중 <code>@Override</code>와 <code>@SuppressWarnings</code>를 제외하고 모두 이 메타 애노테이션이 붙는다.
<figure><table><tbody><tr><td><pre>1 2 3 4 </pre></td><td><pre>@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface FunctionalInterface(){ } </pre></td></tr></tbody></table></figure>

<h2 id="Inherited"><a href="#Inherited" title="@Inherited"></a><a name="inherited"></a>@Inherited</h2>애노테이션이 자손 클래스에 상속되도록 하는 애노테이션이다. 애노테이션에 <code>@inherited</code>를 사용하면, 이를 상속받는 클래스에도 해당 애노테이션이 상속된다.
<code>@Inherited</code>는 클래스나 메서드가 아니라 애노테이션을 정의하는 영역에서 사용하는 애노테이션이다.
<figure><table><tbody><tr><td><pre>1 2 3 4 5 6 7 </pre></td><td><pre>@Inherited @interface SupperAnno { } @SuperAnno class Parent { } class Child extends Parent { } </pre></td></tr></tbody></table></figure>

Child 클래스엔 애노테이션이 없지만, 부모 클래스 Parent의 <code>@SuperAnno</code>가 <code>@Inherited</code>를 메타 애노테이션을 갖으므로 자식 클래스인 Child 클래스에도 <code>@SupperAnno</code>가 상속된다.
 

<h2 id="애노테이션-프로세서"><a href="#애노테이션-프로세서" title="애노테이션 프로세서"></a><a name="annotation-processor"></a>애노테이션 프로세서</h2>애노테이션 프로세싱은 Java 5 에서 추가된 기술로서 컴파일 타임에서 사용자가 정의한 어노테이션의 코드를 분석하고 처리하기 위해 사용되는 훅(Hook)이다.
<a target="_blank" rel="noopener" href="https://projectlombok.org/">Lombok</a>이 이를 활용한 대표적인 라이브러리이다.
애노테이션 프로세싱은 추가적으로 학습이 더 필요할것 같다.
 
 </div></div>

기록하는개발자 | DevAndy

DevAndy

애노테이션 정의하는 방법
자바 표준 애노테이션

Live Study 12주차 - Annotation

댓글