# iexcel

**Repository Path**: houbinbin/iexcel

## Basic Information

- **Project Name**: iexcel
- **Description**: 📚IExcel is a java tool for create and read excel easy.(excel 读取和写入，解决 excel OOM 问题。)
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-07-30
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: excel-utils

**Tags**: None

## README

# 项目简介

[IExcel](https://github.com/houbb/iexcel) 用于优雅地读取和写入 excel。

避免大 excel 出现 oom，简约而不简单。

[![Build Status](https://travis-ci.com/houbb/iexcel.svg?branch=master)](https://travis-ci.com/houbb/iexcel)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.houbb/iexcel/badge.svg)](http://mvnrepository.com/artifact/com.github.houbb/iexcel)
[![](https://img.shields.io/badge/license-Apache2-FF0080.svg)](https://github.com/houbb/iexcel/blob/master/LICENSE.txt)
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/houbb/iexcel)

# 特性

- 一行代码搞定一切

- OO 的方式操作 excel，编程更加方便优雅。

- sax 模式读取，SXSS 模式写入。避免 excel 大文件 OOM。

- 基于注解，编程更加灵活。

- 设计简单，注释完整。方便大家学习改造。

- 可根据注解指定表头顺序

- 支持 excel 文件内容 bytes[] 内容获取，便于用户自定义操作。

## 变更日志

> [变更日志](CHANGELOG.md)

## v0.0.9 主要变更

Fixed [@ExcelField注解失效问题](https://github.com/houbb/iexcel/issues/7)

# 创作缘由

实际工作和学习中，apache poi 操作 excel 过于复杂。

近期也看了一些其他的工具框架：

- easypoi

- easyexcel

- hutool-poi

都或多或少难以满足自己的实际需要，于是就自己写了一个操作 excel 导出的工具。

实现：在阿里 [easyexcel](https://github.com/alibaba/easyexcel) 的基础上进行封装，提升使用的简易度。

# 快速开始

## 环境要求

jdk1.7+

maven 3.x

## 引入 jar

使用 maven 管理。

```xml
<dependency>
     <groupId>com.github.houbb</groupId>
     <artifactId>iexcel</artifactId>
     <version>0.0.9</version>
</dependency>
```

## Excel 写入

### 示例

```java
// 基本属性
final String filePath = PathUtil.getAppTestResourcesPath()+"/excelHelper.xls";
List<User> models = User.buildUserList();

// 直接写入到文件
ExcelHelper.write(filePath, models);
```

其中：

- User.java

```java
public class User {

    private String name;

    private int age;

    //fluent getter/setter/toString()
}
```

- buildUserList()

构建对象列表方法如下：

```java
/**
 * 构建用户类表
 * @return 用户列表
 * @since 0.0.4
 */
public static List<User> buildUserList() {
    List<User> users = new ArrayList<>();
    users.add(new User().name("hello").age(20));
    users.add(new User().name("excel").age(19));
    return users;
}
```

### 写入效果

excel 内容生成为：

```
name	age
hello	20
excel	19
```

## Excel 读取

### 示例

```java
final String filePath = PathUtil.getAppTestResourcesPath()+"/excelHelper.xls";
List<User> userList = ExcelHelper.read(filePath, User.class);
```

### 信息

```
[User{name='hello', age=20}, User{name='excel', age=19}]
```

# 文档

[01-ExcelBs 引导类使用说明](doc/user/01-ExcelBs引导类讲解.md)

[02-ExcelField 注解指定字段属性](doc/user/02-ExcelField注解使用说明.md)

[03-ExcelField#order 指定列顺序](doc/user/03-ExcelField-order-列顺序指定.md)

[04-ExcelBs#bytes 获取文件字节信息](doc/user/04-ExcelBs-bytes-获取文件字节信息.md)

# Bug & Issues

欢迎提出宝贵意见：[Bug & Issues](https://github.com/houbb/iexcel/issues)

# 后期 Road-Map

- [ ] 是否有表头的指定

- [ ] 添加类型转换支持

- [ ] 对于枚举值的注解支持

- [ ] 对于样式的注解支持

- [ ] 多 sheet 支持