虽然 Apache POI 是非常强大的针对 Microsoft Office 读写的工具,但是其太过于复杂,往往不太好编写代码,且编写出的代码不宜维护(也可能只是网上大家分享的代码大多都不好好整理的原因)。所以在导出读取 Excel 方面有阿里简化后的 easyexcel 可供使用,关于导出 word 我们可以使用 freemarker 模板引擎。
1、在 springboot 项目中添加 freemarker 的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
2、使用 word 做一个你需要的文件模板,并将其中需要改变的部分编程变量(注:图片建议先贴上大小相等的其他图片),类似下面:
3、制作完成之后,将其另存为xml格式
4、将转存的 xml 文件使用文本编辑器例如 notepad++ 等打开,将其中红色区域的删除掉,那些是图片的base64编码后的信息,然后替换为一个图片变量,传入新的图片的 base64 编码即可导出你所要的图片,一般来说导出的图片都是由前台 echarts 等工具生成的。
5、导出列表的话还需要在 xml 中找到 <w:tr> ,在其前加入 <#list list as list> (注意第一个list 不能变,第二个list 为变量名,第三个list 为别名),和</w:tr> 后加入 </#list> ,此外需将 name 改成 list.name,gender 改成 list.gender 。
6、复制 xml 粘贴至项目文件中,并将后缀名更改为 .ftl
7、编写导出 Word 工具类
@Slf4j
public class ExportWordUtil {
private Configuration config;
public ExportWordUtil() {
config = new Configuration(DEFAULT_INCOMPATIBLE_IMPROVEMENTS);
config.setDefaultEncoding("utf-8");
}
/**
* FreeMarker生成Word
* @param dataMap 数据
* @param templateName 模板名
* @param response HttpServletResponse
* @param fileName 导出的word文件名
*/
public void exportWord(Map<String, Object> dataMap, String templateName, HttpServletResponse response, String fileName) {
//加载模板(路径)数据,也可使用setServletContextForTemplateLoading()方法放入到web文件夹下
config.setClassForTemplateLoading(this.getClass(), "/templates");
//设置异常处理器 这样的话 即使没有属性也不会出错 如:${list.name}...不会报错
config.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
try {
if(templateName.endsWith(".ftl")) {
templateName = templateName.substring(0, templateName.indexOf(".ftl"));
}
Template template = config.getTemplate(templateName + ".ftl");
response.setContentType("application/msword");
response.setHeader("Content-disposition", "attachment;filename="+ URLEncoder.encode(fileName, StandardCharsets.UTF_8));
OutputStream outputStream = response.getOutputStream();
Writer out = new BufferedWriter(new OutputStreamWriter(outputStream));
//将模板中的预先的代码替换为数据
template.process(dataMap, out);
log.info("由模板文件:" + templateName + ".ftl" + " 生成Word文件 " + fileName + " 成功!!");
out.flush();
} catch (TemplateNotFoundException e) {
log.info("模板文件未找到");
e.printStackTrace();
} catch (MalformedTemplateNameException e) {
log.info("模板类型不正确");
e.printStackTrace();
} catch (TemplateException e) {
log.info("填充模板时异常");
e.printStackTrace();
} catch (IOException e) {
log.info("IO异常");
e.printStackTrace();
}
}
}
8、编写简单的Controller方法
@RestController
public class Controller {
/**
* @param image 注意该image参数为前台传过来图片
*/
@PostMapping("/exportWord")
public void exportWord(HttpServletResponse response, @RequestParam("image") MultipartFile image){
ExportWordUtil ewUtil = new ExportWordUtil();
Map<String, Object> dataMap = new HashMap<>();
dataMap.put("title", "荒野大镖客2人物");
Base64.Encoder base64 = Base64.getEncoder();
try {
dataMap.put("image", base64.encodeToString(image.getBytes()));
} catch (Exception e){
}
List<User> userList = new ArrayList<>();
userList.add(new User("亚当·摩根","男"));
userList.add(new User("达奇","男"));
userList.add(new User("阿比盖尔·马斯顿","女"));
dataMap.put("list", userList);
ewUtil.exportWord(dataMap, "test.ftl", response, "荒野大镖客2人物.doc");
}
}
9、application.yml 中设置下 size,防止图片的字节数过大
spring:
servlet:
multipart:
max-file-size: 1024MB
max-request-size: 1024MB
10、启动项目,传入某个图片进行测试【注意:尽量前台直接传图片,而不是传图片的 base64 编码的字符串,这可能导致 word 中图片显示不完整】
代码地址:https://github.com/Econfer/exportword
参考如下: