使用Velocity模板引擎进行代码生成：详细指南

Apache Velocity是一个基于Java的模板引擎，可以通过特定的语法获取在Java对象的数据，填充到模板中，从而实现界面和Java代码的分离。Velocity模板引擎的核心组件包括VelocityEngine、模板文件、上下文（Context）和Velocity Template Language（VTL）。

2. Velocity模板语法

Velocity模板语言（VTL）是一种轻量级的模板语言，专为Velocity设计。它提供了变量处理、条件语句、循环、宏等功能，使模板语言具有很强的灵活性。以下是一些常用的VTL语法和占位符：

2.1 变量处理

在VTL中，变量使用$符号引用，例如$name。上下文中的变量名必须与模板中的变量名一致，才能正确渲染。

2.2 条件语句

Velocity支持#if, #elseif, #else, #end语法，用于实现条件逻辑：

vm复制

#if($age > 18)
  You are an adult.
#else
  You are a minor.
#end

2.3 循环语句

#foreach用于遍历集合或数组：

vm复制

#foreach($item in $items)
  - $item
#end

假设上下文中items是一个包含["apple", "banana", "cherry"]的列表，渲染结果将是：

apple
banana
cherry

2.4 宏定义与调用

Velocity中的宏可以理解为函数定义。定义的语法如下：

vm复制

#macro(macroName arg1 arg2 …)
...
#end

调用这个宏的语法是：

vm复制

#macroName(arg1 arg2 …)

3. 使用Velocity进行代码生成

以下是一个使用Velocity模板引擎生成Java代码的详细步骤：

3.1 创建Velocity模板

在src/main/resources/templates目录下创建一个名为Entity.vm的Velocity模板文件。这个模板将用于生成Java实体类。模板内容如下：

vm复制

package ${packageName};

public class ${className} {
    #foreach($field in $fields)
    private ${field.type} ${field.name};
    #end

    #foreach($field in $fields)
    public ${field.type} get${field.name.capitalize()}() {
        return ${field.name};
    }

    public void set${field.name.capitalize()}(${field.type} ${field.name}) {
        this.${field.name} = ${field.name};
    }
    #end
}

在这个模板中，${packageName}、${className}和$fields是占位符，将在生成代码时被实际值替换。

3.2 编写代码生成服务

创建一个服务类CodeGeneratorService，用于加载Velocity模板并生成Java代码：

java复制

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.Template;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
import java.io.StringWriter;
import java.util.Properties;

public class CodeGeneratorService {

    public String generateCode(String packageName, String className, String[] fieldNames, String[] fieldTypes) {
        Properties prop = new Properties();
        prop.put(RuntimeConstants.RESOURCE_LOADER, "classpath");
        prop.put("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
        VelocityEngine velocityEngine = new VelocityEngine(prop);
        velocityEngine.init();

        VelocityContext context = new VelocityContext();
        context.put("packageName", packageName);
        context.put("className", className);
        context.put("fields", fieldNames);
        context.put("fieldTypes", fieldTypes);

        Template template = velocityEngine.getTemplate("Entity.vm");
        StringWriter writer = new StringWriter();
        template.merge(context, writer);

        return writer.toString();
    }
}

3.3 测试代码生成功能

创建一个控制器，通过REST API调用生成代码的功能：

java复制

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class CodeGeneratorController {

    @Autowired
    private CodeGeneratorService codeGeneratorService;

    @GetMapping("/generate")
    public String generateCode(@RequestParam String packageName, @RequestParam String className,
                              @RequestParam String[] fieldNames, @RequestParam String[] fieldTypes) {
        return codeGeneratorService.generateCode(packageName, className, fieldNames, fieldTypes);
    }
}