Java读取velocity文件自动生成代码

  • 背景
  • 基础概念
  • 1.什么是velocity文件
  • 2.velocity文件的构成
  • 思路&方案
  • 引入velocity依赖
  • 1.Java类模板文件（也就是我们的vm文件）
  • 2.Java代码，读取vm文件生成Java类文件
  • 执行效果
  • 升华

背景

本文将带你学习，如何读取velocity文件的方式，在Java里自动生成类。

基础概念

1.什么是velocity文件

Velocity文件指的是使用Apache Velocity模板引擎语言编写的模板文件。Apache Velocity是一个基于Java的模板引擎，可用于动态生成文本输出，例如HTML网页、电子邮件、XML文件等。Velocity模板文件通常包含静态文本和Velocity标记，这些标记使用Velocity语法表示，并告诉Velocity如何在模板中填充动态数据

2.velocity文件的构成

Velocity文件的语法由静态文本和Velocity标记组成。其中，静态文本是指在模板中不需要进行处理的部分，可以是任何文本，包括HTML标签、文本字符等。Velocity标记则是特定的Velocity语法，用于告诉Velocity引擎如何处理动态数据。

Velocity标记可以分为以下几类：

  1. 变量标记（$variable）：用于表示动态数据，其中“variable”表示变量名。变量标记会在模板执行时替换为对应变量的值。
  2. 指令标记（#directive）：用于执行特定的操作，例如循环、条件判断等。指令标记以“#”符号开头，后跟指令名称和指令参数。
  3. 注释标记（##）：用于在模板中添加注释，不会被Velocity引擎处理。

思路&方案

引入velocity依赖

<dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>

1.Java类模板文件（也就是我们的vm文件）

我们先准备好我们的类模板文件，接下来会在我们的Java文件内去读取这个文件，并且根据这个文件生成类

package $package;

public class $className {

  public $className() {
    // Constructor
  }

  public void $methodName() {
    // Method body
  }

}

这里带有$标识的是Velocity，其余为静态文本。我们要做的就是将这些动态的变量填充成我们想要的值，并且进行类文件的生成。

2.Java代码，读取vm文件生成Java类文件

我们使用以下代码，进行生成java文件

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;

public class JavaClassGenerator {

  public static void main(String[] args) throws IOException {
    
    // 创建VelocityEngine实例
    VelocityEngine ve = new VelocityEngine();
    ve.init();
    
    // 从文件加载模板
    Template template = ve.getTemplate("ClassTemplate.vm");
    
    // 创建VelocityContext实例，并添加动态数据
    VelocityContext context = new VelocityContext();
    context.put("package", "com.example");
    context.put("className", "ExampleClass");
    context.put("methodName", "exampleMethod");

    // 将模板和数据合并，并输出结果到文件
    File file = new File("ExampleClass.java");
    FileWriter writer = new FileWriter(file);
    template.merge(context, writer);
    writer.flush();
    writer.close();
  }
}

上文的整个过程都标注了对应的注释。大概的流程就是

  1. 加载模板文件
  2. 填充模板文件内的值
  3. 模板和数据合并，将结果写入到某个Java文件

执行效果

如果运行该程序，将会生成一个名为"ExampleClass.java"的Java类文件，内容如下：

package com.example;

public class ExampleClass {

  public ExampleClass() {
    // Constructor
  }

  public void exampleMethod() {
    // Method body
  }

}

可以根据模板，控制生成的效果，比如，我们可以批量添加属性，批量添加get和set方法。

升华

根据这个例子，我们可以看到，使用Velocity模板引擎可以很方便地根据模板生成Java类文件，这对于Java代码的自动生成和代码重用非常有帮助。我们可以根据这个例子进行扩展，结合自己的需求，自动进行代码生成，避免我们去做一些重复性的工作。