以JSON装备的办法去完成通用性和动态调整，当然，这个通用依然存在必定的局限性，每个项目的代码风格都不同，想要写出一个合适一切项目的通用性模块并不容易，这里的通用局限于其所在项目，所以该功用代码假如不适用于自己的项目，希望能够以此为参阅，稍作修正。
那么现在来分析一下，咱们会需求哪些JSON装备项。
导出
根底装备项
先从最简单的导出开端，被导出数据应该支撑经过业务层查出，如：Service.search(param)，这是大前提，
然后为了支撑显现导出进展，业务层还需求提供数量查询办法，如：Service.count(param)，不然无法完成导出进展。
最终导出文件名也能够定制，如：filename
由上能够得出装备项：
- serviceClazz：业务类途径，如：com.cc.service.UserService，必填
- methodName：查询办法名，如：listByCondition，必填
- countMethodName：数量查询办法名，可填，用于支撑导出进展
- filename：导出文件名
- searchParams：查询参数，数组类型，字典元素。用数组是为了支撑查询办法需求传多参数的状况
至于查询办法的参数类，不需求填，由于咱们能够经过反射去获取到该办法所需求传入的参数类型（注意，以下贴出的是要害代码，仅作参阅了解）：
Class<?> serviceClass = Class.forName(param.getServiceClazz());
// param为请求参数类
Method searchMethod = ReflectUtil.findMethodByName(serviceClass, param.getMethodName());
// 办法所需求传入的参数列表
Class<?>[] parameterTypes = searchMethod.getParameterTypes();
/**
* 经过反射从指定类中获取办法目标
*/
public static Method findMethodByName(Class<?> clazz, String name) {
Method[] methods = clazz.getMethods();
if (StringUtils.isEmpty(name)) {
return null;
}
for (Method method : methods) {
if (method.getName().equals(name)) {
return method;
}
}
return null;
}
现在咱们来想想，导出都会有哪些场景：
- 列表页的分页查询，可能是当前页数据导出，也可能是一切数据导出，这触及到分页查询
- 数据总览页的查询，通常是开发者自定义的杂乱连表查询，不需求分页
那么本文针对以上两种状况来完成第一版的通用导出功用。
列表页的分页查询
列表页的数据导出分当前页导出和一切数据导出，
假定查询流程是这样的：
- 接口层接纳参数：Controller.search(Param param)
- 业务层调用查询办法：Service.search(param)
- 耐久层拜访数据库：Mapper.search(param)
这种状况很简单，但假如流程是这样的：
- 接口层接纳参数：Controller.search(Param param)
- 业务层调用查询办法：Service.search(new Condition(param))
- 耐久层拜访数据库：Mapper.search(condition)
上面代码中，接口请求参数和耐久层参数不一致，在业务层经过了包装，那么这种状况也要兼容处理。
可是假如请求参数在业务层经过了包中包中包，那么就算了。
接着是分页参数，咱们用pageNum和pageSize来表明页码和数量字段，相似于：
{
"pageNum": 1,
"pageSize": 10,
"name": "老刘" // 此为查询字段，如查询姓名为老刘的数据
}
关于当前页导出和一切数据导出，能够用一个bool来表明：onlyCurrentPage，默许false，即导出时会自动分页查询数据，直到一切数据查询完毕，导出一切数据时分页查询很有必要，能提高功用，防止内存溢出，当onlyCurrentPage为true时，则只导出当前页面数据。
得出需求的装备项为：
- searchParam：接口分页请求参数，JSON类型，必填
- conditionClazz：条件查询类，也能够认为是包装类，如：com.cc.codition.UserCondition，可填
- onlyCurrentPage：仅当前页导出，默许false，可填
数据总览页的查询
数据总览数据没有数量查询办法，即Service.count(xxx)，也没有分页查询参数，相似于当前页导出，在也只考虑一层包装类的状况下，没有额外的装备项，上面的现已满足了，要注意的便是代码里面得把分页参数剔除去。
表头装备
一级表头
模仿一些数据来加深了解，现有一个接口是查询体系用户列表，如：/user/search，回来结果是这样的：
{
"code": 0,
"msg": "请求成功",
"data": [
{
"id": 1,
"username": "admin",
"nickname": "超管",
"phone": "18818881888",
"createTime": "2023-06-23 17:16:00"
},
{
"id": 2,
"username": "cc",
"nickname": "管理员",
"phone": "18818881888",
"createTime": "2023-06-23 17:16:00"
},
...
]
}
现在贴出EasyExcel的代码：
// 创立excel文件
try (ExcelWriter excelWriter = EasyExcel.write(path).build()) {
WriteSheet writeSheet = EasyExcel.writerSheet("sheet索引", "sheet名称").head(getHeader()).build();
excelWriter.write(getDataList(), writeSheet);
}
// 模仿表头
private static List<List<String>> getHeader() {
List<List<String>> list = new ArrayList<>();
list.add(createHead("账号"));
list.add(createHead("昵称"));
list.add(createHead("联系办法"));
list.add(createHead("注册时刻"));
return list;
}
public static List<String> createHead(String... head) {
return new ArrayList<>(Arrays.asList(head));
}
// 模仿数据
public static List<List<Object>> getDataList() {
List<List<Object>> list = new ArrayList<>();
list.add(createData("admin", "超管", "18818881888", "2023-06-23 17:16:00"));
list.add(createData("cc", "管理员", "18818881888", "2023-06-23 17:16:00"));
return list;
}
public static List<Object> createData(String... data) {
return new ArrayList<>(Arrays.asList(data));
}s
然后导出作用是这样的：
现在先别在乎作用图的excel款式，咱们后边都会进行动态装备，比方列宽、表头背景色、字体居中等。
上面咱们虽然是写死了代码，但聪明的开发者必定懂得将数据库查询来的数据转换成对应的格局，所以这段就跳过了。
现在咱们就能够得出根底的表头装备：
"customHeads": [
{
"fieldName": "username",
"fieldNameZh": "账号"
},
{
"fieldName": "nickname",
"fieldNameZh": "昵称"
},
{
"fieldName": "phone",
"fieldNameZh": "联系办法"
},
{
"fieldName": "createTime",
"fieldNameZh": "注册时刻"
}
]
也便是：
- fieldName：特点名，这样能够从回来结果的数据目标里面经过反射找到该特点以及值
- fieldNameZh：特点名肯定不合适作为表头名，添加一个中文说明来替代特点名作为表头
有了上面的根底，咱们就能够添加更多的项来完成功用的丰富性，比方
{
"fieldName": "username",
"fieldNameZh": "账号",
"width": 20, // 列宽
"backgroundColor": 1, // 表头背景色
"fontSize": 20, // 字体大小
"type": "date(yyyy-MM-dd)" // 字段类型
...
}
注：字段类型能够用作数据格局化，比方该特点是一个status状态，1表明正常，2表明异常，那么导出这个1或2是没有意义的，所以经过字段类型识别出这个状态值对应的中文描述，这样的导出才正常。
一级表头现已能够满意咱们许多场景了，可是这并不满足，我的经历中，经常需求用到两行表头甚至是杂乱表头，好在EasyExcel是支撑多级表头的。
多级表头
先贴出EasyExcel生成二级表头的示例代码：
// 模仿表头
private static List<List<String>> getHeader() {
List<List<String>> list = new ArrayList<>();
list.add(createHead("用户信息", "账号"));
list.add(createHead("用户信息", "昵称"));
list.add(createHead("用户信息", "联系办法"));
list.add(createHead("用户信息", "注册时刻"));
list.add(createHead("人物信息", "超管"));
list.add(createHead("人物信息", "管理员"));
return list;
}
public static List<String> createHead(String... head) {
return new ArrayList<>(Arrays.asList(head));
}
// 模仿数据
public static List<List<Object>> getDataList() {
List<List<Object>> list = new ArrayList<>();
list.add(createData("admin", "超管", "18818881888", "2023-06-23 17:16:00", "是", "是"));
list.add(createData("cc", "管理员", "18818881888", "2023-06-23 17:16:00", "否", "是"));
return list;
}
public static List<Object> createData(String... data) {
return new ArrayList<>(Arrays.asList(data));
}
作用是这样的：
能够看到，前面4列有一个一起表头【用户信息】，后边两列有一个一起表头【人物信息】，
从上面的示例代码咱们知道，要使表头合并，数据列表得按次序和相同表头名，这样会被EasyExcel识别到然后才有合并作用，这点需求注意。
同理，当咱们需求生成杂乱表头的时分，能够这样：
// 模仿表头
private static List<List<String>> getHeader() {
List<List<String>> list = new ArrayList<>();
list.add(createHead("导出用户数据", "用户信息", "账号"));
list.add(createHead("导出用户数据", "用户信息", "昵称"));
list.add(createHead("导出用户数据", "用户信息", "联系办法"));
list.add(createHead("导出用户数据", "用户信息", "注册时刻"));
list.add(createHead("导出用户数据", "人物信息", "超管"));
list.add(createHead("导出用户数据", "人物信息", "管理员"));
return list;
}
作用图：
定论
以上是我对导出功用的考虑和完成思路，由于篇幅的联系，我没有贴出完整的代码，可是信任以上内容现已满足大家作为参阅，短少的内容，比方列宽、色彩字体等设置，请查阅EasyExcel官方文档来完成，首要办法便是根据前端传过来的JSON装备信息，来动态装备EasyExcel的导出文件。
导入
导入分两个步骤：
- 用户下载导入模板
- 用户填内容进导入模板，然后上传模板文件到体系，完成数据导入操作
下载导入模板
导入模板只需求上面的customHeads参数即可：
"customHeads": [
{
"fieldName": "username",
"fieldNameZh": "账号"
},
{
"fieldName": "nickname",
"fieldNameZh": "昵称"
},
{
"fieldName": "phone",
"fieldNameZh": "联系办法"
},
{
"fieldName": "createTime",
"fieldNameZh": "注册时刻"
}
]
甚至fieldName都能够不要，生成一个只有表头的excel文件。
导入数据
导入数据有两种场景：
- 单表数据导入，该场景很简单
- 杂乱数据导入，触及多表，这种状况就稍微杂乱点
单表数据导入
单表只需求考虑对应实体类的特点即可，咱们能够经过反射来获取实体类的特点，所以需求的装备项是：
- modelClazz：实体类途径，如：com.cc.entity.User
装备示例：
{
"modelClazz": "com.cc.entity.User",
"customHeads": [
{
"fieldName": "username",
"fieldNameZh": "账号"
},
{
"fieldName": "nickname",
"fieldNameZh": "昵称"
},
{
"fieldName": "phone",
"fieldNameZh": "联系办法"
},
{
"fieldName": "createTime",
"fieldNameZh": "注册时刻"
}
]
}
这样在导入数据，被EasyExcel读取每一行数据的时分，能够识别到如：username项对应com.cc.entity.User类的username特点那么就能做到相似这样的事情：
User user = new User();
user.setUsername(fieldName列的值)
由此能够得到一个List<User> userList数组，再经过体系的UserService或UserMapper保存到数据库，即可完成数据导入操作。
杂乱数据导入
杂乱数据比方这种场景：excel文件中每行的数据是这样的：
| 账号 | 昵称 | 联系办法 | 注册时刻 | 人物名 |
|---|---|---|---|---|
| admin | 超管 | 18818881888 | 2023-06-23 17:16:00 | 超级管理员 |
| cc | 管理员 | 18818881888 | 2023-06-23 17:16:00 | 管理员 |
其中是否超管和是否管理员触及相关表：
- 用户表：tb_user
- 人物表：tb_role
- 用户人物相关表：tb_user_role_relation
为了支撑这种杂乱数据导入，体系内需求提供对应的保存办法：
-
新建DTO类：
第一种：
public class UserDto { private String username; private String nickname; private String phone; private Date createTime; private Boolean superAdminFlag; private Boolean adminFlag; }第二种：
public class UserDto { private User user; private Role role; }这两种DTO的状况咱们都应该考虑，第一种不必多说，上面的装备就能够应对，首要看第二种，第二种办法要考虑“途径”这个问题，所以customHeads的写法就要有所改动：
{ "modelClazz": "com.cc.model.UserDto", "customHeads": [ { "fieldName": "user.username", "fieldNameZh": "账号" }, ... ] }这样装备账号途径为：user.username，特点的反射查询就要有递归概念，先去查找UserDto类的user特点，得到该特点的类，再去获取其内的username特点，赋值办法就变成了：
UserDto dto = new UserDto(); User user = new User(); user.setUsername(fieldName列的值); dto.setUser(user);这样得到一个List<UserDto> dtoList数组。
-
既然有杂乱数据导入的业务，那么在Service业务层中，也应该编写杂乱数据的保存函数：
public interface UserService { // 单条刺进 void saveUserDto(UserDto dto); // 批量刺进 void saveUserDtoBatch(List<UserDto> dtoList); }@Service public class UserServiceImpl implements UserService { @Autowired private UserMapper userMapper; @Autowired private RoleService roleService; @Autowired private UserRoleRelationService relationService; // 业务 @Transactional(rollbackFor = Exception.class) @Override public void saveUserDto(UserDto dto) { // 保存用户 User user = userMapper.save(dto.getUser()); // 保存人物 Role role = roleService.save(dto.getRole); // 保存相关 UserRoleRelation relation = new UserRoleRelation(); relation.setUserId(user.getId()); relation.setRoleId(role.getId()); relationService.save(relation); } // 批量刺进代码省略，原理同上 void saveUserDtoBatch(List<UserDto> dtoList); } -
经过EasyExcel读取到的每一行数据都能转成UserDto目标，再经过单条或批量来保存数据，这期间有许多能够优化考虑的点，比方：
- 批量比单条保存效率高、功用好，可是批量不容易识别出部分失败的行
- 批量保存的数量不能太多，要考虑体系和数据库的功用，比方每次读取500行就履行一次保存
- 保存的进展显现，先获取excel总行数，再根据当前读取行数来计算进展，并回来给前端
- 导入时刻过长，能够做成后台任务进行，至于前端提醒能够是轮询也能够是WebSocket
所以需求指定查询办法，这装备项上面现已给出来了。
装备项总结
最终给出一个总装备项出来参阅：
导出数据装备
{
"filename": "用户数据导出",
"serviceClazz": "com.cc.service.UserService",
"methodName": "listByCondition",
"countMethodName": "countByCondition",
"searchParams": [
{
"nickname": "cc" // 查找昵称为cc的用户
}
],
"customHeads": [
{
"fieldName": "username",
"fieldNameZh": "账号",
"width": 20, // 列宽
"fontSize": 20 // 字体大小
},
{
"fieldName": "createTime",
"fieldNameZh": "注册时刻",
"type": "date(yyyy-MM-dd)" // 特点类型声明为date，而且转换成指定格局导出
}
]
}
导入模板装备
{
"filename": "用户数据导入",
"modelClazz": "com.cc.entity.User",
"customHeads": [
{
"fieldName": "username",
"fieldNameZh": "账号",
"width": 20, // 列宽
"fontSize": 20 // 字体大小
},
{
"fieldName": "createTime",
"fieldNameZh": "注册时刻",
"type": "date(yyyy-MM-dd)" // 特点类型声明为date，而且转换成指定格局导出
}
]
}
导入数据装备
{
"modelClazz": "com.cc.entity.User",
"serviceClazz": "com.cc.service.UserService",
"methodName": "save",
"customHeads": [
{
"fieldName": "username",
"fieldNameZh": "账号",
},
{
"fieldName": "createTime",
"fieldNameZh": "注册时刻",
"type": "date(yyyy-MM-dd)" // 特点类型声明为date，而且转换成指定格局导出
}
]
}
