数字化转型：应用工程代码自动生成之模板替换(一)

喜欢ヅ旅行 2022-12-14 03:50 75阅读 0赞

**目录**

[1、应用场景：][1]

[2、实战][2]

[1.环境搭建][1.]

[2.代码][2.]

[3.运行结果][3.]

[3、官方网站][3]

[4、总结：][4]

--------------------

序言：对于重复的工程和基础代码我们怎么通过工程化的手段自动生成呢？今天就介绍下偷懒大杀器——Freemaker。【FreeMarker 是一款 *模板引擎*：即一种基于模板和要改变的数据， 并用来生成输出文本(HTML网页，电子邮件，配置文件，源代码等)的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件】。官方的解释真的是高级，用一句话来说就是给程序员使用的，用来做内容生成的。

## 1、应用场景： ##

FreeMarker最初的设计，是被用来在MVC模式的Web开发框架中生成HTML页面的，它没有被绑定到 Servlet或HTML或任意Web相关的东西上。它也可以用于非Web应用环境中。在我们的游戏项目中有一些缓存类，和查询数据库的代码是重复的机械性代码，因此用来生成项目内的一些通用代码结构，提高了生产效率，也减少了出错的可能性，机智。

## 2、实战 ##

不管是Jsp 还是freemaker 都是内容替换，用公式来表达就是：模板 + 数据模型 = 输出。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5MjE5MjE_size_16_color_FFFFFF_t_70][]

你要做的就是理解，然后记住那些该死的标签，用完然后忘掉，重复，轮回，o(╯□╰)o。

### 1.环境搭建 ###

创建maven 项目，或者直接下载 下面对应的包加入你的项目中，看你方便，建议使用maven，自动下载包，多happy。

<dependency>
    
            <groupId>org.freemarker</groupId>
    
              <artifactId>freemarker</artifactId>
    
              <version>2.3.30</version>
    
      </dependency>

### 2.代码 ###

模板文件：

package ${packagePath};
    
    
    public class ${className} {
    
    
      public static void main(String[] args) {
    
          System.out.println("${helloWorld}");
    
      }
    
    }

生成代码

package org.pdool.d20201010;
    
    
    import freemarker.template.Configuration;
    
    import freemarker.template.Template;
    
    import java.io.*;
    
    import java.util.HashMap;
    
    import java.util.Map;
    
    
    
    public class Aain {
    
       private static final String TEMPLATE_PATH ="src/main/java/org/pdool/d20201010";
    
       private static final String CLASS_PATH ="src/main/java/org/pdool/d20201010/gen/";
    
       private static final String PACKAGE_PATH = "org.pdool.d20201010.gen";
    
    
       public static void main(String[] args) throws Exception {
    
           //1、 创建freeMarker配置实例
    
           Configuration configuration = new Configuration();
    
           String genClassName = "HelloFreeMaker";
    
           // 2、 获取模版路径
    
           configuration.setDirectoryForTemplateLoading(new File(TEMPLATE_PATH));
    
           // 3、 准备数据，等会替换用内容，key为模板内变量
    
           Map<String, Object> dataMap = new HashMap<>();
    
           dataMap.put("packagePath", PACKAGE_PATH);
    
           dataMap.put("className", genClassName);
    
           dataMap.put("helloWorld", "hello freeMaker,from 西瓜");
    
           // 4、 加载模版文件
    
           Template template = configuration.getTemplate("helloFreemaker.ftl");
    
           // 5、将生成的内容
    
           File docFile = new File(CLASS_PATH + genClassName + ".java");
    
           Writer out = new BufferedWriter(new OutputStreamWriter(newFileOutputStream(docFile)));
    
           // 6、输出文件
    
           template.process(dataMap, out);
    
           System.out.println(genClassName + ".java 文件创建成功 !");
    
      }
    
    }

### 3.运行结果 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5MjE5MjE_size_16_color_FFFFFF_t_70 1][]

## 3、官方网站 ##

上面介绍了基本的使用，在你使用的过程中可能需要一些其他的标签，可以查阅官方网站。

官方网站的链接：http://freemarker.foofun.cn/index.html，网站上有完整的介绍，今天主要还是介绍下怎么快速的入门，官方的网站上太全，等你遇到问题再去查也不着急。

## 4、总结： ##

不过是内容替换而已，相信会Java的同学基本一眼就能看明白，和Jsp 同理，跟着规则来，将生成的内容写入到文件，免去一些日常的代码操作。

疯狂提升开发效率，留点时间划划水，找朋友聊聊天，带其他的同学飞，展示下你的技术，何乐而不为。

使用步骤：

第一步：创建一个Configuration对象，直接new一个对象。

第二步：设置模板文件所在的路径。

第三步：设置模板文件使用的字符集。一般就是utf-8。

第四步：加载一个模板，创建一个模板对象。

第五步：创建一个模板使用的数据集。一般是Map。

第六步：创建一个Writer对象，一般创建一FileWriter对象，指定生成的文件名。

第七步：调用模板对象的process方法输出文件。

第八步：关闭流。

写文章不容易，求点赞转发，关注我的公众号【架构微学堂】，会有惊喜哦。点赞，转发 三连，谢谢支持。

[1]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#1%E3%80%81%E5%BA%94%E7%94%A8%E5%9C%BA%E6%99%AF%EF%BC%9A
[2]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#2%E3%80%81%E5%AE%9E%E6%88%98
[1.]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#1.%E7%8E%AF%E5%A2%83%E6%90%AD%E5%BB%BA
[2.]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#2.%E4%BB%A3%E7%A0%81
[3.]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#3.%E8%BF%90%E8%A1%8C%E7%BB%93%E6%9E%9C
[3]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#3%E3%80%81%E5%AE%98%E6%96%B9%E7%BD%91%E7%AB%99
[4]: https://blog.csdn.net/perfect2011/article/details/109006513?utm_medium=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase&depth_1-utm_source=distribute.pc_feed.none-task-blog-vip_agree_hot-1.nonecase#4%E3%80%81%E6%80%BB%E7%BB%93%EF%BC%9A
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5MjE5MjE_size_16_color_FFFFFF_t_70]: /images/20221123/558fc5254aa4402fba7fea9f860edbe1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI5MjE5MjE_size_16_color_FFFFFF_t_70 1]: /images/20221123/68cf2dfb7f5649e0a4e9063e2fbd40e6.png