Java

【リフレクションとアノテーション】プログラムにメタ情報を付加する

アノテーションとは?

アノテーションとはクラスやインタフェース、メソッドやフィールド、パッケージなどに対してメタデータとして付加情報を記入する機能のことだよ

アノテーションの分類

・マーカーアノテーション

名前だけでデータのないアノテーション(@Overrride, @Deprecated)

・単一アノテーション

データを一つ持つアノテーション(@SupperessWarning)

・フルアノテーション

複数のデータを持つアノテーション

・メタアノテーション

定義しているアノテーションにのみつけられるアノテーション(@Target, @Retention)

付加情報の付け方

コメントを使う場合

アノテーション使う場合

アノテーションの定義方法・使い方

アノテーションの定義方法

・ “@Retantionアノテーション名”で有効範囲を設定する
→”@Retention(RetentionPolicy.RUNTIME)“のように設定する

RetentionPolicy名 説明
RetentionPolicy.CLASS アノテーション情報はコンパイル時に保存されるが実行時にはVMによって保持されない。
RetentionPolicy.RUNTIME アノテーション情報はコンパイル時に保存され、実行時にもVMによって保持される。
RetentionPolicy.SOURCE アノテーション情報はコンパイル時に破棄される。ソースコード内のみで有効。

・ “@Targetアノテーション名”でメソッド・フィールドを限定する
→”@Target (ElementType.TYPE)“のように設定する

ElementType名 説明
ElementType.ANNOTATION_TYPE アノテーション型に指定できることを示す。
ElementType.CONSTRUCTOR コンストラクタに指定できることを示す。
ElementType.LOCAL_VARIABLE ローカル変数に指定できることを示す。
ElementType.FIELD フィールドに指定できることを示す。
ElementType.METHOD メソッドに指定できることを示す。
ElementType.PACKAGE パッケージに指定できることを示す。
ElementType.PARAMETER メソッド引数に指定できることを示す。
ElementType.TYPE クラス、またはインタフェース(アノテーション型を含む)、列挙型に指定できることを示す

・ “@interfaceアノテーション名”でアノテーションを定義する
→各キーには、”default”キーワードでデフォルト値を設定する
値の指定は、”@アノテーション名(キー名=値)”という形で行う
デフォルト値が指定されている場合、値の指定は省略できる
単一アノテーションで値のキー名が”value”の場合のみ、キー名を省略できる

 

アノテーションの種類

・@Override
記述するメソッドが親クラスのメソッドをオーバーライドしていることを明示する

・@Deprecated
記述するメソッドの仕様が非推奨であることを明示する

・@SuppressWarning
引数にメッセージを指定することで、記述するメソッドによる警告を非表示にすることができます。

 

・@Target
独自に定義したアノテーションが何を対象としているか宣言するために使われます。

 

・@Retention
コンパイル時やプログラム実行時にアノテーションの情報を保持するかどうか決めるために使われる

 

・@Test
そのメソッドがテストメソッドであることを示す。このメソッドにテストを記述する。従来のJUnitでメソッド名がtestで始まるメソッドと同じ。

・@Before
このアノテーションが付加されたメソッドは、@Testアノテーションが付いたメソッドを実行するたびに事前に実行されることを意味する。JUnit4以前のsetup()メソッドと同じ。

・@After
このアノテーションが付加されたメソッドは、@Testアノテーションが付いたメソッドを実行するたびに、必ず後から実行されることを意味する。JUnit4以前のtearDown()メソッドと同じ。

・@BeforeClass
このアノテーションが付加されたメソッドは、そのテストクラスを呼び出す前に実行される。

・@AfterClass
このアノテーションが付加されたメソッドは、そのテストクラスを呼び出した後に実行される。

・@author
作成者の名前を記述

・@param
引数と引数の説明を記述

・@return
戻り値の説明を記述

・@version
クラスやメソッドなどのバージョンを記述

・@see
他の関連するクラスやメソッドなどの参照先を記述

1 2