MyBatis-Plus聯(lián)表查詢的短板,終于有一款工具補齊了
哈嘍大家好啊,我是Hydra。
mybatis-plus?作為mybatis?的增強工具,它的出現(xiàn)極大的簡化了開發(fā)中的數(shù)據(jù)庫操作,但是長久以來,它的聯(lián)表查詢能力一直被大家所詬病。一旦遇到left join或right join的左右連接,你還是得老老實實的打開xml文件,手寫上一大段的sql語句。
直到前幾天,偶然碰到了這么一款叫做mybatis-plus-join?的工具(后面就簡稱mpj?了),使用了一下,不得不說真香!徹底將我從xml地獄中解放了出來,終于可以以類似mybatis-plus中QueryWrapper的方式來進行聯(lián)表查詢了,話不多說,我們下面開始體驗。
引入依賴
首先在項目中引入引入依賴坐標,因為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項目中,像往常一樣正常配置數(shù)據(jù)源連接信息就可以了。
數(shù)據(jù)準備
因為要實現(xiàn)聯(lián)表查詢,所以我們先來建幾張表進行測試。
訂單表:
用戶表,包含用戶姓名:
商品表,包含商品名稱和單價:
在訂單表中,通過用戶id和商品id與其他兩張表進行關聯(lián)。
修改Mapper
以往在使用myatis-plus?的時候,我們的Mapper?層接口都是直接繼承的BaseMapper?,使用mpj?后需要對其進行修改,改為繼承MPJBaseMapper接口。
@Mapper
public interface OrderMapper extends MPJBaseMapper<Order> {
}
對其余兩個表的Mapper?接口也進行相同的改造。此外,我們的service?也可以選擇繼承MPJBaseService,serviceImpl?選擇繼承MPJBaseServiceImpl,這兩者為非必須繼承。
查詢
Mapper?接口改造完成后,我們把它注入到Service?中,雖然說我們要完成3張表的聯(lián)表查詢,但是以Order?作為主表的話,那么只注入這一個對應的OrderMapper就可以,非常簡單。
@Service
@AllArgsConstructor
public class OrderServiceImpl implements OrderService {
private final OrderMapper orderMapper;
}
MPJLambdaWrapper
接下來,我們體驗一下再也不用寫sql的聯(lián)表查詢:
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);
}
不看代碼,我們先調用接口來看一下執(zhí)行結果:
可以看到,成功查詢出了關聯(lián)表中的信息,下面我們一點點介紹上面代碼的語義。
首先,調用mapper的selectJoinList()?方法,進行關聯(lián)查詢,返回多條結果。后面的第一個參數(shù)OrderDto.class?代表接收返回查詢結果的類,作用和我們之前在xml?中寫的resultType類似。
這個類可以直接繼承實體,再添加上需要在關聯(lián)查詢中返回的列即可:
@Data
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
public class OrderDto extends Order {
String userName;
String productName;
Double unitPrice;
}
接下來的MPJLambdaWrapper就是構建查詢條件的核心了,看一下我們在上面用到的幾個方法:
- selectAll():查詢指定實體類的全部字段
- select()?:查詢指定的字段,支持可變長參數(shù)同時查詢多個字段,但是在同一個select中只能查詢相同表的字段,所以如果查詢多張表的字段需要分開寫
- selectAs()?:字段別名查詢,用于數(shù)據(jù)庫字段與接收結果的dto中屬性名稱不一致時轉換
- leftJoin()?:左連接,其中第一個參數(shù)是參與聯(lián)表的表對應的實體類,第二個參數(shù)是這張表聯(lián)表的ON?字段,第三個參數(shù)是參與聯(lián)表的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);
}
運行結果與之前完全相同,需要注意的是,這樣寫時在引用表名時不要使用數(shù)據(jù)庫中的原表名,主表默認使用t?,其他表使用join語句中我們?yōu)樗鸬膭e名,如果使用原表名在運行中會出現(xiàn)報錯。
并且,在MPJQueryWrapper中,可以更靈活的支持子查詢操作,如果業(yè)務比較復雜,那么使用這種方式也是不錯的選擇。
分頁查詢
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);
}
注意在這里需要添加一個分頁參數(shù)的Page對象,我們再執(zhí)行上面的代碼,并對日志進行解析,查看sql語句:
可以看到底層通過添加limit?進行了分頁,同理,MPJQueryWrapper也可以這樣進行分頁。
最后
經過簡單的測試,個人感覺mpj?這款工具在聯(lián)表查詢方面還是比較實用的,能更應對項目中不是非常復雜的場景下的sql查詢,大大提高我們的生產效率。當然,在項目的issues中也能看到當前版本中也仍然存在一些問題,希望在后續(xù)版本迭代中能繼續(xù)完善。