# excel-spring-boot-starter
**Repository Path**: mysymt/excel-spring-boot-starter
## Basic Information
- **Project Name**: excel-spring-boot-starter
- **Description**: EasyExcel spring boot 封装
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 64
- **Created**: 2023-05-04
- **Last Updated**: 2023-05-04
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# excel-spring-boot-starter
此项目底层基于 `Easyexcel` 实现 Excel 的读写。
EasyExcel是一个基于Java的简单、省内存的读写Excel的开源项目。在尽可能节约内存的情况下支持读写百M的Excel。
64M内存1分钟内读取75M(46W行25列)的Excel,当然还有急速模式能更快，但是内存占用会在100M多一点
## 依赖引用
- 项目已上传至 maven 仓库，直接引入即可使用
| 版本 | 支持 |
|-------|--|
| 3.0.0 | 适配 SpringBoot3.x |
| 1.2.7 | 适配 SpringBoot2.x |
```xml
com.pig4cloud.excel
excel-spring-boot-starter
${lastVersion}
```
## 导入 Excel
- 接口类定义List 接受表格对应的数据 使用 @RequestExcel 标记
```java
@PostMapping("/upload")
public void upload(@RequestExcel List dataList, BindingResult bindingResult) {
// JSR 303 校验通用校验获取失败的数据
List errorMessageList = (List) bindingResult.getTarget();
}
```
- 实体声明
```java
@Data
public class Demo {
@ExcelProperty(index = 0)
private String username;
@ExcelProperty(index = 1)
private String password;
}
```
- 测试表格
## 导出 Excel
只需要在 `Controller` 层返回 List 并增加 `@ResponseExcel`注解即可
```java
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ResponseExcel {
String name() default "";
ExcelTypeEnum suffix() default ExcelTypeEnum.XLSX;
String password() default "";
Sheet[] sheets() default @Sheet(sheetName = "sheet1");
boolean inMemory() default false;
String template() default "";
String[] include() default {};
String[] exclude() default {};
Class[] writeHandler() default {};
Class[] converter() default {};
Class headGenerator() default HeadGenerator.class;
}
```
### 基础用法
- 返回单 `sheet`, 全部字段导出
-
```java
@ResponseExcel(name = "test", sheets = @Sheet(sheetName = "testSheet1"))
@GetMapping("/e1")
public List e1() {
List dataList = new ArrayList<>();
for (int i = 0; i < 100; i++) {
DemoData data = new DemoData();
data.setUsername("tr1" + i);
data.setPassword("tr2" + i);
dataList.add(data);
}
return dataList;
}
// 实体对象
@Data
public class DemoData {
private String username;
private String password;
}
```
- 自定义字段属性
```java
@Data
public class DemoData {
@ColumnWidth(50) // 定义宽度
@ExcelProperty("用户名") // 定义列名称
@ContentStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 40)
private String username;
@ExcelProperty("密码")
private String password;
}
```
- 忽略部分字段
```java
@Data
public class DemoData {
@ColumnWidth(50) // 定义宽度
@ExcelProperty("用户名") // 定义列名称
@ContentStyle(fillPatternType = FillPatternType.SOLID_FOREGROUND, fillForegroundColor = 40)
private String username;
@ExcelIgnore // 忽略这个字段
private String password;
}
```
### 导出并加密
```java
@ResponseExcel(name = "lengleng", password = "lengleng")
@GetMapping("/e1")
public List e1() {
return list();
}
```
### 导出多sheet
```java
@ResponseExcel(name = "lengleng", sheets = {
@Sheet(sheetName = "第一个Sheet"),
@Sheet(sheetName = "第二个sheet")
})
@GetMapping("/e1")
public List> e1() {
List> lists = new ArrayList<>();
lists.add(list());
lists.add(list());
return lists;
}
```
### 导出不同的 Sheet
这里两个 sheet 导出不同类型的对象，只导出 DemoData 中的 username 属性，且将 testData 中的 number 属性排除。
```java
@Controller
@RequestMapping("public/excel")
public class ExportMultiSheetController {
@ResponseExcel(name = "不同Sheet的导出", sheets = {
@Sheet(sheetName = "demoData", includes = {"username"}),
@Sheet(sheetName = "testData", excludes = {"number"})
})
@GetMapping("/different-sheet")
public List multiDifferent() {
List lists = new ArrayList<>();
lists.add(demoDatalist());
lists.add(testDatalist());
return lists;
}
private List demoDatalist(){
List dataList = new ArrayList<>();
for (int i = 0; i < 100; i++) {
DemoData data = new DemoData();
data.setUsername("tr1" + i);
data.setPassword("tr2" + i);
dataList.add(data);
}
return dataList;
}
private List testDatalist(){
List dataList = new ArrayList<>();
for (int i = 0; i < 100; i++) {
TestData data = new TestData();
data.setStr("str" + i);
data.setNumber(i);
data.setLocalDateTime(LocalDateTime.now());
dataList.add(data);
}
return dataList;
}
// 实体对象
@Data
public static class DemoData {
private String username;
private String password;
}
@Data
public static class TestData {
private String str;
private Integer number;
@ColumnWidth(50) // 定义宽度
private LocalDateTime localDateTime;
}
}
```
### 导出并自定义头信息
**测试实体类：**
```java
@Data
public class SimpleData {
@ExcelProperty("字符串标题")
private String string;
@ExcelProperty("日期标题")
private Date date;
@ExcelProperty("数字标题")
private Integer number;
// 忽略
@ExcelIgnore
private String ignore;
}
```
**自定义头信息生成器**：
> 注意需要实现 `HeadGenerator` 接口，且注册为一个 spring bean.
```java
@Component
public class SimpleDataHeadGenerator implements HeadGenerator {
@Override
public HeadMeta head(Class clazz) {
HeadMeta headMeta = new HeadMeta();
headMeta.setHead(simpleDataHead());
// 排除 number 属性
headMeta.setIgnoreHeadFields(new HashSet<>(Collections.singletonList("number")));
return headMeta;
}
private List> simpleDataHead() {
List> list = new ArrayList<>();
List head0 = new ArrayList<>();
head0.add("自定义字符串标题" + System.currentTimeMillis());
List head1 = new ArrayList<>();
head1.add("自定义日期标题" + System.currentTimeMillis());
list.add(head0);
list.add(head1);
return list;
}
}
```
该头生成器，将固定返回 自定义字符串标题 和 自定义日期标题 两列头信息，实际使用时可根据业务动态处理，方便在一些权限控制时动态修改或者增删列头。
**测试代码：**
```java
@RequestMapping("/head")
@RestController
public class ExcelHeadTestController {
@ResponseExcel(name = "customHead", headGenerator = SimpleDataHeadGenerator.class)
@GetMapping
public List multi() {
List list = new ArrayList<>();
for (int i = 0; i < 10; i++) {
SimpleData simpleData = new SimpleData();
simpleData.setString("str" + i);
simpleData.setNumber(i);
simpleData.setDate(new Date());
list.add(simpleData);
}
return list;
}
}
```
## 国际化的导入导出
国际化配置基于 Spring 的 MessageSource，开启国际化时，spring 容器中必须有一个 MessageSource 的 Bean。
> 具体 Spring
>
的国际化使用这里不再展开，想要了解的可以参看官方文档 [Spring MessageSource 使用](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#context-functionality-messagesource)
>
以及 [SpringBoot 国际化配置 ](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.internationalization)
**首先在 resource 下，新建国际化配置文件**
- messages.properties
```properties
DemoData.username=Username
DemoData.age=Age
```
- messages_en_US.properties
```properties
DemoData.username=Username
DemoData.age=Age
```
- messages_zh_CN.properties
```properties
DemoData.username=用户名
DemoData.age=年龄
```
**测试类的注解信息上，使用 `{}` 标记配置文件中的 key**
```java
@Data
public class DemoData {
@ExcelProperty(value = "{DemoData.username}", index = 0)
private String username;
@ExcelProperty(value = "{DemoData.age}", index = 1)
private Integer age;
}
```
**导出注解上设置 i18nHeader=true **
```java
@ResponseExcel(name = "i18nExport", i18nHeader = true)
@GetMapping("excelExport")
public List i18nExport() {
List list = new ArrayList<>();
for (int i = 0; i < 10; i++) {
DemoData demoData = new DemoData();
demoData.setUsername("username:" + i);
demoData.setAge(i);
list.add(demoData);
}
return list;
}
```
**使用 Postman 测试导出**
请求头上使用 `Accept-Language` 指定当前语言区域，中文是 `zh-CN`, 英文是 `en-US`
> SpringBoot 的国际化默认会读取请求头中的 `Accept-Language` 进行判断当前区域，可以通过定制 `LocaleResolver` 替换这一默认行为
**导出效果**
**导入 controller**
注意，这里导入接受的对象如果和导出是同一个的话，由于列名是国际化配置的占位符，无法和实际上传文件进行对应，所以需要给该对象的属性指定 index，导入文件根据 index 进行数据映射。
当然，也可以使用额外的导入类来接收导入信息。
```java
@PostMapping("i18n")
@ResponseBody
public List importExcel(@RequestExcel List list) {
return list;
}
```
- 导入获取excel 行号，实体属性增加 @ExcelLine 注解即可
```java
/**
* 导入时候回显行号
*/
@ExcelLine
@ExcelIgnore
private Long lineNum;
```
**使用 Postman 测试导入**
## 添加全局自定义转换器（Converter）
`0.0.7` 版本开始添加了全局自定义转换器注入的功能，你只需要将自定义的 `Converter` 注册成 `Spring bean` 即可。
示例代码如下（对 set 类型转换）：
```java
@Data
public class TestModel {
@ExcelProperty("名称集合")
private Set nameSet;
}
/**
* 集合转换器
*
* @author L.cm
*/
@Component
public class SetConverter implements Converter> {
private final ConversionService conversionService;
SetConverter() {
this.conversionService = DefaultConversionService.getSharedInstance();
}
@Override
public Class supportJavaTypeKey() {
return Set.class;
}
@Override
public CellDataTypeEnum supportExcelTypeKey() {
return CellDataTypeEnum.STRING;
}
@Override
public Set convertToJavaData(CellData cellData, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
String[] value = StringUtils.delimitedListToStringArray(cellData.getStringValue(), ",");
return (Set) conversionService.convert(value, TypeDescriptor.valueOf(String[].class), new TypeDescriptor(contentProperty.getField()));
}
@Override
public CellData convertToExcelData(Set value, ExcelContentProperty contentProperty, GlobalConfiguration globalConfiguration) {
return new CellData<>(StringUtils.collectionToCommaDelimitedString(value));
}
}
```
## 高级用法模板导出
```java
@ResponseExcel(name = "模板测试excel", sheet = "sheetName",template = "example.xlsx")
@GetMapping("/e1")
public List e1() {
return list();
}
```
## 其他用法
- 理论上支持 [alibaba/easyexcel](https://github.com/alibaba/easyexcel) v2.2.10 版本的大部分配置
- 支持 [alibaba/easyexcel](https://www.yuque.com/easyexcel/doc/write) 原生的配置注解
- [github stater 地址，可fork 魔改](https://github.com/pigxcloud/excel-spring-boot-starter)