mybatis-Plus 之 apply 拼接SQL

apply 拼接SQL

本章节将介绍 apply 方法，该方法用来拼接 SQL 语句。它可用于动态的给数据库函数传入参，例如：

apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2020-10-08")

上面 apply 函数将使用后面的“2020-10-08”参数替换第一个参数中的 {0}。因此，替换后的 SQL 语句如下：

date_format(dateColumn,’%Y-%m-%d’) = ‘2020-10-08’")
像上面这样做，可以避免 SQL 注入风险。如果你不想上面这样做，很有可能会导致 SQL 风险。

apply 方法定义

apply(String applySql, Object... params)
apply(boolean condition, String applySql, Object... params)

参数说明：

applySql：要拼接的 SQL 语句，该 SQL 语句中可能会有 {0}、{1}、…、{n} 等字符串，用来替换参数。

params：参数列表，用于替换 applySql SQL 语句中的 {0}、{1}、…、{n} 等

condition：用于指定当前这个条件是否有效；如果为 true，则应用当前条件；如果为 false，则忽略当前条件。

实例：使用 apply 方法拼接 SQL 语句，如下：

// 拼接：id = 100
apply("id = 100");
 
// 拼接：date_format(dateColumn,'%Y-%m-%d') = '2018-08-08'")
apply("date_format(dateColumn,'%Y-%m-%d') = '2018-08-08'")
 
// 拼接：date_format(dateColumn,'%Y-%m-%d') = '2018-08-08'")
apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2018-08-08")

示例代码

package com.hxstrive.mybatis_plus.simple_mapper.condition;
 
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.hxstrive.mybatis_plus.mapper.SimpleMapper;
import com.hxstrive.mybatis_plus.model.UserBean;
import org.junit.jupiter.api.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
 
import java.util.List;
 
@RunWith(SpringRunner.class)
@SpringBootTest
class Condition15Test {
 
    @Autowired
    private SimpleMapper simpleMapper;
 
    @Test
    void contextLoads() {
        QueryWrapper<UserBean> wrapper = new QueryWrapper<>();
        wrapper.apply("date_format(borthday,'%Y-%m-%d') = {0}", "1990-10-01");
 
        List<UserBean> userBeanList = simpleMapper.selectList(wrapper);
        System.out.println("result size=" + userBeanList.size());
    }
 
}

运行上面代码，将执行如下 SQL 语句：

Preparing: SELECT user_id,name,sex,age,face,salary,borthday FROM user WHERE (date_format(borthday,'%Y-%m-%d') = ?)
Parameters: 1990-10-01(String)