快捷導(dǎo)航

MyBatis-Plus中使用Wrapper自定義SQL的詳細(xì)步驟

更新時(shí)間：2025年07月11日 10:55:32 作者：野犬寒鴉

在 MyBatis-Plus 中使用 Wrapper 自定義 SQL 可以靈活組合條件并復(fù)用條件邏輯,通過 ${ew.customSqlSegment} 占位符注入 Wrapper 生成的 SQL 片段,本文給大家介紹了詳細(xì)步驟和示例,需要的朋友可以參考下

核心步驟

Mapper 接口定義方法 使用 @Param("ew") 注解聲明 Wrapper 參數(shù)，在 SQL 中通過 ${ew.customSqlSegment} 引用條件。
XML 或注解編寫 SQL 在 SQL 中嵌入 ${ew.customSqlSegment}，MyBatis-Plus 會(huì)自動(dòng)替換為 Wrapper 生成的 WHERE 語(yǔ)句（包含 WHERE 關(guān)鍵字）。
Wrapper 構(gòu)建條件 使用 QueryWrapper/LambdaQueryWrapper 組裝條件，注意字段名與 SQL 中的別名一致。

示例一：XML 方式實(shí)現(xiàn)自定義 SQL

1. Mapper 接口聲明

public interface UserMapper extends BaseMapper<User> {
    // 使用 @Param("ew") 定義 Wrapper 參數(shù)
    List<User> selectUserList(@Param("ew") Wrapper<User> wrapper);
}

2. XML 映射文件（如 UserMapper.xml）

<select id="selectUserList" resultType="User">
    SELECT id, name, age, email 
    FROM user 
    ${ew.customSqlSegment} <!-- 自動(dòng)注入 WHERE 及條件 -->
</select>

3. 使用 Wrapper 構(gòu)建查詢

QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like("name", "張")       // 模糊查詢 name 包含"張"
       .gt("age", 20)            // age > 20
       .orderByDesc("create_time"); // 按創(chuàng)建時(shí)間倒序
 
List<User> users = userMapper.selectUserList(wrapper);

生成的 SQL：

SELECT id, name, age, email 
FROM user 
WHERE name LIKE '%張%' AND age > 20 
ORDER BY create_time DESC

示例二：注解方式實(shí)現(xiàn)自定義 SQL

Mapper 接口直接寫 SQL

@Select("SELECT * FROM user ${ew.customSqlSegment}")
List<User> selectByWrapper(@Param("ew") Wrapper<User> wrapper);

示例三：聯(lián)表查詢 + Wrapper

1. Mapper 接口

List<UserVO> selectUserWithRole(@Param("ew") Wrapper<User> wrapper);

2. XML 映射文件

<select id="selectUserWithRole" resultType="UserVO">
    SELECT u.*, r.role_name 
    FROM user u
    LEFT JOIN role r ON u.role_id = r.id
    ${ew.customSqlSegment} <!-- 注入條件 -->
</select>

3. 使用 LambdaWrapper（避免硬編碼字段名）

LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
wrapper.like(User::getName, "王")     // 使用實(shí)體類方法引用
       .eq(User::getStatus, 1)        // status = 1
       .nested(i -> i.gt(User::getAge, 18).or().isNotNull(User::getEmail)); // 嵌套條件
 
List<UserVO> list = userMapper.selectUserWithRole(wrapper);

生成的 SQL：

SELECT u.*, r.role_name 
FROM user u 
LEFT JOIN role r ON u.role_id = r.id 
WHERE (
    name LIKE '%王%' 
    AND status = 1 
    AND (age > 18 OR email IS NOT NULL)
)

注意事項(xiàng)

防止 SQL 注入 ${ew.customSqlSegment} 內(nèi)部使用預(yù)編譯安全處理，但避免在 SQL 中直接拼接 ${xxx}（除 MyBatis-Plus 官方占位符外）。
表別名問題 若 SQL 中使用別名（如 u.name），Wrapper 條件需同步聲明別名：

wrapper.like("u.name", "張"); // XML 中表別名為 u

空 Wrapper 處理 若 Wrapper 無(wú)條件，${ew.customSqlSegment} 生成空字符串，SQL 仍合法。
復(fù)雜 SQL 場(chǎng)景 如需分組、聚合函數(shù)等，直接在 SQL 中編寫，Wrapper 僅負(fù)責(zé) WHERE 條件部分。

總結(jié)

核心占位符：${ew.customSqlSegment} 注入動(dòng)態(tài)條件。
條件構(gòu)造：通過 QueryWrapper 或 LambdaWrapper 構(gòu)建樹狀條件（支持 and/or 嵌套）。
安全機(jī)制：MyBatis-Plus 自動(dòng)處理參數(shù)預(yù)編譯，防止注入風(fēng)險(xiǎn)。

此方案完美契合 MyBatis-Plus 設(shè)計(jì)哲學(xué)，在保留原生 MyBatis 靈活性的同時(shí)，極大簡(jiǎn)化動(dòng)態(tài) SQL 編寫。

以上就是MyBatis-Plus中使用Wrapper自定義SQL的詳細(xì)步驟的詳細(xì)內(nèi)容，更多關(guān)于MyBatis-Plus Wrapper自定義SQL的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: