excel匯入匯出使用poi自定義註解
阿新 • • 發佈:2018-12-29
最近在做一個數據匯入匯出的模組 在網上找了一些例子 在這裡整理一下 這裡就不再貼原作者的地址
(以下程式碼來自網上非原創 稍作簡單修改)
首先引入pom.xml依賴
<!-- excel工具 -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>3.9</version>
</dependency>
使用自定義註解
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target( { java.lang.annotation.ElementType.FIELD })
public @interface ExcelVOAttribute {
/**
* 匯出到Excel中的名字.
*/
public abstract String name();
/**
* 配置列的名稱,對應A,B,C,D....
*/
public abstract String column();
/**
* 提示資訊
*/
public abstract String prompt() default "";
/**
* 設定只能選擇不能輸入的列內容.
*/
public abstract String[] combo() default {};
/**
* 是否匯出資料,應對需求:有時我們需要匯出一份模板,這是標題需要但內容需要使用者手工填寫.
*/
public abstract boolean isExport() default true;
}
Excel 工具類
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.poi.hssf.usermodel.DVConstraint;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFCellStyle;
import org.apache.poi.hssf.usermodel.HSSFDataValidation;
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.ss.util.CellRangeAddressList;
import com.sj.stages.common.excel.annotation.ExcelVOAttribute;
/*
* ExcelUtil工具類實現功能:
* 匯出時傳入list<T>,即可實現匯出為一個excel,其中每個物件T為Excel中的一條記錄.
* 匯入時讀取excel,得到的結果是一個list<T>.T是自己定義的物件.
* 需要匯出的實體物件只需簡單配置註解就能實現靈活匯出,通過註解您可以方便實現下面功能:
* 1.實體屬性配置了註解就能匯出到excel中,每個屬性都對應一列.
* 2.列名稱可以通過註解配置.
* 3.匯出到哪一列可以通過註解配置.
* 4.滑鼠移動到該列時提示資訊可以通過註解配置.
* 5.用註解設定只能下拉選擇不能隨意填寫功能.
* 6.用註解設定是否只匯出標題而不匯出內容,這在匯出內容作為模板以供使用者填寫時比較實用.
* 本工具類以後可能還會加功能,請關注我的部落格: http://blog.csdn.net/lk_blog
*/
public class ExcelUtil<T> {
Class<T> clazz;
public ExcelUtil(Class<T> clazz) {
this.clazz = clazz;
}
public List<T> importExcel(String sheetName, InputStream input) {
int maxCol = 0;
List<T> list = new ArrayList<T>();
try {
HSSFWorkbook workbook = new HSSFWorkbook(input);
HSSFSheet sheet = workbook.getSheet(sheetName);
if (!sheetName.trim().equals("")) {
sheet = workbook.getSheet(sheetName);// 如果指定sheet名,則取指定sheet中的內容.
}
if (sheet == null) {
sheet = workbook.getSheetAt(0); // 如果傳入的sheet名不存在則預設指向第1個sheet.
}
int rows = sheet.getPhysicalNumberOfRows();
if (rows > 0) {// 有資料時才處理
// Field[] allFields = clazz.getDeclaredFields();// 得到類的所有field.
List<Field> allFields = getMappedFiled(clazz, null);
Map<Integer, Field> fieldsMap = new HashMap<Integer, Field>();// 定義一個map用於存放列的序號和field.
for (Field field : allFields) {
// 將有註解的field存放到map中.
if (field.isAnnotationPresent(ExcelVOAttribute.class)) {
ExcelVOAttribute attr = field
.getAnnotation(ExcelVOAttribute.class);
int col = getExcelCol(attr.column());// 獲得列號
maxCol = Math.max(col, maxCol);
// System.out.println(col + "====" + field.getName());
field.setAccessible(true);// 設定類的私有欄位屬性可訪問.
fieldsMap.put(col, field);
}
}
for (int i = 1; i < rows; i++) {// 從第2行開始取資料,預設第一行是表頭.
HSSFRow row = sheet.getRow(i);
// int cellNum = row.getPhysicalNumberOfCells();
// int cellNum = row.getLastCellNum();
int cellNum = maxCol;
T entity = null;
for (int j = 0; j < cellNum; j++) {
HSSFCell cell = row.getCell(j);
if (cell == null) {
continue;
}
int cellType = cell.getCellType();
String c = "";
if (cellType == HSSFCell.CELL_TYPE_NUMERIC) {
c = String.valueOf(cell.getNumericCellValue());
} else if (cellType == HSSFCell.CELL_TYPE_BOOLEAN) {
c = String.valueOf(cell.getBooleanCellValue());
} else {
c = cell.getStringCellValue();
}
if (c == null || c.equals("")) {
continue;
}
entity = (entity == null ? clazz.newInstance() : entity);// 如果不存在例項則新建.
// System.out.println(cells[j].getContents());
Field field = fieldsMap.get(j);// 從map中得到對應列的field.
if (field==null) {
continue;
}
// 取得型別,並根據物件型別設定值.
Class<?> fieldType = field.getType();
if (String.class == fieldType) {
field.set(entity, String.valueOf(c));
} else if ((Integer.TYPE == fieldType)
|| (Integer.class == fieldType)) {
field.set(entity, Integer.parseInt(c));
} else if ((Long.TYPE == fieldType)
|| (Long.class == fieldType)) {
field.set(entity, Long.valueOf(c));
} else if ((Float.TYPE == fieldType)
|| (Float.class == fieldType)) {
field.set(entity, Float.valueOf(c));
} else if ((Short.TYPE == fieldType)
|| (Short.class == fieldType)) {
field.set(entity, Short.valueOf(c));
} else if ((Double.TYPE == fieldType)
|| (Double.class == fieldType)) {
field.set(entity, Double.valueOf(c));
} else if (Character.TYPE == fieldType) {
if ((c != null) && (c.length() > 0)) {
field.set(entity, Character
.valueOf(c.charAt(0)));
}
}
}
if (entity != null) {
list.add(entity);
}
}
}
} catch (IOException e) {
e.printStackTrace();
} catch (InstantiationException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (IllegalArgumentException e) {
e.printStackTrace();
}
return list;
}
/**
* 對list資料來源將其裡面的資料匯入到excel表單
*
* @param sheetName
* 工作表的名稱
* @param output
* java輸出流
*/
public boolean exportExcel(List<T> lists[], String sheetNames[],
OutputStream output) {
if (lists.length != sheetNames.length) {
System.out.println("陣列長度不一致");
return false;
}
HSSFWorkbook workbook = new HSSFWorkbook();// 產生工作薄物件
for (int ii = 0; ii < lists.length; ii++) {
List<T> list = lists[ii];
String sheetName = sheetNames[ii];
List<Field> fields = getMappedFiled(clazz, null);
HSSFSheet sheet = workbook.createSheet();// 產生工作表物件
workbook.setSheetName(ii, sheetName);
HSSFRow row;
HSSFCell cell;// 產生單元格
HSSFCellStyle style = workbook.createCellStyle();
style.setFillForegroundColor(HSSFColor.SKY_BLUE.index);
style.setFillBackgroundColor(HSSFColor.GREY_40_PERCENT.index);
row = sheet.createRow(0);// 產生一行
// 寫入各個欄位的列頭名稱
for (int i = 0; i < fields.size(); i++) {
Field field = fields.get(i);
ExcelVOAttribute attr = field
.getAnnotation(ExcelVOAttribute.class);
int col = getExcelCol(attr.column());// 獲得列號
cell = row.createCell(col);// 建立列
cell.setCellType(HSSFCell.CELL_TYPE_STRING);// 設定列中寫入內容為String型別
cell.setCellValue(attr.name());// 寫入列名
// 如果設定了提示資訊則滑鼠放上去提示.
if (!attr.prompt().trim().equals("")) {
setHSSFPrompt(sheet, "", attr.prompt(), 1, 100, col, col);// 這裡預設設了2-101列提示.
}
// 如果設定了combo屬性則本列只能選擇不能輸入
if (attr.combo().length > 0) {
setHSSFValidation(sheet, attr.combo(), 1, 100, col, col);// 這裡預設設了2-101列只能選擇不能輸入.
}
cell.setCellStyle(style);
}
int startNo = 0;
int endNo = list.size();
// 寫入各條記錄,每條記錄對應excel表中的一行
for (int i = startNo; i < endNo; i++) {
row = sheet.createRow(i + 1 - startNo);
T vo = (T) list.get(i); // 得到匯出物件.
for (int j = 0; j < fields.size(); j++) {
Field field = fields.get(j);// 獲得field.
field.setAccessible(true);// 設定實體類私有屬性可訪問
ExcelVOAttribute attr = field
.getAnnotation(ExcelVOAttribute.class);
try {
// 根據ExcelVOAttribute中設定情況決定是否匯出,有些情況需要保持為空,希望使用者填寫這一列.
if (attr.isExport()) {
cell = row.createCell(getExcelCol(attr.column()));// 建立cell
cell.setCellType(HSSFCell.CELL_TYPE_STRING);
cell.setCellValue(field.get(vo) == null ? ""
: String.valueOf(field.get(vo)));// 如果資料存在就填入,不存在填入空格.
}
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
try {
output.flush();
workbook.write(output);
output.close();
return true;
} catch (IOException e) {
e.printStackTrace();
System.out.println("Output is closed ");
return false;
}
}
/**
* 對list資料來源將其裡面的資料匯入到excel表單
*
* @param sheetName
* 工作表的名稱
* @param sheetSize
* 每個sheet中資料的行數,此數值必須小於65536
* @param output
* java輸出流
*/
@SuppressWarnings("unchecked")
public boolean exportExcel(List<T> list, String sheetName,
OutputStream output) {
//此處 對型別進行轉換
List<T> ilist = new ArrayList<>();
for (T t : list) {
ilist.add(t);
}
List<T>[] lists = new ArrayList[1];
lists[0] = ilist;
String[] sheetNames = new String[1];
sheetNames[0] = sheetName;
return exportExcel(lists, sheetNames, output);
}
/**
* 將EXCEL中A,B,C,D,E列對映成0,1,2,3
*
* @param col
*/
public static int getExcelCol(String col) {
col = col.toUpperCase();
// 從-1開始計算,字母重1開始運算。這種總數下來算數正好相同。
int count = -1;
char[] cs = col.toCharArray();
for (int i = 0; i < cs.length; i++) {
count += (cs[i] - 64) * Math.pow(26, cs.length - 1 - i);
}
return count;
}
/**
* 設定單元格上提示
*
* @param sheet
* 要設定的sheet.
* @param promptTitle
* 標題
* @param promptContent
* 內容
* @param firstRow
* 開始行
* @param endRow
* 結束行
* @param firstCol
* 開始列
* @param endCol
* 結束列
* @return 設定好的sheet.
*/
public static HSSFSheet setHSSFPrompt(HSSFSheet sheet, String promptTitle,
String promptContent, int firstRow, int endRow, int firstCol,
int endCol) {
// 構造constraint物件
DVConstraint constraint = DVConstraint
.createCustomFormulaConstraint("DD1");
// 四個引數分別是:起始行、終止行、起始列、終止列
CellRangeAddressList regions = new CellRangeAddressList(firstRow,
endRow, firstCol, endCol);
// 資料有效性物件
HSSFDataValidation data_validation_view = new HSSFDataValidation(
regions, constraint);
data_validation_view.createPromptBox(promptTitle, promptContent);
sheet.addValidationData(data_validation_view);
return sheet;
}
/**
* 設定某些列的值只能輸入預製的資料,顯示下拉框.
*
* @param sheet
* 要設定的sheet.
* @param textlist
* 下拉框顯示的內容
* @param firstRow
* 開始行
* @param endRow
* 結束行
* @param firstCol
* 開始列
* @param endCol
* 結束列
* @return 設定好的sheet.
*/
public static HSSFSheet setHSSFValidation(HSSFSheet sheet,
String[] textlist, int firstRow, int endRow, int firstCol,
int endCol) {
// 載入下拉列表內容
DVConstraint constraint = DVConstraint
.createExplicitListConstraint(textlist);
// 設定資料有效性載入在哪個單元格上,四個引數分別是:起始行、終止行、起始列、終止列
CellRangeAddressList regions = new CellRangeAddressList(firstRow,
endRow, firstCol, endCol);
// 資料有效性物件
HSSFDataValidation data_validation_list = new HSSFDataValidation(
regions, constraint);
sheet.addValidationData(data_validation_list);
return sheet;
}
/**
* 得到實體類所有通過註解映射了資料表的欄位
*
* @param map
* @return
*/
@SuppressWarnings("rawtypes")
private List<Field> getMappedFiled(Class clazz, List<Field> fields) {
if (fields == null) {
fields = new ArrayList<Field>();
}
Field[] allFields = clazz.getDeclaredFields();// 得到所有定義欄位
// 得到所有field並存放到一個list中.
for (Field field : allFields) {
if (field.isAnnotationPresent(ExcelVOAttribute.class)) {
fields.add(field);
}
}
if (clazz.getSuperclass() != null
&& !clazz.getSuperclass().equals(Object.class)) {
getMappedFiled(clazz.getSuperclass(), fields);
}
return fields;
}
}
完成以上步驟一個簡單的excel匯入匯出工具就可以開箱即用了
這裡我們以一個學生為例
import com.sj.stages.common.excel.annotation.ExcelVOAttribute;
public class StudentVO {
@ExcelVOAttribute(name = "序號", column = "A")
private int id;
@ExcelVOAttribute(name = "姓名", column = "B", isExport = true)
private String name;
@ExcelVOAttribute(name = "年齡", column = "C", prompt = "年齡保密哦!", isExport = false)
private int age;
@ExcelVOAttribute(name = "班級", column = "D", combo = { "五期提高班", "六期提高班",
"七期提高班" })
private String clazz;
@ExcelVOAttribute(name = "公司", column = "F")
private String company;
//省略get/set
}
一個簡單的測試 作為結束
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.util.ArrayList;
import java.util.List;
import org.apache.log4j.Logger;
import org.junit.Test;
public class ExcelUtilTest {
private Logger logger = Logger.getLogger(ExcelUtilTest.class);
@Test
public void exportExcel(){
// 初始化資料
List<StudentVO> list = new ArrayList<StudentVO>();
StudentVO vo = new StudentVO();
vo.setId(1);
vo.setName("李坤");
vo.setAge(26);
vo.setClazz("五期提高班");
vo.setCompany("天融信");
list.add(vo);
StudentVO vo2 = new StudentVO();
vo2.setId(2);
vo2.setName("曹貴生");
vo2.setClazz("五期提高班");
vo2.setCompany("中銀");
list.add(vo2);
StudentVO vo3 = new StudentVO();
vo3.setId(3);
vo3.setName("柳波");
vo3.setClazz("五期提高班");
list.add(vo3);
FileOutputStream out = null;
try {
out = new FileOutputStream("d:\\success3.xls");
} catch (FileNotFoundException e) {
e.printStackTrace();
}
ExcelUtil<StudentVO> util = new ExcelUtil<StudentVO>(StudentVO.class);// 建立工具類.
util.exportExcel(list, "學生資訊", out);// 匯出
logger.info("----執行完畢----------");
}
@Test
public void importExcel(){
FileInputStream fis = null;
try {
fis = new FileInputStream("d:\\success3.xls");
ExcelUtil<StudentVO> util = new ExcelUtil<StudentVO>(
StudentVO.class);// 建立excel工具類
List<StudentVO> list = util.importExcel("學生資訊0", fis);// 匯入
logger.info(list);
} catch (FileNotFoundException e) {
e.printStackTrace();
}
}
}
如果上面簡單匯出一個物件還無法滿足你的需求的話 這裡有它的一個升級版 支援一對多的關係匯入 匯出