HuToolツールで使用されるExcelドキュメントのインポートとエクスポート
序文
日常の作業や開発では、Excelのインポートとエクスポートが不可欠です。対応するインポートとエクスポートの方法を自分で書くと、非常に煩雑になります。この記事では、Hutoolツールによって実装されるExcelのインポートとエクスポート機能を使用するため、将来の開発を大幅に削減できます。 Excelで関連操作をインポートおよびエクスポートします。
ヒント：以下はこの記事の内容であり、以下のケースは参照用です
1. Hutoolとは何ですか？
Hutoolは、小型で完全なJavaツールクラスライブラリです。静的メソッドのカプセル化により、関連するAPIの学習コストを削減し、作業効率を向上させます。これにより、Javaは関数型言語の優雅さを備え、Java言語は「甘い」ものになります。
Hutoolのツールとメソッドは、各ユーザーの細心の注意を払って作成されたものです。Java開発の基礎となるコードのすべての側面をカバーしています。これは、大規模プロジェクト開発における小さな問題を解決するためのツールであるだけでなく、小規模プロジェクトにおける効率の責任も果たします。
Hutoolは、プロジェクトの「util」パッケージに代わるフレンドリーなツールです。開発者は、プロジェクトのパブリッククラスとパブリックツールメソッドのカプセル化時間を節約し、開発をビジネスに集中できるようにし、不完全なカプセル化によって引き起こされるバグを回避します。
次に、Excelファイルをエクスポートします
1.関連する依存関係を導入する
MS Officeオペレーション用のJavaライブラリーはほんの一握りで、より有名なものはApache POIライブラリーです。このライブラリは非常に強力ですが、使用するのは簡単ではありません。HutoolはPOIのいくつかの一般的なツールをカプセル化し、JavaでExcelやその他のファイルを操作することを非常に簡単にします。Hutool-poiはApache POIのパッケージであるため、ユーザーはPOIライブラリーを自分でインポートする必要があります。Hutoolはデフォルトではそれをインポートしません。
hutool-4.xのpoi-ooxmlバージョンは3.17以降でなければならず、hutool-5.xのpoi-ooxmlバージョンは4.1.2以降でなければならないことに注意してください。この記事で使用されている依存関係情報を次の図に示します。
<!-- hutool工具类依赖-->
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.4.3</version>
</dependency>
<!--POI依赖，对office进行操作-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>4.1.2</version>
</dependency>
2. Excelエクスポート機能の実現
HutoolはExcelの書き出しをExcelWriterとしてカプセル化します。原則はWorkbookオブジェクトをパッケージ化することです。merge（セルのマージ）またはwrite（データの書き出し）メソッドを呼び出すたびに、ファイルではなくデータのみをWorkbookに書き込み、呼び出しだけを書き込みますflushまたはcloseメソッドの後でのみ、ファイルが書き出されます。このメカニズムのため、書き込みが完了したらExcelWriterオブジェクトを閉じる必要があり、閉じるメソッドを呼び出して閉じることができます。このとき、Workbookオブジェクトのリソースが解放されます。それ以外の場合、データを含むWorkbookは常にメモリに常駐します。コードは次のとおりです。
@RequestMapping(EXCEL_DOWNLOAD)
public void excelExport(HttpServletResponse httpServletResponse) throws IOException {
UserDTO userDTO = new UserDTO();
List<UserDTO> userDTOS = userService.selectUserDOBatch(userDTO);
//通过hutool工具创建的excel的writer，默认为xls格式
ExcelWriter writer = ExcelUtil.getWriter();
//设置要导出到的sheet
writer.setSheet("表2");
writer.setSheet("表3");
//自定义excel标题和列名
writer.addHeaderAlias("id","用户ID");
writer.addHeaderAlias("userName","用户名");
writer.addHeaderAlias("loginPassword","密码");
writer.addHeaderAlias("email","邮箱");
writer.addHeaderAlias("createDate","数据创建日期");
//合并单元格后的标题行，使用默认标题样式
writer.merge(4,"用户基本信息表");
writer.renameSheet(0,"用户登录信息");
//一次性写出内容，使用默认样式，强制输出标题
writer.write(userDTOS,true);
httpServletResponse.setContentType("application/vnd.ms-excel;charset=utf-8");
//name是下载对话框的名称，不支持中文，想用中文名称需要进行utf8编码
String excelName = "用户基本信息表";
//excelName = new String(excelName.getBytes(),"utf-8");
excelName = URLEncoder.encode(excelName, "utf-8");
httpServletResponse.setHeader("Content-Disposition", "attachment;filename=" + excelName +".xls");
//将excel文件信息写入输出流，返回给调用者
ServletOutputStream excelOut = null;
try {
excelOut = httpServletResponse.getOutputStream();
writer.flush(excelOut,true);
} catch (IOException e) {
e.printStackTrace();
}finally {
writer.close();
}
IoUtil.close(excelOut);
}
上記のエクスポートされたExcel形式は.xlsです。Excelファイルを.xlsx形式でエクスポートする場合は、上の図に示す対応するロケーションコードを変更するだけで済みます。変更コードは次のとおりです。
//设置返回excel的格式为xlsx
httpServletResponse.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=utf-8");
httpServletResponse.setHeader("Content-Disposition","attachment;filename="+ URLEncoder.encode("用户信息表","utf-8") + ".xlsx");
生成されるExcelファイルは次のとおりです。
次に、Excelファイルをエクスポートします
1. Excel Read-ExcelReader
Excelファイルのインポートは、次の3つの状況に分けられます。
1. Excelですべての行と列を読み取り、すべてリストで表現する
ExcelReader reader = ExcelUtil.getReader("d:/aaa.xlsx");
List<List<Object>> readAll = reader.read();
2.マップリストとして読み取る。デフォルトの最初の行はタイトル行、マップのキーはタイトル、値はタイトルに対応するセル値です。
ExcelReader reader = ExcelUtil.getReader("d:/aaa.xlsx");
List<Map<String,Object>> readAll = reader.readAll();
3. Beanリストとして読み取り、Bean内のフィールド名はタイトルで、フィールド値はタイトルに対応するセル値です。
ExcelReader reader = ExcelUtil.getReader("d:/aaa.xlsx");
List<Person> all = reader.readAll(Person.class);
この記事では、3番目の方法を使用してExcelのインポートと読み取りの例を実装します。関連するコードは次のとおりです。
@RequestMapping(READ_EXCEL)
public void readExcel(){
ExcelReader reader = ExcelUtil.getReader("H:\\user.xlsx");
List<UserDTO> userDTOS = reader.readAll(UserDTO.class);
//日志输出读取到的信息
log.info(userDTOS.toString());
}
UserDTOクラスのコードは次のとおりです。
@Data
public class UserDTO {
@NotNull(message = "用户id不能为空")
private Integer id;
@NotNull(message = "用户名不能为空")
@Size(min = 4, max = 16, message = "用户名长度错误")
private String userName;
@NotNull(message = "密码不能为空")
@Size(min = 4, max = 16, message = "密码长度错误")
private String loginPassword;
@NotNull(message = "邮箱不能为空")
@Email(message = "邮箱格式错误")
private String email;
@NotNull(message = "日期不能为空")
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
@JSONField(format = "yyyy-MM-dd HH:mm:ss")
private Date createDate;
}