導入
Java開発において、同じアノテーションを一つのクラスやメソッドに複数付けたいと思ったことはありませんか？通常、アノテーションは原則として「1箇所につき1つ」ですが、Java 8から導入された @Repeatable を使用することで、同じアノテーションを複数回記述できるようになります。これにより、設定の重複や冗長なラッパーアノテーションを排除し、コードの可読性を劇的に向上させることができます。
基礎知識
@Repeatableを理解するには、以下の3つの要素が重要です。
1. コンテナアノテーション: 繰り返し適用するアノテーションを格納するための「入れ物」となるアノテーションです。
2. @Retention: アノテーションが保持される期間を指定します。リフレクションで読み取る場合は RetentionPolicy.RUNTIME が必須です。
3. @Target: アノテーションを付与できる場所（クラス、メソッドなど）を制限します。
実装/解決策
@Repeatableを利用するには、まず「個々のアノテーション」と「それを保持するコンテナアノテーション」の2つを定義する必要があります。手順は以下の通りです。
1. 繰り返し用のアノテーションに @Repeatable(コンテナ名.class) を付与する。
2. コンテナアノテーションの値を、繰り返し用アノテーションの配列型（value()）として定義する。
3. リフレクションで取得する際は、コンテナアノテーションを介して取得するか、直接繰り返し用アノテーションを問い合わせるメソッドを使用する。
サンプルプログラム
import java.lang.annotation.;
import java.util.Arrays;
// 1. 繰り返し用アノテーションの定義
@Repeatable(Tags.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tag {
String value();
}
// 2. コンテナアノテーションの定義
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tags {
Tag[] value(); // 繰り返し用アノテーションの配列を持つ必要がある
}
// 3. 実際に使用する例
@Tag(“エンジニア”)
@Tag(“Java”)
@Tag(“ブログ”)
public class RepeatableSample {
public static void main(String[] args) {
// リフレクションで取得
Class
Tag[] tags = clazz.getAnnotationsByType(Tag.class);
// 取得したアノテーションを表示
System.out.println(“付与されたタグ一覧:”);
Arrays.stream(tags).forEach(t -> System.out.println(“- ” + t.value()));
}
}
応用・注意点
現場で活用する際のポイントを2点挙げます。
1. リフレクションの取得メソッド: getAnnotationsByType(Class) を使用してください。従来の getAnnotation(Class) を使ってしまうと、コンテナアノテーション自体しか取得できず、個別の値を取り出すのが非常に面倒になります。このメソッドを使えば、Javaが自動的にコンテナを展開して配列で返してくれます。
2. 設計のバランス: @Repeatable は便利ですが、乱用すると「結局どこに何が設定されているのか」を追うのが難しくなる場合があります。フレームワークの設定ファイルなどを代替する目的以外での多用は控え、構成管理の複雑さを考慮して導入を検討しましょう。
コメント