Spring AOP 实现 Excel 导出统一处理

你好，我是柳岸花开。在实际开发中，经常会遇到需要导出 Excel 数据的需求。为了避免代码重复，我们可以使用 Spring AOP（面向切面编程）来实现 Excel 导出的统一处理。本文将介绍如何使用 Spring AOP 在项目中统一处理 Excel 导出的操作，减少重复代码的编写。

1. 引言

Excel 导出是许多项目中常见的功能，但每次都编写导出逻辑会导致代码重复，降低开发效率。通过 Spring AOP，我们可以将导出逻辑进行统一处理，提高代码的可维护性和可重用性。

2. ExcelResponseAspect 类

下面是一个使用 Spring AOP 实现的 Excel 导出统一处理类 ExcelResponseAspect。该类使用了注解 @ExcelResponse 来标记需要进行 Excel 导出的方法，然后根据注解的配置来处理导出逻辑。 // ...（省略导入包和类定义）

​ @Aspect @Component @Slf4j public class ExcelResponseAspect { ​ @Pointcut("@annotation(com.uc.common.excel.annotations.ExcelResponse)") public void arroundHandlerPoinCut() { } ​ @Around(value = "arroundHandlerPoinCut()") public Object doAround(ProceedingJoinPoint pjp) throws Throwable { MethodSignature signature = (MethodSignature) pjp.getSignature(); Method method = signature.getMethod(); ExcelResponse excelResponse = method.getAnnotation(ExcelResponse.class); ​ // 获取方法参数 Object[] args = pjp.getArgs(); Object target = args[0]; ​ // 根据注解配置判断是否导出 Excel if (StringUtils.isNotBlank(excelResponse.determineExportName())) { Object exportExcel = BeanUtil.getFieldValue(target, excelResponse.determineExportName()); if (!Boolean.valueOf(String.valueOf(exportExcel))) { return pjp.proceed(); } } ​ // 如果有分页参数，设置记录数为最大 if (StringUtils.isNotBlank(excelResponse.pageSizeName())) { BeanUtil.setFieldValue(target, excelResponse.pageSizeName(), Integer.MAX_VALUE); } ​ Object result = null; try { result = pjp.proceed(); String fileName = URLEncoder.encode(excelResponse.fileName(), "UTF-8").replaceAll("\+", "%20"); HttpServletResponse response = genResponse(fileName); ​ MethodReturnValueHandler methodReturnValueHandler = excelResponse.methodReturnValueHandler().newInstance(); EasyExcel.write(response.getOutputStream(), methodReturnValueHandler.getHeaderClass()) .autoCloseStream(Boolean.FALSE) .sheet(excelResponse.sheetName()) .doWrite(methodReturnValueHandler.exactList(result)); ​ response.getOutputStream().flush(); } catch (Throwable e) { log.error("请求异常, method: {} ", method.getName(), e); } return null; } ​ // ...（省略方法） ​ public interface MethodReturnValueHandler { Class getHeaderClass(); Collection exactList(Object result); } } ​ 3. 使用 ExcelResponse 注解

要使用 ExcelResponse 注解来标记需要导出 Excel 的方法，需要在方法上添加 @ExcelResponse 注解，并配置相关属性。下面是一个示例： @ExcelResponse(fileName = "user_data", sheetName = "User Data") public List exportUserData(UserQuery userQuery) { List userList = userService.getUserList(userQuery); return userList; } ​ 在这个示例中，@ExcelResponse 注解标记了一个导出用户数据的方法，指定了 Excel 文件名为 "user_data"，工作表名称为 "User Data"。

4. 总结 通过使用 Spring AOP 和 ExcelResponseAspect 类，我们可以实现 Excel 导出的统一处理，将导出逻辑与业务逻辑分离，提高了代码的可维护性和可重用性。这对于需要频繁进行 Excel 导出的项目来说，是一个非常有用的技术。希望本文能够帮助你更好地理解 Spring AOP 和 Excel 导出的结合应用。

👇关注我，下期了解👇 ​ SpringMVC源码 ​ ​ ​ ​ 回复 222，获取Java面试题合集 ​ 关于我 ​ 一枚爱折腾的Java程序猿，专注Spring干货。把路上的问题记录下来，帮助那些和我一样的人。 ​ 好奇心强，喜欢并深入研究古天文。 ​ 崇尚 个人系统创建，做一些时间越长越有价值的事情。思考 把时间留下来 又 每刻都是新的。