生成源代码，这是一个妥协

源代码生成不好

在开始讨论任何其他内容之前，该主题中最重要的声明是源代码生成是次优的解决方案。 它可能是必需的，并且可能是一个可行的解决方案，但是无论何时生成源代码，它都可以做得更好。 仅仅是环境，可用工具，开发人员不适合此目的。 让我举一些例子。

对Java进行编程时，将使用Eclipse，IntelliJ或NetBeans。 这些IDE中的每一个都能够生成hashCode() 。 怎么了 该语言可以提供有关如何计算函数的声明性描述。 哈希码取决于字段的哈希码，并且计算是相当标准的。 为什么我们不能仅定义应考虑的字段，而语言将隐式地为我们提供该方法呢？ 在这种情况下，语言不足以达到目的。 我并不是说Java应该提供这样的功能。 也许应该，也许不应该。

对于二传手和吸气者，情况更为突出。 Java需要它们，并且我们必须在需要时生成它们。 其他语言，例如C＃，Swift甚至Groovy，都在语言级别支持该功能。

我的实践中的另一个示例，当我需要将几种业务对象类转换为具有特殊格式的Map <String，String>时。 我创建了一些实用程序类，这些实用程序类使用反射列出了这些字段并执行了转换。 但是，此解决方案在代码审查期间被拒绝。 代码太复杂，以后负责维护的团队可能无法应对代码。 我可以说他们应该雇用聪明的人，但是那会花更多的钱，而且他们想要便宜的代码来维护。 解决方案是为每个业务对象类编写极其相似的代码。 如果有任何工具可以生成该文件，并且它可能是构建过程的一部分，那么它又会增加维护成本。 在这种情况下，人类环境不足。

请不要在本文的这一部分开始火焰战争。 该示例部分是由于NDA的原因而构成的，毕竟它不是本文的主题。

Navigare Necesse Est

上面的示例清楚地说明了必须生成源代码。 虽然我们可能不喜欢它，但这是必须的。 下一个问题是何时生成代码，在开发过程的哪个阶段？

很明显，源代码只能在编译阶段之前生成。 您可以在编译阶段之后生成源代码，但这就像在患者死亡之后打电话给医生：没有用。 我们可以在构建过程中，在编译阶段之前或在编辑过程中生成代码。 两者都有优点和缺点。

编辑阶段源代码生成

当您在编辑代码时生成代码时，代码生成不需要成为构建过程的一部分。 这意味着代码的重建更简单，更少
可能会偏离标准构建流程，因此，在受限的企业环境中工作时，您更有可能做到这一点。 例如，当您使用IntelliJ生成hashCode() 。 生成的方法可在编辑环境中立即使用，并且自动完成之类的功能将考虑生成的代码。

缺点是该过程是手动触发的。 该过程越是手动，就越有可能出现人为错误。 您创建一个新的字段，并且您忘记更新该类中的hashCode() 。 生成的代码也可能进入最佳状态的源代码存储库。 源代码存储库是用于源代码的，生成的源代码不是真正的源代码，对吗？

构建过程源代码生成

当您在构建过程中生成源代码时，代码生成工具肯定会依赖于源代码的最新版本。 在我们的示例中， hashCode()方法不会遗漏任何字段。

缺点是构建过程更加复杂。 您喜欢的代码生成工具可能在您所处的环境中不可用或不允许使用。可以挂接到构建过程中的工具通常会生成整个文件。 您不太可能使用在批处理模式下在构建服务器上运行的工具在类的中间生成hashCode()方法。 另外，您的IDE中将没有生成的代码，并且您可能会失去一些代码编辑支持。

构建时源代码生成工具通常也是特定于环境的。 您可能拥有一个适用于Java的工具，但不适用于Rust或Python项目。

没有明确的“一个比另一个更好”的决定。 有时构建时间源代码生成会更好，而其他目的更适合于编辑时间源代码生成。 我创建了我的文章“ Java中的命名参数 ”中提到的Fluflu之类的工具，或文章“ 不要编写样板，使用scriapt ”中所描述的Scriapt Java注释处理工具。 这些工具特定于Java，并且在构建时可执行。 它们是注解处理器，它们挂接到Java编译过程中，因此有趣的是，IDE连续构建也可以处理它们。

内联源代码生成

这次，我想写一个Python编写的工具Pyama ，该工具不仅可以用于生成Java代码，还可以生成Go，Rust，Markdown或其他任何代码。 这是一个编辑阶段工具，在设计时就考虑了编辑。 主要思想是使编辑过程中可以自动化的部分自动化。

我的苛刻需求

苛刻的需求是我编辑了Packt出版的《 Java 9编程实例》一书的新版本。 本书的第一版在MS Word中进行了编辑，我不得不从IDE复制粘贴源代码示例。 但是，书籍和代码开发不是线性工作。 有时，代码在复制后会被编辑和修改。 回顾本书中的每个代码示例以查看文档中是否包含最新版本是一项艰巨的工作。 我想要其他东西，更自动化的东西。 幸运的是，将针对Java 11的第二版以我可以从Markdown转换的另一种格式进行编辑。 我在Markdown中编辑文本，我需要一个将代码样本复制到文本中的工具。

第一个想法是创建一个工具，该工具将包含markdown和控制源代码包含的特殊指令的.md.pre文件转换为包含代码段的.md 。 但是，这种解决方案不允许我在Markdown WYIWYG编辑器中看到完整的渲染文档。 IntelliJ让我在屏幕的左侧呈现markdown文档文本，并在右侧看到结果，当我忘记关闭反引号时，这是一个很大的帮助。 因此，我决定创建一个可以将代码段复制到编辑的文本文件中的工具。 IntelliJ几乎始终保持文件保存并在磁盘上对其进行修改时重新加载它也非常方便。 因此，我可以在编辑器中编辑文件，并且可以使用任何外部工具安全地编辑文件。 开发此工具也是一个不错的Python学习项目。

我还想创建比从代码文件中获取代码片段并将其插入markdown文档中更通用的功能。 结果是一个框架，目前已有几个扩展。 一种是处理代码片段和标记，另一种是生成Java代码（设置器，获取器，等于，hashCode，构造函数，构建器方法），处理文本宏，在任何代码文件中执行Python脚本等等。 这些扩展是示例，您可以使用几行Python代码创建其他扩展。 就书籍写作和Markdown Pyama而言，这被证明是极有价值的工具。

yama山建筑

将代码生成到已经存在的源文件中时，很明显，编辑单元应比文件更细化。 我们不应该用新的东西覆盖整个文件。 该工具必须区分需要更改的线，或者允许更改的线和不得触摸的线。 Pyama在处理文件时引入了段的概念。 该工具将其使用的源文件分割为多个段。 段包含文本文件的行。 因此， pyama项目可处理文件，每个文件包含段，每个段包含行。 文件的各个部分组成了整个文件。 换句话说，线段外没有线。 Pyama将文件的内容读入内存，然后调用已配置的处理程序（Python对象）以对各个段进行处理。 调用时，处理程序将处理单个段。 它可以从中收集信息，可以建立数据结构以备后用，并且可以读取和修改该段中的行。 这样，处理程序的代码非常简单，因为它除了处理字符串列表之外不执行其他任何操作，并且不需要关心其他任何事情。

为了确定段的起点， pyama要求处理程序对象提供正则表达式，以标识段的起点和终点。 不同的处理程序可能使用不同的段，并且它们可能具有不同的开始和结束模式。

所有文件中的段都经过几次处理，并多次调用处理程序。 例如，片段阅读器可以将代码片段从已配置的源文件中收集到片段存储中，其中每个片段都用一个名称标识。 在下一个过程中，代码片段编写器处理程序将查看以引用命名代码片段的行开头的段，并将其替换为所收集代码段的当前版本。

片段阅读器说，包含START SNIPPET每一行都开始一个新段，并且该段持续到包含END SNIPPET的行或文件末尾为止。 然后是代码

// START SNIPPET main_java
     System.out.println("Hello, world!");
// END SNIPPET

将收集一个包含代码示例的代码段。 代码段编写器管理的段以包含USE SNIPPET的行和代码段的名称开头，以包含END SNIPPET的行结尾。 如果片段编写器处理的文件中有一行读取

USE SNIPPET main_java
     System.out.println("Hello, outdated string world!");
END SNIPPET

它将替换为

USE SNIPPET main_java
     System.out.println("Hello, world!");
END SNIPPET

USE SNIPPET和END SNIPPET保留在代码中，但是在大多数格式中，可以将它们隐藏在输出（HTML渲染器或Java编译器）将忽略的注释字段中。

这只是此代码生成，文本处理工具的冰山一角。 有些处理程序可以为代码段行编号，修剪代码，跳过某些可能对打印输出不感兴趣的行，应用正则表达式搜索和替换，甚至执行可以创建段文本的小型Python脚本。

例如下面的代码

/* PYTHON SNIPPET xxx
fields = ["String name", "String office", "BigDecimal salary"]
print("    public void setParameters(",end="")
print(", ".join(fields), end="")
print("){")
for field in fields:
    field_name = field.split(" ")[1]
    print("        this." + field_name + " = " + field_name + ";")
print("        }")
 
print("""
    public Map getMap(){
        Map retval = new HashMap();\
""")
for field in fields:
    field_name = field.split(" ")[1]
    print("        retval.put(\""+field_name+"\", this."+field_name+");")
print("        return retval;\n        }")
 
END SNIPPET*/
 
public class SimpleBusinessObject {
    //USE SNIPPET ./xxx
    public void setParameters(String name, String office, BigDecimal salary){
        this.name = name;
        this.office = office;
        this.salary = salary;
        }
 
    public Map getMap(){
        Map retval = new HashMap();
        retval.put("name", this.name);
        retval.put("office", this.office);
        retval.put("salary", this.salary);
        return retval;
        }
    //END SNIPPET
}

可以很容易地更改为包含另一个字段，只需将命名字段的类型和字段名称添加到数组中即可。 在现实生活中的示例中，源打印代码将存储在某个外部文件中并导入，并且可能生成的代码也将比该示例更为复杂。 但是，此代码启发了我们，只需具备最少的Python知识，即可自动执行此类手动任务。

请随时尝试使用GitHub提供的pyama 。

翻译自: https://www.javacodegeeks.com/2018/05/generating-source-code-a-compromise.html