Java使用jxls2根据模板导出excel

首先准备maven依赖

<dependency>
   <groupId>org.jxls</groupId>
   <artifactId>jxls</artifactId>
   <version>2.2.8</version>
</dependency>
<dependency>
   <groupId>org.jxls</groupId>
   <artifactId>jxls-poi</artifactId>
   <version>1.0.6</version>
</dependency>
<dependency>
   <groupId>org.jxls</groupId>
   <artifactId>jxls-jexcel</artifactId>
   <version>1.0.6</version>
</dependency>
<dependency>
   <groupId>org.jxls</groupId>
   <artifactId>jxls-reader</artifactId>
   <version>2.0.1</version>
</dependency>

然后制作模板，制作模板有一些注意事项，也是必须做到符合jxls语法命令的，否则无法动态生成

Excel模板样例

 

Excel模板标记在jxls中的作用分为三部分：

1、bean属性标记

2、XLS Area定义标记

3、XLS Command表示标记

• bean属性标记

jxls使用 Apache JEXL表达式语言来解析定义在excel模板中的表达式。JEXL与JSTL相似，并对JSTL进行了扩展。eg：

${department.chief.age} //属性可以是无限深度

${utils:dateFmt(date,"yyyy-MM-dd")} //自定义工具函数

• XLS Area定义标记

XLS Area 是JxlsPlus中的一个重要概念，它代表excel模板中需要被解析的矩形区域，由A1到最后一个单元格表示，有利于加快解析速度。

XLS Area 使用excel注释标注表示，它需要被定义在excel 模板的第一个单元格（A1）：

jx:area(lastCell = "<AREA_LAST_CELL>")

这个标记定义了excel模板需要被解析的矩形区域为：A1到<AREA_LAST_CELL>。

• XLS Command表示标记

XLS Command 使用excel注释标注表示，命令格式如下：

jx:<command_name>(attr1='val1' attr2='val2' ... attrN='valN' lastCell=<last_cell> areas=["<command_area1>", "<command_area2",
... "<command_areaN>"])

<command_name> 是库自带的命名或是用户自定义并注册到XlsCommentAreaBuilder的命令。

each 命令是最常用的XLS命令，形如：

jx:each(items="employees" var="employee" lastCell="D4")

each 可以有如下一些属性：

• items 上下文中集合的变量名；
• var 在遍历集合的时候每一条记录的变量名；
• area 该XLS Command的解析区域；
• direction 数据在excel中填充的方向，默认（DOWN）向下；
• select 其值为一个表达式，用来过滤数据。

jexl自定义工具函数

如果你需要自定jexl来处理数据，你可以从Transformer对象获取JexlEngine引用，并对其配置。

下面的例子实现了将一个自定义jexl函数注册到utils命名空间下：

JxlsHelper jxlsHelper = JxlsHelper.getInstance();

Transformer transformer = jxlsHelper.createTransformer(is, os);

JexlExpressionEvaluator evaluator = (JexlExpressionEvaluator)transformer.getTransformationConfig().getExpressionEvaluator();

Map<String, Object> funcs = new HashMap<String, Object>();

funcs.put("utils", new JxlsUtils()); //添加自定义功能

evaluator.getJexlEngine().setFunctions(funcs);

接下来就是代码的实现 一个完成的工具类。

package com.sgcc.mall.onestop.utils;
import com.sgcc.mall.core.entitys.DejNgOrder;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class ExportUtil {
    //文件保存位置 TODO
    private static String url = "D:\tools";

    public static void outExportFile(List billInfo) throws IOException {

        Map<String,Object> map = new HashMap<String, Object>();
        map.put("billInfo", billInfo);
        //获取模板所在位置 TODO
        String filePath = "D:\template.xls";
        //导出文件名称
        String fileName = "demo";
        File file = FreeMarkerFileUtil.getPdfFile(filePath,fileName,map);
        FreeMarkerFileUtil.outFile(file,url);
    }

    public static void main(String[] args) {
        List<NgOrder> ngOrders = new ArrayList<NgOrder>();
        NgOrder d = new NgOrder();
        d.setBrand("海尔");
        ngOrders.add(d);
        try {
            outExportFile(ngOrders);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

package com.sgcc.mall.onestop.utils;

import com.aspose.cells.License;
import com.aspose.cells.SaveFormat;
import com.aspose.cells.Workbook;
import org.apache.log4j.Logger;
import org.jxls.common.Context;
import org.jxls.util.JxlsHelper;

import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.net.URLEncoder;
import java.util.Map;


public final class FreeMarkerFileUtil {
    private static Logger log = Logger.getLogger(FreeMarkerFileUtil.class);

    public static final String UTF8 = "utf-8";
    /**
     * 生成execl文件后缀名
     */
    public static final String XLS_SUFFIX = ".xls";
    /**
     * 生成pdf文件后缀名
     */
    public static final String PDF_SUFFIX = ".pdf";
    /**
     * 向浏览器输出execl文件类型，用于指定响应头信息
     */
    public static final int XLS_OUT_TYPE = 1;
    /**
     * 向浏览器输出execl文件响应头信息
     */
    public static final String XLS_CONTENT_TYPE = "application/vnd.ms-excel;charset=" + UTF8;
    /**
     * 向浏览器输出pdf文件类型，用于指定响应头信息
     */
    public static final int PDF_OUT_TYPE = 2;
    /**
     * 向浏览器输出pdf文件响应头信息
     */
    public static final String PDF_CONTENT_TYPE = "application/pdf;charset=" + UTF8;


    /**
     * 根据指定模板生成execl文件
     *
     * @param tmpFilePath 模板文件
     * @param fileName    文件名称
     * @param beans       模板填充数据集
     * @return
     */
    public static File getXlsFile(String tmpFilePath, String fileName, Map beans) throws IOException {
        File xlsFile = File.createTempFile(fileName, XLS_SUFFIX);
        Context context = new Context();
        context.putVar("beans", beans);
        log.info("进入数据填充");
        JxlsHelper.getInstance().processTemplate(new FileInputStream(tmpFilePath), new FileOutputStream(xlsFile), context);
        log.info("数据填充完成");
        return xlsFile;
    }

    /**
     * 根据指定模板生成execl的PDF格式文件
     *
     * @param tmpFilePath 模板文件
     * @param fileName    文件名称
     * @param beans       模板填充数据集
     * @return
     */
    public static File getPdfFile(String tmpFilePath, String fileName, Map beans) throws IOException {
        // 根据模板获取execl文件
        File xlsFile = getXlsFile(tmpFilePath, fileName, beans);
        File pdfFile = execl2Pdf(xlsFile, fileName);
        return pdfFile;
    }

    /**
     * execl文件转换为pdf文件
     *
     * @param xlsFile     execl文件
     * @param pdfFileName 生成的pdf文件名称
     * @return
     */
    public static File execl2Pdf(File xlsFile, String pdfFileName) {
        // 验证License
        if (!getLicense()) {
            throw new RuntimeException("验证License失败！");
        }
        try {
            InputStreamReader inputStreamReader = new InputStreamReader(new FileInputStream(xlsFile), "UTF-8");
            Workbook wb = new Workbook(new FileInputStream(xlsFile));
            File pdfFile = File.createTempFile(pdfFileName, PDF_SUFFIX);
            // 输出路径
            FileOutputStream fileOS = new FileOutputStream(pdfFile);
            wb.save(fileOS, SaveFormat.PDF);
            return pdfFile;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 输出文件到浏览器
     *
     * @param file     需要输出的文件
     * @param fileName 输出的文件名
     * @param response
     * @param type     输出的文件类型
     * @throws IOException
     */
    public static void outFile(File file, String fileName, HttpServletResponse response, int type) throws IOException {
        try {
            fileName = URLEncoder.encode(fileName, UTF8);
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
            throw new RuntimeException("不支持的编码格式：" + UTF8);
        }

        response.reset();
        //设置响应文本格式
        if (type == XLS_OUT_TYPE) {
            response.setContentType(XLS_CONTENT_TYPE);
        } else if (type == PDF_OUT_TYPE) {
            response.setContentType(PDF_CONTENT_TYPE);
        } else {
            throw new RuntimeException("类型错误");
        }
        response.setHeader("Content-Disposition", "attachment;filename=" + new String((fileName).getBytes(), "iso-8859-1"));
        InputStream bis = null;
        OutputStream bos = null;
        try {
            //将文件输出到页面
            ServletOutputStream out = response.getOutputStream();
            bis = new BufferedInputStream(new FileInputStream(file));
            bos = new BufferedOutputStream(out);
            byte[] buff = new byte[1024];
            int bytesRead;
            // 根据读取并写入
            while (-1 != (bytesRead = bis.read(buff, 0, buff.length))) {
                bos.write(buff, 0, bytesRead);
            }
        } finally {
            if (bis != null) {
                bis.close();
            }
            if (bos != null) {
                bos.close();
            }
        }

    }

    /**
     * 输出文件到本地磁盘
     *
     * @param file
     * @param outDir
     * @throws IOException
     */
    public static void outFile(File file, String outDir) throws IOException {
        InputStream bis = null;
        OutputStream bos = null;
        try {
            bis = new BufferedInputStream(new FileInputStream(file));
            bos = new BufferedOutputStream(new FileOutputStream(outDir + file.getName()));
            byte[] buff = new byte[2048];
            int bytesRead;
            // 根据读取并写入
            while (-1 != (bytesRead = bis.read(buff, 0, buff.length))) {
                bos.write(buff, 0, bytesRead);
            }
        } finally {
            if (null != bis) {
                bis.close();
            }
            if (null != bos) {
                bos.close();
            }
        }
    }
    /**
     * 验证license
     *
     * @return
     */
    public static boolean getLicense() {
        boolean result = false;
        try {
            InputStream is = FreeMarkerFileUtil.class.getClassLoader().getResourceAsStream("\license.xml");
            License aposeLic = new License();
            aposeLic.setLicense(is);
            result = true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return result;
    }
}

一个根据模板导出Excel的功能就结束了，更多复杂的功能之后继续完善，希望大家多多提意见，共同进步。