想法：在 Java 中嵌入数据/DSL 作为注释并使用 APT 生成 Java 代码

Question

我有一个想法，我想由你来运行它以获得一些反馈。 请仔细阅读以下内容，让我知道您的想法，无论是积极的还是消极的。

我一直希望有一种方法可以将某些数据片段嵌入到 Java 代码中，而不必一直遵循 Java 的规则。 我最近听到了很多关于领域特定语言 (DSL) 的讨论，以及如果我们能够在日常工作中更多地利用它们，那就太好了。 我想我知道如何以相当优雅的方式做到这一点。

以下是我所知道的一些示例，这些示例在 Java 代码（和其他类 C 语言）中很难表示，我希望通过此方法来解决这些问题：

字符串数组的短字符串列表

String[] ar = { "Item1", "Item2", "Item3", "Item4" };

作为字符串数组的长字符串列表

String[] ar = { "The quick brown\n fox jumped over\n the lazy dog.",
"The quick brown\n fox jumped over\n the lazy dog.",
"The quick brown\n fox jumped over\n the lazy dog.",
"The quick brown\n fox jumped over\n the lazy dog.",  };

作为 字符串作为多维字符串数组：

String[][] ar = { { "InvoiceID", "Date", "SubTotal", "Tax", "Total" },
{ "1", "1/2/2009", "300, "21", "321" },
{ "2", "1/4/2008", "100", "7", "107" },
{ "3", "1/6/2008", "200", "14", "214" } };

键值对列表

Map states = new HashMap();
states.add("FL", "Florida");
states.add("OH", "Ohio");
states.add("GA", "Georgia");
states.add("NY", "New York");
states.add("SC", "South Carolina");

HTML代码单字符串

String html = "<a href=\"www.somesite.com\">Some site</a>";

HTML文本块具有适当的文本格式

String html = "Hi, John,\r\n<br>\r\n<br>Thank you for writing to us. We do not currently carry that specific product.\r\n<br>\r\n<br>Regards,\r\n<br>";

我已经研究了以下描述的解决方案，我相信可以创建一个可用的库，它允许您优雅地实现这一点。 在 Java 5 和 6 中，有一个称为注释处理器工具 (APT) 的东西（与 Debian APT 不同）。 您创建自己的源代码处理器，该处理器将在编译代码时被调用，以便您有机会重写源代码。 重写代码后，它会像平常一样编译。

要使用 APT，必须执行以下操作： 1. 将此库的 jar 放在 ANT 类路径上。 2. 将此库的 jar 放在项目类路径中。 3. 调用 apt 任务而不是 javac，并添加 preprocessdir 参数来指定生成的文件必须放置的位置。

DSL 代码可以放置在变量后面的注释内，代码的结果将放置在该变量之后。 当处理器运行时，它可以在代码中查找下一个注释，提取代码，通过处理器运行它，生成代码并进行编译。

这里又是这个列表，这次它可能看起来像这样：

作为字符串数组的短字符串列表

@DslTextArray
String[] ar = null; /* Item1, Item2, Item3, Item4 */

作为字符串数组的长字符串列表

@DslMultilineTextArray
String[] ar = null;
/*
The quick brown
fox jumped over
the lazy dog.

The quick brown
fox jumped over
the lazy dog.

The quick brown
fox jumped over
the lazy dog.

The quick brown
fox jumped over
the lazy dog.
*/

作为多维字符串数组或 JTable 的字符串表：

@DslTextTable
String[][] ar = null;
/*
InvoiceID,Date,SubTotal,Tax,Total
1,1/2/2009,300,21,321
2,1/4/2008,100,7,107
3,1/6/2008,200,14,214
*/

键值对列表

@DslMap
Map states = null; /* FL=Florida, OH=Ohio, GA=Georgia, NY=New York, SC=South Carolina */
// Could also put each pair on a new line

HTML 代码单 具有适当文本格式的字符串

@DslText
String html = null; /* <a href="www.somesite.com">Some site</a> */

HTML 文本块

@DslText
String html = null;
/*
Hi, John,

Thank you for writing to us. We do not currently carry that specific product.

Regards,
Mike
*/

我可以想到此解决方案的一些要求/功能：

您必须声明变量来保存脚本将在 Java 源代码中生成的数据。 这使得源代码的其余部分可以了解结果数据，即使编译器不知道它来自哪里。

• 不得违反 Java 语言，以便 IDE 和 javac 不会显示错误。
• 使用您拥有的所有现有 Java 代码。 无需替换任何现有代码。 只需将这些片段添加到您喜欢的任何地方即可。
• 必须易于通过其他类型进行扩展。
• 稍后必须能够对 IDE 进行扩展，以允许源代码突出显示和自动完成。
• 翻译发生在编译时，因此必须生成有效的 Java 代码。
• 将列表、多行文本块（如 CSS、SQL）转换为 String 和 String[]
• 转换和编码 XML、HTML
• 重写代码时保留相同的行号。 不要添加任何行，这样调试和读取错误就不会变得痛苦。
• 在运行时运行用任何 BSF 语言编写的代码。 允许它将任何参数传递给脚本并将任何 Java 类或原语返回给 Java。
• 在编译时运行以任何 BSF 语言编写的代码以生成 Java 源代码。 类似于 Linux 上 M4 的使用方式。
• 稍后：允许您将多次调用的字符串结果链接在一起以构建长字符串。 有些可能是编译时的，有些可能是运行时的。

再次强调，我非常希望得到一些有关此问题的反馈。 这是一个愚蠢的想法吗？ 已经有类似的东西了吗？ 你会费心使用这样的东西还是我应该把它留给自己？

Answer 1

我现在将使用 google collections api，它是 guava 库 http://code.google 的一部分。 com/p/guava-libraries/ 它有很棒的列表和地图支持。 它支持您想要实现的构建类型

public static final ImmutableList<Color> GOOGLE_COLORS
   = new ImmutableList.Builder<Color>()
       .addAll(WEBSAFE_COLORS)
       .add(new Color(0, 191, 255))
       .build();

Answer 2

这当然是可行的，但我必须说我不太喜欢它。

它使数据结构的初始化变得更加容易，

但是

• 我很少需要使用编译时常量来初始化这样的数据结构。 因此，类/java 文件旁边的单独文件会更有用

• 这对开发人员来说一点也不透明。 没有人期望评论会转化为数据。 实际上，如果遇到这样的评论，我可能会认为它评论了旧代码并立即将其删除

• ATP 是一个强大而有趣的工具，但缺乏 IDE 集成。 因此，您必须始终使用 ANT 来构建和运行您的应用程序，这只是不如按 F11 或您的 IDE 为此目的提供的任何快捷方式那么好和快

所以基本上，您会以最小的代价在开发基础设施复杂性方面遭受巨大打击。提高打字速度。

这个想法仍然很有趣。 我实际上会欣赏一种变体，其中可以定义“DSL”类型的注释，允许以注释声明定义的任意语言将代码放入该注释中。 当然，这将是一个重大的语言变化，并且不会很快发生，而且可能根本不会发生。