MybatisPlus與前端分頁工具結(jié)合實(shí)現(xiàn)
雖然MybatisPlus提供了PaginationInnerInterceptor插件用來分頁，并且該插件使用起來也還不錯(cuò)，但是我們開發(fā)項(xiàng)目的時(shí)候總是希望前后端搭配干活，實(shí)現(xiàn)一些好用的功能。
比如說前端表單點(diǎn)擊表頭排序，這個(gè)功能我們就可以結(jié)合分頁插件完成。而且我們現(xiàn)在很多時(shí)候會(huì)開發(fā)多端項(xiàng)目，在不同前端使用不同組件適配后端接口的時(shí)候，總可能遇到命名方式不一致的問題，比如A前端框架中當(dāng)前頁叫currPage，B框架中叫page等情況?；谶@樣的實(shí)際情況，我們需要對項(xiàng)目中MybatisPlus的分頁進(jìn)行一定程度的封裝，讓它能滿足我們不同情況下的實(shí)際需要。
首先是分頁插件的配置
@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方法進(jìn)行分頁。這兩個(gè)方法都需要傳入
com.baomidou.mybatisplus.extension.plugins.pagination.Page對象，這個(gè)對象也就是實(shí)際用來分頁的參數(shù)對象了。我們可以在這個(gè)對象中設(shè)置分頁的頁數(shù)，每頁的數(shù)據(jù)數(shù)量，同時(shí)也可以設(shè)置排序的字段、排序的方式。但是排序字段是直接通過字符串連接的方式填寫在sql中的，所以是存在sql注入的風(fēng)險(xiǎn)的，所以我們需要個(gè)過濾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注入風(fēng)險(xiǎn)：存在SQL注入關(guān)鍵詞[{}] 值[{}]",xss,value);
throw new RuntimeException("請注意，值可能存在SQL注入風(fēng)險(xiǎn)!--->" + 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注入風(fēng)險(xiǎn)：存在SQL注入關(guān)鍵詞[{}] 值[{}]",xss,value);
throw new RuntimeException("請注意，值可能存在SQL注入風(fēng)險(xiǎn)!--->" + value);
}
}
}
}
}
com.baomidou.mybatisplus.extension.plugins.pagination.Page這個(gè)分頁工具只是提供了分頁的功能，但是并不能很方便的直接拿來使用，所以我封裝了一個(gè)工具類，用來通過我們寫好的配置從參數(shù)中獲取分頁需要的信息以及配合前端Table排序的參數(shù)信息，并且過濾了SQL注入
public class Constant {
/**
* 當(dāng)前頁碼
*/
public static final String PAGE = "page";
/**
* 每頁顯示記錄數(shù)
*/
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);
// 設(shè)置排序方式
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框架中接收的數(shù)據(jù)格式也有一些差別，我們分頁方法返回的
com.baomidou.mybatisplus.core.metadata.IPage也不能滿足我們的格式要求。所以根據(jù)實(shí)際情況封裝一個(gè)工具類，用來返回我們需要的數(shù)據(jù)格式
@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;
}
最后分頁調(diào)用的時(shí)候就變得簡單了
@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));
}
