您好,登錄后才能下訂單哦!
本文小編為大家詳細介紹“如何創建一個Java工具類來導出Excel”,內容詳細,步驟清晰,細節處理妥當,希望這篇“如何創建一個Java工具類來導出Excel”文章能幫助大家解決疑惑,下面跟著小編的思路慢慢深入,一起來學習新知識吧。
我們的工程是利用Maven來構建的,項目具體搭建過程大家可以參見網上其他資料,這里我們僅給出最核心的Maven配置
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-scratchpad</artifactId>
<version>3.11-beta2</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>3.11-beta2</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml-schemas</artifactId>
<version>3.11-beta2</version>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-excelant</artifactId>
<version>3.11-beta2</version>
</dependency>
這個類使我們整個工具的核心,它實現了Excel文件的導出功能,具體代碼如下:
package com.lyz.utils.excel.poi;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFFont;
import org.apache.poi.hssf.usermodel.HSSFRichTextString;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.hssf.util.HSSFColor;
import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFColor;
import org.apache.poi.xssf.usermodel.XSSFFont;
import org.apache.poi.xssf.usermodel.XSSFRichTextString;
import org.apache.poi.xssf.usermodel.XSSFRow;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
/**
* 導出Excel
* @author liuyazhuang
*
* @param <T>
*/
public class ExportExcelUtil<T>{
// 2007 版本以上 最大支持1048576行
public final static String EXCEl_FILE_2007 = "2007";
// 2003 版本 最大支持65536 行
public final static String EXCEL_FILE_2003 = "2003";
/**
* <p>
* 導出無頭部標題行Excel <br>
* 時間格式默認:yyyy-MM-dd hh:mm:ss <br>
* </p>
*
* @param title 表格標題
* @param dataset 數據集合
* @param out 輸出流
* @param version 2003 或者 2007,不傳時默認生成2003版本
*/
public void exportExcel(String title, Collection<T> dataset, OutputStream out, String version) {
if(StringUtils.isEmpty(version) || EXCEL_FILE_2003.equals(version.trim())){
exportExcel2003(title, null, dataset, out, "yyyy-MM-dd HH:mm:ss");
}else{
exportExcel2007(title, null, dataset, out, "yyyy-MM-dd HH:mm:ss");
}
}
/**
* <p>
* 導出帶有頭部標題行的Excel <br>
* 時間格式默認:yyyy-MM-dd hh:mm:ss <br>
* </p>
*
* @param title 表格標題
* @param headers 頭部標題集合
* @param dataset 數據集合
* @param out 輸出流
* @param version 2003 或者 2007,不傳時默認生成2003版本
*/
public void exportExcel(String title,String[] headers, Collection<T> dataset, OutputStream out,String version) {
if(StringUtils.isBlank(version) || EXCEL_FILE_2003.equals(version.trim())){
exportExcel2003(title, headers, dataset, out, "yyyy-MM-dd HH:mm:ss");
}else{
exportExcel2007(title, headers, dataset, out, "yyyy-MM-dd HH:mm:ss");
}
}
/**
* <p>
* 通用Excel導出方法,利用反射機制遍歷對象的所有字段,將數據寫入Excel文件中 <br>
* 此版本生成2007以上版本的文件 (文件后綴:xlsx)
* </p>
*
* @param title
* 表格標題名
* @param headers
* 表格頭部標題集合
* @param dataset
* 需要顯示的數據集合,集合中一定要放置符合JavaBean風格的類的對象。此方法支持的
* JavaBean屬性的數據類型有基本數據類型及String,Date
* @param out
* 與輸出設備關聯的流對象,可以將EXCEL文檔導出到本地文件或者網絡中
* @param pattern
* 如果有時間數據,設定輸出格式。默認為"yyyy-MM-dd hh:mm:ss"
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public void exportExcel2007(String title, String[] headers, Collection<T> dataset, OutputStream out, String pattern) {
// 聲明一個工作薄
XSSFWorkbook workbook = new XSSFWorkbook();
// 生成一個表格
XSSFSheet sheet = workbook.createSheet(title);
// 設置表格默認列寬度為15個字節
sheet.setDefaultColumnWidth(20);
// 生成一個樣式
XSSFCellStyle style = workbook.createCellStyle();
// 設置這些樣式
style.setFillForegroundColor(new XSSFColor(java.awt.Color.gray));
style.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND);
style.setBorderBottom(XSSFCellStyle.BORDER_THIN);
style.setBorderLeft(XSSFCellStyle.BORDER_THIN);
style.setBorderRight(XSSFCellStyle.BORDER_THIN);
style.setBorderTop(XSSFCellStyle.BORDER_THIN);
style.setAlignment(XSSFCellStyle.ALIGN_CENTER);
// 生成一個字體
XSSFFont font = workbook.createFont();
font.setBoldweight(XSSFFont.BOLDWEIGHT_BOLD);
font.setFontName("宋體");
font.setColor(new XSSFColor(java.awt.Color.BLACK));
font.setFontHeightInPoints((short) 11);
// 把字體應用到當前的樣式
style.setFont(font);
// 生成并設置另一個樣式
XSSFCellStyle style2 = workbook.createCellStyle();
style2.setFillForegroundColor(new XSSFColor(java.awt.Color.WHITE));
style2.setFillPattern(XSSFCellStyle.SOLID_FOREGROUND);
style2.setBorderBottom(XSSFCellStyle.BORDER_THIN);
style2.setBorderLeft(XSSFCellStyle.BORDER_THIN);
style2.setBorderRight(XSSFCellStyle.BORDER_THIN);
style2.setBorderTop(XSSFCellStyle.BORDER_THIN);
style2.setAlignment(XSSFCellStyle.ALIGN_CENTER);
style2.setVerticalAlignment(XSSFCellStyle.VERTICAL_CENTER);
// 生成另一個字體
XSSFFont font2 = workbook.createFont();
font2.setBoldweight(XSSFFont.BOLDWEIGHT_NORMAL);
// 把字體應用到當前的樣式
style2.setFont(font2);
// 產生表格標題行
XSSFRow row = sheet.createRow(0);
XSSFCell cellHeader;
for (int i = 0; i < headers.length; i++) {
cellHeader = row.createCell(i);
cellHeader.setCellStyle(style);
cellHeader.setCellValue(new XSSFRichTextString(headers[i]));
}
// 遍歷集合數據,產生數據行
Iterator<T> it = dataset.iterator();
int index = 0;
T t;
Field[] fields;
Field field;
XSSFRichTextString richString;
Pattern p = Pattern.compile("^//d+(//.//d+)?$");
Matcher matcher;
String fieldName;
String getMethodName;
XSSFCell cell;
Class tCls;
Method getMethod;
Object value;
String textValue;
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
while (it.hasNext()) {
index++;
row = sheet.createRow(index);
t = (T) it.next();
// 利用反射,根據JavaBean屬性的先后順序,動態調用getXxx()方法得到屬性值
fields = t.getClass().getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
cell = row.createCell(i);
cell.setCellStyle(style2);
field = fields[i];
fieldName = field.getName();
getMethodName = "get" + fieldName.substring(0, 1).toUpperCase()
+ fieldName.substring(1);
try {
tCls = t.getClass();
getMethod = tCls.getMethod(getMethodName, new Class[] {});
value = getMethod.invoke(t, new Object[] {});
// 判斷值的類型后進行強制類型轉換
textValue = null;
if (value instanceof Integer) {
cell.setCellValue((Integer) value);
} else if (value instanceof Float) {
textValue = String.valueOf((Float) value);
cell.setCellValue(textValue);
} else if (value instanceof Double) {
textValue = String.valueOf((Double) value);
cell.setCellValue(textValue);
} else if (value instanceof Long) {
cell.setCellValue((Long) value);
}
if (value instanceof Boolean) {
textValue = "是";
if (!(Boolean) value) {
textValue = "否";
}
} else if (value instanceof Date) {
textValue = sdf.format((Date) value);
} else {
// 其它數據類型都當作字符串簡單處理
if (value != null) {
textValue = value.toString();
}
}
if (textValue != null) {
matcher = p.matcher(textValue);
if (matcher.matches()) {
// 是數字當作double處理
cell.setCellValue(Double.parseDouble(textValue));
} else {
richString = new XSSFRichTextString(textValue);
cell.setCellValue(richString);
}
}
} catch (SecurityException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} finally {
// 清理資源
}
}
}
try {
workbook.write(out);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* <p>
* 通用Excel導出方法,利用反射機制遍歷對象的所有字段,將數據寫入Excel文件中 <br>
* 此方法生成2003版本的excel,文件名后綴:xls <br>
* </p>
*
* @param title
* 表格標題名
* @param headers
* 表格頭部標題集合
* @param dataset
* 需要顯示的數據集合,集合中一定要放置符合JavaBean風格的類的對象。此方法支持的
* JavaBean屬性的數據類型有基本數據類型及String,Date
* @param out
* 與輸出設備關聯的流對象,可以將EXCEL文檔導出到本地文件或者網絡中
* @param pattern
* 如果有時間數據,設定輸出格式。默認為"yyyy-MM-dd hh:mm:ss"
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public void exportExcel2003(String title, String[] headers, Collection<T> dataset, OutputStream out, String pattern) {
// 聲明一個工作薄
HSSFWorkbook workbook = new HSSFWorkbook();
// 生成一個表格
HSSFSheet sheet = workbook.createSheet(title);
// 設置表格默認列寬度為15個字節
sheet.setDefaultColumnWidth(20);
// 生成一個樣式
HSSFCellStyle style = workbook.createCellStyle();
// 設置這些樣式
style.setFillForegroundColor(HSSFColor.GREY_50_PERCENT.index);
style.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
style.setBorderBottom(HSSFCellStyle.BORDER_THIN);
style.setBorderLeft(HSSFCellStyle.BORDER_THIN);
style.setBorderRight(HSSFCellStyle.BORDER_THIN);
style.setBorderTop(HSSFCellStyle.BORDER_THIN);
style.setAlignment(HSSFCellStyle.ALIGN_CENTER);
// 生成一個字體
HSSFFont font = workbook.createFont();
font.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
font.setFontName("宋體");
font.setColor(HSSFColor.WHITE.index);
font.setFontHeightInPoints((short) 11);
// 把字體應用到當前的樣式
style.setFont(font);
// 生成并設置另一個樣式
HSSFCellStyle style2 = workbook.createCellStyle();
style2.setFillForegroundColor(HSSFColor.WHITE.index);
style2.setFillPattern(HSSFCellStyle.SOLID_FOREGROUND);
style2.setBorderBottom(HSSFCellStyle.BORDER_THIN);
style2.setBorderLeft(HSSFCellStyle.BORDER_THIN);
style2.setBorderRight(HSSFCellStyle.BORDER_THIN);
style2.setBorderTop(HSSFCellStyle.BORDER_THIN);
style2.setAlignment(HSSFCellStyle.ALIGN_CENTER);
style2.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
// 生成另一個字體
HSSFFont font2 = workbook.createFont();
font2.setBoldweight(HSSFFont.BOLDWEIGHT_NORMAL);
// 把字體應用到當前的樣式
style2.setFont(font2);
// 產生表格標題行
HSSFRow row = sheet.createRow(0);
HSSFCell cellHeader;
for (int i = 0; i < headers.length; i++) {
cellHeader = row.createCell(i);
cellHeader.setCellStyle(style);
cellHeader.setCellValue(new HSSFRichTextString(headers[i]));
}
// 遍歷集合數據,產生數據行
Iterator<T> it = dataset.iterator();
int index = 0;
T t;
Field[] fields;
Field field;
HSSFRichTextString richString;
Pattern p = Pattern.compile("^//d+(//.//d+)?$");
Matcher matcher;
String fieldName;
String getMethodName;
HSSFCell cell;
Class tCls;
Method getMethod;
Object value;
String textValue;
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
while (it.hasNext()) {
index++;
row = sheet.createRow(index);
t = (T) it.next();
// 利用反射,根據JavaBean屬性的先后順序,動態調用getXxx()方法得到屬性值
fields = t.getClass().getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
cell = row.createCell(i);
cell.setCellStyle(style2);
field = fields[i];
fieldName = field.getName();
getMethodName = "get" + fieldName.substring(0, 1).toUpperCase()
+ fieldName.substring(1);
try {
tCls = t.getClass();
getMethod = tCls.getMethod(getMethodName, new Class[] {});
value = getMethod.invoke(t, new Object[] {});
// 判斷值的類型后進行強制類型轉換
textValue = null;
if (value instanceof Integer) {
cell.setCellValue((Integer) value);
} else if (value instanceof Float) {
textValue = String.valueOf((Float) value);
cell.setCellValue(textValue);
} else if (value instanceof Double) {
textValue = String.valueOf((Double) value);
cell.setCellValue(textValue);
} else if (value instanceof Long) {
cell.setCellValue((Long) value);
}
if (value instanceof Boolean) {
textValue = "是";
if (!(Boolean) value) {
textValue = "否";
}
} else if (value instanceof Date) {
textValue = sdf.format((Date) value);
} else {
// 其它數據類型都當作字符串簡單處理
if (value != null) {
textValue = value.toString();
}
}
if (textValue != null) {
matcher = p.matcher(textValue);
if (matcher.matches()) {
// 是數字當作double處理
cell.setCellValue(Double.parseDouble(textValue));
} else {
richString = new HSSFRichTextString(textValue);
cell.setCellValue(richString);
}
}
} catch (SecurityException e) {
e.printStackTrace();
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} finally {
// 清理資源
}
}
}
try {
workbook.write(out);
} catch (IOException e) {
e.printStackTrace();
}
}
}
為了演示導出功能,這里我們創建了一個Student學生類。
package com.lyz.utils.excel.poi;
/**
* 例子JavaBean
* @author liuyazhuang
*
*/
public class Student {
private int id;
private String name;
private String sex;
public Student(int id, String name, String sex) {
this.id = id;
this.name = name;
this.sex = sex;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
}
這個類,主要是用來測試我們的工具類。具體代碼如下:
package com.lyz.test;
import java.io.FileOutputStream;
import java.util.ArrayList;
import java.util.List;
import com.lyz.utils.excel.poi.ExportExcelUtil;
import com.lyz.utils.excel.poi.Student;
/**
* 測試文件導出
* @author liuyazhuang
*
*/
public class TestExportExcelUtil {
public static void main(String[] args) throws Exception{
ExportExcelUtil<Student> util = new ExportExcelUtil<Student>();
// 準備數據
List<Student> list = new ArrayList<>();
for (int i = 0; i < 10; i++) {
list.add(new Student(111,"張三asdf","男"));
list.add(new Student(111,"李四asd","男"));
list.add(new Student(111,"王五","女"));
}
String[] columnNames = { "ID", "姓名", "性別" };
util.exportExcel("用戶導出", columnNames, list, new FileOutputStream("E:/test.xls"), ExportExcelUtil.EXCEL_FILE_2003);
}
}
我們運行TestExportExcelUtil類,會發現在我們的E盤下生成了test.xls文件,具體如下:
以上實現均是在本地磁盤生成excel文件,但更多的時候,我們需要通過點擊網頁上的某個按鈕來自動生成并下載Excel文檔,那么,這又如何實現呢?下面我們就一起來實現這個功能。
根據Java的繼承思想,我們不在ExportExcelUtil類上修改添加,我們創建一個ExportExcelUtil類的子類ExportExcelWrapper,這個類繼承ExportExcelUtil的所有功能,同時,擴展了網頁生成Excel的功能。具體代碼如下:
package com.lyz.utils.excel.poi;
import java.net.URLEncoder;
import java.util.Collection;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.lang3.StringUtils;
/**
* 包裝類
* @author liuyazhuang
*
* @param <T>
*/
public class ExportExcelWrapper<T> extends ExportExcelUtil<T> {
/**
* <p>
* 導出帶有頭部標題行的Excel <br>
* 時間格式默認:yyyy-MM-dd hh:mm:ss <br>
* </p>
*
* @param title 表格標題
* @param headers 頭部標題集合
* @param dataset 數據集合
* @param out 輸出流
* @param version 2003 或者 2007,不傳時默認生成2003版本
*/
public void exportExcel(String fileName, String title, String[] headers, Collection<T> dataset, HttpServletResponse response,String version) {
try {
response.setContentType("application/vnd.ms-excel");
response.addHeader("Content-Disposition", "attachment;filename="+ URLEncoder.encode(fileName, "UTF-8") + ".xls");
if(StringUtils.isBlank(version) || EXCEL_FILE_2003.equals(version.trim())){
exportExcel2003(title, headers, dataset, response.getOutputStream(), "yyyy-MM-dd HH:mm:ss");
}else{
exportExcel2007(title, headers, dataset, response.getOutputStream(), "yyyy-MM-dd HH:mm:ss");
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
這樣,我們可以在Controller層調用ExportExcelWrapper將相關的數據和HttpServletResponse傳遞進來,即可實現通過網頁生生并下載Excel文檔了。
@Controller("test")
@RequestMapping("/test")
public class TestController {
@RequestMapping("/get/excel")
public void getExcel(HttpServletRequest request, HttpServletResponse response) throws Exception {
// 準備數據
List<Student> list = new ArrayList<>();
for (int i = 0; i < 10; i++) {
list.add(new Student(111,"張三asdf","男"));
list.add(new Student(111,"李四asd","男"));
list.add(new Student(111,"王五","女"));
}
String[] columnNames = { "ID", "姓名", " 性別"};
String fileName = "excel1";
ExportExcelWrapper<Student> util = new ExportExcelWrapper<Student>();
util.exportExcel(fileName, fileName, columnNames, list, response, ExportExcelUtil.EXCEL_FILE_2003);
}
}
這個網頁很簡單,具體實現如下:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>導出Excel</title>
</head>
<body>
<form id="form_login" action="http://127.0.0.1:8080/test/get/excel" method="post">
</form>
<button id="btn-submit" onclick="beforeSubmit()">Submit</button>
<script type="text/javascript">
var loginForm = document.getElementById('form_login');
function beforeSubmit() {
loginForm.submit();
}
</script>
</body>
</html>
讀到這里,這篇“如何創建一個Java工具類來導出Excel”文章已經介紹完畢,想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會,如果想了解更多相關內容的文章,歡迎關注億速云行業資訊頻道。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。