如何通过图解深入理解Maven的optional关键字？

本文共计1598个文字，预计阅读时间需要7分钟。

在前面，我原本想写一篇关于如何自定义Spring Boot Starter的文章。但为了更好地理解Starter的一些设计理念和其中的关键点，我将一些细节内容单独提取出来讲解。

首先，要自定义一个Spring Boot Starter，你需要：

1. 创建一个Maven项目：这个项目将作为你的Starter的基础。

2.定义依赖：在`pom.xml`中添加对Spring Boot的依赖，以及你希望提供的任何其他依赖。

3.创建自动配置类：这个类将包含自动配置的逻辑，使你的Starter能够无缝集成到Spring Boot应用中。

4.添加配置属性：通过配置属性，用户可以自定义Starter的行为。

5.编写自定义Bean：实现你的Starter的核心功能，通过Spring容器管理这些Bean。

以下是一些关键步骤的详细说明：

1. 创建Maven项目

在`pom.xml`中，你需要添加Spring Boot的父项目依赖，以及Spring Boot的依赖管理。

xml

org.springframework.boot spring-boot-dependencies 2.3.4.RELEASE pom import

2. 定义依赖

在你的Starter中，你需要添加Spring Boot的依赖，以及任何其他必要的依赖。

xml org.springframework.boot spring-boot-starter

3. 创建自动配置类

自动配置类是Starter的核心。它使用Spring的自动配置机制来配置你的Bean。

java@Configuration@ConditionalOnClass(YourClass.class)public class YourStarterAutoConfiguration { @Bean public YourBean yourBean() { // 创建并返回你的Bean }}

4. 添加配置属性

通过添加配置属性，用户可以自定义Starter的行为。

java@ConfigurationProperties(prefix=your.starter)public class YourStarterProperties { private String property; // 其他属性}

5. 编写自定义Bean

实现你的Starter的核心功能，通过Spring容器管理这些Bean。

java@Componentpublic class YourBean { // Bean的属性和方法}

这样，你就完成了一个自定义的Spring Boot Starter。在Maven的`pom.xml`中，你可以这样引用你的Starter：

xml com.example your-starter 1.0.0

通过以上步骤，你就可以在Spring Boot应用中集成和使用你的自定义Starter了。

写在前面

本来想写一篇「如何自定义Spring Boot Starter」，但是为了更好理解 Starter 的一些设计理念和其中的关键点，所以提前将一些细节内容单独提取出来讲解说明

在 Maven pom.xml 中，你经常会看到依赖项中有类似下面的代码:

<dependency> <groupId>sample.ProjectA</groupId> <artifactId>Project-A</artifactId> <version>1.0</version> <scope>compile</scope> <optional>true</optional> </dependency>

这里的 <optional>true</optional> 是什么意思呢？

optional 关键字的奥秘

老规矩，画个图说明问题:

由于 project C 使用到了两个来自 project A 的类 (OptionalFeatureAClass) 和 project B 的类 (OptionalFeatureBClass). 如果 project C 没有依赖 packageA 和 packageB，那么编译将会失败。

project D 依赖 project C，但是对于 project D 来说，类 (OptionalFeatureAClass) 和类 (OptionalFeatureBClass) 是可选的特性，所以为了让最终的 war/ejb package 不包含不必要的依赖，使用<optional> 声明当前依赖是可选的, 默认情况下也不会被其他项目继承(好比 Java 中的 final 类，不能被其他类继承一样)

如果 project D 确实需要用到 project C 中的 OptionalFeatureAClass 怎么办呢？那我们就需要在 project D 的 pom.xml 中显式的添加声明 project A 依赖，继续看下图:

Project D 需要用到 Project A 的 OptionalFeatureAClass，那么需要在 Project D 的 pom.xml 文件中显式的添加对 Project A 的依赖

到这也就很好理解为什么 Maven 为什么要设计 optional 关键字了，假设一个关于数据库持久化的项目(Project C), 为了适配更多类型的数据库持久化设计，比如 Mysql 持久化设计(Project A) 和 Oracle 持久化设计(Project B)，当我们的项目(Project D) 要用的 Project C 的持久化设计，不可能既引入 mysql 驱动又引入 oracle 驱动吧，所以我们要显式的指定一个，就是这个道理了

实际案例

在 spring-boot-actuator pom.xml 文件中，有超过 20 个依赖是 optional

因为 Spring Boot 不可能将没必要的依赖也打包到你最终的 jar package 中，所以用到 spring boot actuator 的项目最终生成的 jar package 中不会包含这 20 多个依赖 jar，如果你要用到哪一个，显式的加入到你的项目就好了

在接下来的文章，自定义 Spring Boot Starter 也是这个策略，因为 starter 是包含特定功能为其他项目服务用的，类似本文的 Project C 的角色了，到这里你理解 optional 的奥秘了吗？

反向应用

如果 Project C 引入的依赖没有加 <optional>true</optional>，Project D 又需要依赖 Project C，但只用到 Project A 的类怎么办呢？Maven 也是有解决办法的，使用 exclusion 关键字，不多说，上一段代码就懂了:

<dependencies> <dependency> <groupId>top.dayarch.demo</groupId> <artifactId>Project-C</artifactId> <exclusions> <exclusion> <groupId>top.dayarch.demo</groupId> <artifactId>Project-B</artifactId> </exclusion> </exclusions> </dependency> </dependencies>

总结

到这里，在你今后设计功能性依赖时，你应该明白怎样设计依赖关系了, 我这里推荐使用 optional 的形式，简单来说，你设计的依赖什么菜都有，想吃什么菜自己 "抱蔡明" 就好，接下来我们就模拟官方标准创建自定义的 starter...... 博客 访问恢复正常，欢迎交流

灵魂追问

1. 有很多童鞋项目组用的构建工具时 Gradle，你知道 Gradle 中是怎样表示的吗？
2. 自定义 starter，你知道官方标准 starter 的结构是什么样的吗？

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持自由互联。