Mybatis-Plus：实现自定义SQL

目录

1.简介

2.自定义SQL具体实现

2.1.注解SQL

2.2.Wrapper传参+注解SQL

2.3.Wrapper传参+xml文件SQL

2.4.正常传参+XML文件SQL

3.总结

---

1.简介

        Mybatis-Plus（以下简称MBP）的初衷是为了简化开发，而不建议开发者自己写SQL语句的；但是有时客户需求比较复杂，仅使用MBP提供的Service，Mapper与Wrapper进行组合，难以实现可以需求； 这时我们就要用到自定义的SQL了。

        Java 开发使用 mybatis-plus 来执行 sql 操作，往往比 mybatis 能够省时省力，因为 mybatis-plus 封装了很多常用的接口。但对于一些更为复杂的查询来说，mybatis-plus 也相形见绌，还得需要我们自定义 sql 语句。本文就来介绍一下在使用 mybatis-plus/mybatis 的情况下，如何自定义 sql 语句、动态 sql 等。

Mybatis-Plus实现自定义的方式有以下几种：

1）注解SQL

2）Wrapper传参+注解SQL

        局限性：不适用于多表关联查询，查询字段过多代码比较凌乱

3）Wrapper传参+XML文件SQL：推荐

4）对象传参+XML文件SQL

        最传统的写法，流程过于繁琐，简单的单表查询时，配置麻烦

2.自定义SQL具体实现

2.1.注解SQL

Mybatis-plus提供了注解SQL功能，可以通过注解方式实现SQL的编写，注解SQL的前提是在Mybatis的配置文件中开启注解功能。

我们可以在Mapper的继承类中，使用完整的自定义SQL；

//多数据源情况下，@DS注解用于指定数据源
@DS("zw-mysqldb")
public interface CarMapper extends BaseMapper {
 
    @Select("select * from car where car_seq = #{carSeq}")
    Car queryCar(String carSeq);

}

   @RequestMapping("/ok")
    public void testCustomSQL2() {
 
        Car car = carMapper.queryCar("11");
        System.out.println(car.toString());
    }

补充： 

1）使用@Param注解

当以下面的方式进行写SQL语句时：

    @Select("select column from table where userid = #{userid} ")
    public int selectColumn(int userid);

当你使用了使用@Param注解来声明参数时，如果使用 #{} 或 ${} 的方式都可以。

    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);


当你不使用@Param注解来声明参数时，必须使用使用 #{}方式。如果使用 ${} 的方式，会报错。

    @Select("select column from table where userid = ${userid} ")
    public int selectColumn(@Param("userid") int userid);
 

2）不使用@Param注解

不使用@Param注解时，参数只能有一个，并且是Javabean。在SQL语句里可以引用JavaBean的属性，而且只能引用JavaBean的属性。

    // 这里id是user的属性

    @Select("SELECT * from Table where id = ${id}")
    Enchashment selectUserById(User user);

上面的代码中使用了注解SQL的方式，通过@Select注解指定了SQL语句。在方法中使用@Param注解指定参数名称，可以方便的进行参数传递，参数名称与sql参数名称一致可省略。

注解SQL的优点是代码简洁，可读性好，同时也可以结合Wrapper等方式进行复杂的SQL构建。

2.2.Wrapper传参+注解SQL

使用Wrapper方式的一些使用场景：

1）动态查询：使用Wrapper可以根据不同的查询条件，动态地拼接SQL语句，实现精确查询。

2）多表联合查询：在多表联合查询时，使用Wrapper可以方便地拼接SQL语句，实现多表联合查询。

3）分页查询：在分页查询时，使用Wrapper可以方便地拼接SQL语句，实现分页功能。

4）条件查询：使用Wrapper可以根据不同的条件，动态地拼接SQL语句，实现条件查询。

5）排序查询：使用Wrapper可以方便地拼接SQL语句，实现排序功能

使用SQL结合Wrapper进行复杂的SQL构建时，通常需要完成以下几个步骤：

a）创建Wrapper对象

通过创建Wrapper对象，可以方便地进行SQL构建和条件设置。下面是创建Wrapper对象的示例代码：

QueryWrapper wrapper = new QueryWrapper<>(); 

b）设置查询条件

可以使用Wrapper对象的方法设置查询条件，例如eq、ne等方法可以设置等于、不等于等条件。下面是设置查询条件的示例代码：

wrapper.eq("column1", value1)
       .ne("column2", value2)
       .like("column3", value3);

//示例
wrapper.eq("car_state", "1")
                .like("car_id", "渝A");

c）设置排序条件（非必须）

可以使用Wrapper对象的orderBy方法设置排序条件，例如orderByAsc、orderByDesc等方法可以设置升序、降序等条件。下面是设置排序条件的示例代码：

wrapper.orderByAsc("car_id")

d）设置分页条件（非必须）

可以使用Wrapper对象的方法设置分页条件，例如page方法可以设置页码和每页大小等条件。下面是设置分页条件的示例代码：

Page resultPage = new Page<>(1, 10);
carMapper.selectByPrimaryKey(resultPage,wrapper)

e）mapper接口

@Select("select * from car ${ew.customSqlSegment}")
Page selectByPrimaryKey(Page page, @Param(Constants.WRAPPER) QueryWrapper queryWrapper);

f）执行SQL操作

接口的方法执行SQL操作，例如selectList、selectPage等方法可以执行SQL查询操作，也可以自定义查询。下面是执行SQL操作的示例完整代码：

//分页查询方式1
QueryWrapper wrapper = new QueryWrapper<>();
Page resultPage = new Page<>(1, 10);

wrapper.eq("car_state", "1")
       .like("car_id", "渝A")
       .orderByAsc("car_id");//排序
carMapper.selectByPrimaryKey(resultPage,wrapper);


//分页查询方式2
IPage page = new Page<>(1, 10); // 分页查询
LambdaQueryWrapper qw = new LambdaQueryWrapper()
     .like(Car::getCarId, "渝A") // 车牌号 =
     .eq(Car::getCarState, 1); // 状态

//selectPage是BaseMapper自带方法
IPage userPage = carMapper.selectPage(page, qw);

注意：

1）QueryWrapper中使用自定义uservo类，不能使用LambdaQueryWrapper 

2）上边涉及到 IPage 和 Page 都可以用用于分页，这里就涉及到MybatisPlus的几种方式问题

xml文件

g）执行结果：

补充：

在实际应用中，我们还可以使用LambdaQueryWrapper和QueryWrapper实现更多复杂的查询操作，以满足不同的业务需求。例如，我们可以使用LambdaQueryWrapper和QueryWrapper进行动态查询，通过判断前端传入的参数，来组合SQL语句，实现灵活的查询操作 

public List getUserList(String name, Integer age) {
    LambdaQueryWrapper qw = new LambdaQueryWrapper()
            .eq(StringUtils.isNotEmpty(name), UserEntity::getName, name) // 姓名 = name
            .gt(age != null, UserEntity::getAge, age); // 年龄 > age

    return userMapper.selectList(qw);
}

以上代码中，我们通过LambdaQueryWrapper实现了动态的查询操作。如果传入的name参数不为空，那么就会添加一个等于查询条件；如果传入的age参数不为空，那么就会添加一个大于查询条件。

这样的查询操作，可以根据前端传入的参数，灵活地组合SQL语句，实现更多的业务需求。

注意：

        1）mapper方法里的@Param(Constants.WRAPPER) Wrapper query对象,Constants.WRAPPER的值就是ew。
        2）首先判断ew.emptyOfWhere是否存在where条件，有的话再拼接上去，

        3）ew.customSqlSegment该值是WHERE + sql语句，还有个ew.sqlSegment是不包括WHERE字符串

        4）${ew.customSqlSegment}是一个查询条件占位符，代表Wapper查询条件。 

当然，Mybatis-Plus提供了一些自定义SQL方法，例如selectObjs、selectByMap等，可以直接使用，例如：

List