Java中 excel导入导出

  其实此处用的主要是apache提供的POI组件，POI参考: https://blog.youkuaiyun.com/wsh900221/article/details/80600180，其次辅助技术为:

• 对输入输出流的使用
• 自定义注解的使用:https://blog.youkuaiyun.com/PORSCHE_GT3RS/article/details/80304701

一：导出

1.数据库查询得到要导出的数据list

2.工具类：导出，将list数据转换为excel（将excel数据转为ByteArrayOutputStream，间接传给下载方法）

  2.1 先写入表头，用到注解类。写入时设置每列的属性（此整列是否导出，是否可输入)
  2.2循环list写入内容
  2.3将excel写入ByteArrayOutputStream（workbook.write(output)）

3.工具类：浏览器下载excel

  3.1设置浏览器的保存文件的格式为excel，文件名
  3.2将ByteArrayOutputStream 转为 —> 字节数据—> 将字节数组写入BufferedInputStream（缓冲提高效率）转为—> 字节数组—>BufferedOutputStream

二：导入

1.页面设置

  form应设置enctype="multipart/form-data，input的类型为file

<form method="post" action="excel" enctype="multipart/form-data">
   <input type="submit" name="export" value="Excel导出">
</form>

2.servlet设置

  2.1参数类型为MultipartFile 来接收页面传来的值（参数名和jsp中name一样）
  2.2在servlet中将MultipartFile转换为文件输入流FileInputStream，传给工具类方法importExcel
  2.3工具类方法importExcel返回list，根据需求，将list插入到数据库

3.工具类：导入

  3.1将servlet传进来的文件输入流 读取到—>工作簿—>获取工作簿中的第一张工作表
  3.2写入list：首先获取excel表的总行数；外层循环行数，循环体为：第一个里循环：首先获取实体注解的字段，并根据注解获取最大列号，并将每个字段放入map中，列号为key，字段为字段，第二个里层循环：列数，获取每个字段的值设置到实体中，里层循环完就是一个实体，然后添加到list

三：工具

  完整代码地址：https://pan.baidu.com/s/1esJKELCHqpoCcKzyaaIpiw

导入导出工具代码：

package CommonUtil;

import org.apache.poi.hssf.usermodel.*;
import org.apache.poi.hssf.util.HSSFColor;
import org.apache.poi.ss.util.CellRangeAddressList;
//
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


/* 
 * ExcelUtil工具类实现功能: 
 * 导出时传入list<T>,即可实现导出为一个excel,其中每个对象Ｔ为Excel中的一条记录. 
 * 导入时读取excel,得到的结果是一个list<T>.T是自己定义的对象. 
 * 需要导出的实体对象只需简单配置注解就能实现灵活导出,通过注解您可以方便实现下面功能: 
 * 1.实体属性配置了注解就能导出到excel中,每个属性都对应一列. 
 * 2.列名称可以通过注解配置. 
 * 3.导出到哪一列可以通过注解配置. 
 * 4.鼠标移动到该列时提示信息可以通过注解配置. 
 * 5.用注解设置只能下拉选择不能随意填写功能. 
 * 6.用注解设置是否只导出标题而不导出内容,这在导出内容作为模板以供用户填写时比较实用. 
 * 本工具类以后可能还会加功能,请关注我的博客: http://blog.youkuaiyun.com/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);

			// 如果指定sheet名,则取指定sheet中的内容.
			if (!sheetName.trim().equals("")) {
				sheet = workbook.getSheet(sheetName);
			}

			// 如果传入的sheet名不存在则默认指向第1个sheet.
			if (sheet == null) {
				sheet = workbook.getSheetAt(0);
			}

			//获取的时excel记录数：获取的是物理行数，也就是不包括那些空行（隔行）的情况;https://blog.youkuaiyun.com/z69183787/article/details/54091306
			int rows = sheet.getPhysicalNumberOfRows();

			if (rows > 0) {// 有数据时才处理
				// Field[] allFields = clazz.getDeclaredFields();// 得到类的所有field
				List<Field> allFields = getMappedFiled(clazz, null);

				//{{0:name;1:sex},{0:name;1:sex}}
				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);// 设置类的private私有字段属性可访问.
						fieldsMap.put(col, field);
					}
				}
				/*for (Map.Entry<Integer, Field>  e : fieldsMap.entrySet()) {
					System.err.println("key="+e.getKey());
					System.err.println("value="+e.getValue());
				}*/
				/*
				* 读取每行
				*/
				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;
					//System.err.println("cellNum="+cellNum);
					/*
					* 读取每列
					*/
					for (int j = 0; j <= cellNum; j++) {
						//System.err.println("j="+j);
						if (row==null) {
							continue;
						}
						//获取每行中的列
						HSSFCell cell = row.getCell(j);
						if (cell == null) {
							continue;
						}

						//获取单元格的数据类型（
						// CELL_TYPE_NUMERIC 数值型 0
						//CELL_TYPE_STRING 字符串型 1
						//CELL_TYPE_FORMULA 公式型 2
						//CELL_TYPE_BLANK 空值 3
						//CELL_TYPE_BOOLEAN 布尔型 4
						//CELL_TYPE_ERROR 错误 5
						int cellType = cell.getCellType();
						String c = "";
						Integer val;
						//System.err.println("cellType="+cellType);

						//得到单元格内容
						if (cellType == HSSFCell.CELL_TYPE_NUMERIC) {
							//数值类型，
							val=(int)cell.getNumericCellValue();
							c = String.valueOf(val);
						} else if (cellType == HSSFCell.CELL_TYPE_BOOLEAN) {
							//布尔类型，
							c = String.valueOf(cell.getBooleanCellValue());
						} else {
							//直接读取单元格内容
							c = cell.getStringCellValue();
						}
						//System.err.println("c="+c);
						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();
						//System.err.println("fieldType="+fieldType.toString());
						if (String.class == fieldType) {
							//，将单元格内容转换为实体属性类型的值
							field.set(entity, String.valueOf(c));
						} else if ((Integer.TYPE == fieldType) || (Integer.class == fieldType)) {
							field.set(entity, Integer.valueOf(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)));
							}
						}else{
							System.out.println("未知的字段数据类型fieldType="+fieldType.getClass().toString());
						}

					}
					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 lists  导出数据的集合
	 * @param sheetNames 工作表名称
	 *            工作表的名称
	 * @param output
	 *            java输出流
	 */
	@SuppressWarnings("resource")
	public boolean exportExcel(List<T> lists[], String sheetNames[], OutputStream output) {

		//excel表格数 = 文件名个数
		if (lists.length != sheetNames.length) {
			System.out.println("数组长度不一致");
			return false;
		}

		// 产生工作薄对象（apache）
		HSSFWorkbook workbook = new HSSFWorkbook();
		for (int ii = 0,len= lists.length ; ii < len; ii++) {
			//获取list数组中的每个list<T>,将其导出
			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);
				// 设置单元格类型，设置列中写入内容为String类型,
				cell.setCellType(HSSFCell.CELL_TYPE_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);//单元格内容数据格式为string
							 如果数据存在就填入,不存在填入空格（Field.get（）返回指定对象上由此Field表示的字段的值。如果该对象具有原始类型，则该值将自动包装在对象中）
							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);//将生成的excel文件写入字节流
			output.close();//关闭字节流
			return true;
		} catch (IOException e) {
			e.printStackTrace();
			System.out.println("Output is closed ");
			return false;
		}

	}

	/**
	 * 对单个list数据源将其里面的数据导入到一张excel表单
	 * @param list
	 *            要导出的数据
	 * @param sheetName
	 *            工作表的名称

	 * @param output
	 *            java输出流
	 */
	@SuppressWarnings("unchecked")
	public boolean exportExcel(List<T> list, String sheetName, OutputStream output) {

		// 将自定类型的list  转换为  泛型类型的list
		List<T> ilist = new ArrayList<T>();
		for (T t : list) {
			ilist.add(t);
		}

		//为了方法通用，调用导出多个excel表格
		//将导出一张excel的数据存入list[] 中
		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 clazz 实体类型
	 * @param fields
	 * @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) {
			//判断 指定类型的注释存在于此元素上,否则返回false
			if (field.isAnnotationPresent(ExcelVOAttribute.class)) {
				fields.add(field);
			}
		}

		//得到父类注解的所有字段名称（实体继承时）
			//返回当前类的父类
		if (clazz.getSuperclass() != null && !clazz.getSuperclass().equals(Object.class)) {
			getMappedFiled(clazz.getSuperclass(), fields);
		}

		return fields;
	}
	
	
	public static void main(String[] args) {}

	/**
	 * 浏览器下载excel（只能时xls格式）
	 *
	 * @param fileName 实体类型
	 * @param os 字节输出流
	 * param response
	 * @return 表格表头
	 */
	public void download(String fileName, ByteArrayOutputStream os, HttpServletResponse response) {
		byte[] content = os.toByteArray();
		InputStream is = new ByteArrayInputStream(content);//创建字节数组输入流
		try {
			// 设置response参数，可以打开下载页面

			//来清除html首部的空白行（空白行的出现原因，jsp代码编译后产生。就是有jsp生成html文件的时候，html文件内部会出现很多空白行。下载后的文件内的空白行也是这样产生的）
			response.reset();

			//设置浏览器保存excel文件
			// 使客户端浏览器，区分不同种类的数据，并根据不同的MIME调用浏览器内不同的程序嵌入模块来处理相应的数据(即让浏览器把接收到数据以指定的格式解析，这就是xls格式解析)
			// :https://blog.youkuaiyun.com/luman1991/article/details/53423305
			response.setContentType("application/vnd.ms-excel;charset=utf-8");

			//设置下载文件的名称：https://blog.youkuaiyun.com/junmoxi/article/details/76976692
			response.setHeader("Content-Disposition", "attachment;filename=" + new String((fileName).getBytes(), "iso-8859-1"));

			//将二进制数据写入响应的流
			ServletOutputStream out = response.getOutputStream(); //使用OutputStream流流向客户端浏览器输出中文数据

			BufferedInputStream bis = null; //缓冲字节输入流，是一个高级流(处理流)，与其他低级流配合使用
			BufferedOutputStream bos = null;//缓冲字节输出流
			try {
				//创建字节缓冲输入流：将字节数组输入流 转换为 字节缓冲输入流，提高缓存
				bis = new BufferedInputStream(is);
				//创建字节缓冲输出流
				bos = new BufferedOutputStream(out);
				//创建字节数组
				byte[] buff = new byte[2048];
				int bytesRead;
				// Simple read/write loop.
				//读取字节的输入流buff.length个字节到buff字节数组,返回读取的字节数
				while (-1 != (bytesRead = bis.read(buff, 0, buff.length))) {
					//将指定 buff 数组中从偏移量 0 开始的 bytesRead 个字节写入此输出流（因为在while循环中已经将数据写入到了数组buff中）
					bos.write(buff, 0, bytesRead);
				}
			} catch (final IOException e) {
				throw e;
			} finally {
				if (bis != null)
					//关闭输入流
					bis.close();
				if (bos != null)
					//关闭输出流
					bos.close();
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}


}

注解类:

package CommonUtil;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)  
@Target(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;  
}

  此篇文章参考：[http://blog.youkuaiyun.com/lk_blog](http://blog.youkuaiyun.com/lk_blog)，自己只是在原有的基础上给工具类添加了一些注释