在编译时添加/生成方法

时间:2012-06-26 18:05:06

标签: java dynamic-code

我目前正在构建一个API,我将要求许多开发人员使用。大部分都是直截了当的,但是有一些api调用本质上是复杂的,但应该以非常类似的方式使用。

我想要做的是在类中生成样板代码,可能通过标记一些注释,但那些生成的方法在Eclipse / IntelliJ中可供开发人员查看。我看了Javassist,但不确定运行时性质是一件好事。我宁愿采用编译时方法。

如果可能的话,我希望隐藏实现的代码(即我不希望开发人员尝试更改生成的方法的代码,因为它们将在重新编译时重写)。

这一切都是为了将​​处理的复杂性隐藏在开发人员和维护人员之外,并将其保留在核心框架代码中。

2 个答案:

答案 0 :(得分:4)

这个问题分为两部分。首先,您希望开发人员可以使用 API ,而无需编写/公开样板实现。其次,您希望自动生成样板代码。

如果您愿意承认正在使用某个框架,则可以在不生成代码/字节码的情况下执行此操作:

  • 对于每个重要的概念,编写一个完全定义API的接口。
  • 现在编写相应的类,实现接口,但匹配非样板API的方法签名。您可能希望使用命名约定来配对它们。
  • 编写一个使用Java Proxies生成接口实现的工厂。代理将尽可能委托实施。样板代码将直接在实现处理程序中实现。
  • 您可能需要各种类型的调用处理程序,在这种情况下,也要考虑那些的命名约定
  • 如果您不喜欢逻辑和接口之间未经检查的耦合,请提取不包含样板API的超级接口。
  • 使用这些构造的逻辑将通过接口名称请求实例;工厂将知道如何实例化底层逻辑实例和调用处理程序。

另一方面,如果您不希望开发人员记住框架的存在,或者您需要样板实现来访问逻辑的内部,那么您需要进行代码生成/字节码操作

操作本身可以使用自定义类加载器完成,也可以在使用Java Agents进行初始类加载时完成。但是,如何让API可供开发人员使用?以下是一些想法:

  • 使实现类成为抽象,并声明将生成样板代码的抽象方法。

  • 编写样板文件方法的存根实现(即在void方法中不执行任何操作;在所有其他方法中抛出RuntimeException。)使用一些注释标记这些方法。

  • 执行类似Google Web Toolkit的操作,并将样板方法声明为native。这与标记方法abstract类似,但允许您执行类final之类的操作。

答案 1 :(得分:0)

Java编译器支持annotation processing。您可以编写own processors来生成注释所需的代码。