SpringBootプロジェクトEasyExcelの使用
序文
EasyExcel は、大きなファイルのメモリ オーバーフローを解決する、Java ベースの高速で簡潔な Excel 処理ツールです。
パフォーマンスやメモリなどの要素を考慮せずに、Excel の読み書きなどの機能をすばやく完了できます。
1. EasyExcel データをディスクにエクスポートする
1. 依存関係の追加
EasyExcel が依存する必要がある
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>3.1.0</version>
</dependency>
2. ファイルをローカルに書き込みます。
データを Excel に書き込み、ローカルに保存する
public void dowloadDataExcel() {
try {
String fileName = "导出测试";
//表头
List<List<String>> heads = Lists.newArrayList();
heads.add(Lists.newArrayList("姓名"));
heads.add(Lists.newArrayList("英文名称"));
heads.add(Lists.newArrayList("密码"));
heads.add(Lists.newArrayList("角色"));
heads.add(Lists.newArrayList("手机号"));
// 数据
List<List<String>> contents = Lists.newArrayList();
for (int i = 0; i <= 10; i++) {
List<String> content = Lists.newArrayList();
for (int j = 0; j < 5; j++) {
content.add("第" + i + "行第" + j + "例内容");
}
contents.add(content);
}
EasyExcel.write("D:\\data\\test.xlsx")
.head(heads)
.registerWriteHandler(new SimpleColumnWidthStyleStrategy(16)) // 列宽
.sheet("数据").doWrite(contents);
} catch (Exception e) {
log.error("导出数据异常：{}", e.getMessage());
}
}
結果の出力は次のようになります
2. EasyExcel はインターフェイスを通じてカスタム テンプレートをエクスポートします
1. テンプレートを組み立て、インターフェースを通じてダウンロードします。
テーブルのヘッダーを Excel に書き込み、ブラウザーを通じてダウンロードします (注: nginx プロキシの後、ファイル ストリームが改ざんされる可能性があり、ファイルが破損して開けなくなります)。
@GetMapping("/export/excel")
@Timed
@ResponseStatus(HttpStatus.OK)
public void dowloadExcel(HttpServletResponse response) {
try {
// 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName = URLEncoder.encode("用户模板", "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
List<List<String>> heads = Lists.newArrayList();
heads.add(Lists.newArrayList("姓名"));
heads.add(Lists.newArrayList("英文名称*"));
heads.add(Lists.newArrayList("密码*"));
heads.add(Lists.newArrayList("角色"));
heads.add(Lists.newArrayList("手机号"));
EasyExcel.write(response.getOutputStream())
.head(heads)
.registerWriteHandler(new SimpleColumnWidthStyleStrategy(16))
.sheet("用户数据")
.doWrite(null);
} catch (Exception e) {
e.printStackTrace();
log.error("导出模板异常：{}", e.getMessage());
}
}
結果の出力は次のようになります
![[外部リンク画像の転送に失敗しました。ソース サイトには盗難防止リンク メカニズムがある可能性があります。画像を保存して直接アップロードすることをお勧めします (img-tfatQEDm-1676599385893)(https://img-blog.csdnimg.cn/) b405186638204d2b962abcb650410b88.png)]](https://img-blog.csdnimg.cn/301c704de5c44585b3031149e247d2b2.png)
3. EasyExcel は Excel のデフォルトのドロップダウン データを追加します
1.Excel列設定ドロップダウンデータ
ロール列をデフォルトのドロップダウン データ
1、カスタム処理クラスに設定します。
public class CustomSheetWriteHandler implements SheetWriteHandler {
@Override
public void beforeSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
}
@Override
public void afterSheetCreate(WriteWorkbookHolder writeWorkbookHolder, WriteSheetHolder writeSheetHolder) {
//定义一个map key是需要添加下拉框的列的index value是下拉框数据
Map<Integer, String[]> mapDropDown = new HashMap<>(3);
//设置单位身份 值写死
String[] role = {
"系统管理员","平台管理员","数据工程师","配置管理员"};
//下拉选在Excel中对应的第4列
mapDropDown.put(3,role);
//获取工作簿
Sheet sheet = writeSheetHolder.getSheet();
///开始设置下拉框
DataValidationHelper helper = sheet.getDataValidationHelper();
//设置下拉框
for (Map.Entry<Integer, String[]> entry : mapDropDown.entrySet()) {
/*起始行、终止行、起始列、终止列 起始行为1即表示表头不设置**/
CellRangeAddressList addressList = new CellRangeAddressList(1, 65535, entry.getKey(), entry.getKey());
/*设置下拉框数据**/
DataValidationConstraint constraint = helper.createExplicitListConstraint(entry.getValue());
DataValidation dataValidation = helper.createValidation(constraint, addressList);
sheet.addValidationData(dataValidation);
}
}
}
Excelを生成するときに使用します
public void dowloadExcel(HttpServletResponse response) {
try {
// 这里注意 有同学反应使用swagger 会导致各种问题，请直接用浏览器或者用postman
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName = URLEncoder.encode("用户模板", "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
List<List<String>> heads = Lists.newArrayList();
heads.add(Lists.newArrayList("姓名"));
heads.add(Lists.newArrayList("英文名称*"));
heads.add(Lists.newArrayList("密码*"));
heads.add(Lists.newArrayList("角色"));
heads.add(Lists.newArrayList("手机号"));
EasyExcel.write(response.getOutputStream())
.head(heads)
.sheet("用户数据")
.registerWriteHandler(new SimpleColumnWidthStyleStrategy(16))
.registerWriteHandler(new CustomSheetWriteHandler())
.doWrite(null);
} catch (Exception e) {
e.printStackTrace();
log.error("导出模板异常：{}", e.getMessage());
}
}
結果の出力は次のようになります
4. EasyExcelはExcelデータを読み込みます
1. Excel を解析してデータを読み取る
Excel データを読み取ります。ここでは、各行と列を読み取り、処理したいオブジェクトを変換します。EasyExcel には、データをエンティティに直接マッピングするメソッドも用意されており、自分で学習できます。
public List<User> excelHandle(MultipartFile multipartFile) {
List<User> list = new ArrayList<>();
byte[] bytes;
try {
bytes = multipartFile.getBytes();
} catch (IOException e) {
log.error("excel解析异常:{}", e.getMessage());
throw new BadRequestAlertException(ErrorCodes.INNER_ERROR, "excel解析异常");
}
try {
InputStream inputStream = new ByteArrayInputStream(bytes);
List<Map<Integer, String>> maps = ExcelUtils.readExcel(inputStream);
for (int i = 0; i < maps.size(); i++) {
Map<Integer, String> bookMaps = maps.get(i);
User user = pauseUserDto(bookMaps);
list.add(user);
}
} catch (Exception e) {
log.error("上传表格数据异常:{}", e.getMessage());
throw new BadRequestAlertException(ErrorCodes.INNER_ERROR, "上传表格数据异常，检查后重试");
}
return list;
}
要約する
上記は EasyExcel の SpringBoot 統合です。最も簡単な使用方法はインポートとエクスポートです。Excel では、Excel データの読み取りやオブジェクト バインディング操作など、他の多くの機能も実装できます。これらについては後で順に紹介します。