皆さん、普段は普通にアノテーションを使ってコーディングしているかと思います。
筆者は、アノテーションについて、Java開発初期時は特に重要に考えていませんでした。
ただの、JavaDocに記述するためのキーワードぐらい？程度です。
でも、アノテーションにロジックを組み込めることを知ってから、自作アノテーションは重宝しています。
今回は、アノテーションを自分で作成する方法を紹介していきます。
大規模なシステムとなり開発メンバが増えれば増えるほど、処理の統一の意味であらかじめ準備されているアノテーションではなく、システム固有のアノテーションを作りたくなってきます。
自分でアノテーションを作って、使用する処理のヘッダに組み込んでいく、といった形です。
今回は、自前でアノテーションを作る方法を紹介していきます。
アノテーションとは
アノテーションには、大きく分けて以下の３つがあります。
- 名前だけでデータのないマーカー 例：＠Override、＠Deprecated
- データをひとつ持つ単一アノテーション 例：＠SuppressWarnings
- 複数のデータをもつフルアノテーション
アノテーションは、メソッドのコメントに「@（アットマーク）」を付けることで有効になります。
当然ながら、ここに書いたアノテーションはJavaDocに出力されます。
日本語としては『注釈』です。
『注釈』の説明としては以下になります。
- 語句や文章の意味をわかりやすく解説すること。また、それをした文。 「古典を－する」 「 －を加える」
- 補足的な説明。
そもそもアノテーションを記載する意味ですが、要は、”複数人でプログラムを開発する時に、コーディングのやり方を統一するため”と言ってよいかと思います。
複数人で開発を同時進行する場合、コーディング規約を定めていたとしても、どうしても人によってそれぞれのプログラムが出来上がってしまうことがあります。
その、人による差をゼロにすることはできないですが、なるべく差を小さくしていくための仕組みの一つがアノテーションです。
例えば、「＠Override」。
「＠Override」を付ける意味は、”このメソッドは親メソッドのオーバーライドメソッドだよ。”という『注釈』です。
このアノテーションを付けた場合、親メソッドに同メソッドが存在しない場合はエラーになります。
開発チーム内で、こういったルールを設けていれば、勝手にオーバーライドメソッドを作る確率が減ります。
※あくまで、”確率が減る”だけですが。
代表的なアノテーション
SpringMVCであらかじめ準備されているアノテーションについて紹介しておきます。
代表的なやつ、です。
|
@Autowired
|
自動注入（Dependency Injection）する際に使用する
|
|
@Autowired
|
自動注入（Dependency Injection）する際に使用する
|
|
@Component
|
自動注入（Dependency Injection）して使いたいクラスに付与
|
|
@Service
|
サービスクラスに付与する
|
|
@Transactional
|
トランザクション境界を定義する際に付与
|
|
@RestController
|
ＡＰＩのコントローラに付与
|
|
@Controller
|
ページのコントローラに付与
|
|
@Validated
|
バリデーションを自動的に実施
|
|
@Min
|
最少値チェック
|
|
@Max
|
最大値チェック
|
|
@Size
|
桁数チェック
|
|
@Pattern
|
正規表現チェック
|
アノテーションを自分で作る
それではアノテーションを自分で作ってみましょう。
アノテーションを作るには、以下の３つを準備すればよいです。
アノテーションの定義
「@interface」をつけて、アノテーション定義をおこないます。
ここでは、「anotationAccess」というアノテーションを定義しています。
public class anotationControl {
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface anotationAccess {
}
}
アノテーションのロジック部
アノテーションが実行された際のロジックを記述するクラスを準備します。
ここでは、「anotationLogic」というメソッドを準備しています。
public class anotationLogic {
private anotationLogic() {
}
public void anotationAccessLogic() {
※アノテーションの中身のロジック。ここに書く。
}
}
定義とロジックの紐付け
アノテーションの定義とロジックの紐つけをおこないます。
定義は「servlet-context.xml」におこないます。
ここまで作成した定義とロジックであれば、以下のような紐つけになります。
<aop:config>
<aop:aspect id="ana" ref="anotationAccess">
<aop:pointcut id="anaPointcut" expression="@annotation(jp.co.xxx.anotationLogic)"/>
<aop:before pointcut-ref="racPointcut" method="anotationAccessLogic" />
</aop:aspect>
</aop:config>
「jp.co.xxx.anotationLogic」は、システム独自のパッケージになります。
こうすることで、システム内で自作のアノテーションが使用できるようになります。
アノテーションの使い方は、あらかじめ準備されているアノテーションを使う場合とまったく同じです。
@anotationAccess
public xxx method() {
まとめ
いかがでしたでしょうか？
アノテーションを使ったり、自分で作る際の参考にしてもらえればと思います。
それではまた！
