アプリ開発ときどきアウトドアアウトドアWebツール自己紹介お問合せアプリ開発ときどきアウトドア主にJavaを使ったアプリ開発やトラブルシューティング等のノウハウ、キャンプや登山の紹介や体験談など。2020年1月23日mybatis-generatorを使うことで、各テーブルを操作するためのクラス群を容易に準備することができます。mybatis-generatorが提供する機能では、システム開発で求められる要件を満たせない場合があります。このような状況に対応できるよう、ここではmybatis-generatorプラグインの実装方法について説明します。概要mybatis-generatorが生成するクラスやファイルを要件に応じてカスタマイズ方法として、mybatis-generatorクラスを継承する方法と、プラグインを作成する方法があります。ここでは、プラグインを使って成果物をカスタマイズする方法を説明します。mybatis-generator自体の使い方については、公式サイトやその他参考サイトをご覧ください。ここで説明するサンプルのプロジェクトはこちらで公開しています。使用しているmybatis-generatorのバージョンは1.4.0です。(4.8.0)で行っています。mariadb5.6です。以降では、mybatis-generatorを「MBG」と表記します。mybatis-generatorの設定ファイルであるgeneratorConfig.xmlのことを「設定ファイル」と表記します。MBGの成果物mybatisではDB操作を行うためのクラス・ファイルとして、Javaクライアント、モデル、SQLマップ(XML)を使用できます。動的SQLの使用、Kotlin環境等の実行環境によって、使用されるクラス・ファイルが変わってきます。MBGでは、いくつかの実行環境に向けたクラス・ファイル(以後、成果物と表記)を生成することができます。サポートする実行環境とその環境に合わせた成果物の詳細については公式サイトをご覧ください。(どの環境向けの成果物を生成するかは、設定ファイルのcontext要素のtargetRuntime属性で指定します。Javaのプログラムからmybatisを操作するためのクライアントクラス/インターフェイスであり、insert/update等のテーブル操作を行うためのメソッドを含んでいます。プログラマは、このクラス/インターフェイスを使って、DB操作を行うことになります。具体的な成果物例として、マッパーインターフェイスがあります。テーブル検索時の条件や検索結果のデータを格納するクラスであり、JavaクライアントやSQLマップで使用します。指定されている実行環境に応じて、PrimaryKey、Record、RecordWithBlob、Exampleクラスが作成されます。Javaクライアントに定義されたinsertメソッド等に対応するSQL文がXMLで定義されたファイルです。指定されている実行環境によっては作成されません。MBGの拡張方法MBGの拡張方法として、MBGの主要クラスを継承した独自クラスを作成する方法、MBGの成果物作成処理の過程の処理を修正するためのプラグインクラスを作成する方法があります。ほとんどの場合はプラグインクラスを作成する方法で十分であるため、本稿ではプラグインを使ったカスタマイズ方法について説明します。前者の継承を使う場合、MBGでは次のクラスを継承できる仕組みになっています。詳細は公式サイトの説明をご覧ください。FreeMakerやVelocityを使って成果物の内容を大きく変更する場合は良いが、基本的にはこのクラスを拡張するべきではない。このクラスを拡張する場合、設定ファイルのcontext要素のtargetRuntime属性値に拡張したクラス名を指定する。MyBatis3等の既定値を指定するが、独自クラスを使う場合はクラス名を指定する。カラムに関するDBのメタ情報を格納するクラスである。このクラスを拡張する場合は、設定ファイルのcontext要素のintrospectedColumnImpl属性値に拡張したクラス名を指定する。DB構造を解析する際にDBの型(JDBC型)からJava型に変換するためのクラスであり、独自の型変換を実装したい場合はこのクラスを拡張する。このクラスを拡張する場合、設定ファイルのjavaTypeResolver要素で拡張したクラス名を指定する。プロジェクト/パッケージ情報に基づいたディレクトリの決定や、成果物出力時に既存ファイルが存在した場合のマージ方法等を決定するためのコールバッククラスである。MBG実行時の進捗を報告するためのコールバッククラスである。MBGをAntやIDEに統合する場合に使用できる。(参考)Introspectedという言葉が頻出します。翻訳すると「内省」とかが出てきますが、どうも直感的に「これだ!」という説明がありません。Bean.”という説明がありました。これを参考として、”Introspection”とは「対象の構造を分析するプロセス」と理解しました。ここではreflectionとintrospectionの違いが記載されています。introspectionを行うためにreflectionを使用する、という関係性のようです。プラグインによるカスタマイズ方法MBGがクラス、メソッド、XML等の成果物を生成したタイミングで、プラグインの所定のメソッドを実行する仕組みになっています。Javaクライアントやモデルのクラスやメソッドが生成された際に実行されるプラグインのメソッドを実装することで、成果物を期待通りに変更することができます。公式サイトでは、いくつかのプラグインが公開されているので、これらのプラグインで要件を満たせるか検討してください。これらのプラグインで要件を満たせない場合、独自にプラグインを実装する必要があります。Lifecycle)をご覧ください。公式サイトでは、メソッドの説明が乏しく、私には理解が難しかったです。そのため、独自に纏めたメソッドの説明を本稿の最後に記載しましたので、参考になれば幸いです。プラグインのメソッドの実行順番をトレースしたい場合、こちらのサンプルをご覧ください。このプラグインを使用することで、プラグインのメソッドの呼び出し順番がログに出力されます。プラグイン実装のイメージ自分がカスタマイズしたい成果物が生成される際に呼び出されるメソッドを特定し、そのメソッドを実装します。MBGは成果物を作成した後に、その成果物を引数としてプラグインの該当メソッドを呼び出します。開発者はメソッドの中で、引数の成果物オブジェクトを操作して、成果物をカスタマイズします。成果物の作成自体を中止する場合は、メソッドの戻り値としてfalseを指定します。モデルクラスのgetterメソッドの出力をカスタマイズする場合、プラグインのmodelGetterMethodGenerated()メソッドを実装します。引数として、getterメソッドの情報(Methodオブジェクト)が渡されるので、このオブジェクトのメソッドやプロパティを使用して成果物の内容を変更します。true;}MBGがプラグインのメソッドを実行する際に引き渡される主要な引数は次の通りです。成果物として作成予定のJavaクラスを表している。クラスコメント/import文一覧/クラス名/基底クラス等の情報を保持し、これらの変更を行うためのメソッドを提供する。import文を追加するためのaddImportedType()がよく使用される。成果物として作成予定のJavaインターフェイスを表している。TopLevelClassと同様の機能を提供する。成果物として作成予定のメソッドを表している。メソッド名や引数の変更、アノテーションの追加等が可能。成果物として作成予定のモデルクラスのフィールド(getter/setterに対応する変数宣言)を表している。MBGが解析したDBのテーブルやカラムを表している。DB上のテーブルやカラムの解析結果の他に、成果物を生成するための各種条件を格納する。成果物のカスタマイズを行うために条件の取得元としてよく使用する。高度なカスタマイズを行う場合、このクラスに対する変更操作が必要な場面がある。プラグインの実装の流れプラグインがMBGによって実行される流れは、プラグインクラスのインスタンスの生成、プラグイン初期化メソッドの実行、処理対象となるテーブル単位で成果物作成メソッドの実行、後処理メソッドの実行の流れになります。(一度プラグインインスタンスが作成されると、MBG終了までそのインスタンスが使いまわされます。)そのため、基本的な実装の流れとしては、プラグイン初期化のためのメソッドを実装し、カスタイマイズしたい成果物が生成されたタイミングで実行される成果物作成メソッドを実装します。MBGが作成する成果物とは別に、JavaクラスやXMLを追加したい場合は後処理メソッドを実装します。設定ファイルで指定している実行環境の定義によって作成される成果物が変わるために、期待するメソッドが呼び出されない場合があります。設定ファイルにてプラグインに与えられたプロパティの取得処理をsetProperties()に実装します。プラグインを実行するために必要条件の検証処理をvalidate()に実装します。このメソッドの実装は必須です。setContext()は使用頻度は低いと考えているため、ここでは記載していません。Client)の定義を変更したい場合、clientXXX系のメソッドを実装します。RecordやExample等のデータを格納するためのモデルクラスの定義を変更したい場合、modelXXX系のメソッドを実装します。INSERT/UPDATE等のSQL文等を格納するSQLマップファイル(XML)の定義を変更したい場合、sqlMapXXX系メソッドを実装します。テーブルに関連する独自クラスやXMLファイルを追加したい場合、contextGenerateAdditionalXXXFiles(IntrospectedTable)メソッドを実装します。後処理メソッドの実装テーブルに関わらず固定でJavaやXMLのファイルを追加したい場合、contextGenerateAdditionalXXXFiles()を実装します。プラグインの実装詳細ExamplePluginというサンプルのプラグインをベースに説明します。完全なソースコードはこちらで公開しています。準備プラグインの開発ではMBGのAPIを使用するので、プロジェクトにMBGライブラリを追加する必要があります。mavenの場合、次のように依存関係を追加します。...<dependencies>...<dependency><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-core</artifactId><version>1.4.0</version></dependency>...</dependencies>...クラスの定義MBGのプラグインとして動作するためにはPluginインターフェイスを実装する必要があります。PluginインターフェイスにはMBGから呼び出される全てのメソッドの定義がされています。このクラスを実装する場合、使用するメソッドは少数であるにもかかわらず、全てのメソッドの実装が必要になり大変です。この手間を減らすために、基本的には次のようにPluginAdapterを継承してプラグインクラスを開発します。(こうすることで、必要なメソッドのみの実装になります。setProperties()を実装します。プラグイン実行の前提条件を検証するためのvalidate()メソッドは必ず実装する必要があります。メッセージがない場合は正常と見なす。0;}...設定ファイルのプラグイン定義で指定されたプロパティがsetProperties()メソッド渡されるので、必要に応じてクラス内に保持します。/></plugin>...取得したプロパティ値の検証等のプラグイン実行に必要な条件をvalidate()メソッドに実装(必須)します。validate()でfalseを返却するとプラグインが無効になり、それ以降のプラグインの処理は実行されません。引数のwarningsに追加したメッセージは、MBG実行時のログにWARNINGで出力されます。generatorConfig.xmlの定義情報の参照や変更を行いたい場合、setContext()メソッドを実装することもできます。setProperties()の引数で渡されるContextやProperitesを保持するだけなら、PluginAdapterのメソッドで実装されているので、あえてこれらのメソッドを実装する必要はありません。成果物作成のカスタマイズテーブル単位でJavaクライアント、モデル、SQLマップが作成されます。これらの作成をカスタマイズする方法を説明します。テーブルに対応する成果物全般initialized()メソッドを実装することで、テーブル毎に作成されるJavaクライアント、モデル、SQLマップをカスタマイズできます。次の例では、clientXXX()、modelXXX()、sqlMapXXX()で作成される各クラスやXMLから、特定カラムを除外しています。(モデルやXMLからtest_dummy_col1の存在が消される。sqlMap()メソッドの引数として利用されます。そのため、このオブジェクトを変更することで、後続処理の動作を制御できます。IntrospectedTableでも変更できるものとそうでないものがあることに注意してください。getBaseColumns()で取得されるリストはIntrospectedTable内で保持するインスタンスなので、このリストに対する操作はIntrospectedTableに反映されます。getAllColumns()で取得されたリストはIntrospectedTable内部で保持するリストではなく複製されたリストであるため、このリストに対する操作はIntrospectedTableに反映されません。詳細はIntrospectedTableのソースコードを見た方が安全です。JavaクライアントclientXXX()メソッドを実装することで、生成されるJavaクライアントをカスタマイズできます。次の例では、JavaクライアントのselectByPrimary()メソッドを生成する際、このメソッドを複製した新しいメソッドを作成し、作成対象メソッドに追加しています。併せてアノテーションを追加しています。true;}モデルmodelXXX()を実装することで、生成するモデルをカスタマイズできます。次の例では、特定カラムに対応するフィールドにアノテーションを追加しています。true;}対象となるカラムかどうかの判定方法として、Field#getName()を使う方法もあります。“TestDummyCol2′′等のように変わってくるので、可能な限りIntrospectedColumn#getActualColumnName()等のIntrospected系のオブジェクトを使うように統一することをお薦めします。SQLマップsqlMapXXX()メソッドを実装することで、生成されるSQLマップ(XML)をカスタマイズできます。次の例は、SQLマップXMLのinsert要素(id=”insert”)にあるINSERT文のパラメータに関数を挿入しています。modelXXX()ではメソッドやプロパティ操作で出力内容をカスタマイズできましたが、ここでは文字列操作が基本となります。XMLに出力される内容はTextElementクラスのリスト(便宜上「要素リスト」と表記)で表現されており、XML上の1行がTextElementインスタンス1つに対応します。引数のXmlElementから、この要素リストを取得し、XML1行単位の文字列を取得します。要素リストにはTextElement以外(MBGで動的SQLを生成するための条件を格納したXmlElement)が含まれる場合があるので注意が必要です。出力を変更する場合は、TextElementインスタンスを生成して要素リストを変更します。参考ですが、引数のXmlElementはorg.mybatis.generator.codegen.mybatis3.xmlmapper.XMLMapperGeneratorで定義されているジェネレータ(クラス)で生成されおり、例えばInsert文を生成する場合は、InsertElementGeneratorクラスを使うよう定義されています。XMLElementを作り直す場合は、これらのジェネレータのコードが参考になると思います。この例で生成されたSQLマップファイルは次のようになります。</insert>...プラグイン後処理MBGの成果物とは別に、独自のクラスやXMLファイルを追加することもできます。次の例では、Javaクライアントのフォルダに独自のJavaクラスを追加しています。これはサンプルで動的に追加したクラスです。設定情報の参照や編集時に使用します。引数のContextには、主にgeneratorConfig.xmlで指定した設定情報が格納されています。プラグインのプロパティを保持する場合に使用します。使用するプラグインの宣言はgeneratorConfig.xmlのPlugin要素で行いますが、この際に必要であればproperty要素でプロパティを定義することができます。この宣言されたプロパティが、引数として引き渡されます。プロパティが不要なプラグインの場合、このメソッドの実装は不要です。プラグイン実行の前提条件を検証する場合に使用します。プラグインの実行に必要なプロパティが正しく宣言しているか、等の検証ロジックを実装します。検証に成功した場合は戻り値としてtrueを返却するよう実装します。検証に失敗した場合、引数のListにエラーメッセージを追加し、falseを返却するよう実装します。戻り値がfalseの場合、このプラグインは無効(使用されない)になります。後続処理で使用するInspectedTable情報を変更する場合に使用します。InspectedTableの属性情報やデータベースの解析結果を修正したい場合、引数のIntrospectedTableインスタンスが保持する情報を編集します。マッパーインターフェイスのselectByExample/insertSelective等のメソッド定義を編集する場合に使用します。(XXXは、MBGが作成しようとするメソッド名になります。)マッパーインターフェイスの個々のメソッドが作成されたタイミングで、このメソッドが実行されます。Interface)として渡されます。Methodインスタンスにはメソッド情報(修飾子、メソッド名、引数、戻り値、アノテーション等)が含まれており、これらを編集できます。import文の追加が必要になる場合、InterfaceインスタンスのaddImportedType()を使用できます。※リファレンスでは第2引数にTopLevelClassを持つメソッドも記載されています。現在の実装では基本的にマッパーインターフェイスしか作成しないので除外されたのだと思います。マッパーインターフェイスの定義を編集する場合に使用します。上記のclientXXXMethodGeneratedはメソッド作成時に実行されますが、このメソッドは全てのメソッド作成が完了した後に実行されます。この際、作成されたインターフェイス情報が引数(Interface)として渡されます。Intefaceインスタンスにはインターフェイス名、コメント、import文一覧が含まれており、これらを編集できます。多くのWebサーバやAPサーバでは、サーバリソースの過剰な消費やDoS攻撃に対する対処として、アップロードの最大サイズが決められている。Server7(EAP7)を扱うことが多いので備忘録として記載します。...リモートからのwarデプロイの自動化JavaEEベースのツールを公開しているが、デプロイの都度、warファイルをサーバにコピーしてwildflyにデプロイするのが面倒なので、mavenで自動化しました。...Webアプリ用のサイトマップ生成Googleの検索結果への表示を促進するためにGoogleに対してサイトマップを提供する必要がある。EAP7でアプリのDEBUGやTRACEのログを出力する方法を記載します。...PREVシステム開発でのmybatis-generatorの利用NEXT素人の伊豆大島一周サイクリング自己紹介ゆっきーです。都内でシステムエンジニアをやっています。素人の伊豆大島一周サイクリングmybatis-generatorプラグインの実装方法システム開発でのmybatis-generatorの利用mavenマルチモジュールプロジェクトの構成例Java正規表現によるパラメータ置換アウトドアWebツール自己紹介お問合せアプリ開発ときどきアウトドア主にJavaを使ったアプリ開発やトラブルシューティング等のノウハウ、キャンプや登山の紹介や体験談など。