方法评论

Spring 团队创建了两种创建新项目的方法和一种修改现有项目的方法。我们发现最佳方法是使用 Spring Initializr 生成项目,然后使用 boot add 命令进行添加。以下部分解释了为什么这是最佳方法。

Initializr

创建新的 Spring Boot 项目的常用方法是使用 Initializr,位于 start.spring.io。Spring CLI 提供了一个命令与 Initializr 交互。参见 Initializr,但也提供了其他创建新项目的方法,并解决了在现有项目中添加代码或配置的“第二天”用例。

使用 Boot New

boot new 命令允许您从现有项目(位于源代码存储库中)创建新项目。boot new 命令允许您指定少量选项以根据您的需求进行自定义(例如更改包名称),但它不提供 Initializr 中提供的依赖项选择。

boot new 的方法是克隆一个现有的存储库,该存储库除了项目的依赖项之外,还包含完全可用的代码和配置。这种方法使您或您的团队成员可以轻松地创建多个项目原型,因为它们是源代码存储库中的常规 Spring 项目,可以验证其是否可以使用 CI 过程进行工作。有关更多信息,请参见 创建新项目

使用 Boot Add

然后,在初始项目创建之后,您可以使用 boot add 命令根据需要添加其他代码和依赖项。此命令会将现有项目智能地合并到当前项目中。与 boot new 命令一样,现有项目是源代码存储库中的常规 Spring 项目,可以编译并验证其是否可以使用 CI 过程进行工作。有关更多信息,请参见 “boot add”指南

模板化代码和配置

或者,您可以使用用户定义的命令添加其他代码和依赖项,这些命令依赖于使用模板引擎来创建代码和配置。有关更多信息,请参见 用户定义命令指南。使用模板引擎并使用户能够轻松地贡献调用这些模板的命令的方法受到 hygen 项目的启发。

结论

虽然添加其他代码和依赖项的两种方法都有其用例,但在从头开始创建新项目时,我们发现从工作项目开始更容易。您不仅可以获得公司所需的已批准依赖项,还可以获得代码、配置和测试。这是一个起点,它消除了选择依赖项和从教程中复制代码的繁琐工作和不确定性。通常,这些教程非常基础,不遵循常见的最佳实践约定,也没有测试。

使用模板创建新项目可能是一个挑战。在我们看来,为新项目模板化 Java 代码比从现有工作项目克隆新项目更困难。创建模板、运行模板,然后编译生成的项目的循环很脆弱。但是,我们发现创建更小的代码和配置块更适合模板方法,例如,使用 spring controller new 将控制器添加到当前项目,或使用 spring feature new 添加一些文件,例如用 @Controller@Service@Repository 注释的类。

您的体验可能有所不同,但两种类型的代码生成都在 Spring CLI 中可用。