多表联合查询：基于注解SQL

Posted 2022-11-29 汤圆学Java

作者：汤圆

个人博客：javalover.cc

前言

背景：Spring Boot + MybatisPlus

用MybatisPlus就是为了不写SQL，用起来方便；

但是如果需要多表联合查询，还是需要手写SQL（不过GitHub上也是有一些开源的库，可以不写SQL）

本节介绍的还是通用的写法，基于注解SQL实现的多表联合查询

简介

大概流程就是

1. 先把要联合查询的参数封装到一个类里进行返回 - 结果类
2. 再在mapper中注入SQL查询语句 - @Select
3. 最后在service中拼接查询条件 - QueryWrapper构造器（这里没用Lambda构造器，因为它不支持编写自定义的字段名)

正文

我们就按照上面的流程来演示：

先贴一下这里我们要执行的SQL查询语句：这里只贴了我们手写的部分，还有一部分是程序在后面自动追加的（比如条件、分页），这里先不写

select device.*, car.car_number from gps_device as device left join gps_car as car on device.car_id = car.car_id

1. 定义实体结果类

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class DeviceResult extends Device implements Serializable 

    /**
     * 车牌号:只有这个属性是联合Car查询的，其他属性都是Device自带的
     */
    private String carNumber;

    /**
     * 设备id
     */
    private Long deviceId;

    /**
     * 车辆id
     */
    private Long carId;

    /**
     * 设备类型：0-无线，1-有线
     */
    private Integer deviceType;

    /**
     * 设备编号
     */
    private String deviceNumber;

    /**
     * SIM卡号
     */
    private String simNumber;

可以看到，这里我们将联合查询的carNumber封装了进去，这样返回时，就可以将设备信息和车牌号一并返回（多表联合查询的目的就是这个，联合多个表的数据进行返回）

2. mapper中注入SQL语句

这里有多种方式：

• 基于注解
• 基于xml

这里我们用的是基于注解（因为Spring Boot中xml的使用还是比较少的）

DeviceMapper.java

public interface DeviceMapper extends BaseMapper<Device> 
    /**
     * 联合查询 left join car
     */
    @Select("select device.*, car.car_number from gps_device as device left join gps_car as car on device.car_id = car.car_id $ew.customSqlSegment")
    Page<DeviceResult> joinCarPage(Page<?> page, @Param(Constants.WRAPPER) Wrapper<Device> wrapper);

代码说明：

• @Select注解：注入SQL语句

• @Param(Constants.WRAPPER) Wrapper<Device> wrapper： 这个注解有点类似@RequestParam，用来代替SQL语句中的ew变量（如果把形参wrapper改为ew，就不需要加@Param注解)；

  这里的构造器wrapper中的自定义SQL会自动追加到@Select语句的后面，最后的service中会有拼接结果SQL

• BaseMapper：Mybatis-Plus的基类Mapper，封装了各种常用的数据库操作（增删改查分页等）,有了它，一些基本的操作（增删改查等）我们就不用自己去写SQL

• Page：Mybatis-Plus中的分页对象，将联合查询的数据进行分页；这里的分页相关的SQL会自动追加到wrapper包装器的后面（同上面的wrapper）

最后拼接的SQL为：

select device.*, car.car_number from gps_device as device left join gps_car as car on device.car_id = car.car_id LIMIT ?,?

其中limit ?, ?就是Page自动追加的SQL，wrapper追加的SQL在下面的service中定义

3. Service中调用mapper

此时在Service中就不能再使用Lambda表达式了，因为这里需要自定义字段名

核心代码如下：

QueryWrapper<Device> queryWrapper = new QueryWrapper<>();
queryWrapper.eq(ObjectUtil.isNotEmpty(deviceParam.getDeviceType()), "device.device_type", deviceParam.getDeviceType());
queryWrapper.like(ObjectUtil.isNotEmpty(deviceParam.getCarNumber()), "car.car_number", deviceParam.getCarNumber());

最后拼接的SQL为：（这里假设deviceType和carNumber都有传进来）

select device.*, car.car_number from gps_device as device left join gps_car as car on device.car_id = car.car_id where (device.device_number = ? and car.car_number = ?) LIMIT ?,?

总结

基于注解的多表联合查询，分三步：

1. 定义实体结果类：封装需要多表联合查询的数据
2. 在mapper中注入SQL语句
3. 在service中调用mapper，拼接where条件

后记

其实这种写法还是比较繁琐的，但好在用的不多；如果用的多，建议去找一些开源的库来整合