自界说注解实现Excel 导出

概述

一个用自界说注解实现导出字段界说的工具实现。
1. 注解界说,界说导出Excel的字段

1. @Target(ElementType.FIELD)
2. @Retention(RetentionPolicy.RUNTIME)
3. public @interface PoiExportField {
4.     // Label of the column
5.     String label();
7.     // Order of the column,default 0,means the first column
8.     int order() default 0;
10.     // If true, this field will be used to create subgroup rows
11.     boolean subGroup() default false;
13.     // Width of the column
14.     int width() default 20;
16.     // Alignment of the column
17.     HorizontalAlignment align() default HorizontalAlignment.LEFT;
18. }

复制代码

2. 实体类，使用注解界说导出字段，不导出的字段不用加注解

1. @Data
2. public class OrderVO {
3.     @PoiExportUtil.PoiExportField(label = "订单编号", order = 1, align = HorizontalAlignment.CENTER)
4.     private String orderNo;
5.     @PoiExportUtil.PoiExportField(label = "订单用户", order = 2, align = HorizontalAlignment.CENTER)
6.     private String orderUser;
7.     @PoiExportUtil.PoiExportField(label = "订单时间", order = 3, align = HorizontalAlignment.CENTER)
8.     private String orderTime;
9.     @PoiExportUtil.PoiExportField(label = "订单金额", order = 4, width = 15, align = HorizontalAlignment.RIGHT)
10.     private String orderAmount;
11.     private String orderDesc;
12.     private String orderRemark;
13.     private String orderPhone;
14.     private String orderZipCode;
15.     @PoiExportUtil.PoiExportField(label = "订单国家", subGroup = true)
16.     private String orderCountry;
17.     @PoiExportUtil.PoiExportField(label = "订单省份", subGroup = true)
18.     private String orderProvince;
19.     @PoiExportUtil.PoiExportField(label = "订单城市", order = 6)
20.     private String orderCity;
21.     @PoiExportUtil.PoiExportField(label = "详细地址", order = 7)
22.     private String orderAddressDetail;
24. }

复制代码

3. Excel导出工具类，注解界说放到工具类中，方便使用

1. public class PoiExportUtil {
3.     /**
4.      * Custom annotation for exporting Excel file
5.      */
6.     @Target(ElementType.FIELD)
7.     @Retention(RetentionPolicy.RUNTIME)
8.     public @interface PoiExportField {
9.         // Label of the column
10.         String label();
12.         // Order of the column,default 0,means the first column
13.         int order() default 0;
15.         // If true, this field will be used to create subgroup rows
16.         boolean subGroup() default false;
18.         // Width of the column
19.         int width() default 20;
21.         // Alignment of the column
22.         HorizontalAlignment align() default HorizontalAlignment.LEFT;
23.     }
25.     /**
26.      * Export data to excel file
27.      *
28.      * @param list     List of data
29.      * @param fileName File name
30.      * @param <T>      Type of data
31.      */
32.     public <T> void exportToExcel(List<T> list, String fileName) {
33.         Workbook workbook = new XSSFWorkbook();
34.         Sheet sheet = workbook.createSheet("Data");
35.         writeSheet(sheet, list, null, null, null);
37.         // Write to file
38.         try (FileOutputStream fileOut = new FileOutputStream(fileName)) {
39.             workbook.write(fileOut);
40.             fileOut.flush();
41.         } catch (Exception e) {
42.             e.printStackTrace();
43.         }
44.     }
46.     /**
47.      * Write data to a sheet
48.      *
49.      * @param sheet         Sheet
50.      * @param dataList      List of data
51.      * @param headerStyle   Header style
52.      * @param subGroupStyle Subgroup style
53.      * @param dataCellStyle Data cell style
54.      * @param <T>           Type of data
55.      */
56.     public <T> void writeSheet(Sheet sheet, List<T> dataList, CellStyle headerStyle, CellStyle subGroupStyle, CellStyle dataCellStyle) {
57.         // If data list is empty, return
58.         if (dataList == null || dataList.isEmpty()) {
59.             return;
60.         }
62.         // If styles are not provided, use default styles
63.         if (headerStyle == null) {
64.             headerStyle = createDefaultHeaderStyle(sheet.getWorkbook());
65.         }
66.         if (subGroupStyle == null) {
67.             subGroupStyle = createDefaultSubGroupStyle(sheet.getWorkbook());
68.         }
69.         if (dataCellStyle == null) {
70.             dataCellStyle = createDefaultDataCellStyle(sheet.getWorkbook());
71.         }
73.         Field[] fields = dataList.get(0).getClass().getDeclaredFields();
74.         // Filter fields with PoiExportField annotation
75.         List<Field> annotatedFields = new ArrayList<>();
76.         // Filter fields with PoiExportField annotation and subGroup is true, for creating subgroup rows
77.         List<Field> subGroupFields = new ArrayList<>();
79.         // Filter fields with PoiExportField annotation and sort them by order attribute
80.         for (Field field : fields) {
81.             PoiExportField annotation = field.getAnnotation(PoiExportField.class);
82.             if (annotation != null) {
83.                 if (annotation.subGroup()) {
84.                     subGroupFields.add(field);
85.                 } else {
86.                     annotatedFields.add(field);
87.                 }
88.             }
89.         }
90.         // Sort fields by order attribute
91.         annotatedFields.sort(Comparator.comparingInt(field -> {
92.             PoiExportField annotation = field.getAnnotation(PoiExportField.class);
93.             return annotation.order();
94.         }));
96.         //annotated fields is empty, return
97.         if (annotatedFields.isEmpty()) {
98.             return;
99.         }
100.         // Create header row
101.         createHeaderRow(sheet, annotatedFields, headerStyle);
103.         // Create data rows
104.         createSheetWithData(sheet, dataList, annotatedFields, subGroupFields, subGroupStyle, dataCellStyle);
105.     }
107.     /**
108.      * Create header row
109.      *
110.      * @param sheet           Sheet
111.      * @param annotatedFields List of annotated fields
112.      * @param headerStyle     Header style
113.      */
114.     private void createHeaderRow(Sheet sheet, List<Field> annotatedFields, CellStyle headerStyle) {
115.         int lastRowNum = sheet.getLastRowNum();
116.         Row headerRow = sheet.createRow(lastRowNum + 1);
117.         for (int i = 0; i < annotatedFields.size(); i++) {
118.             Field field = annotatedFields.get(i);
119.             PoiExportField annotation = field.getAnnotation(PoiExportField.class);
120.             Cell headerCell = headerRow.createCell(i);
121.             headerCell.setCellValue(annotation.label());
122.             headerCell.setCellStyle(headerStyle);
123.             // Set column width
124.             sheet.setColumnWidth(i, annotation.width() * 256);
125.         }
126.     }
128.     /**
129.      * Create data rows
130.      *
131.      * @param sheet           Sheet
132.      * @param dataList        List of data
133.      * @param annotatedFields List of annotated fields
134.      * @param subGroupFields  List of subgroup fields
135.      * @param subGroupStyle   Subgroup style
136.      * @param dataCellStyle   Data cell style
137.      * @param <T>             Type of data
138.      */
140.     private <T> void createSheetWithData(Sheet sheet, List<T> dataList, List<Field> annotatedFields, List<Field> subGroupFields, CellStyle subGroupStyle, CellStyle dataCellStyle) {
141.         String lastSubGroupValue = null;
142.         int rowIndex = sheet.getLastRowNum() + 1;
143.         for (T data : dataList) {
144.             // Create subgroup row
145.             if (subGroupFields != null && !subGroupFields.isEmpty()) {
146.                 String currentSubGroupValue = getSubGroupValue(data, subGroupFields);
147.                 if (!currentSubGroupValue.equals(lastSubGroupValue)) {
148.                     Row subGroupRow = sheet.createRow(rowIndex++);
149.                     Cell subGroupCell = subGroupRow.createCell(0);
150.                     subGroupCell.setCellValue(currentSubGroupValue);
151.                     CellRangeAddress mergeRegion = new CellRangeAddress(rowIndex - 1, rowIndex - 1, 0, annotatedFields.size() - 1);
152.                     sheet.addMergedRegion(mergeRegion);
153.                     //CellRangeAddress  mergeRegion = sheet.getMergedRegion(sheet.getNumMergedRegions() - 1);
154.                     RegionUtil.setBorderBottom(BorderStyle.THIN, mergeRegion, sheet);
155.                     RegionUtil.setBorderTop(BorderStyle.THIN, mergeRegion, sheet);
156.                     RegionUtil.setBorderLeft(BorderStyle.THIN, mergeRegion, sheet);
157.                     RegionUtil.setBorderRight(BorderStyle.THIN, mergeRegion, sheet);
158.                     subGroupCell.setCellStyle(subGroupStyle);
159.                     lastSubGroupValue = currentSubGroupValue;
160.                 }
161.             }
162.             // Create data row
163.             Row row = sheet.createRow(rowIndex++);
164.             for (int j = 0; j < annotatedFields.size(); j++) {
165.                 Field field = annotatedFields.get(j);
166.                 PoiExportField annotation = field.getAnnotation(PoiExportField.class);
167.                 Cell cell = row.createCell(j);
168.                 try {
169.                     // Get field value from getter method
170.                     field.setAccessible(true);
171.                     String getterName = "get" + Character.toUpperCase(field.getName().charAt(0)) + field.getName().substring(1);
172.                     Method getterMethod = data.getClass().getMethod(getterName);
173.                     Object value = getterMethod.invoke(data);
174.                     if (value != null) {
175.                         cell.setCellValue(value.toString());
176.                     }
177.                     // Set cell style alignment
178.                     CellStyle cellStyle = sheet.getWorkbook().createCellStyle();
179.                     cellStyle.cloneStyleFrom(dataCellStyle);
180.                     cellStyle.setAlignment(annotation.align());
181.                     cell.setCellStyle(cellStyle);
182.                 } catch (Exception e) {
183.                     e.printStackTrace();
184.                 }
185.             }
186.         }
187.     }
189.     /**
190.      * Get subgroup value
191.      *
192.      * @param data           Data
193.      * @param subGroupFields List of subgroup fields
194.      * @param <T>            Type of data
195.      * @return Subgroup value
196.      */
197.     private <T> String getSubGroupValue(T data, List<Field> subGroupFields) {
198.         StringBuilder subGroupValue = new StringBuilder();
199.         for (Field field : subGroupFields) {
200.             try {
201.                 field.setAccessible(true);
202.                 Object value = field.get(data);
203.                 if (value != null) {
204.                     subGroupValue.append(value.toString()).append(" ");
205.                 }
206.             } catch (IllegalAccessException e) {
207.                 e.printStackTrace();
208.             }
209.         }
210.         return subGroupValue.toString().trim();
211.     }
213.     /**
214.      * Create and return default header style
215.      *
216.      * @param workbook Workbook
217.      * @return CellStyle
218.      */
219.     private CellStyle createDefaultHeaderStyle(Workbook workbook) {
220.         Font fontBold = workbook.createFont();
221.         fontBold.setBold(true);
222.         fontBold.setFontHeightInPoints((short) 12);
223.         CellStyle headerStyle = workbook.createCellStyle();
224.         headerStyle.setBorderTop(BorderStyle.THIN);
225.         headerStyle.setBorderBottom(BorderStyle.THIN);
226.         headerStyle.setBorderLeft(BorderStyle.THIN);
227.         headerStyle.setBorderRight(BorderStyle.THIN);
228.         headerStyle.setAlignment(HorizontalAlignment.CENTER);
229.         headerStyle.setVerticalAlignment(VerticalAlignment.CENTER);
230.         headerStyle.setWrapText(true);
231.         headerStyle.setFont(fontBold);
232.         return headerStyle;
233.     }
235.     /**
236.      * Create and return default subgroup style
237.      *
238.      * @param workbook Workbook
239.      * @return CellStyle
240.      */
241.     private CellStyle createDefaultSubGroupStyle(Workbook workbook) {
242.         // Create and return default subgroup style
243.         Font fontBold = workbook.createFont();
244.         fontBold.setBold(true);
245.         fontBold.setFontHeightInPoints((short) 11);
246.         CellStyle subGroupStyle = workbook.createCellStyle();
247.         subGroupStyle.setBorderTop(BorderStyle.THIN);
248.         subGroupStyle.setBorderBottom(BorderStyle.THIN);
249.         subGroupStyle.setBorderLeft(BorderStyle.THIN);
250.         subGroupStyle.setBorderRight(BorderStyle.THIN);
251.         subGroupStyle.setAlignment(HorizontalAlignment.CENTER);
252.         subGroupStyle.setVerticalAlignment(VerticalAlignment.CENTER);
253.         subGroupStyle.setFont(fontBold);
254.         return subGroupStyle;
255.     }
257.     /**
258.      * Create and return default data cell style
259.      *
260.      * @param workbook Workbook
261.      * @return CellStyle
262.      */
263.     private CellStyle createDefaultDataCellStyle(Workbook workbook) {
264.         // Create and return default data cell style
265.         CellStyle dataCellStyle = workbook.createCellStyle();
266.         Font fontBold = workbook.createFont();
267.         fontBold.setBold(true);
268.         fontBold.setFontHeightInPoints((short) 11);
269.         dataCellStyle.setBorderTop(BorderStyle.THIN);
270.         dataCellStyle.setBorderBottom(BorderStyle.THIN);
271.         dataCellStyle.setBorderLeft(BorderStyle.THIN);
272.         dataCellStyle.setBorderRight(BorderStyle.THIN);
273.         dataCellStyle.setFont(fontBold);
274.         return dataCellStyle;
275.     }
276. }

复制代码

4. 测试

1. public class PoiExportUtilTest {
2.     @Test
3.     public void exportToExcel() {
4.         PoiExportUtil poiExportUtil = new PoiExportUtil();
5.         List<OrderVO> orderVOList = generateOrders();
6.         poiExportUtil.exportToExcel(orderVOList, "order.xlsx");
7.     }
9.     public List<OrderVO> generateOrders() {
10.         String[] COUNTRIES = {"China", "Japan", "Canada"};
11.         Random RANDOM = new Random();
12.         List<OrderVO> orders = new ArrayList<>();
13.         for (int i = 0; i < 30; i++) {
14.             String orderNo = "OrderNo" + (i + 1);
15.             String orderUser = "User" + (i + 1);
16.             String orderTime = "Time" + (i + 1);
17.             String orderAmount = RANDOM.nextInt(10000) + ".00";
18.             String orderDesc = "Desc" + (i + 1);
19.             String orderRemark = "Remark" + (i + 1);
20.             String orderPhone = "Phone" + (i + 1);
21.             String orderZipCode = "ZipCode" + (i + 1);
22.             String orderCountry = COUNTRIES[RANDOM.nextInt(COUNTRIES.length)];
23.             String orderProvince = "Province" + (i + 1) % 3;
24.             String orderCity = "City" + (i + 1);
25.             String orderAddressDetail = "AddressDetail" + (i + 1);
26.             OrderVO order = createOrder(orderNo, orderUser, orderTime, orderAmount, orderDesc, orderRemark, orderPhone,
27.                     orderZipCode, orderCountry, orderProvince, orderCity, orderAddressDetail);
28.             orders.add(order);
29.         }
30.         // Sort by orderCountry and orderTime
31.         return orders.stream()
32.                 .sorted(Comparator.comparing(OrderVO::getOrderCountry)
33.                         .thenComparing(OrderVO::getOrderProvince)
34.                         .thenComparing(OrderVO::getOrderTime))
35.                 .collect(Collectors.toList());
36.     }
39.     private OrderVO createOrder(String orderNo, String orderUser, String orderTime, String orderAmount,
40.                                 String orderDesc, String orderRemark, String orderPhone, String orderZipCode,
41.                                 String orderCountry, String orderProvince, String orderCity, String orderAddressDetail) {
42.         OrderVO order = new OrderVO();
43.         order.setOrderNo(orderNo);
44.         order.setOrderUser(orderUser);
45.         order.setOrderTime(orderTime);
46.         order.setOrderAmount(orderAmount);
47.         order.setOrderDesc(orderDesc);
48.         order.setOrderRemark(orderRemark);
49.         order.setOrderPhone(orderPhone);
50.         order.setOrderZipCode(orderZipCode);
51.         order.setOrderCountry(orderCountry);
52.         order.setOrderProvince(orderProvince);
53.         order.setOrderCity(orderCity);
54.         order.setOrderAddressDetail(orderAddressDetail);
55.         return order;
56.     }
57. }

复制代码

参考源代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。