130

我正在寻找一个框架来生成 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 个答案......使用 CodeModelEclipse JDT

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

4

15 回答 15

70

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

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

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

于 2008-09-23T16:41:45.973 回答
46

使用 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;
    }
}
于 2008-09-25T20:53:36.867 回答
28

使用 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();
  }
}
于 2008-09-25T20:54:11.170 回答
19

您可以使用 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;
   }
}
于 2014-07-10T16:24:57.187 回答
9

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

于 2008-09-23T15:19:38.120 回答
4

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

于 2008-09-23T14:37:04.040 回答
3

不知道库,但您可能只需要一个通用模板引擎。有很多,我个人对FreeMarker有很好的经验

于 2008-09-23T15:25:08.967 回答
2

我构建了一个看起来非常像您的理论 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,自动修剪在此 codegen 运行中未触及的任何旧文件,正确缩进内部类等。

这个想法是生成的代码应该看起来很漂亮,没有警告(未使用的导入等),就像你的代码的其余部分一样。这么多生成的代码读起来很难看……太可怕了。

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

于 2013-10-09T05:30:12.500 回答
1

如果你真的需要源,我不知道任何产生源的东西。但是,您可以使用ASMCGLIB直接创建 .class 文件。

您可能能够从这些生成源代码,但我只使用它们来生成字节码。

于 2008-09-23T14:32:21.727 回答
1

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

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

于 2008-09-23T15:00:52.813 回答
1

还有StringTemplate。它是由 ANTLR 的作者编写的,非常强大。

于 2009-09-22T22:38:12.960 回答
1

有一个新项目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;
    }
}
于 2014-05-18T12:15:18.693 回答
0

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

于 2011-03-13T05:46:38.107 回答
0

示例: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//"));
于 2014-03-28T17:37:20.203 回答
0

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

http://www.jsonschema2pojo.org/

于 2016-02-04T21:14:13.377 回答