用poi-ooxml导出/读取Excel文件

文章展示了如何在Java项目中利用ApachePOI库,结合自定义注解来标记实体类字段,从而实现特定字段到Excel表格的导出。通过注解`@ExcelHeader`定义表头和列索引,然后在导出代码中解析这些注解以生成Excel文件。
部署运行你感兴趣的模型镜像

使用依赖

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>4.1.2</version>
</dependency>

自定义注解

注解使用在实体类上,表示哪些字段的值需要到处到 excel 表格中

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcelHeader {
    /**
     * 表头
     * @return
     */
    String value() default "";
    /**
     * 列索引
     * @return
     */
    int columnIndex() default 0;
}

实体类

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    @ExcelHeader(value = "账号")
    private String username;

    @ExcelHeader(value = "密码")
    private String password;

    @ExcelHeader(value = "生日")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime birthday;

    // 该字段没有添加注解, Excel不导出
    private Integer age;

    public User(String username, String password, LocalDateTime birthday) {
        this.username = username;
        this.password = password;
        this.birthday = birthday;
    }
}

导出代码

@Slf4j
class IdcPoiApplicationTests {

    @Test
    void contextLoads() throws NoSuchFieldException, IllegalAccessException, IOException {
        // 创建模拟数据
        User user1 = new User("admin", "123456", LocalDateTime.now());
        User user2 = new User("test", "123456", LocalDateTime.now());
        List<User> users = Arrays.asList(user1, user2);

        // 文件路径
        String basePath =  "/Users/cuishiying/Documents/spring-cloud-learning/idc-poi/oss/";
        String fileName = new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()).toString() +".xls";

        // 将Excel写入文件
        HSSFWorkbook workbook = exportExcel(users, User.class);
        workbook.setSheetName(0,"sheetName");//设置sheet的Name

        // 无论是通过HttpServletResponse导出还是导出到本地磁盘,本质都是IO操作,所以这里将IO操作提取到外层。
        workbook.write(new File(basePath + File.separator + fileName));
    }

    /**
     *
     * @param data 需要导出的数据
     * @param clz 数据对应的实体类
     * @param <T> 泛型
     * @return Excel文件
     * @throws NoSuchFieldException
     * @throws IllegalAccessException
     */
    public <T> HSSFWorkbook exportExcel(List<T> data, Class<T> clz) throws NoSuchFieldException, IllegalAccessException {

        Field[] fields = clz.getDeclaredFields();
        List<String> headers = new LinkedList<>();
        List<String> variables = new LinkedList<>();

        // 创建工作薄对象
        HSSFWorkbook workbook=new HSSFWorkbook();//这里也可以设置sheet的Name
        // 创建工作表对象
        HSSFSheet sheet = workbook.createSheet();
        // 创建表头
        Row rowHeader = sheet.createRow(0);

        // 表头处理
        //根据实体类的自定义注解来创建表头值
        for (int h = 0; h < fields.length; h++) {
            Field field = fields[h];
            if (field.isAnnotationPresent(ExcelHeader.class)) {
                // 表头
                ExcelHeader annotation = field.getAnnotation(ExcelHeader.class);
                headers.add(annotation.value());
                rowHeader.createCell(h).setCellValue(annotation.value());

                // 每个字段名
                variables.add(field.getName());
            }
        }

        // 数据处理
        for (int i = 0; i < data.size() ; i++) {

            //创建工作表的行(表头占用1行, 这里从第二行开始)
            HSSFRow row = sheet.createRow(i + 1);
            // 获取一行数据
            T t = data.get(i);
            Class<?> aClass = t.getClass();
            // 填充列数据
            for (int j = 0; j < variables.size(); j++) {

                Field declaredField = aClass.getDeclaredField(variables.get(j));
                declaredField.setAccessible(true);

                String key = declaredField.getName();
                Object value = declaredField.get(t);

                row.createCell(j).setCellValue(value.toString());
            }
        }
        log.info("Excel文件创建成功");
        return workbook;
    }

}

读取 excel

	File file = new File("C:\\user\\desktop\\文件.xlsx");
    XSSFWorkbook sheets= new XSSFWorkbook(new FileInputStream());
    //System.out.println(sheets.getNumberOfSheets());  获取总sheet表个数
    for(int i = 0; i < sheets.getNumberOfSheets(); i ++){
    	//获取单个sheet
    	XSSFSheet sheet = sheets.getSheetAt(i);
    	//获取首行
    	XSSFRow title = sheet.getRow(0);
    	
    	for(int j = 1; j < sheet.getPhysicalNumberOfRows(); j ++){
    		//获取单行
    		XSSFRow row = sheet.getRow(j);
    		//获取单个单元格
    		XSSFCell cell= row.getCell(0);
    		//设置单元格格式
    		cell.setCellType(CellType.STRING);
    		
    		...对单元格进行操作
	    }
    }

您可能感兴趣的与本文相关的镜像

Stable-Diffusion-3.5

Stable-Diffusion-3.5

图片生成
Stable-Diffusion

Stable Diffusion 3.5 (SD 3.5) 是由 Stability AI 推出的新一代文本到图像生成模型,相比 3.0 版本,它提升了图像质量、运行速度和硬件效率

<think> 我们正在讨论Apache POI的两个组件:poi-ooxmlpoi-ooxml-schemas。根据引用[1]和[2],我们可以得到以下信息: 1. poi-ooxml-lite是Apache POI处理新版Office文件格式(如.xlsx, .pptx, .docx)的基础支撑,它提供了核心的XML模式定义。在POI 5.0.0之前,这个角色是由poi-ooxml-schemas担任的。从5.0.0开始,poi-ooxml-lite取代了poi-ooxml-schemas。 2. 通常,我们在项目中引入poi-ooxml(高版本)时,Maven或Gradle会自动处理传递依赖,包括poi-ooxml-lite。因此,我们不需要单独引入poi-ooxml-schemas。 3. 需要注意的是,如果项目中还有其他依赖使用了旧版的poi-ooxml-schemas,可能会引起冲突。解决方法如引用[3]所示,排除掉旧版的poi-ooxml-schemas。 4. 引用[2]提到,POI库用于处理Office文档,包括生成报告、数据导入导出等。 5. 引用[4]展示了使用POI读取Excel单元格内容的代码示例,这属于POI的具体应用。 现在,用户想要获取poi-ooxmlpoi-ooxml-schemas的详细介绍。 根据上述信息,我们可以这样组织回答: - 先介绍poi-ooxml:它是一个用于读写Office Open XML(OOXML)格式文件(如Excel的.xlsx)的Java库。它依赖于poi-ooxml-lite(在5.0.0之前是poi-ooxml-schemas)来提供XML模式定义。 - 再介绍poi-ooxml-schemas:在POI 5.0.0之前,它包含了完整的OOXML模式定义(XSD文件),用于解析和生成OOXML文档。由于它非常大(几十MB),所以从5.0.0开始,POI团队将其替换为poi-ooxml-lite,后者只包含必要的模式定义,体积更小。 - 强调现在(5.0.0及以上版本)应该使用poi-ooxml-lite,而不再使用poi-ooxml-schemas。 - 关于依赖冲突的解决方法。 此外,我们还可以提到: - poi-ooxmlPOI项目的一部分,POI项目还包含其他组件,如poi(处理旧版Office格式,如.xls)等。 由于用户要求详细介绍,我们可以分点说明。 注意:回答中引用的部分末尾要自然地添加引用标识,如[^1]。 </think> ### Apache POI 组件详解:`poi-ooxml` 与 `poi-ooxml-schemas` #### 1. **poi-ooxml** **核心功能**: - 📌 **OOXML 文档处理引擎**:实现对 `.xlsx` (Excel)、`.docx` (Word)、`.pptx` (PPT) 等 Office Open XML 格式的读写操作[^2] - 📦 **依赖结构**: ```mermaid graph TD poi-ooxml --> poi-ooxml-lite <!-- 5.0+ 版本 --> poi-ooxml --> poi poi-ooxml-lite --> XMLBeans <!-- XML 解析核心 --> ``` - 🔧 **核心接口**: ```java // Excel 文件读写示例 XSSFWorkbook workbook = new XSSFWorkbook(); // 创建 .xlsx 文件 XSSFSheet sheet = workbook.createSheet("Data"); // 创建工作表 XSSFRow row = sheet.createRow(0); row.createCell(0).setCellValue("POI-OOXML Demo"); // 写入数据 ``` **适用场景**: - 动态生成 Excel 报表 - 解析用户上传的 Word/PPT 文档 - 批量处理 Office 文档数据[^2] --- #### 2. **poi-ooxml-schemas** **历史定位**: - 🧩 **XML 模式定义库**:包含完整的 OOXML 规范 XML Schema(3000+ XSD 文件- ⚖️ **体积问题**:完整库约 20MB(POI 4.x 及更早版本) - 🔄 **版本演进**: | POI 版本 | 组件变更 | |------------|------------------------| | ≤ 4.1.2 | poi-ooxml-schemas | | ≥ 5.0.0 | **poi-ooxml-lite** 替代 | **核心作用**: - 📐 提供 Office 文档结构的 XML 元数据约束 - 🔍 支持 XMLBeans 解析 OOXML 底层格式 - ⚠️ **典型冲突场景**(需依赖排除)[^3]: ```xml <dependency> <groupId>org.example</groupId> <artifactId>problematic-lib</artifactId> <exclusions> <exclusion> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml-schemas</artifactId> </exclusion> </exclusions> </dependency> ``` --- #### 3. **关键技术对比** | 维度 | poi-ooxml | poi-ooxml-schemas (旧版) | |--------------------|-------------------------------|----------------------------| | **组件类型** | 功能实现层 | 规范定义层 | | **文件大小** | ≈ 3MB (含传递依赖) | ≈ 20MB (仅自身) | | **POI 5.0+ 状态** | ✅ 主力组件 | 被 poi-ooxml-lite 替代 | | **是否需直接引用** | ✅ 项目必须引入 | ❌ 禁止显式引入 | > 💡 **最佳实践**:使用 POI 5.0+ 时,只需声明 `poi-ooxml` 依赖,其自动引入轻量级 `poi-ooxml-lite`(约 5MB),无需处理原始 schemas 包[^1]。 --- #### 4. **典型应用场景** **Excel 数据读取**(结合 `poi-ooxml`)[^4]: ```java // 读取单元格数据(兼容新旧格式) String readCell(Cell cell) { return switch (cell.getCellType()) { case STRING -> cell.getStringCellValue(); // 文本 case NUMERIC -> DateUtil.isCellDateFormatted(cell) ? // 日期判断 new DateTime(cell.getDateCellValue()).toString() : String.valueOf(cell.getNumericCellValue()); case BOOLEAN -> String.valueOf(cell.getBooleanCellValue()); default -> ""; }; } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值