SpringBoot基於Hutool解析Excel實現文件導出導入、讀取寫入

1. 簡介

  Hutool是一個小而全的Java工具類庫，Hutool是項目中“util”包友好的替代，它節省了開發人員對項目中公用類和公用工具方法的封裝時間，使開發專注於業務，同時可以最大限度的避免封裝不完善帶來的bug。強烈推薦大家使用。
  Java針對MS Office的操作的庫屈指可數，比較有名的就是Apache的POI庫。這個庫異常強大，但是使用起來也並不容易。Hutool針對POI封裝一些常用工具，使Java操作Excel等文件變得異常簡單。
  官網：https://www.hutool.cn/

2. 相關博客

  SpringBoot基於EasyExcel解析Excel實現文件導出導入、讀取寫入

3. 示例代碼

• 創建工程
  
• 修改pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.c3stones</groupId>
	<artifactId>spring-boot-hutool-excel-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>spring-boot-hutool-excel-demo</name>
	<description>Spring Boot + Hutool Excel Demo</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.3.4.RELEASE</version>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
	</parent>

	<dependencies>
		<dependency>
			<groupId>org.apache.poi</groupId>
			<artifactId>poi-ooxml</artifactId>
			<version>4.1.2</version>
		</dependency>
		<dependency>
			<groupId>cn.hutool</groupId>
			<artifactId>hutool-all</artifactId>
			<version>5.5.7</version>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
	</dependencies>

</project>

• 創建實體

import java.util.Date;

import com.fasterxml.jackson.annotation.JsonFormat;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 學生實體
 * 
 * @author CL
 *
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Student {

	/**
	 * 學號
	 */
	private String sno;

	/**
	 * 姓名
	 */
	private String name;

	/**
	 * 年齡
	 */
	private Integer age;

	/**
	 * 性別
	 */
	private String gender;

	/**
	 * 籍貫
	 */
	private String nativePlace;

	/**
	 * 入學時間
	 */
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
	private Date enrollmentTime;

}

• 創建文件導出導入Controller示例

import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;

import javax.servlet.http.HttpServletResponse;

import org.apache.poi.ss.util.CellRangeAddressList;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import com.c3stones.entity.Student;

import cn.hutool.poi.excel.ExcelReader;
import cn.hutool.poi.excel.ExcelUtil;
import cn.hutool.poi.excel.ExcelWriter;

/**
 * 學生Controller
 * 
 * @author CL
 *
 */
@RestController
@RequestMapping(value = "student")
public class StudentController {

	/**
	 * 
	 * 導出學生信息
	 * 
	 * @param response
	 * @throws ParseException
	 * @throws UnsupportedEncodingException
	 */
	@SuppressWarnings("serial")
	@RequestMapping(value = "export")
	public void exportStudentInfos(HttpServletResponse response) throws ParseException, UnsupportedEncodingException {
		// 設置響應類型
		response.setContentType("application/vnd.ms-excel");
		// 設置字符編碼
		response.setCharacterEncoding("utf-8");
		// 設置響應頭信息
		response.setHeader("Content-disposition",
				"attachment;filename*=utf-8''" + URLEncoder.encode("學生花名冊", "UTF-8") + ".xlsx");

		List<Student> studentList = new ArrayList<Student>() {
			{
				SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
				add(new Student("1001", "張三", 23, "男", "陝西西安", dateFormat.parse("2020-09-01")));
				add(new Student("1002", "李四", 22, "女", "陝西渭南", dateFormat.parse("2020-09-01")));
			}
		};

		// 寫入文件
		ExcelWriter writer = ExcelUtil.getWriter();
		writer.addHeaderAlias("sno", "學號");
		writer.addHeaderAlias("name", "姓名");
		writer.addHeaderAlias("age", "年齡");
		writer.addHeaderAlias("gender", "性別");
		writer.addHeaderAlias("nativePlace", "籍貫");
		writer.addHeaderAlias("enrollmentTime", "入學時間");

		writer.autoSizeColumn(5);
		CellRangeAddressList regions = new CellRangeAddressList(1, studentList.size(), 3, 3);
		writer.addSelect(regions, "男", "女");

		writer.write(studentList, true);

		try {
			writer.flush(response.getOutputStream(), true);
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			writer.close();
		}
	}

	/**
	 * 導入學生信息
	 * 
	 * @param file
	 * @throws IOException
	 */
	@RequestMapping(value = "import")
	public List<Student> importStudentInfos(MultipartFile file) throws IOException {
		ExcelReader reader = ExcelUtil.getReader(file.getInputStream());
		reader.addHeaderAlias("學號", "sno");
		reader.addHeaderAlias("姓名", "name");
		reader.addHeaderAlias("年齡", "age");
		reader.addHeaderAlias("性別", "gender");
		reader.addHeaderAlias("籍貫", "nativePlace");
		reader.addHeaderAlias("入學時間", "enrollmentTime");
		List<Student> studentList = reader.readAll(Student.class);
		return studentList;
	}

}

• 創建文件讀取寫入Controller示例

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;

import org.apache.poi.ss.util.CellRangeAddressList;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.c3stones.entity.Student;

import cn.hutool.poi.excel.ExcelReader;
import cn.hutool.poi.excel.ExcelUtil;
import cn.hutool.poi.excel.ExcelWriter;

/**
 * 文件Controller
 * 
 * @author CL
 *
 */
@RestController
@RequestMapping(value = "file")
public class FileController {

	/**
	 * 讀取Excel
	 * 
	 * @return
	 */
	@RequestMapping(value = "readExcel")
	public List<Student> readExcel() {
		String fileName = "C:\\Users\\Administrator\\Desktop\\學生花名冊.xlsx";
		ExcelReader reader = ExcelUtil.getReader(fileName);
		reader.addHeaderAlias("學號", "sno");
		reader.addHeaderAlias("姓名", "name");
		reader.addHeaderAlias("年齡", "age");
		reader.addHeaderAlias("性別", "gender");
		reader.addHeaderAlias("籍貫", "nativePlace");
		reader.addHeaderAlias("入學時間", "enrollmentTime");
		List<Student> studentList = reader.readAll(Student.class);
		return studentList;
	}

	/**
	 * 寫入Excel
	 * 
	 * @return
	 * @throws ParseException
	 */
	@SuppressWarnings("serial")
	@RequestMapping(value = "writeExcel")
	public Boolean writeExcel() throws ParseException {
		String fileName = "C:\\Users\\Administrator\\Desktop\\學生花名冊2.xlsx";
		List<Student> studentList = new ArrayList<Student>() {
			{
				SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
				add(new Student("2001", "張三2", 23, "男", "陝西西安", dateFormat.parse("2020-09-01")));
				add(new Student("2002", "李四2", 22, "女", "陝西渭南", dateFormat.parse("2020-09-01")));
			}
		};

		ExcelWriter writer = ExcelUtil.getWriter(fileName);
		writer.addHeaderAlias("sno", "學號");
		writer.addHeaderAlias("name", "姓名");
		writer.addHeaderAlias("age", "年齡");
		writer.addHeaderAlias("gender", "性別");
		writer.addHeaderAlias("nativePlace", "籍貫");
		writer.addHeaderAlias("enrollmentTime", "入學時間");

		CellRangeAddressList regions = new CellRangeAddressList(1, studentList.size(), 3, 3);
		writer.addSelect(regions, "男", "女");
		writer.setColumnWidth(5, 15);

		writer.write(studentList, true);
		writer.close();
		return true;
	}

}

• 創建啟動類

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 啟動類
 * 
 * @author CL
 *
 */
@SpringBootApplication
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}

}

4. 測試

  通過Postman依次測試導出、導入、讀取和寫入：

• 測試導出
  
    將導出文件保存到桌面（學生花名冊.xlsx）。
• 測試導入
  
• 測試讀取
  
• 測試寫入
  
    可以看到在代碼中配置的文件目錄已存在寫入成功的文件（學生花名冊2.xlsx）。

5. 項目地址

  spring-boot-hutool-excel-demo