深圳杰恩创意设计有限公司网站,如何关闭wordpress默认编辑器,网络文化经营许可证变更,上海优化公司有哪些目录 前言结构组成定义自定义注解定义导出数据的实体定义Excel导出逻辑定义导出服务注解验证总结 前言
在企业级应用中#xff0c;导入导出 Excel 文件是很常见的需求。通过使用自定义注解不仅可以实现灵活的 Excel 数据导入导出还可以减少手动配置的麻烦#xff0c;提高代码… 目录 前言结构组成定义自定义注解定义导出数据的实体定义Excel导出逻辑定义导出服务注解验证总结 前言
在企业级应用中导入导出 Excel 文件是很常见的需求。通过使用自定义注解不仅可以实现灵活的 Excel 数据导入导出还可以减少手动配置的麻烦提高代码的可读性和可维护性。本文记录了如何通过自定义注解来实现将实体类数据导出为 Excel 文件的过程适合所有有相同需求的开发者学习和参考✍✍✍ 结构组成
自定义导出Excel注解编写类时博主建议以模块化的思路来构建结构博主以如下结构来组织仅供大家参考 annotation用于存放自定义的注解所有自定义的注解可以放在这里其中创建一个Excel.java文件专门用于定义导出Excel的元数据entity用于存放实体类 用于描述业务模型或数据结构。每个实体类可以和数据库表或导出的Excel表格列对应创建一个User.java文件来加上Excel注解util用于存放工具类通常用于处理具体的操作逻辑比如生成 Excel 文件、处理文件流等。这种工具类可以重复使用并且与具体业务逻辑分离这里创建一个 ExcelExporter.java用来实现 Excel 导出逻辑service用于存放服务类负责核心业务逻辑如从数据库获取数据或者对外提供 API 的功能。这里我们创建一个 UserService.java负责定义用户数据并提供导出功能 定义自定义注解
我们首先创建一个自定义的注解 Excel用于标注需要导出到 Excel 文件中的字段。这个注解可以为每个字段提供额外的元数据例如列名、列顺序、日期格式等。 小贴士将 Excel 注解直接作用在实体类的字段上用于指定字段的导出行为和格式 package com.jianzhou.annotation;import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.IndexedColors;import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;/*** BelongsProject: pmhub-learn* BelongsPackage: com.jianzhou.annotation* Author: ZJ* CreateTime: 2024-10-19 22:16* Description: 自定义导出Excel数据注解*/
Retention(RetentionPolicy.RUNTIME)
Target(ElementType.FIELD)
public interface Excel {//Excel 列名String name() default ;//列的顺序int sort() default Integer.MAX_VALUE;//日期格式String dateFormat() default ;//列的宽度单位是字符double width() default 16;//是否需要合并单元格boolean needMerge() default false;// 单元格对齐方式HorizontalAlignment align() default HorizontalAlignment.CENTER;// 列头颜色IndexedColors headerColor() default IndexedColors.WHITE;// 单元格颜色IndexedColors cellColor() default IndexedColors.BLACK;
}
在这个注解中博主定义了几个关键属性
属性含义name导出的 Excel 列名sort列的顺序dateFormat日期格式化适用于 Date 类型字段width列的宽度needMerge是否需要合并单元格align单元格的对齐方式headerColor列头的颜色cellColor单元格的颜色
Retention(RetentionPolicy.RUNTIME) 和 Target(ElementType.FIELD) 是两个元注解它们分别控制自定义注解的生命周期和适用位置。
Retention 用于指定注解的 保留策略即在代码的哪一个阶段能够获取到注解。RetentionPolicy 是一个枚举类型它定义了注解的三种保留策略这里的 Retention(RetentionPolicy.RUNTIME) 表示 Excel 注解会保留到运行时并且可以通过反射机制获取注解信息。在导出 Excel 时我们正是通过反射读取这些注解的。
RetentionPolicy保留策略含义用途RetentionPolicy.SOURCE注解只会保留在源代码中编译时就会被丢弃注解Override只用于代码检查或提高可读性不会进入字节码文件RetentionPolicy.CLASS注解会保留到编译后的 .class 文件中但在运行时无法通过反射获取到它常见于框架内部处理这种注解仅在编译期间使用不在运行时被访问RetentionPolicy.RUNTIME注解不仅会保留到 .class 文件中还能在运行时通过反射获取到这种注解常用于需要在运行时动态获取注解信息的场景例如 Spring、Hibernate 等框架广泛使用的注解
Target 用于指定注解可以作用在程序的哪些位置。ElementType 是一个枚举定义了注解可以应用的不同代码元素。这里的 Target(ElementType.FIELD) 表示 Excel 注解只能应用于 类的字段Field 上。也就是说这个注解只能用在属性字段上不能用在类、方法或构造函数等其他地方。
注解的可应用代码元素含义ElementType.TYPE类、接口包括注解类型或枚举声明ElementType.FIELD字段声明包括枚举常量ElementType.METHOD方法声明ElementType.PARAMETER参数声明ElementType.CONSTRUCTOR构造函数声明ElementType.LOCAL_VARIABLE局部变量声明ElementType.ANNOTATION_TYPE注解类型声明ElementType.PACKAGE包声明ElementType.TYPE_PARAMETER类型参数如泛型ElementType.TYPE_USE可以用于所有的类型声明如泛型、类声明、异常声明等
interface 是 Java 中用来定义自定义注解的关键字。注解是一种特殊的接口它允许我们为程序中的元素如类、方法、字段等添加元数据metadata。通过 interface我们可以自定义自己的注解并使用这些注解来描述代码中的某些行为或特性。其中这样是定义注解的属性default表示带有默认值的注解值若没有定义默认值则使用注解时必须提供。
String name() default ;//带有默认值的属性定义导出数据的实体
然后我们定义一个测试的用户实体类代表需要导出数据的对象。在这个例子中我们定义了一个 User 实体类并在每个字段上加上 Excel 注解来指定导出的配置。 提示大家可以根据业务需求在实体类上加上自定义的 Excel 注解来控制导出的格式 package com.jianzhou.entity;import com.jianzhou.annotation.Excel;import java.util.Date;import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;/*** BelongsProject: pmhub-learn* BelongsPackage: com.jianzhou.entity* Author: ZJ* CreateTime: 2024-10-19 22:16* Description: 定义用户实体数据*/
Data
AllArgsConstructor
NoArgsConstructor
public class User {Excel(name 用户ID, sort 1)private Long userId;Excel(name 用户名, sort 2)private String userName;Excel(name 创建时间, dateFormat yyyy-MM-dd HH:mm:ss, sort 3)private Date createTime;
} 定义Excel导出逻辑
为了实现将实体类数据导出为 Excel 文件的功能博主编写了 ExcelExporter 工具类。这个类使用反射机制获取实体类中 Excel 注解的字段并根据注解配置生成 Excel 文件
package com.jianzhou.util;import java.io.FileOutputStream;
import java.lang.reflect.Field;
import java.util.List;import com.jianzhou.annotation.Excel;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;/*** BelongsProject: pmhub-learn* BelongsPackage: com.jianzhou.service* Author: ZJ* CreateTime: 2024-10-19 22:16* Description: 定义Excel导出逻辑*/
public class ExcelExporter {public static void exportExcel(List? data, Class? clazz, String filePath) throws Exception{Workbook workbook new XSSFWorkbook();Sheet sheet workbook.createSheet(Sheet1);Row headerRow sheet.createRow(0);// 通过反射机制获取实体类clazz的所有字段信息并存储在Field数组中Field[] fields clazz.getDeclaredFields();int colIdx 0;for (Field field : fields) {if (field.isAnnotationPresent(Excel.class)) {//检查字段是否有 Excel 注解Excel excel field.getAnnotation(Excel.class);//获取 Excel 注解的实例以便访问注解的属性Cell cell headerRow.createCell(colIdx);//在表头行中创建一个单元格colIdx 表示列的索引cell.setCellValue(excel.name());//设置该列的名称为注解中的 name 属性值/**设置该列的宽度宽度基于注解中的 width 属性。256 是单位转换系数因为 Apache POI 中宽度单位是 1/256 个字符*/sheet.setColumnWidth(colIdx, (int) (excel.width() * 256));colIdx;}}// 填充数据int rowIdx 1;//从第二行开始填充数据第一行是表头for (Object obj : data) {//通过遍历每个对象将其数据填充到对应的 Excel 行中Row dataRow sheet.createRow(rowIdx);colIdx 0;for (Field field : fields) {if (field.isAnnotationPresent(Excel.class)) {field.setAccessible(true); // 允许访问私有字段Object value field.get(obj);//通过反射获取该对象的字段值Cell cell dataRow.createCell(colIdx);if (value ! null) {cell.setCellValue(value.toString()); // 将字段值转换为字符串写入单元格}}}}// 输出 Excel 文件try (FileOutputStream fileOut new FileOutputStream(filePath)) {workbook.write(fileOut);}workbook.close();}
} 定义导出服务
为了模拟数据博主在 UserService 中定义了用户数据生成逻辑并调用 ExcelExporter 工具类将用户数据导出为 Excel 文件
package com.jianzhou.service;import com.jianzhou.entity.User;
import com.jianzhou.util.ExcelExporter;import java.util.ArrayList;
import java.util.Date;
import java.util.List;/*** BelongsProject: pmhub-learn* BelongsPackage: com.jianzhou.service* Author: ZJ* CreateTime: 2024-10-19 22:16* Description: 定义导出服务*/
public class UserService {public ListUser getUsers() {ListUser users new ArrayList();users.add(new User(1L, Alice, new Date()));users.add(new User(2L, Bob, new Date()));return users;}public void exportUsersToExcel(String filePath) throws Exception {ListUser users getUsers();ExcelExporter.exportExcel(users, User.class, filePath);}
}注解验证
最后我们可以通过 Main 类验证整个注解和导出逻辑是否工作正常
package com.jianzhou;import com.jianzhou.service.UserService;/*** BelongsProject: pmhub-learn* BelongsPackage: com.jianzhou* Author: ZJ* CreateTime: 2024-10-19 23:08* Description: 注解验证*/
public class Main {public static void main(String[] args) {try {UserService userService new UserService();userService.exportUsersToExcel(users.xlsx);System.out.println(Excel 文件导出成功);} catch (Exception e) {e.printStackTrace();}}
} 总结
博主通过这篇文章展示了如何通过自定义注解简化 Excel 导出的开发过程。自定义注解不仅能让代码更加简洁还能使代码具备高度的灵活性。在日常开发中这种注解机制可以大大减少重复代码同时让 Excel 导出操作更加直观和可控。希望这篇文章对大家有所帮助✊✊✊
