EasyPoi导出到响应流工具类

男娘i 2024-04-29 19:12 69阅读 0赞

可以使用实体类导出也可以使用模版导出，还有合并单元格功能

import cn.afterturn.easypoi.excel.ExcelExportUtil;
    import cn.afterturn.easypoi.excel.entity.ExportParams;
    import cn.afterturn.easypoi.excel.entity.TemplateExportParams;
    import com.qdport.common.exception.ServiceException;
    import org.apache.poi.ss.usermodel.Sheet;
    import org.apache.poi.ss.usermodel.Workbook;
    import org.apache.poi.ss.util.CellRangeAddress;
    
    import javax.annotation.Nonnull;
    import javax.annotation.Nullable;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    import java.io.OutputStream;
    import java.io.UnsupportedEncodingException;
    import java.net.URLEncoder;
    import java.util.Collections;
    import java.util.List;
    import java.util.Map;
    
    /**
     * Excel工具类
     *
     * @author luck
     */
    public final class ExcelUtils {
    	private ExcelUtils() {
    		throw new UnsupportedOperationException("工具类无需实例化");
    	}
    
    	/**
    	 * 通过EasyPoi导出到请求响应中
    	 *
    	 * @param <T>      导出实体类型
    	 * @param response 请求响应
    	 * @param name     名称，不要加后缀
    	 * @param dtoClass 导出实体类型实体
    	 * @param dtoList  导出实体列表
    	 * @return Excel文件的名称
    	 * @throws ServiceException Excel导出失败或写入请求响应失败
    	 */
    	public static <T> String exportToResponse(@Nonnull HttpServletResponse response, @Nonnull String name, @Nonnull Class<T> dtoClass, @Nullable List<T> dtoList) throws ServiceException {
    		ExportParams exportParams = new ExportParams(name, name);
    		Workbook workbook;
    		try {
    			workbook = ExcelExportUtil.exportExcel(exportParams, dtoClass, dtoList == null ? Collections.emptyList() : dtoList);
    			setResponse(response, name, workbook);
    		} catch (Exception e) {
    			throw new ServiceException("Excel导出失败", e);
    		}
    		return name;
    	}
    
    	/**
    	 * 导出模版文件到响应流
    	 *
    	 * @param response 响应
    	 * @param name     文件名，可以不带后缀
    	 * @param tempUrl  模版文件的位置
    	 * @param map      数据
    	 * @throws ServiceException
    	 */
    	public static void exportTemplateToResponse(@Nonnull HttpServletResponse response, @Nonnull String name, @Nonnull String tempUrl, @Nonnull Map<String, Object> map) throws ServiceException {
    		ExcelUtils.exportTemplateToResponse(response, name, tempUrl, map, null);
    	}
    
    	/**
    	 * 导出模版文件到响应流
    	 *
    	 * @param response  响应
    	 * @param name      文件名，可以不带后缀
    	 * @param tempUrl   模版文件的位置
    	 * @param map       数据
    	 * @param mergeList 合并单元格的列表，一个元素代表一次合并（例如A2:C5）,注意：要合并的单元格要确保模版中没有被合并
    	 * @throws ServiceException
    	 */
    	public static void exportTemplateToResponse(@Nonnull HttpServletResponse response, @Nonnull String name, @Nonnull String tempUrl, @Nonnull Map<String, Object> map, List<CellRangeAddress> mergeList) throws ServiceException {
    		TemplateExportParams params = new TemplateExportParams(tempUrl);
    		try {
    			Workbook workbook = ExcelExportUtil.exportExcel(params, map);
    			if (mergeList != null) {
    				Sheet sheet = workbook.getSheetAt(0);
    				for (CellRangeAddress cellRangeAddress : mergeList) {
    					sheet.addMergedRegion(cellRangeAddress);
    				}
    			}
    			setResponse(response, name, workbook);
    		} catch (Exception e) {
    			throw new ServiceException("Excel导出失败", e);
    		}
    	}
    
    	public static void setResponse(HttpServletResponse response, String name, Workbook workbook) throws ServiceException {
    		response.setContentType("application/vnd.ms-excel");
    		response.setCharacterEncoding("utf-8");
    		response.setHeader("Access-Control-Expose-Headers", "filename,Content-Disposition");
    		try {
    			name = URLEncoder.encode(name, "UTF-8") + ".xlsx";
    			response.setHeader("filename", name);
    			response.setHeader("Content-Disposition", "attachment;filename=" + name);
    		} catch (UnsupportedEncodingException e) {
    			response.setHeader("Content-Disposition", "attachment");
    		}
    		try (OutputStream os = response.getOutputStream()) {
    			workbook.write(os);
    			os.flush();
    		} catch (IOException e) {
    			throw new ServiceException("Excel写入到请求响应失败：", e);
    		}
    	}
    }