takashno / mbg-addannotation-plugin

MyBatisGenerator Add Annotation Plugin.

mbg-addannotation-plugin

Overview

これはMyBatisGeneratorで生成するModel/Entityに対して任意のアノテーションを付与するための汎用プラグインです。

Description

MyBatisGeneratorでは、Model/Entityに対して通常の方法ではアノテーションを割り振ることはできません。このプラグインを利用すると単純なアノテーションを割り振りたい場合に簡単に実現することができます。
ただし、BeanValidationのアノテーションのように複数のアノテーション等を付与するための用途には単純すぎるため向いていません。

How To Use

設定ファイルの作成

このプラグイン独自のYamlにてアノテーション付与の指示を行うため、作成します。

annotations:
- fullQueryAnnotationName: com.example.Annoataion //(1)
  attribute: value = "example" //(2)
  tableConfigs:
  - tableName: "example_table" //(3)
    regexp: false //(4)
    columnConfigs:
    - columnName: "example_column1" //(5)
      regexp: false //(6)
    - columnName: "example_column2"
      regexp: false

1. 追加したいアノテーションをFQCNで記載します。

2. アノテーションの属性値を全て記載する。そのまあ出力されます。

3. 対象としたテーブル名を記載します。

4. 正規表現でテーブル名を扱いたい場合は「true」とします。

5. 対象としたカラム名を記載します。

6. 正規表現でカラム名を扱いたい場合は「true」とします。

MyBatisGeneratorの設定ファイルの記述

MyBatisGeneratorの出力設定ファイルにプラグイン利用の定義を行います。
この定義の他にこのプラグインのクラスパス設定等は利用する起動方法に合わせて設定してください。

<plugin type="com.zomu.t.mbg.addannotation.plugin.AddFieldAnnotaionPlugin">
	<property name="configFilePath" value="設定ファイルフルパス"/>
</plugin>

How To Build

Gradleの単純なプロジェクトであるため、以下のコマンドでビルド可能です。
作成されたJarを利用してください。

gradle clean build