扩展若依@Excel注解，使其对字段的控制是否导出更加便捷

基于若依框架实现按角色控制 Excel 字段导出功能

一、背景介绍

在我们的项目开发中，采用了若依（RuoYi）的 Java Spring 框架进行系统搭建。若依框架提供了 @Excel 注解，通过在实体类的字段上添加该注解，能够方便地实现 Excel 数据的导出功能。然而，在实际业务场景中，领导提出了根据用户角色来控制某些字段是否导出的需求。但遗憾的是，若依自带的 @Excel 注解并不支持这一功能。为了满足这一业务需求，我们决定自行开发一套解决方案。
二、解决方案思路

为了实现按角色控制 Excel 字段导出的功能，我们的核心思路是自定义一个注解和一个导出工具类。具体步骤如下：

• 自定义注解：创建一个新的注解 RoleExcel，该注解能够标识出需要导出的字段，并且可以指定允许导出该字段的角色列表。
  
• 编写导出工具类：开发一个新的导出工具类 RoleExcelUtil，该工具类会根据当前用户的角色信息，过滤掉没有权限导出的字段，然后将有权限导出的字段数据导出到 Excel 文件中。
  
• 实体类注解应用：在需要导出和进行角色控制的实体类 JiheHandledRate 的相应字段上添加 RoleExcel 注解。
  
• 控制器调用：在控制器 JiheStationCommonController 的 exportHandledRate 方法中调用 RoleExcelUtil 工具类的导出方法，完成数据的导出操作。
  

三、具体实现步骤

3.1 自定义 RoleExcel 注解

首先，我们定义了一个 RoleExcel 注解，用于标识需要导出的字段，并支持按角色控制导出。以下是 RoleExcel 注解的代码实现：

1. package com.sdhs.common.annotation;
3. import java.lang.annotation.*;
5. /**
6. * 扩展Excel注解，支持按角色控制导出字段
7. */
8. @Target({ElementType.FIELD})
9. @Retention(RetentionPolicy.RUNTIME)
10. @Documented
11. public @interface RoleExcel {
12.     // 字段显示名称（同若依@Excel的name）
13.     String name();
15.     // 列宽（默认20）
16.     int width() default 20;
18.     // 日期格式（如"yyyy-MM-dd HH:mm:ss"）
19.     String dateFormat() default "";
21.     // 允许导出该字段的角色标识列表（如"admin","audit_role"）
22.     String[] roles() default {};
24.     // 是否允许所有角色导出（默认false）
25.     boolean allowAll() default false;
27.     // 权限标识（支持按权限控制，如"jihe:export:vehplate"）
28.     String[] permissions() default {};
29. }

复制代码

在这个注解中，我们定义了字段显示名称、列宽、日期格式、允许导出的角色列表、是否允许所有角色导出以及权限标识等属性。
3.2 编写 RoleExcelUtil 导出工具类

接下来，我们编写了 RoleExcelUtil 工具类，该工具类会根据用户角色过滤需要导出的字段，并将数据导出到 Excel 文件中。以下是 RoleExcelUtil 工具类的代码实现：

1. package com.sdhs.common.utils.poi;
3. import com.sdhs.common.annotation.RoleExcel;
4. import com.sdhs.common.core.domain.entity.SysRole;
5. import com.sdhs.common.core.domain.model.LoginUser;
6. import com.sdhs.common.utils.SecurityUtils;
7. import org.apache.poi.ss.usermodel.*;
8. import org.apache.poi.xssf.streaming.SXSSFWorkbook;
10. import javax.servlet.http.HttpServletResponse;
11. import java.io.OutputStream;
12. import java.lang.reflect.Field;
13. import java.net.URLEncoder;
14. import java.util.*;
15. import java.util.stream.Collectors;
17. /*
18. * @description:支持角色权限的Excel工具类
19. * @author: 龙谷情
20. * @date: 2025-07-08 16:39:28
21. **/
22. public class RoleExcelUtil<T> {
24.     private final Class<T> clazz;
25.     private List<ExcelColumn> excelColumns;
27.     public RoleExcelUtil(Class<T> clazz) {
28.         this.clazz = clazz;
29.         this.excelColumns = getFilteredColumns();
30.     }
32.     /**
33.      * 获取过滤后的列（根据角色权限）
34.      */
35.     private List<ExcelColumn> getFilteredColumns() {
36.         List<ExcelColumn> allColumns = new ArrayList<>();
37.         Class<?> currentClass = clazz;
39.         while (currentClass != Object.class) {
40.             Field[] fields = currentClass.getDeclaredFields();
41.             for (Field field : fields) {
42.                 RoleExcel roleExcel = field.getAnnotation(RoleExcel.class);
43.                 if (roleExcel == null) {
44.                     continue;
45.                 }
46.                 if (hasExportPermission(roleExcel)) {
47.                     allColumns.add(buildExcelColumn(field, roleExcel));
48.                 }
49.             }
50.             currentClass = currentClass.getSuperclass();
51.         }
52.         return allColumns;
53.     }
55.     /**
56.      * 检查当前用户是否有权限导出该字段
57.      */
58.     private boolean hasExportPermission(RoleExcel roleExcel) {
59.         if (roleExcel.allowAll()) {
60.             return true;
61.         }
63.         LoginUser loginUser = SecurityUtils.getLoginUser();
64.         if (loginUser == null) {
65.             return false;
66.         }
68.         // 检查角色权限
69.         String[] allowRoles = roleExcel.roles();
70.         if (allowRoles.length > 0) {
71.             List<String> userRoleKeys = loginUser.getUser().getRoles().stream()
72.                    .map(SysRole::getRoleKey)
73.                    .collect(Collectors.toList());
74.             for (String role : allowRoles) {
75.                 if (userRoleKeys.contains(role) || loginUser.getUser().isAdmin()) {
76.                     return true;
77.                 }
78.             }
79.         }
81.         return false;
82.     }
84.     /**
85.      * 构建Excel列信息
86.      */
87.     private ExcelColumn buildExcelColumn(Field field, RoleExcel roleExcel) {
88.         ExcelColumn column = new ExcelColumn();
89.         column.setField(field);
90.         column.setHeader(roleExcel.name());
91.         column.setWidth(roleExcel.width());
92.         column.setDateFormat(roleExcel.dateFormat());
93.         return column;
94.     }
96.     /**
97.      * 导出Excel文件
98.      */
99.     public void exportExcel(HttpServletResponse response, List<T> list, String title) {
100.         try (Workbook workbook = new SXSSFWorkbook(500)) {
101.             Sheet sheet = workbook.createSheet(title);
102.             setSheetStyle(sheet);
104.             // 创建表头
105.             Row headerRow = sheet.createRow(0);
106.             createHeader(headerRow);
108.             // 填充数据
109.             for (int i = 0; i < list.size(); i++) {
110.                 Row dataRow = sheet.createRow(i + 1);
111.                 fillDataRow(dataRow, list.get(i));
112.             }
114.             // 输出到客户端
115.             response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
116.             response.setCharacterEncoding("utf-8");
117.             String fileName = URLEncoder.encode(title + ".xlsx", "UTF-8").replaceAll("\\+", "%20");
118.             response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName);
120.             try (OutputStream os = response.getOutputStream()) {
121.                 workbook.write(os);
122.                 os.flush();
123.             }
124.         } catch (Exception e) {
125.             throw new RuntimeException("导出Excel失败", e);
126.         }
127.     }
129.     /**
130.      * 设置工作表样式
131.      */
132.     private void setSheetStyle(Sheet sheet) {
133.         for (int i = 0; i < excelColumns.size(); i++) {
134.             sheet.setColumnWidth(i, excelColumns.get(i).getWidth() * 256);
135.         }
136.     }
138.     /**
139.      * 创建表头
140.      */
141.     private void createHeader(Row headerRow) {
142.         CellStyle headerStyle = headerRow.getSheet().getWorkbook().createCellStyle();
143.         Font headerFont = headerRow.getSheet().getWorkbook().createFont();
144.         headerFont.setBold(true);
145.         headerStyle.setFont(headerFont);
146.         headerStyle.setAlignment(HorizontalAlignment.CENTER);
148.         for (int i = 0; i < excelColumns.size(); i++) {
149.             Cell cell = headerRow.createCell(i);
150.             cell.setCellValue(excelColumns.get(i).getHeader());
151.             cell.setCellStyle(headerStyle);
152.         }
153.     }
155.     /**
156.      * 填充数据行
157.      */
158.     private void fillDataRow(Row dataRow, T obj) throws Exception {
159.         for (int i = 0; i < excelColumns.size(); i++) {
160.             ExcelColumn column = excelColumns.get(i);
161.             Field field = column.getField();
162.             field.setAccessible(true);
164.             Cell cell = dataRow.createCell(i);
165.             Object value = field.get(obj);
167.             if (value == null) {
168.                 cell.setCellValue("");
169.                 continue;
170.             }
172.             // 处理日期类型
173.             if (value instanceof Date && !column.getDateFormat().isEmpty()) {
174.                 CellStyle style = dataRow.getSheet().getWorkbook().createCellStyle();
175.                 DataFormat format = dataRow.getSheet().getWorkbook().createDataFormat();
176.                 style.setDataFormat(format.getFormat(column.getDateFormat()));
177.                 cell.setCellStyle(style);
178.                 cell.setCellValue((Date) value);
179.                 continue;
180.             }
182.             // 处理基本类型
183.             cell.setCellValue(value.toString());
184.         }
185.     }
187.     // ExcelColumn类定义
188.     public static class ExcelColumn {
189.         private Field field;
190.         private String header;
191.         private int width;
192.         private String dateFormat;
194.         // getters/setters
195.         public Field getField() {
196.             return field;
197.         }
199.         public void setField(Field field) {
200.             this.field = field;
201.         }
203.         public String getHeader() {
204.             return header;
205.         }
207.         public void setHeader(String header) {
208.             this.header = header;
209.         }
211.         public int getWidth() {
212.             return width;
213.         }
215.         public void setWidth(int width) {
216.             this.width = width;
217.         }
219.         public String getDateFormat() {
220.             return dateFormat;
221.         }
223.         public void setDateFormat(String dateFormat) {
224.             this.dateFormat = dateFormat;
225.         }
226.     }
227. }

复制代码

在这个工具类中，getFilteredColumns 方法用于获取过滤后的列，hasExportPermission 方法用于检查当前用户是否有权限导出该字段，exportExcel 方法用于将数据导出到 Excel 文件中。
3.3 在 JiheHandledRate 实体类中添加注解

在 JiheHandledRate 实体类中，我们在需要导出和进行角色控制的字段上添加了 RoleExcel 注解。以下是 JiheHandledRate 实体类的部分代码示例：

1. package com.sdhs.jihe.domain;
3. import com.sdhs.common.annotation.RoleExcel;
4. import com.sdhs.common.utils.CalculationUtils;
5. import lombok.Data;
7. import static com.sdhs.common.utils.CalculationUtils.divide;
8. import static com.sdhs.common.utils.CalculationUtils.multiplyAndRound;
10. @Data
11. public class JiheHandledRate {
12.     private static final long serialVersionUID = 1L;
13.     /**
14.      * 运管中心名称
15.      */
16.     @RoleExcel(name = "运管中心名称", allowAll = true)
17.     private String ygcentername;
19.     /**
20.      * 总数量
21.      */
22.     @RoleExcel(name = "线索总数量", allowAll = true)
23.     private Long totalCount;
24. package com.sdhs.jihe.domain;
26. import com.sdhs.common.annotation.RoleExcel;
27. import com.sdhs.common.utils.CalculationUtils;
28. import lombok.Data;
30. import static com.sdhs.common.utils.CalculationUtils.divide;
31. import static com.sdhs.common.utils.CalculationUtils.multiplyAndRound;
33. @Data
34. public class JiheHandledRate {
35.     private static final long serialVersionUID = 1L;
36.     /**
37.      * 运管中心名称
38.      */
39.     @RoleExcel(name = "运管中心名称", allowAll = true)
40.     private String ygcentername;
42.     /**
43.      * 总数量
44.      */
45.     @RoleExcel(name = "线索总数量", allowAll = true)
46.     private Long totalCount;
48.     /**
49.      * 已处理数量
50.      */
51.     @RoleExcel(name = "已确认线索数量", allowAll = true)
52.     private Long handledCount;
54.     /**
55.      * 待处理数量
56.      */
57.     @RoleExcel(name = "待确认线索数量", allowAll = true)
58.     private Long unhandledCount;
60.     /**
61.      * 处理数量占比 描述
62.      */
63.     @RoleExcel(name = "线索确认占比", allowAll = true)
64.     private String handledPercentDesc;
66.     /**
67.      * 工单发起数量
68.      */
69.     @RoleExcel(name = "工单发起数量", roles = {"internalAuditRole", "admin"})
70.     private Long ticketCount;
72.     /**
73.      * 工单发起数量占比 描述
74.      */
75.     @RoleExcel(name = "工单发起数量占比", roles = {"internalAuditRole", "admin"})
76.     private String ticketPercentDesc;
78.     /**
79.      * 应追缴金额
80.      */
81.     @RoleExcel(name = "工单合计漏征金额（元）", roles = {"internalAuditRole", "admin"})
82.     private double owefeeYuan;
84.     // 其他字段...
85. }

复制代码

3.4 在 JiheStationCommonController 中调用导出方法

最后，在 JiheStationCommonController 的 exportHandledRate 方法中，我们调用了 RoleExcelUtil 工具类的 exportExcel 方法，完成数据的导出操作。以下是 exportHandledRate 方法的代码实现：

1. /**
2. * 导出处理率
3. */
4. @Log(title = "导出处理率", businessType = BusinessType.EXPORT)
5. @PostMapping("/exportHandledRate")
6. public void exportHandledRate(HttpServletResponse response, JiheStationCommon jiheStationCommon) {
7.     //jiheStationCommon.setIsabnormal(2);
8.     jiheStationCommon.setCurrentstatus("abnormal");
9.     jiheStationCommon.setTicketcodeFlag(2);
10.     List<JiheHandledRate> list = jiheStationCommonService.statisticHandledRate(jiheStationCommon);
11.     RoleExcelUtil<JiheHandledRate> util = new RoleExcelUtil<>(JiheHandledRate.class);
12.     util.exportExcel(response, list, "稽核车辆明细数据");
13. }

复制代码

四、总结

通过自定义 RoleExcel 注解和 RoleExcelUtil 导出工具类，我们成功实现了在若依框架中按角色控制 Excel 字段导出的功能。这种实现方式不仅满足了业务需求，还具有良好的扩展性和可维护性。在实际项目中，我们可以根据具体需求对注解和工具类进行进一步的扩展和优化，以适应更多复杂的业务场景。
希望本文对大家在实现类似功能时有所帮助，如果你在实现过程中遇到任何问题，欢迎在评论区留言交流。

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！