コンテンツにスキップ
MyBatis-Plus

条件構築ツール

MyBatis-Plusは、複雑なデータベースクエリ条件を構築するための強力な条件構築器（Wrapper）を提供しています。Wrapperクラスを使用することで、開発者はチェーン呼び出し方式でクエリ条件を構築でき、煩雑なSQL文を記述する必要がなくなり、開発効率が向上し、SQLインジェクションのリスクを低減できます。

MyBatis-Plusにおいて、Wrapperクラスはクエリと更新条件を構築するための核心的なツールです。以下に主要なWrapperクラスとその機能を示します：

  • AbstractWrapper：これは抽象基底クラスであり、すべてのWrapperクラスに共通するメソッドとプロパティを提供します。フィールド（column）、値（value）、演算子（condition）など、条件構築の基本ロジックを定義しています。すべてのQueryWrapper、UpdateWrapper、LambdaQueryWrapper、LambdaUpdateWrapperはAbstractWrapperを継承しています。

  • QueryWrapper：クエリ条件の構築に特化しており、基本的な等号、不等号、大なり、小なりなどの各種一般的な操作をサポートします。チェーン呼び出し方式で複数のクエリ条件を追加でき、andとorロジックを組み合わせて使用できます。

  • UpdateWrapper：更新条件を構築するために使用され、データ更新時に条件を指定できます。QueryWrapperと同様に、チェーン呼び出しと論理組み合わせをサポートします。UpdateWrapperを使用すると、エンティティオブジェクトを作成せずに、直接更新フィールドと条件を設定できます。

  • LambdaQueryWrapper：これはLambda式に基づくクエリ条件構築器であり、Lambda式を使用してエンティティクラスのプロパティを参照することで、フィールド名のハードコーディングを回避します。この方式により、コードの可読性と保守性が向上し、特にフィールド名が変更される可能性がある場合に有効です。

  • LambdaUpdateWrapper：LambdaQueryWrapperと類似しており、LambdaUpdateWrapperはLambda式に基づく更新条件構築器です。Lambda式を使用して更新フィールドと条件を指定でき、同様にフィールド名のハードコーディング問題を回避できます。

機能詳細

MyBatis-Plus の Wrapper クラスは、複雑なクエリおよび更新条件を構築するための重要なツールです。開発者がチェーン呼び出しの方式で SQL の WHERE 句を構築することを可能にし、非常に大きな柔軟性と利便性を提供します。

以下は、Wrapper 機能に関するヒントと注意事項です。

allEq

allEq メソッドは、MyBatis-Plus においてクエリ条件を構築するためのメソッドの一つです。このメソッドを使用すると、Map を通じて複数のフィールドに対する等値条件を設定することができます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// すべてのフィールドの等値条件を設定します。フィールド値が null の場合、null2IsNull パラメータに基づいて IS NULL を設定するかどうかを決定します
allEq(Map<String, Object> params)
allEq(Map<String, Object> params, boolean null2IsNull)
allEq(boolean condition, Map<String, Object> params, boolean null2IsNull)


// すべてのフィールドの等値条件を設定します。filter フィルターを通じて、どのフィールドを含めるべきかを決定します。フィールド値が null の場合、null2IsNull パラメータに基づいて IS NULL を設定するかどうかを決定します
allEq(BiPredicate<String, Object> filter, Map<String, Object> params)
allEq(BiPredicate<String, Object> filter, Map<String, Object> params, boolean null2IsNull)
allEq(boolean condition, BiPredicate<String, Object> filter, Map<String, Object> params, boolean null2IsNull)

パラメータ説明

  • params：Map オブジェクトです。key はデータベースのフィールド名、value は対応するフィールド値です。
  • null2IsNull：true に設定すると、Map 内の value が null の場合、isNull メソッドが呼び出されます。false に設定すると、value が null のキーと値のペアは無視されます。
  • filter：BiPredicate オブジェクトです。クエリ条件にどのフィールドを含めるべきかをフィルタリングするために使用します。
  • condition：ブール値です。これらの条件を適用するかどうかを制御します。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.allEq(Map.of("id", 1, "name", "老王", "age", null));

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.allEq(Map.of("id", 1, "name", "老王", "age", null));

フィルター付きの通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.allEq((field, value) -> field.contains("a"), Map.of("id", 1, "name", "老王", "age", null));

フィルター付きの Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.allEq((field, value) -> field.contains("a"), Map.of("id", 1, "name", "老王", "age", null));

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE id = 1 AND name = '老王' AND age IS NULL


-- フィルター付きの通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name = '老王' AND age IS NULL

eq

eq メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つであり、単一フィールドに対する等価条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの等価条件を設定します
eq(R column, Object val)


// 条件に基づいて、指定されたフィールドの等価条件を設定します
eq(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。
  • condition：この等価条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "老王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.eq(User::getName, "老王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name = '老王'

ne

ne メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つであり、単一フィールドの不一致条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの不一致条件を設定します
ne(R column, Object val)


// 条件に基づいて指定されたフィールドの不一致条件を設定します
ne(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。
  • condition：この不一致条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.ne("name", "老王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.ne(User::getName, "老王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name <> '老王'

gt

gt メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本メソッドの一つであり、単一フィールドに対する「より大きい」条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの「より大きい」条件を設定します
gt(R column, Object val)


// 条件に基づいて、指定されたフィールドの「より大きい」条件を設定します
gt(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。
  • condition：この「より大きい」条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.gt("age", 18);

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.gt(User::getAge, 18);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age > 18

ge

ge メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本メソッドの一つであり、単一フィールドに対する「以上」条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドに対して「以上」条件を設定します
ge(R column, Object val)


// 条件に基づいて、指定されたフィールドに対して「以上」条件を設定します
ge(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。
  • condition：この「以上」条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.ge("age", 18);

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.ge(User::getAge, 18);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age >= 18

lt

lt メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本メソッドの一つであり、単一フィールドに対する「小なり」条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの「小なり」条件を設定します
lt(R column, Object val)


// 条件に基づいて、指定されたフィールドの「小なり」条件を設定します
lt(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。
  • condition：この「小なり」条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.lt("age", 18);

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.lt(User::getAge, 18);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age < 18

le

le メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本メソッドの一つであり、単一フィールドに対する「以下」条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドに対する「以下」条件を設定します
le(R column, Object val)


// 条件に基づいて、指定されたフィールドに対する「以下」条件を設定します
le(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。
  • condition：この「以下」条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.le("age", 18);

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.le(User::getAge, 18);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age <= 18

between

between メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つであり、単一フィールドに対する BETWEEN 条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの BETWEEN 条件を設定します
between(R column, Object val1, Object val2)


// 条件に基づいて指定されたフィールドの BETWEEN 条件を設定します
between(boolean condition, R column, Object val1, Object val2)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val1：フィールド名に対応する最初の値。BETWEEN 条件の開始値を表します。
  • val2：フィールド名に対応する2番目の値。BETWEEN 条件の終了値を表します。
  • condition：この BETWEEN 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.between("age", 18, 30);

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.between(User::getAge, 18, 30);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age BETWEEN 18 AND 30

notBetween

notBetween メソッドは、MyBatis-Plus においてクエリ条件を構築するためのもう一つの基本メソッドであり、単一フィールドの NOT BETWEEN 条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの NOT BETWEEN 条件を設定します
notBetween(R column, Object val1, Object val2)


// 条件に基づいて指定されたフィールドの NOT BETWEEN 条件を設定します
notBetween(boolean condition, R column, Object val1, Object val2)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val1：フィールド名に対応する最初の値。NOT BETWEEN 条件の開始値を表します。
  • val2：フィールド名に対応する2番目の値。NOT BETWEEN 条件の終了値を表します。
  • condition：この NOT BETWEEN 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notBetween("age", 18, 30);

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notBetween(User::getAge, 18, 30);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age NOT BETWEEN 18 AND 30

like

like メソッドは、MyBatis-Plus においてあいまい検索条件を構築するための基本的なメソッドの一つであり、単一フィールドに対する LIKE 条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの LIKE 条件を設定します
like(R column, Object val)


// 条件に基づいて指定されたフィールドの LIKE 条件を設定します
like(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。LIKE 条件における検索値を表します。
  • condition：この LIKE 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.like("name", "王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.like(User::getName, "王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name LIKE '%王%'

notLike

notLike メソッドは、MyBatis-Plus において曖昧検索条件を構築するためのもう一つの基本メソッドであり、単一フィールドの NOT LIKE 条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの NOT LIKE 条件を設定します
notLike(R column, Object val)


// 条件に基づいて指定されたフィールドの NOT LIKE 条件を設定します
notLike(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。NOT LIKE 条件における検索値を表します。
  • condition：この NOT LIKE 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notLike("name", "王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notLike(User::getName, "王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name NOT LIKE '%王%'

likeLeft

likeLeft メソッドは、MyBatis-Plus においてあいまい検索条件を構築するための基本的なメソッドの一つであり、単一フィールドに対する右方一致検索条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの右方一致検索条件を設定します
likeLeft(R column, Object val)


// 条件に基づいて指定されたフィールドの右方一致検索条件を設定します
likeLeft(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値であり、右方一致検索条件における検索値を表します。
  • condition：この右方一致検索条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.likeLeft("name", "王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.likeLeft(User::getName, "王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name LIKE '%王'

上記の最適化により、likeLeft メソッドのドキュメントは、その使用方法、パラメータの説明、使用例、および注意事項をより明確に示しており、開発者がこのメソッドをより容易に理解し、正しく使用できるようになっています。

likeRight

likeRight メソッドは、MyBatis-Plus においてあいまい検索条件を構築するための基本メソッドの一つであり、単一フィールドに対する左方一致検索条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの左方一致検索条件を設定します
likeRight(R column, Object val)


// 条件に基づいて指定されたフィールドの左方一致検索条件を設定します
likeRight(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。左方一致検索条件における検索値を表します。
  • condition：この左方一致検索条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.likeRight("name", "王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.likeRight(User::getName, "王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name LIKE '王%'

notLikeLeft

notLikeLeft メソッドは、MyBatis-Plus において曖昧検索条件を構築するためのもう一つの基本メソッドであり、単一フィールドの右側不一致の曖昧一致条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの右側不一致の曖昧一致条件を設定します
notLikeLeft(R column, Object val)


// 条件に基づいて指定されたフィールドの右側不一致の曖昧一致条件を設定します
notLikeLeft(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。右側不一致の曖昧一致条件における検索値を表します。
  • condition：この右側不一致の曖昧一致条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notLikeLeft("name", "王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notLikeLeft(User::getName, "王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name NOT LIKE '%王'

notLikeRight

notLikeRight メソッドは、MyBatis-Plus において曖昧検索条件を構築するためのもう一つの基本メソッドであり、単一フィールドに対する左方一致否定の条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの左方一致否定条件を設定します
notLikeRight(R column, Object val)


// 条件に基づいて指定されたフィールドの左方一致否定条件を設定します
notLikeRight(boolean condition, R column, Object val)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • val：フィールド名に対応する値。左方一致否定条件における検索値を表します。
  • condition：この左方一致否定条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notLikeRight("name", "王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notLikeRight(User::getName, "王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name NOT LIKE '王%'

上記の最適化により、notLikeRight メソッドのドキュメントは、その使用方法、パラメータの説明、例、および注意事項をより明確に示しており、開発者がこのメソッドをより簡単に理解し、正しく使用できるようになっています。

isNull

isNull メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つであり、単一フィールドに対する IS NULL 条件を設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの IS NULL 条件を設定します
isNull(R column)


// 条件に基づいて指定されたフィールドの IS NULL 条件を設定します
isNull(boolean condition, R column)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • condition：この IS NULL 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.isNull("name");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.isNull(User::getName);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE name IS NULL

in

in メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つです。単一フィールドに対する IN 条件、つまりフィールドの値が指定されたコレクション内に存在するレコードを検索するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの IN 条件を設定します（コレクションを使用）
in(R column, Collection<?> value)
in(boolean condition, R column, Collection<?> value)


// 指定されたフィールドの IN 条件を設定します（可変長引数を使用）
in(R column, Object... values)
in(boolean condition, R column, Object... values)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • value：IN 条件でフィールドが取り得る値を含むコレクション。
  • values：IN 条件でフィールドが取り得る値を含む可変長引数リスト。
  • condition：この IN 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.in("age", Arrays.asList(1, 2, 3));

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.in(User::getAge, Arrays.asList(1, 2, 3));

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age IN (1, 2, 3)

notIn

notIn メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つです。単一フィールドの NOT IN 条件、つまりフィールドの値が指定されたコレクション内に含まれないことを設定するために使用されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの NOT IN 条件を設定します（コレクションを使用）
notIn(R column, Collection<?> value)
notIn(boolean condition, R column, Collection<?> value)


// 指定されたフィールドの NOT IN 条件を設定します（可変長引数を使用）
notIn(R column, Object... values)
notIn(boolean condition, R column, Object... values)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • value：NOT IN 条件におけるフィールドの可能性のある値を含むコレクション。
  • values：NOT IN 条件におけるフィールドの可能性のある値を含む可変長引数リスト。
  • condition：この NOT IN 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notIn("age", Arrays.asList(1, 2, 3));

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notIn(User::getAge, Arrays.asList(1, 2, 3));

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age NOT IN (1, 2, 3)

inSql

inSql メソッドは MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、単一フィールドの IN 条件を設定するために使用されます。ただし、in メソッドとは異なり、inSql は IN 句内の値の集合を生成するために SQL 文を直接使用することを可能にします。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの IN 条件を、SQL 文を使用して設定します
inSql(R column, String sqlValue)
inSql(boolean condition, R column, String sqlValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • sqlValue：IN 句内の値の集合を生成するために使用される SQL 文を含む文字列。
  • condition：この IN 条件を適用するかどうかを制御するブール値。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.inSql("age", "1,2,3,4,5,6");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.inSql(User::getAge, "1,2,3,4,5,6");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age IN (1, 2, 3, 4, 5, 6)

サブクエリを使用した例：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.inSql("id", "select id from other_table where id < 3");

生成される SQL

SELECT * FROM user WHERE id IN (select id from other_table where id < 3)

notInSql

notInSql メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つです。このメソッドは単一フィールドに対する NOT IN 条件を設定するために使用されますが、notIn メソッドとは異なり、notInSql は NOT IN 句内の値の集合を生成するために SQL 文を直接使用することができます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 指定されたフィールドの NOT IN 条件を設定します。SQL 文を使用します。
notInSql(R column, String sqlValue)
notInSql(boolean condition, R column, String sqlValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • sqlValue：NOT IN 句内の値の集合を生成するために使用される SQL 文を含む文字列。
  • condition：この NOT IN 条件を適用するかどうかを制御するブール値。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notInSql("age", "1,2,3,4,5,6");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notInSql(User::getAge, "1,2,3,4,5,6");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE age NOT IN (1, 2, 3, 4, 5, 6)

サブクエリを使用した例：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notInSql("id", "select id from other_table where id < 3");

生成される SQL

SELECT * FROM user WHERE id NOT IN (select id from other_table where id < 3)

eqSql Since 3.5.6

eqSql メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つで、フィールドが SQL 文の結果と等しい（EQ）ことを設定することができます。このメソッドは、フィールドの値とサブクエリの結果を比較する必要があるシナリオに特に適しています。

メソッドシグネチャ

// 指定されたフィールドが SQL 文の結果と等しいことを設定します
eqSql(R column, String inValue)


// 条件が満たされた場合に、指定されたフィールドが SQL 文の結果と等しいことを設定します
eqSql(boolean condition, R column, String inValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • inValue：等価条件を生成するための SQL 文を含む文字列。
  • condition：この等価条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eqSql("id", "select MAX(id) from table");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.eqSql(User::getId, "select MAX(id) from table");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE id = (select MAX(id) from table)

gtSql Since 3.4.3.2

gtSql メソッドは、MyBatis-Plus において、フィールドが特定の SQL 文の結果より大きい（GT）条件を設定するための高度なメソッドの一つです。

メソッドシグネチャ

// 指定されたフィールドが SQL 文の結果より大きいことを設定します
gtSql(R column, String inValue)


// 条件が満たされた場合に、指定されたフィールドが SQL 文の結果より大きいことを設定します
gtSql(boolean condition, R column, String inValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • inValue：大なり条件を生成するための SQL 文を含む文字列。
  • condition：この大なり条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.gtSql("id", "select id from table where name = 'xx'");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.gtSql(User::getId, "select id from table where name = 'xx'");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE id > (select id from table where name = 'xx')

geSql Since 3.4.3.2

geSql メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つで、フィールドが特定の SQL 文の結果以上（以上: Greater than or Equal）である条件を設定することができます。

メソッドシグネチャ

// 指定されたフィールドが SQL 文の結果以上であることを設定します
geSql(R column, String inValue)


// 条件が満たされた場合に、指定されたフィールドが SQL 文の結果以上であることを設定します
geSql(boolean condition, R column, String inValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • inValue：以上条件を生成するために使用される SQL 文を含む文字列。
  • condition：この以上条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.geSql("id", "select id from table where name = 'xx'");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.geSql(User::getId, "select id from table where name = 'xx'");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE id >= (select id from table where name = 'xx')

ltSql Since 3.4.3.2

ltSql メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つで、フィールドが特定の SQL 文の結果より小さい（LT）条件を設定することができます。

メソッドシグネチャ

// 指定されたフィールドが SQL 文の結果より小さいことを設定します
ltSql(R column, String inValue)


// 条件が満たされた場合に、指定されたフィールドが SQL 文の結果より小さいことを設定します
ltSql(boolean condition, R column, String inValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • inValue：小なり条件を生成するための SQL 文を含む文字列。
  • condition：この小なり条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.ltSql("id", "select id from table where name = 'xx'");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.ltSql(User::getId, "select id from table where name = 'xx'");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE id < (select id from table where name = 'xx')

leSql Since 3.4.3.2

leSql メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つで、指定したフィールドが SQL 文の結果以下（LE）となる条件を設定することができます。

メソッドシグネチャ

// 指定したフィールドが SQL 文の結果以下となる条件を設定
leSql(R column, String inValue)


// 条件が満たされた場合に、指定したフィールドが SQL 文の結果以下となる条件を設定
leSql(boolean condition, R column, String inValue)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • inValue：以下条件を生成するための SQL 文を含む文字列。
  • condition：この以下条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.leSql("id", "select id from table where name = 'xx'");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.leSql(User::getId, "select id from table where name = 'xx'");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE id <= (select id from table where name = 'xx')

groupBy

groupBy メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、クエリ結果のグループ化条件を設定するために使用されます。1つまたは複数のフィールドを指定することで、groupBy メソッドは SQL 文の GROUP BY 句を生成します。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// グループ化条件を設定し、フィールド名を使用
groupBy(R... columns)
groupBy(boolean condition, R... columns)

パラメータ説明

  • columns：グループ化に使用するフィールド名を含む可変長パラメータリストです。
  • condition：このグループ化条件を適用するかどうかを制御するブール値です。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.groupBy("id", "name");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.groupBy(User::getId, User::getName);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user GROUP BY id, name

orderByAsc

orderByAsc メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、クエリ結果の昇順ソート条件を設定するために使用されます。1つまたは複数のフィールドを指定することで、orderByAsc メソッドは SQL 文の ORDER BY 句を生成し、昇順ソートを指定します。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 昇順ソート条件を設定、フィールド名を使用
orderByAsc(R... columns)
orderByAsc(boolean condition, R... columns)

パラメータ説明

  • columns：ソートに使用するフィールド名を含む可変長パラメータリストです。
  • condition：このソート条件を適用するかどうかを制御するブール値です。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.orderByAsc("id", "name");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.orderByAsc(User::getId, User::getName);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user ORDER BY id ASC, name ASC

orderByDesc

orderByDesc メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、クエリ結果の降順ソート条件を設定するために使用されます。1つまたは複数のフィールドを指定することで、orderByDesc メソッドは SQL 文の ORDER BY 句を生成し、降順ソートを指定します。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 降順ソート条件を設定、フィールド名を使用
orderByDesc(R... columns)
orderByDesc(boolean condition, R... columns)

パラメータ説明

  • columns：ソートに使用するフィールド名を含む可変長パラメータリストです。
  • condition：このソート条件を適用するかどうかを制御するブール値です。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.orderByDesc("id", "name");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.orderByDesc(User::getId, User::getName);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user ORDER BY id DESC, name DESC

orderBy

orderBy メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、クエリ結果のソート条件を設定するために使用されます。1つまたは複数のフィールドおよびソート方向（昇順または降順）を指定することで、orderBy メソッドは SQL 文の ORDER BY 句を生成します。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// ソート条件を設定します。フィールド名とソート方向を使用します
orderBy(boolean condition, boolean isAsc, R... columns)

パラメータ説明

  • condition：このソート条件を適用するかどうかを制御するブール値です。
  • isAsc：ソート方向を表すブール値です。true は昇順（ASC）、false は降順（DESC）を表します。
  • columns：ソートに使用するフィールド名を含む可変長パラメータリストです。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.orderBy(true, true, "id", "name");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.orderBy(true, true, User::getId, User::getName);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user ORDER BY id ASC, name ASC

having

having メソッドは MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、HAVING 句を設定するために使用されます。通常は GROUP BY と組み合わせて使用され、グループ化後のデータに対する条件フィルタリングを行います。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// HAVING 句を設定します。SQL 文とパラメータを使用します
having(String sqlHaving, Object... params)
having(boolean condition, String sqlHaving, Object... params)

パラメータ説明

  • sqlHaving: HAVING 句を生成するための SQL 文を含む文字列です。
  • params: SQL 文内のプレースホルダを置換するための値を含む可変引数リストです。
  • condition: この HAVING 条件を適用するかどうかを制御するブール値です。

使用例

通常の Wrapper (QueryWrapper):

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.groupBy("age").having("sum(age) > 10");

Lambda Wrapper (LambdaQueryWrapper):

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.groupBy(User::getAge).having("sum(age) > {0}", 10);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user GROUP BY age HAVING sum(age) > 10

func

func メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、条件に応じて異なるクエリ操作を実行するメカニズムを提供します。Consumer 関数型インターフェースを渡すことで、func メソッドは、チェーン呼び出しを中断することなく、条件に基づいて異なるクエリ構築ロジックを実行することを可能にします。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 条件に応じて異なるクエリ構築ロジックを実行
func(Consumer<Children> consumer)
func(boolean condition, Consumer<Children> consumer)

パラメータ説明

  • consumer：Consumer 関数型インターフェース。Children 型のパラメータを受け取り、Children オブジェクトのメソッドを呼び出してクエリ条件を構築できます。
  • condition：この Consumer ロジックを適用するかどうかを制御するためのブール値。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.func(i -> {
    if (true) {
        i.eq("id", 1);
    } else {
        i.ne("id", 1);
    }
});

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.func(i -> {
    if (true) {
        i.eq(User::getId, 1);
    } else {
        i.ne(User::getId, 1);
    }
});

生成される SQL

-- 条件によって生成される SQL は異なります
-- 条件が true の場合、生成される SQL は：
SELECT * FROM user WHERE id = 1


-- 条件が false の場合、生成される SQL は：
SELECT * FROM user WHERE id != 1

or

or メソッドは MyBatis-Plus においてクエリ条件を構築するための基本メソッドの一つであり、クエリ条件に OR 論理を追加するために使用されます。or メソッドを呼び出すことで、後続のクエリ条件の結合方法を、デフォルトの AND 結合から OR 結合に変更することができます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 後続のクエリ条件の結合方法を OR に変更
or()
or(boolean condition)


// OR ネスト条件を追加
or(Consumer<Param> consumer)
or(boolean condition, Consumer<Param> consumer)

パラメータ説明

  • condition：OR 論理を適用するかどうかを制御するためのブール値。
  • consumer：Param 型のパラメータを受け取り、Param オブジェクトのメソッドを呼び出して OR ネスト条件を構築するための Consumer 関数型インターフェース。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("id", 1).or().eq("name", "老王");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.eq(User::getId, 1).or().eq(User::getName, "老王");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じ
SELECT * FROM user WHERE id = 1 OR name = '老王'

OR ネストの例：

// 通常の Wrapper
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.or(i -> i.and(j -> j.eq("name", "李白").eq("status", "alive"))
                         .or(j -> j.eq("name", "杜甫").eq("status", "alive")));


// Lambda Wrapper
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.or(i -> i.and(j -> j.eq(User::getName, "李白").eq(User::getStatus, "alive"))
                              .or(j -> j.eq(User::getName, "杜甫").eq(User::getStatus, "alive")));

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じ
SELECT * FROM user WHERE (name = '李白' AND status = 'alive') OR (name = '杜甫' AND status = 'alive')

and

and メソッドは、MyBatis-Plus においてクエリ条件を構築するための基本的なメソッドの一つであり、クエリ条件に AND 論理を追加するために使用されます。and メソッドを呼び出すことで、AND ネスト条件、つまり一つの AND 論理ブロック内に複数のクエリ条件を含む条件を作成できます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// AND ネスト条件を追加
and(Consumer<Param> consumer)
and(boolean condition, Consumer<Param> consumer)

パラメータ説明

  • consumer：Consumer 関数型インターフェースです。Param 型のパラメータを受け取り、Param オブジェクトのメソッドを呼び出して AND ネスト条件を構築できます。
  • condition：この AND ネストロジックを適用するかどうかを制御するためのブール値です。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.and(i -> i.and(j -> j.eq("name", "李白").eq("status", "alive"))
                         .and(j -> j.eq("name", "杜甫").eq("status", "alive")));

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.and(i -> i.and(j -> j.eq(User::getName, "李白").eq(User::getStatus, "alive"))
                              .and(j -> j.eq(User::getName, "杜甫").eq(User::getStatus, "alive")));

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE ((name = '李白' AND status = 'alive') AND (name = '杜甫' AND status = 'alive'))

nested

nested メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つです。これはデフォルトの AND または OR ロジックを持たない、独立したクエリ条件ブロックを作成するために使用されます。nested メソッドを呼び出すことで、クエリ条件にネストされた句を追加できます。この句は複数のクエリ条件を含むことができ、外部のクエリ条件から AND または OR で接続されます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 独立したクエリ条件ブロックを追加します
nested(Consumer<Param> consumer)
nested(boolean condition, Consumer<Param> consumer)

パラメータ説明

  • consumer：Param 型のパラメータを受け取り、Param オブジェクトのメソッドを呼び出してネストされたクエリ条件を構築するための Consumer 関数型インターフェースです。
  • condition：このネストされたロジックを適用するかどうかを制御するブール値です。

例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.nested(i -> i.eq("name", "李白").ne("status", "活着"));

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.nested(i -> i.eq(User::getName, "李白").ne(User::getStatus, "活着"));

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user WHERE (name = '李白' AND status <> '活着')

apply

apply メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、SQL フラグメントを直接クエリ条件に連結することを可能にします。このメソッドは、データベース関数やその他の複雑な SQL 構文を使用する必要があるシナリオで特に有用です。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// SQL フラグメントを連結
apply(String applySql, Object... params)
apply(boolean condition, String applySql, Object... params)

パラメータ説明

  • applySql：連結する SQL フラグメントを含む文字列。
  • params：SQL フラグメント内のプレースホルダを置き換える値を格納した可変引数リスト。
  • condition：この SQL フラグメントを適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.apply("id = 1");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.apply("date_format(dateColumn, '%Y-%m-%d') = '2008-08-08'");

パラメータプレースホルダを使用した例：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.apply("date_format(dateColumn, '%Y-%m-%d') = {0}", "2008-08-08");

生成される SQL

-- 通常の Wrapper で生成される SQL
SELECT * FROM user WHERE id = 1


-- Lambda Wrapper で生成される SQL
SELECT * FROM user WHERE date_format(dateColumn, '%Y-%m-%d') = '2008-08-08'


-- パラメータプレースホルダを使用して生成される SQL
SELECT * FROM user WHERE date_format(dateColumn, '%Y-%m-%d') = '2008-08-08'

注意事項

  • apply メソッドは、データベース関数を含む SQL フラグメントを連結するために使用できます。
  • 動的入力パラメータ params は、applySql 内部の {index} 部分に対応します。この方法では SQL インジェクションのリスクはありません。パラメータを直接 SQL に連結すると SQL インジェクションのリスクが生じるため、SQL がフロントエンドからの動的パラメータによって直接参照されることは避けるべきです。
  • apply メソッドを使用する際は、applySql パラメータが有効な SQL フラグメントであり、params パラメータがプレースホルダを正しく置き換えていることを確認してください。
  • condition パラメータは、この SQL フラグメントを適用するかどうかを制御するために使用され、特定の条件に基づいてクエリ条件を動的に追加することが可能になります。

last

last メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つです。このメソッドを使用すると、MyBatis-Plus のクエリ最適化ルールの影響を受けずに、クエリの最後に直接 SQL フラグメントを追加することができます。このメソッドは、MyBatis-Plus のクエリ最適化を迂回する可能性があるため、注意して使用する必要があります。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// クエリの最後に SQL フラグメントを追加します
last(String lastSql)
last(boolean condition, String lastSql)

パラメータ説明

  • lastSql: クエリの最後に追加する SQL フラグメントを含む文字列です。
  • condition: この SQL フラグメントを適用するかどうかを制御するブール値です。

例

通常の Wrapper (QueryWrapper):

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.last("limit 1");

Lambda Wrapper (LambdaQueryWrapper):

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.last("limit 1");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
SELECT * FROM user LIMIT 1

exists

exists メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、クエリに EXISTS 副問い合わせを追加するために使用されます。exists メソッドを呼び出すことで、完全な SQL 副問い合わせを EXISTS 条件としてメインクエリに追加できます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// EXISTS 副問い合わせを追加
exists(String existsSql)
exists(boolean condition, String existsSql)

パラメータ説明

  • existsSql: EXISTS 条件として使用する SQL 副問い合わせを含む文字列。
  • condition: この EXISTS 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper):

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.exists("select id from table where age = 1");

Lambda Wrapper (LambdaQueryWrapper):

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.exists("select id from table where age = 1");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じ
SELECT * FROM user WHERE EXISTS (select id from table where age = 1)

notExists

notExists メソッドは、MyBatis-Plus でクエリ条件を構築するための高度なメソッドの一つであり、クエリに NOT EXISTS 副問い合わせを追加するために使用されます。notExists メソッドを呼び出すことで、完全な SQL 副問い合わせを NOT EXISTS 条件としてメインクエリに追加できます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper
  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// NOT EXISTS 副問い合わせを追加
notExists(String notExistsSql)
notExists(boolean condition, String notExistsSql)

パラメータ説明

  • notExistsSql：NOT EXISTS 条件として使用する SQL 副問い合わせを含む文字列。
  • condition：この NOT EXISTS 条件を適用するかどうかを制御するブール値。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.notExists("select id from table where age = 1");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.notExists("select id from table where age = 1");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じ
SELECT * FROM user WHERE NOT EXISTS (select id from table where age = 1)

select

select メソッドは、MyBatis-Plus においてクエリ条件を構築するための高度なメソッドの一つであり、クエリするフィールドを設定するために使用されます。select メソッドを呼び出すことで、クエリ結果に含めるフィールドを指定し、フィールドレベルでのクエリカスタマイズを実現できます。

使用範囲

  • QueryWrapper
  • LambdaQueryWrapper

メソッドシグネチャ

// クエリフィールドを設定
select(String... sqlSelect)


// クエリフィールドをフィルタリング（主キーを除く）
select(Predicate<TableFieldInfo> predicate)
select(Class<T> entityClass, Predicate<TableFieldInfo> predicate)

パラメータ説明

  • sqlSelect：クエリするフィールド名を含む文字列配列。
  • predicate：クエリフィールドをフィルタリングするための Predicate 関数型インターフェース。TableFieldInfo 型のパラメータを受け取り、そのフィールドを選択するかどうかを示すブール値を返します。
  • entityClass：フィールド情報を取得するためのエンティティクラスの型。

使用例

通常の Wrapper (QueryWrapper)：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.select("id", "name", "age");

Lambda Wrapper (LambdaQueryWrapper)：

LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<>();
lambdaQueryWrapper.select(User::getId, User::getName, User::getAge);

Predicate を使用したフィールドフィルタリングの例：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.select(i -> i.getProperty().startsWith("test"));

生成される SQL

-- 通常の Wrapper および Lambda Wrapper で生成される SQL
SELECT id, name, age FROM user


-- Predicate を使用したフィールドフィルタリングで生成される SQL
SELECT testField1, testField2 FROM user

set

set メソッドは MyBatis-Plus において更新操作を構築するための高度なメソッドの一つであり、UPDATE 文の SET 句で設定するフィールドを指定するために使用されます。set メソッドを呼び出すことで、更新操作において変更するフィールドとその新しい値を指定できます。

使用範囲

  • UpdateWrapper
  • LambdaUpdateWrapper

メソッドシグネチャ

// 更新文の SET フィールドを設定します
set(R column, Object val)
set(R column, Object val, String mapping)
set(boolean condition, R column, Object val)
set(boolean condition, R column, Object val, String mapping)

パラメータ説明

  • column：データベースのフィールド名、または Lambda 式を使用したフィールド名。
  • condition：この SET フィールドを適用するかどうかを制御するブール値。
  • val：フィールドに更新する新しい値を表すオブジェクト。
  • mapping：追加で指定します。例: javaType=int,jdbcType=NUMERIC,typeHandler=xxx.xxx.MyTypeHandler

使用例

通常の Wrapper (UpdateWrapper)：

UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.set("name", "老李头");

Lambda Wrapper (LambdaUpdateWrapper)：

LambdaUpdateWrapper<User> lambdaUpdateWrapper = new LambdaUpdateWrapper<>();
lambdaUpdateWrapper.set(User::getName, "老李头");

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じです
UPDATE user SET name = '老李头'

条件制御を使用した例：

UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
updateWrapper.set(true, "name", "");

生成される SQL

-- 条件制御を使用した SQL
UPDATE user SET name = ''

setSql

setSql メソッドは、MyBatis-Plus において更新操作を構築するための高度なメソッドの一つです。このメソッドを使用すると、更新文の SET 句に相当する SQL を直接設定することができます。setSql メソッドを呼び出すことで、カスタムの SQL フラグメントを SET 句として更新文に追加できます。

使用範囲

  • UpdateWrapper
  • LambdaUpdateWrapper

メソッド・シグネチャ

// 更新文の SET 句に相当する SQL を設定します
setSql(String setSql, Object... params)
setSql(boolean condition, String setSql, Object... params)

パラメータ説明

  • setSql：SET 句として使用する SQL フラグメントを含む文字列。
  • condition：この SET フィールドを適用するかどうかを制御するブール値。
  • params：SQL フラグメント内のプレースホルダを置き換える値を含む可変長引数リスト。

使用例

setSql("name = '老李头'")
setSql("dateColumn={0}", LocalDate.now())
setSql("type={0,javaType=int,jdbcType=NUMERIC,typeHandler=xxx.xxx.MyTypeHandler}", "待处理字符串");

setIncrBy Since 3.5.6

setIncrBy メソッドは、MyBatis-Plus における更新操作の高度なメソッドの一つであり、特定のフィールドを指定してデータベース内の値を指定した数値だけ増加させることができます。このメソッドは、数値フィールドに対して増分操作が必要なシナリオに特に適しています。

使用範囲

  • LambdaUpdateWrapper

メソッドシグネチャ

// フィールドを指定数値だけインクリメント
setIncrBy(SFunction<T, ?> column, Number val)


// 条件を満たす場合にフィールドを指定数値だけインクリメント
setIncrBy(boolean condition, SFunction<T, ?> column, Number val)

パラメータ説明

  • column：インクリメント対象のフィールドを表す SFunction オブジェクト
  • val：増加させる数値を表す Number オブジェクト
  • condition（オプション）：条件を満たす場合にのみインクリメント操作を実行するかどうかを示すブール値

使用例

通常の Wrapper (UpdateWrapper)：

UpdateWrapper<Product> updateWrapper = new UpdateWrapper<>();
updateWrapper.setIncrBy(Product::getNum, 1);

ラッパー (LambdaUpdateWrapper)：

LambdaUpdateWrapper<Product> lambdaUpdateWrapper = new LambdaUpdateWrapper<>();
lambdaUpdateWrapper.setIncrBy(Product::getNum, 1);

生成される SQL

-- 通常の Wrapper と Lambda Wrapper で生成される SQL は同じ
UPDATE product SET num = num + 1

setDecrBy Since 3.5.6

setDecrBy メソッドは、MyBatis-Plus における更新操作のための高度なメソッドの一つであり、指定したフィールドのデータベース上の値を指定した数値だけ減少させることを可能にします。このメソッドは、数値フィールドに対して減算操作を行う必要があるシナリオに特に適しています。

使用範囲

  • LambdaUpdateWrapper

メソッドシグネチャ

// フィールドを指定数値で減算
setDecrBy(SFunction<T, ?> column, Number val)


// 条件を満たす場合にフィールドを指定数値で減算
setDecrBy(boolean condition, SFunction<T, ?> column, Number val)

パラメータ説明

  • column：減算対象のフィールドを表す SFunction オブジェクト。
  • val：減算する数値を表す Number オブジェクト。
  • condition（オプション）：条件を満たす場合にのみ減算操作を実行するかどうかを示すブール値。

使用例

通常の Wrapper (UpdateWrapper)：

UpdateWrapper<Product> updateWrapper = new UpdateWrapper<>();
updateWrapper.setDecrBy("num", 1);

ラムダ Wrapper (LambdaUpdateWrapper)：

LambdaUpdateWrapper<Product> lambdaUpdateWrapper = new LambdaUpdateWrapper<>();
lambdaUpdateWrapper.setDecrBy(Product::getNum, 1);

生成される SQL

-- 通常の Wrapper とラムダ Wrapper で生成される SQL は同じです
UPDATE product SET num = num - 1

lambda

lambda メソッドは、QueryWrapper または UpdateWrapper オブジェクトから対応する LambdaQueryWrapper または LambdaUpdateWrapper オブジェクトを取得するための便利なメソッドです。これにより、Lambda 式を使用してクエリ条件や更新条件を構築できるようになり、コードがより簡潔で型安全になります。

使用範囲

  • QueryWrapper
  • UpdateWrapper

メソッド署名

// ラムダ Wrapper を取得
lambda();

例

QueryWrapper から LambdaQueryWrapper を取得：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
LambdaQueryWrapper<User> lambdaQueryWrapper = queryWrapper.lambda();
// Lambda 式を使用してクエリ条件を構築
lambdaQueryWrapper.eq(User::getName, "张三");

UpdateWrapper から LambdaUpdateWrapper を取得：

UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
LambdaUpdateWrapper<User> lambdaUpdateWrapper = updateWrapper.lambda();
// Lambda 式を使用して更新条件を構築
lambdaUpdateWrapper.set(User::getName, "李四");

説明

  • lambda メソッドは LambdaWrapper オブジェクトを返します。具体的な型は、呼び出し元の Wrapper の型によって異なります。
  • QueryWrapper で lambda メソッドを呼び出すと、LambdaQueryWrapper が返されます。
  • UpdateWrapper で lambda メソッドを呼び出すと、LambdaUpdateWrapper が返されます。
  • Lambda 式を使用すると、フィールド名を直接文字列で指定することを避けられるため、エラーを減らし、コードの可読性を向上させることができます。

TypeHandler の使用

wrapper で typeHandler を使用するには、formatSqlMaybeWithParam メソッドを利用した特別な処理が必要です

// クエリ
queryWrapper.apply("type={0,typeHandler="+ MyTypeHandler.class.getCanonicalName()+ "}", "待处理字符串");


// 更新
updateWrapper.setSql("type={0,javaType=string,jdbcType=VARCHAR,typeHandler=xxx.xxx.MyTypeHandler}", "待处理字符串");

使用上のヒント

MyBatis-Plus の Wrapper 条件構築器を使用することで、開発者は複雑なデータベースクエリ条件をより効率的に構築でき、コードの簡潔さと安全性を維持できます。以下に、いくつかの注意事項と推奨される方法を示します：

  • Wrapper を使用する際は、ハードコーディングされたフィールド名を避けるために Lambda 式を使用することを推奨します。これにより、コードの可読性と保守性が向上します。
  • Wrapper はメソッドチェーンをサポートしており、and、or などの論理演算子を使用して複数の条件を組み合わせることができます。
  • 更新操作で UpdateWrapper または LambdaUpdateWrapper を使用する場合、エンティティオブジェクトを省略し、Wrapper 内で直接更新フィールドを設定できます。
  • Wrapper のスレッドセーフ性に注意し、通常は使用するたびに新しい Wrapper インスタンスを作成してください。
  • MyBatis-Plus の Wrapper を使用する際は、SQL インジェクション攻撃を防ぐために、フロントエンドの動的パラメータを直接 SQL フラグメントに連結しないでください。MyBatis-Plus は安全なパラメータバインディング方法を提供しており、eq、apply などのメソッドを使用すると、パラメータバインディングが自動的に処理され、SQL インジェクションのリスクを回避できます。

Wrappers

MyBatis-Plus は Wrappers クラスを提供しています。これは静的ファクトリクラスであり、QueryWrapper、UpdateWrapper、LambdaQueryWrapper、LambdaUpdateWrapper のインスタンスを素早く作成するために使用されます。Wrappers を使用することで、コード量を削減し、開発効率を向上させることができます。

例:

// QueryWrapper の作成
QueryWrapper<User> queryWrapper = Wrappers.query();
queryWrapper.eq("name", "张三");


// LambdaQueryWrapper の作成
LambdaQueryWrapper<User> lambdaQueryWrapper = Wrappers.lambdaQuery();
lambdaQueryWrapper.eq(User::getName, "张三");


// UpdateWrapper の作成
UpdateWrapper<User> updateWrapper = Wrappers.update();
updateWrapper.set("name", "李四");


// LambdaUpdateWrapper の作成
LambdaUpdateWrapper<User> lambdaUpdateWrapper = Wrappers.lambdaUpdate();
lambdaUpdateWrapper.set(User::getName, "李四");

スレッド安全性

Wrapper インスタンスはスレッドセーフではありません。そのため、使用するたびに新しい Wrapper インスタンスを作成することを推奨します。これにより、マルチスレッド環境におけるデータ競合や潜在的なエラーを回避できます。

例：

// 各メソッドまたはリクエストで新しい Wrapper インスタンスを作成
public List<User> getUsersByName(String name) {
    QueryWrapper<User> queryWrapper = Wrappers.query();
    queryWrapper.eq("name", name);
    return userMapper.selectList(queryWrapper);
}

これらのベストプラクティスに従うことで、開発者は MyBatis-Plus の Wrapper 条件コンストラクターをより安全かつ効率的に使用し、安全で保守性の高いデータベース操作コードを構築できます。

Wrapper を使用したカスタム SQL

MyBatis-Plus は強力な Wrapper 条件構築器を提供しており、開発者がより複雑なデータベースクエリのニーズを満たすために、カスタム SQL 文を定義することができます。この機能を使用するには、mybatis-plus のバージョンが 3.0.7 以上であることを確認してください。

注意事項

  • バージョン要件：カスタム SQL 機能をサポートするために、プロジェクトで使用している mybatis-plus のバージョンが少なくとも 3.0.7 であることを確認してください。
  • パラメータ名：カスタム SQL を使用する際、Wrapper オブジェクトをパラメータとして渡すときは、パラメータ名を ew とするか、アノテーション @Param(Constants.WRAPPER) を使用してパラメータが Wrapper オブジェクトであることを明示的に指定する必要があります。
  • ${ew.customSqlSegment} の使用：SQL 文内で ${ew.customSqlSegment} を使用して、Wrapper オブジェクトが生成した SQL フラグメントを参照します。
  • エンティティベースの where 文はサポートされていません：カスタム SQL を使用する際、Wrapper オブジェクトはエンティティクラスに基づいて自動的に where 句を生成しません。完全な SQL 文を手動で記述する必要があります。

例

以下は、Wrapper を使用したカスタム SQL の例です：

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import org.apache.ibatis.annotations.Param;


public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT * FROM user ${ew.customSqlSegment}")
    List<User> selectByCustomSql(@Param(Constants.WRAPPER) Wrapper<User> wrapper);
}

上記の例では、selectByCustomSql メソッドを定義しています。このメソッドはカスタム SQL 文を使用し、${ew.customSqlSegment} を通じて Wrapper オブジェクトが生成した SQL フラグメントを導入しています。

使用方法

カスタム SQL を使用するには、上記のメソッドを呼び出し、Wrapper オブジェクトを渡します：

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "张三");


List<User> userList = userMapper.selectByCustomSql(queryWrapper);

この例では、selectByCustomSql メソッドは、渡された queryWrapper オブジェクトによって生成された where 条件を含むクエリを実行します。

この方法により、MyBatis-Plus の Wrapper 機能とカスタム SQL を柔軟に組み合わせて、さまざまな複雑なデータベース操作のニーズを満たすことができます。

Kotlinにおける永続化オブジェクト定義のベストプラクティス

Kotlinで永続化オブジェクトを定義する際には、コードの明確性と保守性を確保するために、いくつかのベストプラクティスに従うべきです。以下は、MyBatis-Plusを使用した永続化オブジェクトの定義方法を示す例です：

@TableName("sys_user")
class User {
    @TableId(type = IdType.AUTO)
    var id: Int? = null


    @TableField("username")
    var name: String? = null


    var roleId: Int? = null
}

注意：上記のコードにおける@TableIdおよび@TableFieldアノテーションは、MyBatis-Plusの使用方法を示すためのものであり、必須ではありません。すべてのメンバ変数は、JavaにおけるupdateSelectiveのようなシナリオで使用できるように、nullable型として定義し、初期値としてnullを設定する必要があります。

data classや全パラメータコンストラクタの使用は推奨されません。これは、空のオブジェクトを作成する際に不必要なnull値を提供しなければならない可能性があるためです。

アノテーションを使用したクエリ

@Select("select * from mysql_data ${ew.customSqlSegment}")
List<MysqlData> getAll(@Param(Constants.WRAPPER) Wrapper wrapper);

XMLを使用したクエリ設定

List<MysqlData> getAll(Wrapper ew);
<select id="getAll" resultType="MysqlData">
    SELECT * FROM mysql_data ${ew.customSqlSegment}
</select>

KotlinでのWrapper使用

KotlinはQueryWrapperとUpdateWrapperをサポートしていますが、LambdaQueryWrapperとLambdaUpdateWrapperはサポートしていません。LambdaスタイルのWrapperを使用する必要がある場合は、KtQueryWrapperとKtUpdateWrapperを使用できます。

参考例：

val queryWrapper = KtQueryWrapper(User()).eq(User::name, "sss").eq(User::roleId, "sss2")
userMapper!!.selectList(queryWrapper)


val updateConditionWrapper = KtUpdateWrapper(User()).eq(User::name, "sss").eq(User::roleId, "sss2")
val updateRecord = User()
updateRecord.name = "newName"
userMapper!!.update(updateRecord, updateConditionWrapper)


val updateRecord = User()
updateRecord.id = 2
updateRecord.name = "haha"
userMapper.updateById(updateRecord)

チェーンメソッド呼び出しとラムダ式呼び出し

MyBatis-Plusは2種類のチェーンメソッド呼び出しスタイルを提供しています：通常のチェーンメソッド呼び出しとラムダ式チェーンメソッド呼び出しです。注意点として、ラムダ式チェーンメソッド呼び出しはKotlinではサポートされていません。

// 通常のチェーンメソッド呼び出し
UpdateChainWrapper<T> update();
// ラムダ式チェーンメソッド呼び出し（Kotlinではサポートされていません）
LambdaUpdateChainWrapper<T> lambdaUpdate();


// 同等の例：
query().eq("id", value).one();
lambdaQuery().eq(Entity::getId, value).one();


// 同等の例：
update().eq("id", value).remove();
lambdaUpdate().eq(Entity::getId, value).remove();

これらのベストプラクティスに従うことで、Kotlinにおける永続化オブジェクトの定義を明確かつ保守しやすい状態に保ちながら、MyBatis-Plusが提供する機能を十分に活用することができます。

Baomidou

© 2016-2025 Baomidou™. All Rights Reserved.

Power by Astro Starlight | Sponsored by JetBrains

渝ICP备2021000141号-1 | 渝公网安备50011302222097