Mybatis-Plus-Join（MPJ連表查詢）

子墨老师發表於2024-06-17
MyBatis

mybatis-plus作為mybatis的增強工具，它的出現極大的簡化了開發中的資料庫操作，但是長久以來，它的聯表查詢能力一直被大家所詬病。一旦遇到left join或right join的左右連線，你還是得老老實實的開啟xml檔案，手寫上一大段的sql語句

一款叫做mybatis-plus-join的工具（後面就簡稱mpj了），可以不用在xml編寫SQL就可以實現SQL的連線查詢，且使用方式類似mybatis-plus中QueryWrapper的方式來進行聯表查詢了

引入依賴庫

<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>

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

訂單表

使用者表

商品表

修改Mapper介面

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

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

此外，我們的service也可以選擇繼承MPJBaseService，serviceImpl選擇繼承MPJBaseServiceImpl，這兩者為非必須繼承

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

MPJLambdaWrapper使用

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的另一個實體類屬性

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);
}

分頁查詢

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

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
    return interceptor;
}
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);
}

相關文章