MyBatis-Plus聯表查詢(Mybatis-Plus-Join)的功能實現

2022-08-22 14:02:17

mybatis-plus作為mybatis的增強工具，簡化了開發中的資料庫操作。一旦遇到left join或right join的左右連線，還是得老老實實的開啟xml檔案，手寫上一大段的sql語句。今天總結一下一款叫做mybatis-plus-join的工具（後面就簡稱mpj了）,可以用類似mybatis-plus中QueryWrapper的方式來進行聯表查詢。

引入依賴

首先在專案中引入引入依賴座標，因為mpj中依賴較高版本mybatis-plus中的一些api，所以專案建議直接使用高版本。

<dependency>
   <groupId>com.github.yulichang</groupId>
   <artifactId>mybatis-plus-join</artifactId>
   <version>1.2.4</version>
</dependency>
<dependency>
   <groupId>com.baomidou</groupId>
   <artifactId>mybatis-plus-boot-starter</artifactId>
   <version>3.5.1</version>
</dependency>

引入相關依賴後，在springboot專案中，像往常一樣正常設定資料來源連線資訊就可以了。

資料準備

因為要實現聯表查詢，所以我們先來建幾張表進行測試。
訂單表：

使用者表，包含使用者姓名：

商品表，包含商品名稱和單價：

在訂單表中，通過使用者id和商品id與其他兩張表進行關聯。

修改Mapper

以往在使用myatis-plus的時候，我們的Mapper層介面都是直接繼承的BaseMapper，使用mpj後需要對其進行修改，改為繼承MPJBaseMapper介面。

@Mapper
public interface OrderMapper extends MPJBaseMapper<Order> {
}

對其餘兩個表的Mapper介面也進行相同的改造。此外，我們的service也可以選擇繼承MPJBaseService，serviceImpl選擇繼承MPJBaseServiceImpl，這兩者為非必須繼承。

查詢

Mapper介面改造完成後，我們把它注入到Service中，雖然說我們要完成3張表的聯表查詢，但是以Order作為主表的話，那麼只注入這一個對應的OrderMapper就可以，非常簡單。

@Service
@AllArgsConstructor
public class OrderServiceImpl implements OrderService {
   private final OrderMapper orderMapper;
}

MPJLambdaWrapper

不用寫sql的聯表查詢：

public void getOrder() {
   List<OrderDto> list = orderMapper.selectJoinList(OrderDto.class,
    new MPJLambdaWrapper<Order>()
     .selectAll(Order.class)
     .select(Product::getUnitPrice)
     .selectAs(User::getName,OrderDto::getUserName)
     .selectAs(Product::getName,OrderDto::getProductName)
     .leftJoin(User.class, User::getId, Order::getUserId)
     .leftJoin(Product.class, Product::getId, Order::getProductId)
     .eq(Order::getStatus,3));

   list.forEach(System.out::println);
}

呼叫介面來看一下執行結果：

成功查詢出了關聯表中的資訊，

首先，呼叫mapper的selectJoinList()方法，進行關聯查詢，返回多條結果。後面的第一個引數OrderDto.class代表接收返回查詢結果的類，作用和我們之前在xml中寫的resultType類似。

這個類可以直接繼承實體，再新增上需要在關聯查詢中返回的列即可：

@Data
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
public class OrderDto extends Order {
    String userName;
    String productName;
    Double unitPrice;
}

接下來的MPJLambdaWrapper就是構建查詢條件的核心了，看一下我們在上面用到的幾個方法：

selectAll()：查詢指定實體類的全部欄位
select()：查詢指定的欄位，支援可變長引數同時查詢多個欄位，但是在同一個select中只能查詢相同表的欄位，所以如果查詢多張表的欄位需要分開寫
selectAs()：欄位別名查詢，用於資料庫欄位與接收結果的dto中屬性名稱不一致時轉換
leftJoin()：左連線，其中第一個引數是參與聯表的表對應的實體類，第二個引數是這張表聯表的ON欄位，第三個引數是參與聯表的ON的另一個實體類屬性

除此之外，還可以正常呼叫mybatis-plus中的各種原生方法，檔案中還提到，預設主表別名是t，其他的表別名以先後呼叫的順序使用t1、t2、t3以此類推。

我們用外掛讀取紀錄檔轉化為可讀的sql語句，可以看到兩條左連線條件都被正確地新增到了sql中：

MPJQueryWrapper

和mybatis-plus非常類似，除了LamdaWrapper外還提供了普通QueryWrapper的寫法，改造上面的程式碼：

public void getOrderSimple() {
    List<OrderDto> list = orderMapper.selectJoinList(OrderDto.class,
     new MPJQueryWrapper<Order>()
      .selectAll(Order.class)
      .select("t2.unit_price","t2.name as product_name")
      .select("t1.name as user_name")
      .leftJoin("t_user t1 on t1.id = t.user_id")
      .leftJoin("t_product t2 on t2.id = t.product_id")
      .eq("t.status", "3")
    );

    list.forEach(System.out::println);
}

執行結果與之前完全相同，需要注意的是，這樣寫時在參照表名時不要使用資料庫中的原表名，主表預設使用t，其他表使用join語句中我們為它起的別名，如果使用原表名在執行中會出現報錯。

並且，在MPJQueryWrapper中，可以更靈活的支援子查詢操作，如果業務比較複雜，那麼使用這種方式也是不錯的選擇。

分頁查詢

mpj中也能很好的支援列表查詢中的分頁功能，首先我們要在專案中加入分頁攔截器：

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
    return interceptor;
}

接下來改造上面的程式碼，呼叫selectJoinPage()方法：

public void page() {
    IPage<OrderDto> orderPage = orderMapper.selectJoinPage(
      new Page<OrderDto>(2,10),
      OrderDto.class,
      new MPJLambdaWrapper<Order>()
        .selectAll(Order.class)
        .select(Product::getUnitPrice)
        .selectAs(User::getName, OrderDto::getUserName)
        .selectAs(Product::getName, OrderDto::getProductName)
        .leftJoin(User.class, User::getId, Order::getUserId)
        .leftJoin(Product.class, Product::getId, Order::getProductId)
        .orderByAsc(Order::getId));

    orderPage.getRecords().forEach(System.out::println);
}

注意在這裡需要新增一個分頁引數的Page物件，我們再執行上面的程式碼，並對紀錄檔進行解析，檢視sql語句：