Java模板引擎生成代码的几种常见方式及其使用方法_Java

这个问题是关于java中使用模板引擎生成代码的方式，本文我将为您详细介绍几种常见的java模板引擎及其使用方法。

在java中，有多种模板引擎可以用于代码生成，包括freemarker、velocity、thymeleaf等。下面我将详细介绍每种方式的优缺点，并提供完整的代码示例

1. freemarker

freemarker是一个用java编写的模板引擎，最初专注于使用mvc软件架构生成web页面。但freemarker也可以用于非web应用程序环境，如代码生成。

优点：

模板语言功能强大，易于学习
不依赖web环境，可以独立使用
性能良好
模板缓存机制高效

缺点：

学习曲线相较于其他模板引擎略陡峭
错误提示不够友好

maven依赖：

<dependency>
    <groupid>org.freemarker</groupid>
    <artifactid>freemarker</artifactid>
    <version>2.3.32</version>
</dependency>

示例代码：

import freemarker.template.configuration;
import freemarker.template.template;
import freemarker.template.templateexception;

import java.io.*;
import java.util.hashmap;
import java.util.map;

public class freemarkercodegenerator {
    public static void main(string[] args) throws ioexception, templateexception {
        // 创建配置实例
        configuration cfg = new configuration(configuration.version_2_3_32);
        
        // 设置模板文件目录
        cfg.setdirectoryfortemplateloading(new file("src/main/resources/templates"));
        
        // 设置默认编码
        cfg.setdefaultencoding("utf-8");
        
        // 获取模板
        template template = cfg.gettemplate("code-template.ftl");
        
        // 准备数据模型
        map<string, object> datamodel = new hashmap<>();
        datamodel.put("classname", "user");
        datamodel.put("packagename", "com.example.model");
        datamodel.put("fields", new string[]{"id", "name", "email"});
        
        // 输出文件
        writer filewriter = new filewriter(new file("user.java"));
        template.process(datamodel, filewriter);
        filewriter.close();
        
        system.out.println("代码生成完成！");
    }
}

模板文件 (src/main/resources/templates/code-template.ftl):

package ${packagename};

public class ${classname} {
<#list fields as field>
    private string ${field};
</#list>

<#list fields as field>
    public string get${field?cap_first}() {
        return ${field};
    }

    public void set${field?cap_first}(string ${field}) {
        this.${field} = ${field};
    }
</#list>
}

2. apache velocity

velocity是apache软件基金会提供的一个基于java的模板引擎，使用简单模板语言来引用由java代码定义的对象。

优点：

语法简洁
与freemarker相比，语法更简单
社区活跃，文档丰富

缺点：

功能相较于freemarker略显简单
更新频率较低

maven依赖：

<dependency>
    <groupid>org.apache.velocity</groupid>
    <artifactid>velocity-engine-core</artifactid>
    <version>2.3</version>
</dependency>

示例代码：

import org.apache.velocity.template;
import org.apache.velocity.velocitycontext;
import org.apache.velocity.app.velocityengine;
import org.apache.velocity.runtime.runtimeservices;
import org.apache.velocity.runtime.runtimesingleton;
import org.apache.velocity.runtime.parser.parseexception;
import org.apache.velocity.runtime.parser.node.simplenode;

import java.io.*;
import java.util.properties;

public class velocitycodegenerator {
    public static void main(string[] args) throws ioexception, parseexception {
        // 初始化velocity引擎
        properties props = new properties();
        props.setproperty("resource.loader", "file");
        props.setproperty("file.resource.loader.class", 
            "org.apache.velocity.runtime.resource.loader.fileresourceloader");
        props.setproperty("file.resource.loader.path", "src/main/resources/templates");
        
        velocityengine ve = new velocityengine(props);
        ve.init();
        
        // 获取模板
        template template = ve.gettemplate("velocity-template.vm");
        
        // 创建上下文并添加数据
        velocitycontext context = new velocitycontext();
        context.put("classname", "product");
        context.put("packagename", "com.example.model");
        string[] fields = {"id", "name", "price"};
        context.put("fields", fields);
        
        // 输出生成的代码
        writer writer = new filewriter("product.java");
        template.merge(context, writer);
        writer.close();
        
        system.out.println("velocity代码生成完成！");
    }
}

模板文件 (src/main/resources/templates/velocity-template.vm):

package $packagename;

public class $classname {
#foreach($field in $fields)
    private string $field;
#end

#foreach($field in $fields)
    public string get${field.substring(0,1).touppercase()}${field.substring(1)}() {
        return $field;
    }

    public void set${field.substring(0,1).touppercase()}${field.substring(1)}(string $field) {
        this.$field = $field;
    }
#end
}

3. thymeleaf

thymeleaf是一个现代化的服务器端java模板引擎，能够处理html、xml、javascript、css甚至纯文本。

优点：

与spring框架集成良好
支持自然模板（可以在浏览器中直接打开）
功能丰富，支持表达式、条件语句、循环等

缺点：

相对于其他模板引擎，较为重量级
主要用于web开发，用于代码生成略显复杂

maven依赖：

<dependency>
    <groupid>org.thymeleaf</groupid>
    <artifactid>thymeleaf</artifactid>
    <version>3.1.2.release</version>
</dependency>

示例代码：

import org.thymeleaf.templateengine;
import org.thymeleaf.context.context;
import org.thymeleaf.templateresolver.filetemplateresolver;

import java.io.filewriter;
import java.io.ioexception;
import java.io.writer;
import java.util.arrays;
import java.util.hashmap;
import java.util.map;

public class thymeleafcodegenerator {
    public static void main(string[] args) throws ioexception {
        // 配置模板引擎
        templateengine templateengine = new templateengine();
        filetemplateresolver templateresolver = new filetemplateresolver();
        templateresolver.setprefix("src/main/resources/templates/");
        templateresolver.setsuffix(".html");
        templateresolver.settemplatemode("text");
        templateresolver.setcharacterencoding("utf-8");
        templateengine.settemplateresolver(templateresolver);
        
        // 创建上下文
        context context = new context();
        context.setvariable("classname", "order");
        context.setvariable("packagename", "com.example.model");
        context.setvariable("fields", arrays.aslist("id", "customername", "totalamount"));
        
        // 处理模板
        string result = templateengine.process("thymeleaf-template", context);
        
        // 写入文件
        writer writer = new filewriter("order.java");
        writer.write(result);
        writer.close();
        
        system.out.println("thymeleaf代码生成完成！");
    }
}

模板文件 (src/main/resources/templates/thymeleaf-template.html):

package [( ${packagename} )];

public class [( ${classname} )] {
[# th:each="field : ${fields}"]
    private string [( ${field} )];[/]

[# th:each="field : ${fields}"]
    public string get[( ${#strings.capitalize(field)} )]() {
        return [( ${field} )];
    }

    public void set[( ${#strings.capitalize(field)} )](string [( ${field} )]) {
        this.[( ${field} )] = [( ${field} )];
    }
[/]
}

总结表格

模板引擎	优点	缺点	适用场景
freemarker	功能强大，性能好，不依赖web环境	学习曲线较陡，错误提示不够友好	通用代码生成，web页面生成
velocity	语法简洁，易于上手	功能相对简单，更新频率较低	简单代码生成，配置文件生成
thymeleaf	与spring集成好，支持自然模板	较为重量级，主要用于web开发	web应用中的代码生成，与spring集成的项目