MybatisPlus與前端分頁工具結合實現
雖然MybatisPlus提供了PaginationInnerInterceptor插件用來分頁，并且該插件使用起來也還不錯，但是我們開發項目的時候總是希望前后端搭配干活，實現一些好用的功能。
比如說前端表單點擊表頭排序，這個功能我們就可以結合分頁插件完成。而且我們現在很多時候會開發多端項目，在不同前端使用不同組件適配后端接口的時候，總可能遇到命名方式不一致的問題，比如A前端框架中當前頁叫currPage，B框架中叫page等情況?；谶@樣的實際情況，我們需要對項目中MybatisPlus的分頁進行一定程度的封裝，讓它能滿足我們不同情況下的實際需要。
首先是分頁插件的配置
@Configuration
public class MPConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
配置好分頁插件以后MybatisPlus就支持分頁了，可以使用service的page方法或者mapper的selectPage方法進行分頁。這兩個方法都需要傳入
com.baomidou.mybatisplus.extension.plugins.pagination.Page對象，這個對象也就是實際用來分頁的參數對象了。我們可以在這個對象中設置分頁的頁數，每頁的數據數量，同時也可以設置排序的字段、排序的方式。但是排序字段是直接通過字符串連接的方式填寫在sql中的，所以是存在sql注入的風險的，所以我們需要個過濾SQL注入工具類，我參考了JeecgBoot中的工具類，稍作修改
@Slf4j
public class SqlUtil {
private final static String xssStr = "'|and |exec |insert |select |delete |update |drop |count |chr |mid |master |truncate |char |declare |;|or |+";
public static void injection(String value) {
if (value == null || "".equals(value)) {
return;
}
value = value.toLowerCase();
String[] xssArr = xssStr.split("\\|");
for (String xss:xssArr) {
if(value.contains(xss)){
log.error("可能存在SQL注入風險：存在SQL注入關鍵詞[{}] 值[{}]",xss,value);
throw new RuntimeException("請注意，值可能存在SQL注入風險!--->" + value);
}
}
}
public static void injection(String[] values) {
String[] xssArr = xssStr.split("\\|");
for (String value : values) {
if (value == null || "".equals(value)) {
return;
}
value = value.toLowerCase();
for (String xss:xssArr) {
if(value.contains(xss)){
log.error("可能存在SQL注入風險：存在SQL注入關鍵詞[{}] 值[{}]",xss,value);
throw new RuntimeException("請注意，值可能存在SQL注入風險!--->" + value);
}
}
}
}
}
com.baomidou.mybatisplus.extension.plugins.pagination.Page這個分頁工具只是提供了分頁的功能，但是并不能很方便的直接拿來使用，所以我封裝了一個工具類，用來通過我們寫好的配置從參數中獲取分頁需要的信息以及配合前端Table排序的參數信息，并且過濾了SQL注入
public class Constant {
/**
* 當前頁碼
*/
public static final String PAGE = "page";
/**
* 每頁顯示記錄數
*/
public static final String LIMIT = "pageSize";
/**
* 排序字段
*/
public static final String ORDER_FIELD = "prop";
/**
* 排序方式
*/
public static final String ORDER = "order";
/**
* 升序
*/
public static final String ASC = "ascending";
}
public class PageParams<T> extends Page<T>{
public PageParams(Map<String,Object> params){
super(getCurrPage(params),getPageSize(params));
// 排序
String orderField = (String)params.get(Constant.ORDER_FIELD);
String order = (String)params.get(Constant.ORDER);
if(StrUtil.isNotEmpty(orderField) && StrUtil.isNotEmpty(order)){
// SQL 注入過濾
SqlUtil.injection(orderField);
// 設置排序方式
if(Constant.ASC.equals(order)){
addOrder(OrderItem.asc(orderField));
}else {
addOrder(OrderItem.desc(orderField));
}
}
}
public PageParams(){
super(getCurrPage(null),getPageSize(null));
}
private static Long getCurrPage(Map<String,Object> params){
if(params != null && params.get(Constant.PAGE) != null){
return Long.parseLong((String)params.get(Constant.PAGE));
}
return 1L;
}
private static Long getPageSize(Map<String,Object> params){
if(params != null && params.get(Constant.LIMIT) != null){
return Long.parseLong((String)params.get(Constant.LIMIT));
}
return 10L;
}
}
相同的，不同的Table框架中接收的數據格式也有一些差別，我們分頁方法返回的
com.baomidou.mybatisplus.core.metadata.IPage也不能滿足我們的格式要求。所以根據實際情況封裝一個工具類，用來返回我們需要的數據格式
@Data
public class PageResult implements Serializable {
public PageResult(IPage<?> page){
this.page = page.getCurrent();
this.pageSize = page.getSize();
this.total = page.getTotal();
this.rows = page.getRecords();
}
private Long page;
private Long pageSize;
private Long total;
private List<?> rows;
}
最后分頁調用的時候就變得簡單了
@GetMapping("/list")
public SaResult list(@RequestParam Map<String,Object>params){
IPage<SysUserEntity> page = userService.page(new PageParams<SysUserEntity>(params),new LambdaQueryWrapper<SysUserEntity>());
return SaResult.data(new PageResult(page));
}
