生成Word_csdn生成word-优快云博客

本文链接：https://blog.youkuaiyun.com/JavaSE_991226/article/details/134929144

生成Word文件

一、环境

<!-- springboot父依赖 -->
<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
</parent>

<!-- springboot启动器依赖 -->
<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
</dependency>



<!-- freemarker依赖 ★★★★★ -->
<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

二、创建模板

1.简单模板: 固定

未使用占位符

在这里插入图片描述

使用占位符

在这里插入图片描述

2.加强模板:动态行

1.首先手动创建Word文件, 格式、样式、假数据, 给写进Word中

2.Word文件另存为XML文件

3.将XML文件修改为ftl文件

4.将ftl文件移动到项目中： resources/templates/ftl

5.因为是动态表格，所以我们需要打开ftl文件，然后找到需要动态化的表格，然后把表格删除剩余一行表头，一行内容

6.在该表格中，找到内容的哪一行标签：例如：

7.在当前标签处，使用动态标签进行包裹

**注意： **

1.因用户列表是list集合遍历的形式动态展示，所以需要遍历列表标签并展示数据。遍历的语法如下：<#list 集合 as 对象名> </#list>

2.注意此处对象别名要和生成word占位符的属性对应上，不然取不到值

3.标签是行的意思，遍历的范围要对，不然word打不开或者后台报错

三、封装工具类

1.直接响应给用户

注意: 以下有可能在服务器中读取不到ftl模板文件, 可以借鉴封装工具类.2来解决

import freemarker.template.Configuration;
import freemarker.template.Template;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.Map;

public class WordUtil {
    
    protected static Logger logger = LoggerFactory.getLogger(WordUtil.class);
    
    //配置信息	
    private static Configuration configuration = null;

    private static final String templateFolder = WordUtil.class.getResource("/templates").getPath();

    static {
        configuration = new Configuration();
        configuration.setDefaultEncoding(CharsetNames.UTF_8);
        try {
            configuration.setDirectoryForTemplateLoading(new File(templateFolder));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    
    private WordUtil() {}

    /**
     * 导出Word
     *
     * @param response 		响应体
     * @param map			word文档中参数
     * @param ftlName 		为模板的名字  例如xxx.ftl
     * @param fileName 		是word 文件的名字 格式为："xxxx.doc"
     * @param tempName 			是临时的文件名, 可随意定义
     * @throws IOException
     */
    public static void exportMillCertificateWord(HttpServletResponse response, 
                                                 Map map, 
                                                 String ftlName, 
                                                 String fileName, 
                                                 String tempName) throws IOException {
        Template freemarkerTemplate = configuration.getTemplate(ftlName);
        File file = null;
        InputStream is = null;
        OutputStream os = null;
        try {
            // 调用工具类的createDoc方法生成Word文档
            file = createDoc(map,freemarkerTemplate,tempName);
            is = new FileInputStream(file);
            // 设置响应头, 指定文件类型和处理方式
            fileName = "attachment;filename=" + URLEncoder.encode(fileName, CharEncoding.UTF_8);
            response.setHeader("Content-Disposition", new String(fileName.getBytes(), StandardCharsets.UTF_8));
            // 设置响应信息
            response.setCharacterEncoding(CharsetNames.UTF_8);
            response.setContentType("application/msword");
            os = response.getOutputStream();
            // 获取相应输出流, 并进行相应
            byte[] bys = new byte[512];
            int len;
            // 通过循环将读入的Word文件的内容输出到浏览器中
            while((len = is.read(bys)) != -1) {
                os.write(bys, 0, len);
            }
        } finally {
            close(is, out, file);
        }
    }

    /**
     * 生成Doc文件
     *
     * @param dataMap  word文档中参数
     * @param template 模板
     * @param filePath 文件路径
     * @return
     */
    private static File createDoc(Map<?, ?> dataMap, Template template, String tempName) {
        File f = new File(tempName);
        Template t = template;
        try {
            // 这个地方不能使用FileWriter因为需要指定编码类型否则生成的Word文档会因为有无法识别的编码而无法打开
            Writer w = new OutputStreamWriter(new FileOutputStream(f), StandardCharsets.UTF_8);
            t.process(dataMap, w);
            w.close();
        } catch (Exception ex) {
            ex.printStackTrace();
            throw new RuntimeException(ex);
        }
        return f;
    }
    
    /**
     * 关闭资源
     *
     * @param is   输入流
     * @param os   输出流
     * @param file 文件
     */
    private static void close(InputStream is, OutputStream os, File file) {
        try {
            if (is != null) {
                is.close();
            }
        } catch (Exception e) {
            logger.error("", e);
        }
        try {
            if (os != null) {
                os.close();
            }
        } catch (Exception e) {
            logger.error("", e);
        }
        try {
            if (file != null) {
                file.delete();
            }
        } catch (Exception e) {
            logger.error("", e);
        }
    }
}

2.上传到服务器，通过下载方式

import freemarker.template.Configuration;
import freemarker.template.Template;
import org.apache.commons.compress.utils.CharsetNames;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.util.Map;

public class WordUtil {

    protected static Logger logger = LoggerFactory.getLogger(WordUtil.class);

    private WordUtil() {
    }

    /**
     * 导出Word文件
     *
     * @param map      word文档中参数
     * @param ftlName  ftl模板
     * @param destPath 绝对路径
     */
    public static void exportMillCertificateWord(Map map, String ftlName, String destPath, String wordName) throws IOException {
        Configuration configuration = new Configuration(Configuration.VERSION_2_3_31);
        configuration.setDefaultEncoding("UTF-8");
        // 获取模板文件的输入流
        InputStream inputStream = WordUtil.class.getResourceAsStream("/template/ftl/" + ftlName);
        InputStreamReader reader = new InputStreamReader(inputStream, StandardCharsets.UTF_8);
        // 创建 Template 对象
        Template freemarkerTemplate = new Template(ftlName, reader, configuration);
        // 检测当前文件是否存在
        File file = new File(destPath);
        if (!file.exists()){
            file.mkdirs();
        }
        // 调用工具类的createDoc方法生成Word文档
        String filePath = destPath + File.separator + wordName;
        createDoc(map, freemarkerTemplate, filePath);
    }

    /**
     * 生成Doc文件
     *
     * @param dataMap  word文档中参数
     * @param template 模板
     * @param filePath 文件路径
     * @return
     */
    private static File createDoc(Map<?, ?> dataMap, Template template, String filePath) {
        File file = new File(filePath);
        Template temp = template;
        try {
            // 这个地方不能使用FileWriter因为需要指定编码类型否则生成的Word文档会因为有无法识别的编码而无法打开
            Writer writer = new OutputStreamWriter(new FileOutputStream(file), StandardCharsets.UTF_8);
            temp.process(dataMap, writer);
            writer.close();
        } catch (Exception ex) {
            ex.printStackTrace();
            throw new RuntimeException(ex);
        }
        return file;
    }

    /**
     * 关闭资源
     *
     * @param is   输入流
     * @param os   输出流
     */
    private static void close(InputStream is, OutputStream os) {
        try {
            if (is != null) {
                is.close();
            }
        } catch (Exception e) {
            logger.error("", e);
        }
        try {
            if (os != null) {
                os.close();
            }
        } catch (Exception e) {
            logger.error("", e);
        }
    }
}

四、调用测试

对应封装"工具类1-模板2"

import com.example.word_download.dao.InterfaceWord;
import com.example.word_download.dao.Parameter;
import com.example.word_download.dao.User;
import com.example.word_download.util.WordUtil;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@RestController
@RequestMapping("/testControllerDownload")
public class wordController {
    
    /**
     * 生成Word
     */
    @GetMapping("/getWord")
    public void getWord(HttpServletResponse response) throws IOException {
        // 封装集合
        List<Region> list = new ArrayList<>();
        list.add(new Region("宝安区", "65.83", "深圳市西部中心"));
        list.add(new Region("龙岗区", "6.83", "深圳市西部中心"));
        list.add(new Region("坪山区", "650.83", "深圳市西部中心"));
        list.add(new Region("南山区", "63.83", "深圳市西部中心"));
        // 封装对象
        Map<String, Object> map = new HashMap<>();
        map.put("region", list);
        // 封装Word模板结果
        HashMap<String, Object> dataMap = new HashMap<>();
        dataMap.put("biddingScale", map);
        // 模板名
        String wordName = "marketAnalysis.ftl";  
        // 导出文件名
        String fileName = "导出文件.doc";
        // 临时文件名
        String tempName = "tempName";
        // 生成文件
        WordUtil.exportMillCertificateWord(response, dataMap, wordName, fileName, tempName);
    }
}

对应封装"工具类2-模板2"

线下文档中有记载…

五、FTL指令常用标签及语法

1、字符输出

${emp.name?if_exists}　　　　　  　// 变量存在，输出该变量，否则不输出
${emp.name!}　　　　　　　　　　    // 变量存在，输出该变量，否则不输出
${emp.name?default("xxx")}        // 变量不存在，取默认值xxx  
${emp.name!"xxx"}    　　　　　　  // 变量不存在，取默认值xxx

常用内部函数

${"123<br>456"?html}    　　// 对字符串进行HTML编码，对html中特殊字符进行转义    
${"str"?cap_first}    　　  // 使字符串第一个字母大写     
${"Str"?lower_case}        // 将字符串转换成小写     
${"Str"?upper_case}        // 将字符串转换成大写    
${"str"?trim}              // 去掉字符串前后的空白字符

字符串的两种拼接方式拼接

$ {"你好${emp.name！}"} //输出你好+变量名  
$ {"hello"+ emp.name！} //使用+号来连接，输出你好+变量名

可以通过如下语法来截取子串

<#assign str =“abcdefghijklmn”/>
//方法1
$ {str?substring（0,4）} //输出abcd
//方法2 
$ { str [ 0 ] } $ {str [4]} //结果是ae
$ {str [1..4]} //结果是bcde
//返回指定字符的索引
$ {str?index_of（"n"）}

2.日期输出

$ {emp.date?string（'yyyy -MM-dd'）} //日期格式

3.数字输出（以数字20为例）

$ {emp.name?string.number} //输出20  
$ {emp.name?string.currency} //¥20.00  
$ {emp.name?string.percent} // 20％  
$ {1.222？int} //将小数转为int，输出1  

<#setting number_format =“percent”/> //设置数字默认输出方式（'percent'，百分比） 
<#assign answer = 42 /> //声明变量回答42  
#{answer} //输出4,200％
$ {answer？string} //输出4,200％
$ {answer？string.number} //输出42
$ {answer？string.currency} //输出¥42.00 
$ {answer？string.percent} //输出4,200％
#{answer} //输出42 

数字格式化插值可采用＃{expr; format}形式来格式化数字，其中格式可以是：
mX：小数部分最小X位
MX：小数部分最大X位
如下面的例子：
<#assign x = 2.582 /> <#assign y = 4 /> 
＃ {x; M2} //输出2.58 
＃ {y; M2} //输出4 
＃ {x; m2} //输出2.58 
＃{Y; m2} //输出4.0
＃ {x; m1M2} //输出2.58 
＃ {x; m1M2} //输出4.0

4.申明变量

<#assign foo = false /> //声明变量，插入布尔值进行显示，注意不要用引号
$ {foo？string（“yes”，“no”）} //当为真时输出“yes”，否则输出“no”

申明变量的几种方式

<#assign name = value> 
<#assign name1 = value1 name2 = value2 ... nameN = valueN> 
<#assign same as above... in namespacehash> 

<#assign name>
 capture this 
</＃assign> 

<#assign name in namespacehash> 
capture this 
</＃assign>

5.比较运算算符

表达式中支持的比较运算符符如下几个：
=或==：判断两个值是否相等。
！=：判断两个值是否不等。
>或gt：判断左边值是否大于右边值>
<=或lte：判断左边值是否小于等于右边值

6.算术运算符

FreeMarker表达式中完全支持算术运算，
FreeMarker支持的算术运算符包括：+， - ，*，/，％
注意：
（1）运算符两边必须是数字
（2）使用+运算符时，如果一边是数字，一边是字符串，就会自动将数字转换为字符串再连接，
     如：$ {3 +“5”}，结果是：35

7.逻辑运算符

逻辑运算符有如下几个：
逻辑与：&& 
逻辑或：|| 
逻辑非：！
逻辑运算符只能作用于布尔值，否则将产生错误

8.FreeMarker中的运算符优先级如下（由高到低排列）

①，一元运算符：！
②，内建函数：
③，乘除法：*，/，％
④，加减法： - ，+ 
⑤，比较：>，<，> =，<=（lt，lte，gt，gte）
⑥，相等：==，=， ！= 
⑦，逻辑与：&& 
⑧，逻辑或：|| 
⑨，数字范围：.. 实际上，我们在开发过程中应该使用括号来严格区分，这样的可读性好，出错少

9.if逻辑判断（注意：elseif不加空格）

<#if condition>
...
<#elseif condition2>
...
<#elseif condition3>
...
<#else>
...
</#if>
if 空值判断

// 当 photoList 不为空时
<#if photoList??>...</#if> 

值得注意的是,${..}只能用于文本部分,不能用于表达式,下面的代码是错误的:
<#if ${isBig}>Wow!</#if>
<#if "${isBig}">Wow!</#if>

// 正确写法
<#if isBig>Wow!</#if>

10.switch (条件可为数字，可为字符串)

<#switch value> 
<#case refValue1> 
....
<#break> 
<#case refValue2> 
....
<#break> 
<#case refValueN> 
....
<#break> 
<#default> 
.... 
</#switch>

11.集合 & 循环

// 遍历集合:
<#list empList! as emp> 
    ${emp.name!}
</#list>

// 可以这样遍历集合:
<#list 0..(empList!?size-1) as i>
    ${empList[i].name!}
</#list>

// 与jstl循环类似,也可以访问循环的状态。

empList?size 　　　// 取集合的长度
emp_index: 　　　　// int类型，当前对象的索引值 
emp_has_next:     // boolean类型，是否存在下一个对象

// 使用<#break>跳出循环
<#if emp_index = 0><#break></#if>

// 集合长度判断 
<#if empList?size != 0></#if> // 判断=的时候,注意只要一个=符号,而不是==

<#assign l=0..100/>    // 定义一个int区间的0~100的集合，数字范围也支持反递增,如100..2
<#list 0..100 as i> 　　// 等效于java for(int i=0; i <= 100; i++)
　　${i}
</#list>

// 截取子集合：
empList[3..5] //返回empList集合的子集合,子集合中的元素是empList集合中的第4-6个元素

// 创建集合：
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x>

// 集合连接运算,将两个集合连接成一个新的集合
<#list ["星期一","星期二","星期三"] + ["星期四","星期五","星期六","星期天"] as x>

// 除此之外,集合元素也可以是表达式,例子如下:
[2 + 2, [1, 2, 3, 4], "whatnot"]

// seq_contains：判断序列中的元素是否存在
<#assign x = ["red", 16, "blue", "cyan"]> 
${x?seq_contains("blue")?string("yes", "no")}    // yes
${x?seq_contains("yellow")?string("yes", "no")}  // no
${x?seq_contains(16)?string("yes", "no")}        // yes
${x?seq_contains("16")?string("yes", "no")}      // no

// seq_index_of：第一次出现的索引
<#assign x = ["red", 16, "blue", "cyan", "blue"]> 
${x?seq_index_of("blue")}  // 2

// sort_by：排序（升序）
<#list movies?sort_by("showtime") as movie></#list>

// sort_by：排序（降序）
<#list movies?sort_by("showtime")?reverse as movie></#list>

// 具体介绍：
// 不排序的情况：
<#list movies as moive>
　　<a href="${moive.url}">${moive.name}</a>
</#list>

//要是排序，则用
<#list movies?sort as movie>
　　<a href="${movie.url}">${movie.name}</a>
</#list>

// 这是按元素的首字母排序。若要按list中对象元素的某一属性排序的话，则用
<#list moives?sort_by(["name"]) as movie>
　　<a href="${movie.url}">${movie.name}</a>
</#list>

//这个是按list中对象元素的[name]属性排序的，是升序，如果需要降序的话，如下所示：
<#list movies?sort_by(["name"])?reverse as movie>
　　<a href="${movie.url}">${movie.name}</a>
</#list>

12.更多查看

https://blog.youkuaiyun.com/qq_44430410/article/details/127448717

https://blog.youkuaiyun.com/qq_45087487/article/details/129836101?ydreferer=aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDg3NDg3L2FydGljbGUvZGV0YWlscy8xMjk4MzYxMDE%3D