java 根据模板导出word文档(poi-tl)

我会带着你远行 2024-03-25 14:03 109阅读 0赞

##  ##

### poi-tl是什么 ###

**poi-tl**是一个基于Apache POI的Word模板引擎，也是一个免费开源的Java类库，你可以非常方便的加入到你的项目中，并且拥有着让人喜悦的特性。

### 为什么选择poi-tl ###

<table style="width:700px;"> 
 <tbody> 
  <tr> 
   <th>方案</th> 
   <td>移植性</td> 
   <td>功能性</td> 
   <td>易用性</td> 
  </tr> 
  <tr> 
   <td><strong>Poi-tl</strong></td> 
   <td>Java跨平台</td> 
   <td>Word模板引擎，基于Apache POI，提供更友好的API</td> 
   <td>低代码，准备文档模板和数据即可</td> 
  </tr> 
  <tr> 
   <td>Apache POI</td> 
   <td>Java跨平台</td> 
   <td>Apache项目，封装了常见的文档操作，也可以操作底层XML结构</td> 
   <td>文档不全，这里有一个教程：<a href="http://deepoove.com/poi-tl/apache-poi-guide.html" title="Apache POI Word快速入门" rel="nofollow">Apache POI Word快速入门</a></td> 
  </tr> 
  <tr> 
   <td>Freemarker</td> 
   <td>XML跨平台</td> 
   <td>仅支持文本，很大的局限性</td> 
   <td>不推荐，XML结构的代码几乎无法维护</td> 
  </tr> 
  <tr> 
   <td>OpenOffice</td> 
   <td>部署OpenOffice，移植性较差</td> 
   <td>-</td> 
   <td>需要了解OpenOffice的API</td> 
  </tr> 
  <tr> 
   <td>HTML浏览器导出</td> 
   <td>依赖浏览器的实现，移植性较差</td> 
   <td>HTML不能很好的兼容Word的格式，样式糟糕</td> 
   <td>-</td> 
  </tr> 
  <tr> 
   <td>Jacob、winlib</td> 
   <td>Windows平台</td> 
   <td>-</td> 
   <td>复杂，完全不推荐使用</td> 
  </tr> 
 </tbody> 
</table>

### 引入依赖 ###

<dependency>
        <groupId>com.deepoove</groupId>
        <artifactId>poi-tl</artifactId>
        <version>1.10.0</version>
    </dependency>

注意，poi-tl是基于poi的，如还引入poi需要注意版本

![dc47a1da97b3427f8cae62bc12a2073d.png][]

### 怎么使用 ###

下面介绍一下poi-tl的几种常见使用方法

#### 1、文本 ####

标签：\{ \{text\}\}

数据模型：

*  `String` ：文本
 *  `TextRenderData` ：有样式的文本
 *  `HyperlinkTextRenderData` ：超链接和锚点文本
 *  `Object` ：调用 toString() 方法转化为文本

模板：

![a9edb840d91843bb917989707416128d.png][]

代码示例：

public static void main(String[] args) {
    
            try {
                /*文本*/
                Map<String, Object> map = new HashMap<>();
                map.put("name", "Sayi");
                map.put("author", new TextRenderData("000000", "Sayi"));
                map.put("link", new HyperlinkTextRenderData("website", "http://deepoove.com"));
                map.put("anchor", new HyperlinkTextRenderData("anchortxt", "anchor:appendix1"));
    
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\1.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
    }

效果：

![bcccd2ebad51405891bc358cfce8bec1.png][]

#### 2、图片 ####

标签：\{ \{@var\}\}

数据模型：

*  `String` ：图片url或者本地路径，默认使用图片自身尺寸
 *  `PictureRenderData`
 *  `ByteArrayPictureRenderData`
 *  `FilePictureRenderData`
 *  `UrlPictureRenderData`

模板：

![5689d0922ecb4a4e9f87f51914a84110.png][]

代码示例：

public static void main(String[] args) {
    
            try {
    
                Map<String, Object> map = new HashMap<>();
                
                /*图片*/
                map.put("image", "D:\\pic.jpg");       // 指定图片路径
                map.put("svg", "https://profile-avatar.csdnimg.cn/840f4549a5ae4144b243b203900b98c5_qq_38860250.jpg");         // svg图片
                map.put("image1", Pictures.ofLocal("D:\\pic.jpg").size(120, 120).create());            // 设置图片宽高
                map.put("streamImg", Pictures.ofStream(new FileInputStream("D:\\pic.jpg"), PictureType.JPEG)         // 图片流
                        .size(100, 120).create());
                map.put("urlImg", Pictures.ofUrl("https://profile-avatar.csdnimg.cn/840f4549a5ae4144b243b203900b98c5_qq_38860250.jpg")
                        .size(100, 100).create());            // 网络图片(注意网络耗时对系统可能的性能影响)
    
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\2.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

效果：

![73d33dc81a9447968ecdab91683553f1.png][]

#### 3、表格 ####

标签：\{ \{\#tableTest\}\}

数据模型：

*  TableRenderData

推荐使用工厂 \`Tables\` 、 \`Rows\` 和 \`Cells\` 构建表格模型。

模板：

![37b33662c3464f76ab78fa9095f8140c.png][]

代码示例：

public static void main(String[] args) {
    
            try {
    
                Map<String, Object> map = new HashMap<>();
                /*表格*/
                RowRenderData row0 = Rows.of("姓名", "学历").textColor("FFFFFF")
                        .bgColor("4472C4").center().create();
                RowRenderData row1 = Rows.create("李四", "博士");
                map.put("tableTest", Tables.create(row0, row1));
    
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\3.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

效果：

![c7ca846669fe4170b4cc4191cf510522.png][]

#### 4、列表 ####

标签：\{ \{\*var\}\}

数据模型：

*  List<String>
 *  NumberingRenderData

推荐使用工厂 \`Numberings\` 构建列表模型。

模板：

![10bf5ea60257415485ba3adc60823dd7.png][]

代码示例：

public static void main(String[] args) {
    
            try {
    
                Map<String, Object> map = new HashMap<>();
                /*列表*/
                map.put("listTest", Numberings.create("Plug-in grammar",
                        "Supports word text, pictures, table...",
                        "Not just templates"));
     
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\4.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

效果：

![3b480fb6be4547f1887bfda6bc7ed472.png][]

#### 5、嵌套 ####

标签：\{ \{+nested\}\}

数据模型：

*  DocxRenderData

推荐使用工厂 \`Includes\` 构建嵌套模型。

模板：

![d78f73edaed24fbfb4938d7dee890034.png][]

嵌套子模板：

![b544ebee62b443178a6cb0515483797d.png][]

代码示例：

/**
     * @Title: PoiTlTest
     * @Description:
     * @author: leon
     * @date: 2023/3/14 19:11
     */
    public class PoiTlTest {
        public static void main(String[] args) {
    
            try {
    
                Map<String, Object> map = new HashMap<>();
                /*嵌套*/
                List<AddrModel> subData = new ArrayList<>();
                subData.add(new AddrModel("Guangdong,China"));
                subData.add(new AddrModel("Shanghai,China"));
                map.put("nested", Includes.ofLocal("D:\\subInTest.docx").setRenderModel(subData).create());
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\5.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    
    }
    
    class AddrModel {
        private String addr;
        public AddrModel(String addr) {
            this.addr = addr;
        }
        // Getter/Setter
    }

效果：

![5755d77dd3224145bcdc532cac9346e3.png][]

#### 6、条件判断显示 ####

标签 :

\{ \{?condition\}\} 需要显示的内容 \{ \{/condition\}\}

模板：

![e98c546482fc44b4b4700b57c58fa29b.png][]

代码示例：

public static void main(String[] args) {
    
            try {
    
                Map<String, Object> map = new HashMap<>();
                /*条件判断显示*/
                map.put("condition1", false); //不显示，默认值也为false
                map.put("condition1Str","显示1");
                map.put("condition2", true);
                map.put("condition2Str","显示2");
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\6.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

效果：

![8bf5c724a1ea4f90b74da625307a9925.png][]

#### 7、非空集合循环 ####

标签也为 :

\{ \{?songs\}\} 需要遍历的内容 \{ \{/songs\}\}

模板：

![168c672ef3634640a59b7d9501df00ed.png][]

代码示例：

public static void main(String[] args) {
    
            try {
    
                Map<String, Object> map = new HashMap<>();
                /*非空集合循环*/
                Map<String, String> map1 = new HashMap<>();
                map1.put("star","周杰伦");
                map1.put("song","---兰亭序");
                Map<String, String> map2 = new HashMap<>();
                map2.put("star","林俊杰");
                map2.put("song","---江南");
                map.put("songs", Arrays.asList(map1,map2));
    
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\7.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

效果：

![453a2c747a074a14a98d857be8edef4e.png][]

#### 8、图表 ####

图标有单系列图表、多系列图表、组合图表多种类型，下面只介绍单系列图表的使用：

标签：\{ \{var\}\}

注意：该标签不是直接在模板定义，而是在：图表区格式—可选文字—标题（新版本Microsoft Office标签位置在：编辑替换文字-替换文字）。

下面是Microsoft Office的操作步骤：

**点击插入，选择相应的图表**

![9c27ecb030c647f08849fd12b8a6959c.png][]

**编辑替换文字-替换文字**

![5af602867e934bd8911823a409760850.png][]

代码示例：

public static void main(String[] args) {
     try {
    
                Map<String, Object> map = new HashMap<>();
                /*图表*/
                //单系列图表指的是饼图（3D饼图）、圆环图等。
                map.put("chart1",Charts
                        .ofSingleSeries("综合测评结果统计", new String[] { "正常", "异常","其他" })
                        .series("badAndgood", new Integer[] { 19, 17,15})
                        .create());
    
                XWPFTemplate.compile("D:\\testin.docx").render(map).writeToFile("D:\\8.docx");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

效果：

![924a562571e940da87e1fe63c2c2d132.png][]

### 总结 ###

> 上面是poi-tl的一些简单用例，如对其他功能感兴趣的朋友，可以去poi-tl的官网学习，地址为：[http://deepoove.com/poi-tl/][http_deepoove.com_poi-tl]

[dc47a1da97b3427f8cae62bc12a2073d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/3921db8ab1f34e73affb39b1a11ac931.png
[a9edb840d91843bb917989707416128d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/7b608f42cd0a457dbd2021f5c6192fbf.png
[bcccd2ebad51405891bc358cfce8bec1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/2aca63d70505419a925f81b9bc674f79.png
[5689d0922ecb4a4e9f87f51914a84110.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/b46359da0600413fb639583455580ff9.png
[73d33dc81a9447968ecdab91683553f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f989a471214445018505e891561400de.png
[37b33662c3464f76ab78fa9095f8140c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/6672b5ce2c184176bdf154634a3df9e0.png
[c7ca846669fe4170b4cc4191cf510522.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/896491dad505404489813bc8dc5a8ae2.png
[10bf5ea60257415485ba3adc60823dd7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/cace87e11e014f2f82ec4ca256d18192.png
[3b480fb6be4547f1887bfda6bc7ed472.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/88da40dbc3fd4acd9dbc2088c82c00ba.png
[d78f73edaed24fbfb4938d7dee890034.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f8a7eb44d3464b29a2b46c88be627fe3.png
[b544ebee62b443178a6cb0515483797d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/804ef217da1441379494675267fc4f19.png
[5755d77dd3224145bcdc532cac9346e3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/4207cca929bc47fd8f8d3c90aa224552.png
[e98c546482fc44b4b4700b57c58fa29b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/4d91e15b649d4538a251cb2438d4e104.png
[8bf5c724a1ea4f90b74da625307a9925.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/a5963025c0694405869c2be81caedb47.png
[168c672ef3634640a59b7d9501df00ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/248b7c115a854a67b3e8523ec8b3cebb.png
[453a2c747a074a14a98d857be8edef4e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/c9fafb9ebcc9407d92bb58ea0a95c8b8.png
[9c27ecb030c647f08849fd12b8a6959c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/98b83a31a8424a4bb98d5e56bf503ffd.png
[5af602867e934bd8911823a409760850.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f20f5b105ea648bea4d05a8301c6eff3.png
[924a562571e940da87e1fe63c2c2d132.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/bfcfec6eb675450b8f0810a5f655bcfc.png
[http_deepoove.com_poi-tl]: http://deepoove.com/poi-tl/