java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > Java模板填充Word

基于Java实现模板填充Word

作者：放纵日放纵

这篇文章主要为大家详细介绍了如何用 Java 实现按产品经理提供的 Word 模板填充数据,并以 word 或 pdf 形式导出,有需要的小伙伴可以参考一下

Java实现按模板填充word

本文讲解的需求是：我们需要把数据库中的某些数据按照 产品经理提供的 word模板，把数据表中的一些内容根据模板填充到 word 模板，然后把 word 模板 再以 pdf 的形式 导出，我们 可以根据自己的需求来进行一个研究，也可以 只以word的形式导出。

下面这段代码：

模板文件，我们是模板文件放到了 resources包 （资源根） 下的 static 目录下面

首先定义了输出临时word的路径 （因为我们的目标是最终获得 pdf 文件，如果你是想要获得 word 就可以直接是 你的目标存储位置）

定义了 我们 pdf 的最终 的 下载的路径

(在项目中一般是前端给我们传过来的 下载的路径，我们不需要自己 设置，我们可以通过 response 进行获取)

 	    // 清楚模板缓存
        response.reset();
        //传给前端
        response.setCharacterEncoding("UTF-8"); // 设置编码格式
        //设置Header字段
        // 文件名
        String fileName = "模板.docx";
        String encodedFileName = URLEncoder.encode(fileName, "UTF-8");
        // 对文件名进行编码
        response.setHeader("Content-disposition", "attachment;filename=" + encodedFileName);
        // 获得输出流
        OutputStream out = response.getOutputStream();
        template.write(out);

下面就是定义我们想要填充的数据，注意，我们在做word 模板填充的时候是 使用的 poi 依赖，所以 value 必须是 String 类型的

这些数据是我自己 设置的一些假数据 ，在真实的需求中，我们就需要从数据库中获取了

然后调用了 两种方法 分别进行不同的操作

// 这个是 模板填充word的方法
fillWordTemplate(templatePath, outputWordPath, map);
/** 第一个参数是 模板文件
	第二个参数是 输出的 word 的路径 就是模板填写完毕之后，下载到哪里
	第三个参数就是对应的 数据的关系了
*/

 Files.deleteIfExists(Paths.get(outputWordPath));
//在目标是 pdf 文件时，帮助我们删除掉 word 文件

 @Test
    public void testWORDPDF() throws IOException {
        //得到静态包下的模板文件
        String templatePath = "/static/测试文档.docx";
        // 输出临时Word文件路径（用于后续转换为PDF）
        String outputWordPath = "D:\\Users\\lenovo\\Desktop\\模板.docx";
        //给出pdf 下载到的路径 项目中通过 response.getOutputStream() 获取
        String PDFpath = "D:\\Users\\lenovo\\Desktop\\测试.pdf";

        //模拟要填充的数据 项目中从数据库获取，但是要保证，填充的数据一定要是 String 类型
        Map<String, String> map = new HashMap<>();
        map.put("username", "野原新之助");
        map.put("year", "5岁");
        map.put("text", "优点：活泼、好动、乐观、可爱、标新立异，运动神经好（每次跟河村豹跑步都不喘气，而且可以做很多高难度动作），体贴却不坦率。\n" +
                "缺点：挑食，好色、顽皮、早熟、健忘、迟钝（有时看情况）、爱耍贱。\n" +
                "喜好：\n" +
                "喜欢的动画人物有动感超人、钢弹勇士、肥嘟嘟左卫门（小新的自创角色）、铅笔小新（播出后深受小新和自己的朋友欢迎，但父母却很抗议）。\n" +
                "喜欢的运动有剑道（学习剑道目的也只是打赢代代木这个强敌）、足球、躲避球、棒球。（有时将光屁屁舞当成运动）、拳击（在《这就是青春》这一篇章中小新成为国中生时的爱好）、游泳。\n" +
                "喜欢的动作是光屁屁超人舞（也称露屁屁外星人）、大象舞、把妈妈的内衣内裤套在头上、学动感超人大笑、发射动感光波、摸头害羞的笑。 [1]\n" +
                "喜欢的食物有巧克力饼干（日本商店有售，而且是小新代言的）、纳豆拌饭、咖喱、火锅、炸薯条、刨冰、冰淇淋、布丁、蛋糕、洋芋片（薯片）、仙贝（等零食）、寿司等。\n" +
                "喜欢的饮料有100%纯果汁、可乐、绿茶（浓一点的） pus light（瓶子上有这个标识）。\n" +
                "喜欢的歌手是唱《动感超人》主题曲的那位叔叔。\n" +
                "喜欢的动物有小白（捡来的流浪狗，全名为野原小白）、小鸡（被小新取名为：麻雀） 、猫（被小新取名为：问号），大象，仓鼠（正男家仓鼠生小宝宝拜托小新养一只，被小新取名马来亚，另外一只猫（被小新取名为玛莉莲，是松阪老师家的猫）。\n" +
                "喜欢的电影作品有《动感超人》，《钢达姆勇士》。\n" +
                "喜欢的人有大原娜娜子、金有民子、小椿。\n" +
                "喜欢女生的要胸部大，15岁以上且脸蛋可爱漂亮、身材好。 [1]\n" +
                "厌恶：\n" +
                "讨厌的食物有青椒、胡萝卜、不加葱的纳豆和加葱的味增汤、西兰花、洋葱。");

        //填充模板

        // 将填充后的Word文档转换为PDF
        try {
            this.fillWordTemplate(templatePath, outputWordPath, map);
            this.wordToPdf(outputWordPath, PDFpath);
            //            //下面可以添加代码实现下载的逻辑，比如通过响应流返回给客户端
            System.out.println("PDF文件已生成，路径为：" + PDFpath);
        } catch (Exception e) {
            e.printStackTrace();
        }
            Files.deleteIfExists(Paths.get(outputWordPath));  //删除临时文件
    }

下面这个方法是 word 模板填充后下载的方法

首先 我们制定了一个 模板 并且设置了标记 ${ } ；注意这里和你的 word 模板是相照应的，你想要把数据填充后到哪里你就需要怎样进行照应

//例如  word
用户：${username}

因为我们的模板文件是在 resources 包下面 （这里符合真实的项目场景）所以我们要先获取到

InputStream is = ResourceLoader.class.getResourceAsStream(templatePath);
//这里通过 ResourceLoader 这个类并且通过反射得到 流之后，通过我们  模板文件在resources包的源根的路径得到文件的输入流

我们创立的模板对象 template

然后我们就通过 XWPFTemplate.compile（模板文件输入流，模板标记填充数据） 方法进行模板填充

这里我用了一个 缓冲文件 tempFile 来帮我过度一下，因为我后面要进行一些样式的操作（玩一些花活）

所以就把模板填充好的文件给写入到了 tempFile // template.writeToFile(String.valueOf(tempFile));// 写入文件

下面的操作就是一些花活，可以不看，一般用不到

这里首先获得的是 缓冲文件的输入流

然后创建的 缓冲文件的 word 文档对象

然后就是遍历 其中的段落 ，在遍历得到文本内容

如果内容不为空的话就进行一些样式改造

颜色 蓝色 字号 12 字体 楷体 间距 10

并把段落 设置为靠左对齐

最后就是删除缓冲文件

把 word 文档对象下载到 定义的路径中去

 public void fillWordTemplate(String templatePath, String outputWordPath, Map dataMap) throws Exception {
        ConfigureBuilder builder = Configure.builder();
        builder.buildGramer("${", "}");  // 设置 模板标记
        XWPFTemplate template;  // 创建模板对象
        //得到模板文件
        InputStream is = ResourceLoader.class.getResourceAsStream(templatePath);
        System.out.println("is = " + is);
        // 自定义段落样式（设置字体为宋体，字号为12，颜色为红色）
        template = XWPFTemplate.compile(is, builder.build()).render(dataMap);
        File tempFile = File.createTempFile("temp", ".docx");
        template.writeToFile(String.valueOf(tempFile));// 写入文件


        FileInputStream fis = new FileInputStream(tempFile);
        XWPFDocument xwpfDocument = new XWPFDocument(fis);
        for (XWPFParagraph paragraph : xwpfDocument.getParagraphs()) {
            for (XWPFRun run : paragraph.getRuns()) {
                if (run.getText(0) != null) {
                    run.setColor("0000FF");
                    run.setFontSize(12);
                    run.setFontFamily("楷体");
                    run.setTextPosition(10);// 设置文本间距
                    //设置内容为 水平居中
                }
            }
            //设置内容为 靠左对齐
            paragraph.setAlignment(ParagraphAlignment.LEFT);
        }

        tempFile.delete();
        xwpfDocument.write(Files.newOutputStream(Paths.get(outputWordPath)));
        xwpfDocument.close();
        template.close();
        is.close();
    }

下面的方法是 word 转换成为 pdf 的方法

使用了 aspose-words 库（通过 LocalConverter 相关类来操作）将 Word 文件转换为 PDF 文件

首先 传入的两个参数 第一个是 word 模板填充好的文件的下载路径 第二个参数是 pdf 要下载到的目标路径

然后我们就获得 文件输入流 和 pdf 文件的输出流

然后我们通过 构造器模式 构造了一个 aspose-words 库中的一个 转换器对象

//实际的执行操作
converter.convert(doc).as(DocumentType.DOC).to(outputStream).as(DocumentType.PDF).execute();
//将 doc 文件 doc类型的  转换成为 pdf 类型的 转换到 输出流中
//方法的返回结果就是 转换是否成功

成功 我们把 转换器关闭

关闭doc 输入流、pdf 输出流

public void wordToPdf(String inputWordPath, String outputPdfPath) {
        try {
            InputStream doc = Files.newInputStream(Paths.get(inputWordPath));
            OutputStream outputStream = Files.newOutputStream(Paths.get(outputPdfPath));
            IConverter converter = LocalConverter.builder().build();
            boolean flag = converter.convert(doc).as(DocumentType.DOC).to(outputStream).as(DocumentType.PDF).execute();
            if (flag) {
                converter.shutDown();
            }
            doc.close();
            outputStream.close();
            System.out.println("PDF文件已生成，路径为：" + outputPdfPath);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

需要的Maven依赖

    <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi-ooxml</artifactId>
            <version>5.2.3</version>
        </dependency>
        

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>5.2.3</version>
            <exclusions>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-api</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.deepoove</groupId>
            <artifactId>poi-tl</artifactId>
            <version>1.12.2</version>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <artifactId>poi</artifactId>
                    <groupId>org.apache.poi</groupId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-api</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.apache.poi</groupId>
                    <artifactId>poi-ooxml</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.17.2</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.17.2</version>
            <exclusions>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>log4j-api</artifactId>
                </exclusion>
            </exclusions>
        </dependency>


        <dependency>
            <groupId>com.documents4j</groupId>
            <artifactId>documents4j-local</artifactId>
            <version>1.1.6</version>
        </dependency>

        <dependency>
            <groupId>com.documents4j</groupId>
            <artifactId>documents4j-transformer-msoffice-word</artifactId>
            <version>1.1.6</version>
        </dependency>

到此这篇关于基于Java实现模板填充Word的文章就介绍到这了,更多相关Java模板填充Word内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:
阅读全文