Lombokのカスタムアノテーションを作ろうとして諦めたメモ

Lombokのカスタムアノテーションを作ろうとして諦めたメモです。

3行でまとめ:

1. Lombokのアノテーション実装ではJava内部クラス(コンパイラ関連)を参照する。
2. Java9 以降、Java内部クラスの参照方法がビルドシステムやIDEで大きく変わり、難易度がめちゃくちゃ高くなった。
3. アノテーションを集約するメタアノテーション的なのもLombokでは未対応なので、打つ手なし、ギブアップ。

作ろうとした経緯:

1. @Value 大好きなんだけど、Eclipse上からlombokが作成したgetterの利用箇所を Ctrl + Shift + F で逆引きできない。というかしづらい。
   • ソースコード上にはgetterは無いので当然といえば当然。
   • 一応、Outlineビューで表示すれば getter も見えるので、その getter を右クリックして "References" メニュー選べば参照箇所逆引きできるけど、まぁめんどいっちゃめんどい。
   • 参考: https://stackoverflow.com/questions/42644923/eclipse-with-lombok-search-for-getter-and-setter-usages
2. そもそも Immutable なデータ構造体として @ToString @EqualsAndHashCode @AllArgsConstructor をまとめて付けたいがための @Value で、個人的な好みとして getter 要らない。データ構造としてのフィールドは public final でえーやろ、という割り切り。
3. よし、カスタムアノテーション作ってみるか・・・ な～に、@Value のソースパクって、@Getter 機能呼び出してるところ削ればおしまいじゃろ。

ということで、まずは Lombok でカスタムアノテーション作るイロハをググった：

• java - Create custom annotation for Lombok - Stack Overflow
  • https://stackoverflow.com/questions/41243018/create-custom-annotation-for-lombok
• Implementing a Custom Lombok Annotation | Baeldung
  • https://www.baeldung.com/lombok-custom-annotation

うん、予想はしてたけど Java のバイトコードのガチ操作でめんどくさそうだし難易度も高い。止めようかな・・・。
いやいや、そもそも作りたいのは @Value - @Getter なのだから、@Value のソースコードはどうなってる？

• アノテーション
  • https://github.com/rzwitserloot/lombok/blob/v1.18.12/src/core/lombok/Value.java
• 実装本体
  • https://github.com/rzwitserloot/lombok/blob/v1.18.12/src/core/lombok/javac/handlers/HandleValue.java
  • handleFlagUsage(...) はぱっとみた感じ、設定ファイルから読み込んで @Value 使ってOK/NGあたりをチェックしてるっぽいので、カスタムアノテーションとしてコピペする分には不要。
  • deleteAnnotationIfNeccessary(...) 関連も experimental 時代の互換性対応ぽいので、これもカスタムアノテーションとしてコピペする分には不要。
  • あとは以下のように他の handler の組み合わせを順に呼んでるだけなので、これコピペして handleGetter の呼び出しだけ削ればOKそう。

handleFieldDefaults.generateFieldDefaultsForType(typeNode, annotationNode, AccessLevel.PRIVATE, true, true);
handleConstructor.generateAllArgsConstructor(typeNode, AccessLevel.PUBLIC, staticConstructorName, SkipIfConstructorExists.YES, annotationNode);
handleConstructor.generateExtraNoArgsConstructor(typeNode, annotationNode);
handleGetter.generateGetterForType(typeNode, annotationNode, AccessLevel.PUBLIC, true, List.<JCAnnotation>nil());
handleEqualsAndHashCode.generateEqualsAndHashCodeForType(typeNode, annotationNode);
handleToString.generateToStringForType(typeNode, annotationNode);

ここまででコピペ自体は行けそうだが、ふと「あれ・・・そういえば com.sun.tools 系使ってるよな・・・。この辺、java9のmodule導入の影響ガチで受けてるとこだし、どうすりゃいいんだ・・・」と途方に暮れる。

とりあえず java8 時代までの com.sun.tools を maven で扱うときの記事をググった。

• Java/Maven3/tools.jarを使う時のトラブルシュート(<scope>=system, <systemPath>) - Glamenv-Septzen.net
  • https://www.glamenv-septzen.net/view/1084
• java - Missing artifact com.sun:tools:jar - Stack Overflow
  • https://stackoverflow.com/questions/8375423/missing-artifact-com-suntoolsjar

そうそう、こんな感じでした。では java9 でどうなったかちょっとぐぐってみると・・・

• Accessing com.sun.tools.javac.util from Java 9 - Stack Overflow
  • https://stackoverflow.com/questions/46773519/accessing-com-sun-tools-javac-util-from-java-9
• Java Platform, Standard Edition Oracle JDK 9移行ガイド, リリース9
  • https://docs.oracle.com/javase/jp/9/migrate/toc.htm
• Declare maven dependency on tools.jar to work on JDK 9 - Stack Overflow
  • https://stackoverflow.com/questions/35240134/declare-maven-dependency-on-tools-jar-to-work-on-jdk-9
• java - Build error: missing artifact com.sun:tools:jar:1.6 - Stack Overflow
  • https://stackoverflow.com/questions/8694303/build-error-missing-artifact-com-suntoolsjar1-6

めっちゃ雲行き怪しい。というかすでに阿鼻叫喚。ヤバい。
これに Eclipse 側の対応も・・・と軽くぐぐってみると、若干内容は異なるものの、いずれもJava内部クラスへのアクセスで苦労されてる様子：

• Java - 制限されているクラスのアクセスについて｜teratail
  • https://teratail.com/questions/71393
• Java - eclipseでアクセス制限エラーが発生する｜teratail
  • https://teratail.com/questions/590

これはまずい。maven/pom.xml の調整がまずヤバそうだし、それとEclipse側の組み合わせも複雑さを跳ね上げてる。

そもそも、（今回の調査で初めて知った）サードパーティ製のLombokカスタムアノテーションを集めた https://github.com/peichhorn/lombok-pg も、そしてLombok 本体もビルドは Ant を使ってる様子。Eclipse IDE用にも結構調整入ってる雰囲気。(IDEに組み込むものなのか、IDEで開発するときのためのものかまでは不明だけどどちらにしても結構面倒くさそう)

• https://github.com/rzwitserloot/lombok/
• https://github.com/peichhorn/lombok-pg

トドメに、Java9 以降でLombokメンテすることの大変さが忍ばれる記事発見。

• Lombok の Java9以降対応の話 - Qiita
  • https://qiita.com/tmurakam99/items/b5ffe7f18bc06577f619

うーん、カスタムアノテーションがだめだったら、既存のアノテーションを集約するメタアノテーション的なのは作れないかな？とググってみたが・・・

• java - Is it possible to use Lombok annotations as a meta-annotation? - Stack Overflow
  • https://stackoverflow.com/questions/33512957/is-it-possible-to-use-lombok-annotations-as-a-meta-annotation
• Allow usage of annotations as meta-annotations · Issue #557 · rzwitserloot/lombok · GitHub
  • https://github.com/rzwitserloot/lombok/issues/557
• Feature Request: Allow multiple lombok's annotations to be aggregated into one · Issue #1226 · rzwitserloot/lombok · GitHub
  • https://github.com/rzwitserloot/lombok/issues/1226

どうやら難しそうで未対応とのこと。

以上を考えるに、そもそもやりたいのは以下のアノテーションを付けるのを簡単にしたいだけ・・・にも関わらず、実現するためのコストが異常に高い。

@AllArgsConstructor
@EqualsAndHashCode
@ToString
(場合によっては @With )

よって、今回はカスタムアノテーションを作成するのは一旦あきらめ、無難に必要なものだけコピペしてくことにする。