java freemarker实现动态生成excel文件

 更新时间:2023年12月29日 10:39:59   作者:Swallow~  
这篇文章主要为大家详细介绍了java如何通过freemarker实现动态生成excel文件,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下

最近做了一个动态生成excel的功能,这里记录下部分功能,主要用到的是freemarker框架,spring就有带,我起的demo载入了一下freemarker的jar包

一、创建模板

首先可以创建一个excel,编辑自己想要的模板,这里举个简单的例子

编写好后可以保存一下,然后再保存为.xml格式的文件,就能得到模板雏形

大概是长这样

然后根据ftl文件的语法,我们可以对模板进行改造,加入自己需要的字段

这里列举一些常见的方式

1、普通字段填充

<Cell ss:StyleID="s17"><Data ss:Type="String">姓名</Data></Cell>
<Cell ss:StyleID="s17"><Data ss:Type="String">${(name)!}</Data></Cell>

2、日期填充,java传入的参数类型为Date

    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">出生年月</Data></Cell>
    <Cell ss:StyleID="s17">
    <#if birth??><Data ss:Type="String">${birth?string("yyyy-MM-dd")}</Data></#if>
    </Cell>

3、switch case选择用法

<Cell ss:StyleID="s17"><Data ss:Type="String">国籍</Data></Cell>
    <Cell ss:StyleID="s17">
    <#if certType??>
            <#switch certType> 
                <#case "A"> 
                    <Data ss:Type="String">■身份证 □外籍护照 □港澳居民来往内地通行证</Data>
                <#break> 
                <#case "B"> 
                    <Data ss:Type="String">□身份证 ■外籍护照 □港澳居民来往内地通行证</Data>
                <#break> 
                <#case "C"> 
                    <Data ss:Type="String">□身份证 □外籍护照 ■港澳居民来往内地通行证</Data>
                <#break> 
                <#default> 
            </#switch>
            <#else>
                <Data ss:Type="String">□身份证 □外籍护照 □港澳居民来往内地通行证</Data>
        </#if>
    </Cell>

4、数组对象展示

(这边我做的这个主要是因为有动态展示的需求,如果没有家属信息,就不展示家属单元格)

   <#list spouseInfos as row>
   <Row ss:AutoFitHeight="0">
    <Cell ss:MergeDown="2" ss:StyleID="s18"><Data ss:Type="String">家属信息</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">姓名</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(row.name)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">关系</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(row.relation)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">联系电话</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(row.tel)!}</Data></Cell>
   </Row>
   </#list>

这里需要注意如果使用了数组动态展示需要计算行数

可以把xml文件里的ExpandedRowCount参数进行修改,加入totalRowCount参数标记行数

在java程序中需要动态计算这个行数

 <Table ss:ExpandedColumnCount="3" ss:ExpandedRowCount="${(totalRowCount)!}" x:FullColumns="1"
   x:FullRows="1" ss:DefaultColumnWidth="54" ss:DefaultRowHeight="13.5">

模板制作好以后保存再修改文件格式名称为.ftl即可

主体部分为

  <Table ss:ExpandedColumnCount="3" ss:ExpandedRowCount="${(totalRowCount)!}" x:FullColumns="1"
   x:FullRows="1" ss:DefaultColumnWidth="54" ss:DefaultRowHeight="13.5">
   <Column ss:Index="3" ss:AutoFitWidth="0" ss:Width="310.5"/>
   <Row>
    <Cell ss:MergeDown="2" ss:StyleID="s18"><Data ss:Type="String">基本信息</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">姓名</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(name)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">性别</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(sex)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">出生年月</Data></Cell>
    <Cell ss:StyleID="s17">
    <#if birth??><Data ss:Type="String">${birth?string("yyyy-MM-dd")}</Data></#if>
    </Cell>
   </Row>
   <Row>
    <Cell ss:MergeDown="2" ss:StyleID="s18"><Data ss:Type="String">其他信息</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">国籍</Data></Cell>
    <Cell ss:StyleID="s17">
    <#if certType??>
            <#switch certType> 
                <#case "A"> 
                    <Data ss:Type="String">■身份证 □外籍护照 □港澳居民来往内地通行证</Data>
                <#break> 
                <#case "B"> 
                    <Data ss:Type="String">□身份证 ■外籍护照 □港澳居民来往内地通行证</Data>
                <#break> 
                <#case "C"> 
                    <Data ss:Type="String">□身份证 □外籍护照 ■港澳居民来往内地通行证</Data>
                <#break> 
                <#default> 
            </#switch>
            <#else>
                <Data ss:Type="String">□身份证 □外籍护照 □港澳居民来往内地通行证</Data>
        </#if>
    </Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">居住地址</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(address)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">联系电话</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(tel)!}</Data></Cell>
   </Row>
   <#list spouseInfos as row>
   <Row ss:AutoFitHeight="0">
    <Cell ss:MergeDown="2" ss:StyleID="s18"><Data ss:Type="String">家属信息</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">姓名</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(row.name)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">关系</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(row.relation)!}</Data></Cell>
   </Row>
   <Row>
    <Cell ss:Index="2" ss:StyleID="s17"><Data ss:Type="String">联系电话</Data></Cell>
    <Cell ss:StyleID="s17"><Data ss:Type="String">${(row.tel)!}</Data></Cell>
   </Row>
   </#list>
  </Table>

二、生成文件

生成文件的主要java代码如下

import freemarker.template.Configuration;
import freemarker.template.Template;
 
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;
 
public class ExcelUtil {
 
    /**
     * 根据模板生成文件
     * @param dataMap           写入数据
     * @param templateFilePath  模板文件路径
     * @param outFileName       输出文件路径
     */
    public static void doGenerateFile(Map<String, Object> dataMap, String templateFilePath, String outFileName) {
 
        Writer out = null;
        FileOutputStream fileStream = null;
        //需要压缩的文件,大于1个才会压缩
 
        try {//生成合同文件
            Configuration configuration = new Configuration();
            configuration.setDefaultEncoding("UTF-8");
 
            Template t = configuration.getTemplate(templateFilePath); // 获取模板文件
 
            // 导出文件
            File outFile = new File(outFileName);
 
            //获取父目录
            File fileParent = outFile.getParentFile();
            //判断是否存在
            if (!fileParent.exists()) {
                //创建父目录文件
                fileParent.mkdirs();
            }
 
            OutputStreamWriter oWriter = null;
            fileStream = new FileOutputStream(outFile);
            oWriter = new OutputStreamWriter(fileStream, StandardCharsets.UTF_8);
            out = new BufferedWriter(oWriter);
 
            // 将填充数据填入模板文件并输出到目标文件
            t.process(dataMap, out);
        } catch (Exception e1) {
            if (fileStream != null && out != null) {
                close(fileStream, out);
            }
            System.out.println("生成文件出错," + e1.getMessage());
        } finally {
            if (fileStream != null && out != null) {
                close(fileStream, out);
            }
        }
 
    }
 
    private static void close(FileOutputStream fileStream, Writer out) {
        try {
            fileStream.flush();
            fileStream.close();
            out.flush();
            out.close();
        } catch (Exception e) {
            System.out.println("关闭流异常," + e.getMessage());
        }
    }
 
    public static Date str2Date(String dateString) {
        try {
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
            Date date = sdf.parse(dateString);
            return date;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

写个简单的类测试一下

1、如果不需要展示List对象的数据,可以存一个空数组到Map,本文为例,家属信息为列表对象

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
 
public class TestMain {
    public static void main(String[] args) {
        //相对路径 模板文件、输出文件
        String templateFile = "file/temp.ftl";
        String outFileName = "file/test.xls";
        Map<String, Object> dataMap = test01();
//        Map<String, Object> dataMap = test02();
 
        try {
            ExcelUtil.doGenerateFile(dataMap, templateFile, outFileName);
        } catch (Exception e) {
            System.out.println("处理异常," + e.getMessage());
        }
    }
 
    private static Map<String, Object> test01() {
 
        Map<String, Object> dataMap = new HashMap<>();
        BigDecimal baseRow = new BigDecimal(6);
        dataMap.put("name", "张三");
        dataMap.put("sex", "男");
        dataMap.put("birth", ExcelUtil.str2Date("1990-01-10"));
        dataMap.put("certType", "A");
        dataMap.put("address", "地址详情");
        dataMap.put("tel", "110110");
//放入一个空数组的参数避免合成的时候报错
        List<Map<String, Object>> list = new ArrayList<>();
        dataMap.put("spouseInfos", list);
        dataMap.put("totalRowCount", baseRow);
        return dataMap;
    }
 
    private static Map<String, Object> test02() {
 
        Map<String, Object> dataMap = new HashMap<>();
        BigDecimal baseRow = new BigDecimal(6);
        dataMap.put("name", "张三");
        dataMap.put("sex", "男");
        dataMap.put("birth", ExcelUtil.str2Date("1990-01-10"));
        dataMap.put("certType", "A");
        dataMap.put("address", "地址详情");
        dataMap.put("tel", "110110");
        List<Map<String, Object>> list = new ArrayList<>();
        Map<String, Object> s1 = new HashMap<>();
        s1.put("name", "李四");
        s1.put("relation", "夫妻");
        s1.put("tel", "112112");
        list.add(s1);
        dataMap.put("spouseInfos", list);
        //计算展示行数
        BigDecimal subtract = baseRow.add(new BigDecimal(3));
        dataMap.put("totalRowCount", subtract);
        return dataMap;
    }
}

使用test01数据效果如图

使用test02数据效果如图

到此这篇关于java freemarker实现动态生成excel文件的文章就介绍到这了,更多相关java freemarker生成excel内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java后端Spring Boot全局异常处理最佳实践记录

    Java后端Spring Boot全局异常处理最佳实践记录

    Spring Boot通过和提供强大的异常处理机制,支持统一REST和页面错误响应,这篇文章主要介绍了Java后端Spring Boot全局异常处理的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-08-08
  • Java 锁的知识总结及实例代码

    Java 锁的知识总结及实例代码

    这篇文章主要介绍了Java 锁的知识总结及实例代码,需要的朋友可以参考下
    2016-09-09
  • Java多线程中的ThreadPoolExecutor解读

    Java多线程中的ThreadPoolExecutor解读

    这篇文章主要介绍了Java多线程中的ThreadPoolExecutor解读,线程池中的核心线程数,当提交一个任务时,线程池创建一个新线程执行任务,直到当前线程数等于corePoolSize;如果当前线程数为corePoolSize,继续提交的任务被保存到阻塞队列中,等待被执行,需要的朋友可以参考下
    2023-09-09
  • 关于SpringBoot自定义条件注解与自动配置

    关于SpringBoot自定义条件注解与自动配置

    这篇文章主要介绍了关于SpringBoot自定义条件注解与自动配置,Spring Boot的核心功能就是为整合第三方框架提供自动配置,而本文则带着大家实现了自己的自动配置和Starter,需要的朋友可以参考下
    2023-07-07
  • 深入理解框架背后的原理及源码分析

    深入理解框架背后的原理及源码分析

    这篇文章来为大家深入的介绍了框架背后的原理及源码分析,希望大家能够更深层次的理解并使用好框架,在此与君共勉,框架虽好,但不要丢了其背后的原理
    2022-01-01
  • 10种简单的Java性能优化

    10种简单的Java性能优化

    你是否正打算优化hashCode()方法?是否想要绕开正则表达式?Lukas Eder介绍了很多简单方便的性能优化小贴士以及扩展程序性能的技巧
    2017-11-11
  • 解决netty中spring对象注入失败的问题

    解决netty中spring对象注入失败的问题

    这篇文章主要介绍了解决netty中spring对象注入失败的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • java使用jdbc连接数据库简单实例

    java使用jdbc连接数据库简单实例

    这篇文章主要为大家详细介绍了java使用jdbc连接数据库的简单实例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-07-07
  • Java 回调机制(CallBack) 详解及实例代码

    Java 回调机制(CallBack) 详解及实例代码

    这篇文章主要介绍了 Java 回调机制(CallBack) 详解及实例代码的相关资料,需要的朋友可以参考下
    2017-02-02
  • spring boot项目fat jar瘦身的实现

    spring boot项目fat jar瘦身的实现

    这篇文章主要介绍了spring boot项目fat jar瘦身的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06

最新评论