cn.bootx.platform.common.mybatisplus.util.MpUtil Maven / Gradle / Ivy
The newest version!
package cn.bootx.platform.common.mybatisplus.util;
import cn.bootx.platform.common.core.annotation.BigField;
import cn.bootx.platform.common.core.function.EntityBaseFunction;
import cn.bootx.platform.common.core.rest.PageResult;
import cn.bootx.platform.common.core.rest.param.PageParam;
import cn.bootx.platform.common.mybatisplus.base.MpBaseEntity;
import cn.bootx.platform.common.mybatisplus.base.MpCreateEntity;
import cn.bootx.platform.common.mybatisplus.base.MpDelEntity;
import cn.bootx.platform.common.mybatisplus.base.MpIdEntity;
import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.collection.ListUtil;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.IdUtil;
import com.baomidou.mybatisplus.core.metadata.TableFieldInfo;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import com.baomidou.mybatisplus.core.metadata.TableInfoHelper;
import com.baomidou.mybatisplus.core.toolkit.Assert;
import com.baomidou.mybatisplus.core.toolkit.LambdaUtils;
import com.baomidou.mybatisplus.core.toolkit.support.ColumnCache;
import com.baomidou.mybatisplus.core.toolkit.support.LambdaMeta;
import com.baomidou.mybatisplus.core.toolkit.support.SFunction;
import com.baomidou.mybatisplus.extension.conditions.query.LambdaQueryChainWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.apache.ibatis.reflection.property.PropertyNamer;
import java.lang.reflect.Method;
import java.time.LocalDateTime;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.stream.Collectors;
/**
* MP工具类
*
* @author xxm
* @since 2020/4/21 10:00
*/
public class MpUtil {
/**
* mp page转换为 PageResult 同时进行dto转换
*/
public static PageResult convert2DtoPageResult(Page> page) {
if (Objects.isNull(page)) {
return new PageResult<>();
}
List collect = page.getRecords().stream().map(EntityBaseFunction::toDto).collect(Collectors.toList());
// 构造 PageResult 对象
return new PageResult().setSize(page.getSize())
.setCurrent(page.getCurrent())
.setTotal(page.getTotal())
.setRecords(collect);
}
/**
* page转换为 PageResult
*/
public static PageResult convert2PageResult(Page page) {
if (Objects.isNull(page)) {
return new PageResult<>();
}
// 构造 PageResult 对象
return new PageResult().setSize(page.getSize())
.setCurrent(page.getCurrent())
.setTotal(page.getTotal())
.setRecords(page.getRecords());
}
/**
* 获取分页对象 MyBatis-Plus
*/
public static Page getMpPage(PageParam page, Class clazz) {
return Page.of(page.getCurrent(), page.getSize());
}
/**
* 获取行名称
* @param function 对象字段对应的读取方法的Lambda表达式
* @return 字段名
*/
public static String getColumnName(SFunction function) {
LambdaMeta meta = LambdaUtils.extract(function);
Map columnMap = LambdaUtils.getColumnMap(meta.getInstantiatedClass());
Assert.notEmpty(columnMap, "错误:无法执行.因为无法获取到实体类的表对应缓存!");
String fieldName = PropertyNamer.methodToProperty(meta.getImplMethodName());
ColumnCache columnCache = columnMap.get(LambdaUtils.formatKey(fieldName));
return columnCache.getColumn();
}
/**
* 获取行名称
* @param readMethod 对象字段对应的读取方法对象
* @param clazz 实体类类型. 辅助进行判断, 传多个只有第一个生效，可以为空, 为空时使用读取方法对应的Class类，
* @return 字段名
*/
@SafeVarargs
public static String getColumnName(Method readMethod, Class... clazz) {
Class beanClass;
if (ArrayUtil.isNotEmpty(clazz)) {
beanClass = clazz[0];
}
else {
beanClass = readMethod.getDeclaringClass();
}
Map columnMap = LambdaUtils.getColumnMap(beanClass);
Assert.notEmpty(columnMap, "错误:无法执行.因为无法获取到实体类的表对应缓存!");
String fieldName = PropertyNamer.methodToProperty(readMethod.getName());
ColumnCache columnCache = columnMap.get(LambdaUtils.formatKey(fieldName));
return columnCache.getColumn();
}
/**
* 批量执行语句, 通常用于for循环方式的批量插入
*/
public static void executeBatch(List saveList, Consumer> consumer, int batchSize) {
// 开始游标
int start = 0;
// 结束游标
int end = Math.min(batchSize, saveList.size());
while (start < end) {
List list = ListUtil.sub(saveList, start, end);
start = end;
end = Math.min(end + batchSize, saveList.size());
consumer.accept(list);
}
}
/**
* 初始化数据库Entity, 通常配合 executeBatch 使用
* @param entityList 对象列表
* @param userId 用户id, 可以为空
* @param 泛型 MpIdEntity
*/
public static void initEntityList(List entityList, Long userId) {
for (MpIdEntity t : entityList) {
// 设置id
t.setId(IdUtil.getSnowflakeNextId());
if (t instanceof MpCreateEntity) {
MpCreateEntity entity = (MpCreateEntity) t;
entity.setCreator(userId);
entity.setCreateTime(LocalDateTime.now());
}
if (t instanceof MpDelEntity) {
MpDelEntity entity = (MpDelEntity) t;
entity.setLastModifier(userId);
entity.setLastModifiedTime(LocalDateTime.now());
entity.setVersion(0);
}
if (t instanceof MpBaseEntity) {
MpBaseEntity entity = (MpBaseEntity) t;
entity.setDeleted(false);
}
}
}
/**
* 字段是否存在长文本注解
*/
public static boolean excludeBigField(TableFieldInfo tableFieldInfo) {
BigField annotation = tableFieldInfo.getField().getAnnotation(BigField.class);
return Objects.isNull(annotation);
}
/**
* 获取的一条数据, 有多条取第一条
*/
public static Optional findOne(LambdaQueryChainWrapper lambdaQuery) {
Page mpPage = new Page<>(0, 1);
Page page = lambdaQuery.page(mpPage);
// 关闭 count 查询
page.setSearchCount(false);
if (CollUtil.isNotEmpty(page.getRecords())) {
return Optional.of(page.getRecords().get(0));
}
return Optional.empty();
}
/**
* 获取关联的 TableInfo
*/
public static TableInfo getTableInfo(String tableName) {
for (TableInfo tableInfo : TableInfoHelper.getTableInfos()) {
if (tableName.equalsIgnoreCase(tableInfo.getTableName())) {
return tableInfo;
}
}
return null;
}
}