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

Posted on by

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語句：

在這裡插入圖片描述

可以看到底層通過添加limit進行瞭分頁，同理，MPJQueryWrapper也可以這樣進行分頁。

最後

附上mybatis-plus-join gitee地址
代碼示例地址

到此這篇關於MyBatis-Plus聯表查詢(Mybatis-Plus-Join)的文章就介紹到這瞭,更多相關MyBatis Plus聯表查詢內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：