SQLインジェクター

MyBatis-Plusは、カスタムSQLメソッドを注入するための柔軟なメカニズムを提供しており、これは sqlInjector グローバル設定を通じて実現されます。ISqlInjector インターフェースを実装するか、AbstractSqlInjector 抽象クラスを継承することで、カスタムの汎用メソッドをMyBatisコンテナに注入できます。

SQLインジェクターは、開発者がSQL文の生成を拡張およびカスタマイズし、特定のビジネスロジックやクエリ要件に対応できるようにします。以下は、SQLインジェクターの使用例とその実現可能な機能です：

使用シナリオ

カスタムクエリメソッド: 標準的なCRUD操作では複雑なクエリ要件を満たせない場合、SQLインジェクターを使用してカスタムクエリメソッドを追加できます。
複雑なデータ処理: 複数テーブルの結合、サブクエリ、集計関数など、複雑なデータ処理が必要な場合、SQLインジェクターは対応するSQL文の生成を支援します。
パフォーマンス最適化: カスタムSQL文を使用することで、特定のクエリシナリオに対してパフォーマンス最適化を行うことができます。
データ権限制御: ユーザー権限に基づいて動的にSQL文を生成する必要がある場合、SQLインジェクターを使用してデータ権限制御を実装できます。
レガシーシステム移行: レガシーシステムをMyBatis-Plusに移行する際、既存のSQL文構造を維持する必要がある場合、SQLインジェクターがこの移行を支援します。

機能

カスタムSQLメソッドの注入: ISqlInjector インターフェースを実装することで、任意の複雑なSQLクエリであるカスタムSQLメソッドをMyBatisコンテナに注入できます。
BaseMapperの拡張: BaseMapper を継承した上で、SQLインジェクターを通じて追加のクエリメソッドを追加でき、これらのメソッドは自動的にMyBatis-Plusによって認識され使用されます。
柔軟なSQL生成: SQLインジェクターは柔軟なSQL生成メカニズムを提供し、SELECT、INSERT、UPDATE、DELETEなどを含む様々なSQL文をビジネス要件に基づいて生成できます。
サードパーティデータベース機能の統合: ストアドプロシージャ、トリガーなどのデータベース固有の機能を使用する必要がある場合、SQLインジェクターはこれらの機能を呼び出すSQL文の生成を支援します。
動的SQLサポート: 実行時の条件に基づいてSQL文を動的に生成する必要があるシナリオにおいて、SQLインジェクターはこのような動的SQLの生成をサポートします。

SQLインジェクターを通じて、MyBatis-Plusは強力な拡張ポイントを提供し、開発者がプロジェクトの具体的な要件に基づいてSQL文を柔軟にカスタマイズおよび最適化し、アプリケーションのパフォーマンスと適応性を向上させることができます。

インジェクター設定

MyBatis-Plusでは、sqlInjector 設定は、カスタムSQLメソッドをMyBatisのMapperインターフェースに注入する責任を持つ、ISqlInjector インターフェースを実装したクラスを指定するためのグローバル設定項目です。

public interface ISqlInjector {

    /**
     * SQLが既に注入されているかチェックします（既に注入済みの場合は再度注入しません）
     *
     * @param builderAssistant mapper ビルドアシスタント
     * @param mapperClass      mapper インターフェースの class オブジェクト
     */
    void inspectInject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass);
}

デフォルトのインジェクター実装は DefaultSqlInjector です。独自のインジェクターを作成する際の参考にしてください。

以下は sqlInjector の設定方法の例です。

提供された参考情報に基づくと、MyBatis-Plusで論理削除、自動フィル、およびカスタムの insert および insertBatch メソッドを含むカスタムグローバルメソッドを実装する方法を確認できます。以下は、より詳細な手順の説明とサンプルコードです：

カスタムグローバルメソッド攻略

ステップ 1: SQLの定義

まず、カスタムメソッドのSQL文を定義する必要があります。これは通常、AbstractMethod を継承したクラス（例：MysqlInsertAllBatch）で完了します。

public class MysqlInsertAllBatch extends AbstractMethod {

    /**
     * @since 3.5.0
     */
    public MysqlInsertAllBatch() {
        super("mysqlInsertAllBatch");
    }

    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
     // SQL文の定義 (主キー＋通常フィールド)  insert into table(....) values(....),(....)
        String sql = "INSERT INTO " + tableInfo.getTableName() + "(" + tableInfo.getKeyColumn() + "," +
                tableInfo.getFieldList().stream().map(TableFieldInfo::getColumn).collect(Collectors.joining(",")) + ") VALUES ";
        String value = "(" + "#{" + ENTITY + DOT + tableInfo.getKeyProperty() + "}" + ","
                + tableInfo.getFieldList().stream().map(tableFieldInfo -> "#{" + ENTITY + DOT + tableFieldInfo.getProperty() + "}")
                .collect(Collectors.joining(",")) + ")";
        String valuesScript = SqlScriptUtils.convertForeach(value, "list", null, ENTITY, COMMA);
        SqlSource sqlSource = super.createSqlSource(configuration, "<script>" + sql + valuesScript + "</script>", modelClass);
        KeyGenerator keyGenerator = tableInfo.getIdType() == IdType.AUTO ? Jdbc3KeyGenerator.INSTANCE : NoKeyGenerator.INSTANCE;
        // 3番目のパラメータはbaseMapperのカスタムメソッド名と一致している必要があります
        return this.addInsertMappedStatement(mapperClass, modelClass, this.methodName, sqlSource, keyGenerator,tableInfo.getKeyProperty(), tableInfo.getKeyColumn());
    }
}

ステップ 2: カスタムメソッドの登録

次に、DefaultSqlInjector を継承するクラスを作成し、getMethodList メソッドをオーバーライドしてカスタムメソッドを登録する必要があります。

public class MyLogicSqlInjector extends DefaultSqlInjector {

    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        methodList.add(new DeleteAll());
        methodList.add(new MyInsertAll());
        methodList.add(new MysqlInsertAllBatch());
        return methodList;
    }
}

ステップ 3: BaseMapperの定義

次に、BaseMapperインターフェースでカスタムメソッドを定義する必要があります。

public interface MyBaseMapper<T> extends BaseMapper<T> {

    Integer deleteAll();

    int myInsertAll(T entity);

    int mysqlInsertAllBatch(@Param("list") List<T> batchList);
}

ステップ 4: SqlInjectorの設定

最後に、設定ファイルでカスタムSQLインジェクターを指定する必要があります。

`application.yml` での設定

mybatis-plus:
  global-config:
    sql-injector: com.example.MyLogicSqlInjector

`application.properties` での設定

mybatis-plus.global-config.sql-injector=com.example.MyLogicSqlInjector

注意事項

カスタムメソッドを定義する際は、メソッド名が注入されたSQL文のIDと一致していることを確認してください。
カスタムのバッチ挿入と自動フィル機能を使用する際は、Mapperメソッドのパラメータに @Param アノテーションを使用し、その名前がMyBatis-Plusのデフォルトサポート（list, collection, array）に準拠していることを確認してください。
カスタムSQL文は、ビジネス要件に基づいて記述し、目的の操作を正しく実行できることを確認してください。

以上の手順により、MyBatis-Plusでカスタムグローバルメソッドを正常に実装できます。実際の使用では、ビジネス要件に応じてSQL文とメソッドの実装を調整してください。

その他の例

カスタム BaseMapper サンプルを参照すると、カスタムSQLインジェクターの作成方法とプロジェクトでの使用方法に関する詳細な手順を見つけることができます。

この方法により、MyBatis-Plusは特定のビジネス要件を満たすためにその機能を拡張することができ、同時にコードの整理整頓と保守性を維持します。

Power by Astro Starlight | Sponsored by JetBrains