对于最新的稳定版本，请使用 Spring Modulith 1.3.0！spring-doc.cn

基础

Spring Modulith 支持开发人员在 Spring Boot 应用程序中实现逻辑模块。它允许他们应用结构验证、记录模块安排、为单个模块运行集成测试、在运行时观察模块的交互，并且通常以松散耦合的方式实现模块交互。本节将讨论开发人员在深入研究技术支持之前需要了解的基本概念。spring-doc.cn

应用程序模块

在 Spring Boot 应用程序中，应用程序模块是一个功能单元，它由以下部分组成：spring-doc.cn

向 Spring Bean 实例实现的其他模块和模块发布的应用程序事件公开的 API，通常称为提供的接口。spring-doc.cn
不应被其他模块访问的内部实现组件。spring-doc.cn
对其他模块以 Spring bean 依赖项、侦听的应用程序事件和公开的配置属性的形式公开的 API 的引用，通常称为必需接口。spring-doc.cn

Spring Moduliths 提供了在 Spring Boot 应用程序中表达模块的不同方式，主要区别在于整体安排所涉及的复杂程度。这允许开发人员从简单开始，然后根据需要自然地转向更复杂的方法。spring-doc.cn

简单的应用程序模块

应用程序的主包是主应用程序类所在的包。即 class ，它带有 Comments ，通常包含用于运行它的方法。默认情况下，主包的每个直接子包都被视为一个应用程序模块包。@SpringBootApplicationmain(…)spring-doc.cn

如果此 package 不包含任何子 package，则认为它是一个简单的 package。它允许通过使用 Java 的包范围来隐藏其中的代码，以隐藏驻留在其他包中的代码引用的类型，从而不受依赖项注入到这些包中的影响。因此，该模块的 API 自然由包中的所有公共类型组成。spring-doc.cn

让我们看一个示例安排（表示 public 类型， package-private 类型）。spring-doc.cn

单个库存应用程序模块

 Example
└─  src/main/java
   ├─  example                        (1)
   |  └─  Application.java
   └─  example.inventory              (2)
      ├─  InventoryManagement.java
      └─  SomethingInventoryInternal.java

1	应用程序的 main package .`example`
2	应用程序模块包。`inventory`

高级应用程序模块

如果应用程序模块包包含子包，则可能需要公开这些子包中的类型，以便可以从同一模块的代码中引用它。spring-doc.cn

库存和订单应用程序模块

 Example
└─  src/main/java
   ├─  example
   |  └─  Application.java
   ├─  example.inventory
   |  ├─  InventoryManagement.java
   |  └─  SomethingInventoryInternal.java
   ├─  example.order
   |  └─  OrderManagement.java
   └─  example.order.internal
      └─  SomethingOrderInternal.java

在这种安排中，该包被视为 API 包。允许来自其他应用程序模块的代码引用其中的类型。，就像应用程序模块基础包的任何其他子包一样，被视为内部子包。这些模块中的代码不得从其他模块引用。注意，public 类型是 how 的，可能是因为依赖于它。不幸的是，这意味着它也可以从其他软件包（例如 one）中引用。在这种情况下，Java 编译器对于防止这些非法引用没有多大用处。orderorder.internalSomethingOrderInternalOrderManagementinventoryspring-doc.cn

显式应用程序模块依赖项

模块可以通过对类型使用注释来选择声明其允许的依赖项。@ApplicationModulepackage-info.javaspring-doc.cn

清单显式配置模块依赖项

Javaspring-doc.cn
Kotlinspring-doc.cn

@org.springframework.modulith.ApplicationModule(
  allowedDependencies = "order"
)
package example.inventory;

@org.springframework.modulith.ApplicationModule(
  allowedDependencies = "order"
)
package example.inventory

在这种情况下，inventory 模块中的代码只允许引用 order 模块中的代码（并且最初没有将代码分配给任何模块）。在验证应用程序模块结构中了解如何监控该情况。spring-doc.cn

类型`ApplicationModules`

Spring Moduliths 允许检查代码库，以根据给定的 arrangement 和可选配置派生应用程序模块模型。工件包含可以指向 Spring Boot 应用程序类的：spring-modulith-coreApplicationModulesspring-doc.cn

创建应用程序模块模型

Javaspring-doc.cn
Kotlinspring-doc.cn

var modules = ApplicationModules.of(Application.class);

var modules = ApplicationModules.of(Application::class.java)

为了获得所分析的 arrangement 的印象，我们只需将整个模型中包含的各个模块写入控制台：spring-doc.cn

将应用程序模块排列写入控制台

Javaspring-doc.cn
Kotlinspring-doc.cn

modules.forEach(System.out::println);

modules.forEach { println(it) }

我们的应用程序模块安排的控制台输出

## example.inventory ##
> Logical name: inventory
> Base package: example.inventory
> Spring beans:
  + ….InventoryManagement
  o ….SomeInternalComponent

## example.order ##
> Logical name: order
> Base package: example.order
> Spring beans:
  + ….OrderManagement
  + ….internal.SomeInternalComponent

请注意每个模块是如何列出的，包含的 Spring 组件是如何被识别的，以及相应的可见性是如何呈现的。spring-doc.cn

命名接口

默认情况下，如高级应用程序模块中所述，应用程序模块的基本包被视为 API 包，因此是唯一允许从其他模块传入依赖项的包。如果您想将其他软件包公开给其他模块，则需要使用命名接口。您可以通过用 .package-info.java@NamedInterfacespring-doc.cn

封装 SPI 命名接口的封装安排

 Example
└─  src/main/java
   ├─  example
   |  └─  Application.java
   ├─ …
   ├─  example.order
   |  └─  OrderManagement.java
   ├─  example.order.spi
   |  ├—  package-info.java
   |  └─  SomeSpiInterface.java
   └─  example.order.internal
      └─  SomethingOrderInternal.java

package-info.java在example.order.spi

Javaspring-doc.cn
Kotlinspring-doc.cn

@org.springframework.modulith.NamedInterface("spi")
package example.order.spi;

@org.springframework.modulith.NamedInterface("spi")
package example.order.spi

该声明的效果是双重的：首先，允许其他应用程序模块中的代码引用。应用程序模块能够在显式依赖项声明中引用命名接口。假设 inventory 模块正在使用它，它可以引用上面声明的命名接口，如下所示：SomeSpiInterfacespring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@org.springframework.modulith.ApplicationModule(
  allowedDependencies = "order::spi"
)
package example.inventory;

@org.springframework.modulith.ApplicationModule(
  allowedDependencies = "order::spi"
)
package example.inventory

请注意我们如何通过双冒号连接命名接口的名称。在此设置中，允许 inventory 中的代码依赖于 interface 中的其他代码，但不允许 on。对于没有明确描述依赖关系的模块，应用程序模块根包和 SPI 根包都可以访问。spi::SomeSpiInterfaceorder.spiOrderManagementspring-doc.cn

自定义模块检测

如果默认应用程序模块模型不适用于您的应用程序，则可以通过提供的实现来自定义模块的检测。该接口公开了一个方法，并将使用 Spring Boot 应用程序类所在的包调用。然后，您可以检查驻留在其中的包，并根据命名约定等选择要被视为应用程序模块基础包的包。ApplicationModuleDetectionStrategyStream<JavaPackage> getModuleBasePackages(JavaPackage)spring-doc.cn

假设您声明了一个自定义实现，如下所示：ApplicationModuleDetectionStrategyspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

package example;

class CustomApplicationModuleDetectionStrategy implements ApplicationModuleDetectionStrategy {

  @Override
  public Stream<JavaPackage> getModuleBasePackages(JavaPackage basePackage) {
    // Your module detection goes here
  }
}

package example

class CustomApplicationModuleDetectionStrategy : ApplicationModuleDetectionStrategy {

  override fun getModuleBasePackages(basePackage: JavaPackage): Stream<JavaPackage> {
    // Your module detection goes here
  }
}

此类需要按如下方式注册：META-INF/spring.factoriesspring-doc.cn

org.springframework.modulith.core.ApplicationModuleDetectionStrategy=\
  example.CustomApplicationModuleDetectionStrategy

基础