Java模板引擎生成代碼的幾種常見方式及其使用方法

更新時間：2025年08月21日 09:46:07 作者：愛的嘆息

在Java中,有多種模板引擎可以用于代碼生成,包括FreeMarker、Velocity、Thymeleaf等,下面我將詳細(xì)介紹每種方式的優(yōu)缺點,并提供完整的代碼示例,需要的朋友可以參考下

1. FreeMarker

FreeMarker是一個用Java編寫的模板引擎，最初專注于使用MVC軟件架構(gòu)生成Web頁面。但FreeMarker也可以用于非Web應(yīng)用程序環(huán)境，如代碼生成。

優(yōu)點：

模板語言功能強大，易于學(xué)習(xí)
不依賴Web環(huán)境，可以獨立使用
性能良好
模板緩存機制高效

缺點：

學(xué)習(xí)曲線相較于其他模板引擎略陡峭
錯誤提示不夠友好

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 {
        // 創(chuàng)建配置實例
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
        
        // 設(shè)置模板文件目錄
        cfg.setDirectoryForTemplateLoading(new File("src/main/resources/templates"));
        
        // 設(shè)置默認(rèn)編碼
        cfg.setDefaultEncoding("UTF-8");
        
        // 獲取模板
        Template template = cfg.getTemplate("code-template.ftl");
        
        // 準(zhǔn)備數(shù)據(jù)模型
        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代碼定義的對象。

優(yōu)點：

語法簡潔
與FreeMarker相比，語法更簡單
社區(qū)活躍，文檔豐富

缺點：

功能相較于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");
        
        // 創(chuàng)建上下文并添加數(shù)據(jù)
        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是一個現(xiàn)代化的服務(wù)器端Java模板引擎，能夠處理HTML、XML、JavaScript、CSS甚至純文本。

優(yōu)點：

與Spring框架集成良好
支持自然模板（可以在瀏覽器中直接打開）
功能豐富，支持表達(dá)式、條件語句、循環(huán)等

缺點：

相對于其他模板引擎，較為重量級
主要用于Web開發(fā)，用于代碼生成略顯復(fù)雜

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);
        
        // 創(chuàng)建上下文
        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} )];
    }
[/]
}

總結(jié)表格

模板引擎	優(yōu)點	缺點	適用場景
FreeMarker	功能強大，性能好，不依賴Web環(huán)境	學(xué)習(xí)曲線較陡，錯誤提示不夠友好	通用代碼生成，Web頁面生成
Velocity	語法簡潔，易于上手	功能相對簡單，更新頻率較低	簡單代碼生成，配置文件生成
Thymeleaf	與Spring集成好，支持自然模板	較為重量級，主要用于Web開發(fā)	Web應(yīng)用中的代碼生成，與Spring集成的項目

每種模板引擎都有其特點和適用場景，選擇時應(yīng)根據(jù)項目需求、團隊熟悉度和具體應(yīng)用場景來決定。對于一般的代碼生成任務(wù)，F(xiàn)reeMarker和Velocity是較為常見的選擇，而如果項目已經(jīng)使用了Spring框架，Thymeleaf可能是一個更好的選擇。

以上就是Java模板引擎生成代碼的幾種常見方式及其使用方法的詳細(xì)內(nèi)容，更多關(guān)于Java模板引擎生成代碼的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: