用于生成 Java 源文件的 Java API [关闭]

Question

我正在寻找一个框架来生成 Java 源文件。

类似于以下 API：

X clazz = Something.createClass("package name", "class name");
clazz.addSuperInterface("interface name");
clazz.addMethod("method name", returnType, argumentTypes, ...);

File targetDir = ...;
clazz.generate(targetDir);

然后，应该在目标目录的子目录中找到一个java源文件。

有人知道这样的框架吗？

---

编辑：

1. 我真的需要源文件。
2. 我也想填写方法的代码。
3. 我正在寻找高级抽象，而不是直接的字节码操作/生成。
4. 我还需要对象树中的“类结构”。
5. 问题域很笼统：生成大量非常不同的类，没有“共同结构”。

---

解决方案
根据您的回答，我发布了 2 个答案...with CodeModel 和 with Eclipse JDT。

我在我的解决方案中使用了CodeModel，:-)

Answer 1

Sun 提供了一个名为 CodeModel 的 API，用于使用 API 生成 Java 源文件。获取信息并不是最容易的事情，但它就在那里，而且效果非常好。

获取它的最简单方法是作为 JAXB 2 RI 的一部分 - XJC schema-to-java 生成器使用 CodeModel 生成其 java 源代码，它是 XJC jar 的一部分。您可以将其仅用于 CodeModel。

从http://codemodel.java.net/获取它

Answer 2

使用 CodeModel 找到解决方案
谢谢skaffman。

例如，使用以下代码：

JCodeModel cm = new JCodeModel();
JDefinedClass dc = cm._class("foo.Bar");
JMethod m = dc.method(0, int.class, "foo");
m.body()._return(JExpr.lit(5));

File file = new File("./target/classes");
file.mkdirs();
cm.build(file);

我可以得到这个输出：

package foo;
public class Bar {
    int foo() {
        return  5;
    }
}

Answer 3

使用 Eclipse JDT 的 AST 找到解决方案
谢谢Giles。

例如，使用以下代码：

AST ast = AST.newAST(AST.JLS3);
CompilationUnit cu = ast.newCompilationUnit();

PackageDeclaration p1 = ast.newPackageDeclaration();
p1.setName(ast.newSimpleName("foo"));
cu.setPackage(p1);

ImportDeclaration id = ast.newImportDeclaration();
id.setName(ast.newName(new String[] { "java", "util", "Set" }));
cu.imports().add(id);

TypeDeclaration td = ast.newTypeDeclaration();
td.setName(ast.newSimpleName("Foo"));
TypeParameter tp = ast.newTypeParameter();
tp.setName(ast.newSimpleName("X"));
td.typeParameters().add(tp);
cu.types().add(td);

MethodDeclaration md = ast.newMethodDeclaration();
td.bodyDeclarations().add(md);

Block block = ast.newBlock();
md.setBody(block);

MethodInvocation mi = ast.newMethodInvocation();
mi.setName(ast.newSimpleName("x"));

ExpressionStatement e = ast.newExpressionStatement(mi);
block.statements().add(e);

System.out.println(cu);

我可以得到这个输出：

package foo;
import java.util.Set;
class Foo<X> {
  void MISSING(){
    x();
  }
}

Answer 4

您可以使用 Roaster (https://github.com/forge/roaster) 进行代码生成。

这是一个例子：

JavaClassSource source = Roaster.create(JavaClassSource.class);
source.setName("MyClass").setPublic();
source.addMethod().setName("testMethod").setPrivate().setBody("return null;")
           .setReturnType(String.class).addAnnotation(MyAnnotation.class);
System.out.println(source);

将显示以下输出：

public class MyClass {
   private String testMethod() {
       return null;
   }
}

Answer 5

另一种选择是 Eclipse JDT 的 AST，如果您需要重写任意 Java 源代码，而不仅仅是生成源代码，它会非常有用。 （而且我相信它可以独立于 eclipse 使用）。

Answer 6

Eclipse JET 项目可用于生成源代码。我不认为它的 API 与您描述的完全一样，但每次我听说有一个项目进行 Java 源代码生成时，他们都会使用 JET 或自制工具。

Answer 7

不了解库，但您可能只需要一个通用模板引擎。有a bunch of them，我个人对FreeMarker有很好的体验

Answer 8

我构建了一个看起来非常像您的理论 DSL 的东西，称为“sourcegen”，但从技术上讲，而不是我编写的 ORM 的 util 项目。 DSL 看起来像：

@Test
public void testTwoMethods() {
    GClass gc = new GClass("foo.bar.Foo");

    GMethod hello = gc.getMethod("hello");
    hello.arguments("String foo");
    hello.setBody("return 'Hi' + foo;");

    GMethod goodbye = gc.getMethod("goodbye");
    goodbye.arguments("String foo");
    goodbye.setBody("return 'Bye' + foo;");

    Assert.assertEquals(
    Join.lines(new Object[] {
        "package foo.bar;",
        "",
        "public class Foo {",
        "",
        "    public void hello(String foo) {",
        "        return \"Hi\" + foo;",
        "    }",
        "",
        "    public void goodbye(String foo) {",
        "        return \"Bye\" + foo;",
        "    }",
        "",
        "}",
        "" }),
    gc.toCode());
}

https://github.com/stephenh/joist/blob/master/util/src/test/java/joist/sourcegen/GClassTest.java

它还做了一些简洁的事情，例如“自动组织导入”参数/返回类型中的任何 FQCN、自动修剪在此代码生成运行中未触及的任何旧文件、正确缩进内部类等。

这个想法是生成的代码应该看起来很漂亮，没有警告（未使用的导入等），就像您的其他代码一样。这么多生成的代码读起来很难看……太可怕了。

无论如何，文档并不多，但我认为 API 非常简单/直观。 Maven repo 是here，如果有人感兴趣的话。

Answer 9

如果您真的需要源，我不知道任何会生成源的东西。但是，您可以使用 ASM 或 CGLIB 直接创建 .class 文件。

你也许可以从这些生成源代码，但我只用它们来生成字节码。

Answer 10

我自己做的是一个模拟生成器工具。这是一项非常简单的任务，即使您需要遵循 Sun 格式指南。我敢打赌，你会比在 Internet 上找到符合你目标的代码更快地完成代码。

您基本上已经自己概述了 API。现在只需用实际代码填充它！

Answer 11

还有StringTemplate。由ANTLR作者出品，功能相当强大。

Answer 12

有新项目write-it-once。基于模板的代码生成器。您使用Groovy 编写自定义模板，并根据java 反射生成文件。这是生成任何文件的最简单方法。可以通过生成AspectJ文件、基于JPA注解的SQL、基于枚举的插入/更新等方式来制作getters/settest/toString。

模板示例：

package ${cls.package.name};

public class ${cls.shortName}Builder {

    public static ${cls.name}Builder builder() {
        return new ${cls.name}Builder();
    }
<% for(field in cls.fields) {%>
    private ${field.type.name} ${field.name};
<% } %>
<% for(field in cls.fields) {%>
    public ${cls.name}Builder ${field.name}(${field.type.name} ${field.name}) {
        this.${field.name} = ${field.name};
        return this;
    }
<% } %>
    public ${cls.name} build() {
        final ${cls.name} data = new ${cls.name}();
<% for(field in cls.fields) {%>
        data.${field.setter.name}(this.${field.name});
<% } %>
        return data;
    }
}

Answer 13

这真的取决于你想要做什么。代码生成本身就是一个主题。如果没有特定的用例，我建议查看速度代码生成/模板库。另外，如果您要离线进行代码生成，我建议您使用 ArgoUML 之类的工具从 UML 图/对象模型转换为 Java 代码。

Answer 14

示例： 1/

private JFieldVar generatedField;

2/

String className = "class name";
        /* package name */
        JPackage jp = jCodeModel._package("package name ");
         /*  class name  */
        JDefinedClass jclass = jp._class(className);
        /* add comment */
        JDocComment jDocComment = jclass.javadoc();
        jDocComment.add("By AUTOMAT D.I.T tools : " + new Date() +" => " + className);
        // génération des getter & setter & attribues

            // create attribue 
             this.generatedField = jclass.field(JMod.PRIVATE, Integer.class) 
                     , "attribue name ");
             // getter
             JMethod getter = jclass.method(JMod.PUBLIC, Integer.class) 
                     , "attribue name ");
             getter.body()._return(this.generatedField);
             // setter
             JMethod setter = jclass.method(JMod.PUBLIC, Integer.class) 
                     ,"attribue name ");
             // create setter paramétre 
             JVar setParam = setter.param(getTypeDetailsForCodeModel(Integer.class,"param name");
             // affectation  ( this.param = setParam ) 
             setter.body().assign(JExpr._this().ref(this.generatedField), setParam);

        jCodeModel.build(new File("path c://javaSrc//"));

Answer 15

这是一个看起来很有趣的 JSON-to-POJO 项目：

http://www.jsonschema2pojo.org/