最も詳細なカスタム春ブーツスターター開発チュートリアル

1.はじめに

成長して肥大化したSpringと、構成を簡単にするために、箱から出して、迅速な統合、ブーツ春が判明しました。Javaは、フレームワークの中で最も燃えるようになっています。私たちは通常、春ブーツでWebアプリケーションを開発します。サーブレットコンテナTomcatの春のMVCのデフォルト、Spring MVCのコンポーネントが組み込まれているため、スプリング・ブート・スターター-tomcatに。しかし、今引きサーブレットコンテナのパフォーマンスは非常に良いです。私たちは、次の方法でTomcatを除外することができます。

そして、引き波の直接交換:

コードを変更する必要はありません。1つのプラガブル:これは、後者の成分の利点です。2.カスタマイズすることができます。3.統合の需要。なぜ、迅速な適応を達成することができますか?私たちは、このようなシナリオを想像:あなたの車のネジ折れホイールがある場合、あなたは自分の機器にネジを購入したいです。あなたが車の位置やブランド所有者は、使用するネジの種類を正確に知っていることができるようになります報告として、あなたは限り店に行きます。これは開発されている標準の利点です。基準がなければ、それはネジをサポートしていない購入するのは簡単です、あなたは試行錯誤を維持する必要があります。これは、あなたが望むものは明らかではありません。標準的な微妙な場合は、通信中に、我々はさらに便利。時には、あなたのガールフレンドの外観は、あなたは彼女がやりたい知っています。だから、春ブーツので、コンフィギュレーションを減らすプログラムコンポーネント間の複雑さを軽減するために、ルール「の合意が設定よりも大きい」があります。あなたは春ブーツスターターカスタムを開発しているので、我々はまた、どのようにあなたのスターター以上の利便性を検討したいです。

2.春ブーツ規約の一部

コンポーネントの設計は、基準やルールを持っている必要があります。春ブーツスターターも例外ではありません。いつもの容疑者の一部で見てみましょう。

2.1命名スタイル

あなたはすぐに赤ちゃんを持っている場合は、出生前に、ご心配な方はお名前でなければなりません。原点識別にあなたとあなたの愛する人に名前を付け、王は確かに奇妙な表情を引き起こすだろう隣の姓を再生されません。Mavenのでは、のgroupIdはたartifactIdが名を表し、姓を表します。春ブーツも命名の提案です。groupIdを公式org.springframework.bootを使用していない
し、あなた自身のユニークなを使用しています。名付けたartifactIdのために、春ブーツの関係者は形式を命名提案例MyBatisのスプリング・ブート・スタータ用非公式スターターXXXX-春ブート・スターターを、次の。公式スターターは、上記ばねブートスタータ引きとして、ばねブートスターター-XXXXに従います。オープンソースのスターターの多くは非常にありませんでした、この慣例を無視「プロ」。

3.カスタマイズスターター

次に、我々は、カスタム、サードパーティのSMSスターター、指定されたSMS-春ブート・スターターを構築します。導入する書き込みをする一方で、いくつかの詳細があります。ここでは、テンプレートのサンプルとテストモジュールを省略しています。

我々以上を踏まえ、以下の項目を確立しています:

3.1 SMS-春ブート

SMS-春ブートは、プロジェクトの依存関係の管理を構築することが重要です。だから、BOMを導入する必要があります。すべてのモジュールのモジュールのスターターキー管理、およびすべてのSMS-春ブート管理によってスターターでもSMS-春ブート・自動設定に依存します。

3.2 SMS-春-ブート自動構成

このモジュールは、コンフィギュレーションパラメータ、および外部露光(典型的には、抽象インタフェーススプリングビーン)の自動設定の機能を定義するために使用されます。

3.2.1設定パラメータ

一般配置参数都是在Spring Boot 的application.yml中。我们会定义一个前缀标识来作为名称空间隔离各个组件的参数。对应的组件会定义一个XXXXProperties 来自动装配这些参数。自动装配的机制基于@ConfigurationProperties注解,请注意一定要显式声明你配置的前缀标识(prefix)。我们的sms-spring-boot会作如下配置:

c997518d5e8dba9a9bb69dd23a0770d8.png

以上以阿里云的短信功能为例作配置,在将来使用时只需要在application.yml中加入上面对应SmsProperties的配置:

302dd03f038782022ec8cf43168620ca.png

如果你集成了Spring Boot 校验库 你也可以对SmsProperties进行校验。在配置application.yml时细心的java开发者会发现参数配置都有像下面一样的参数描述:
8092aac794d4b77ca959909c3af789dd.png

就像java中的注释一样方便我们理解该配置的作用,其实这个就是java注释生成的。你需要依赖

8092aac794d4b77ca959909c3af789dd.png

然后就该依赖会对SmsProperties 成员属性的注释进行提取生成一个spring-configuration-metadata.json文件,这就是配置描述的元数据文件。Spring Boot官方也对注释进行了一些规则约束:

  • 不要以“The”或“A”开头描述。
  • 对于boolean类型,请使用“Whether" 或“Enable”开始描述。
  • 对于基于集合的类型,请使用“Comma-separated list”
  • 如果默认时间单位不等同于毫秒,则使用java.time.Duration而不是long描述默认单位,例如“如果未指定持续时间后缀,则将使用秒”。
  • 除非必须在运行时确定,否则不要在描述中提供默认值。

补充我个人建议描述尽量使用英文描述。

3.2.2 配置自动暴露功能接口

拿到配置后,接下来就是根据配置来初始化我们的功能接口,我们会抽象一个短信发送接口SmsSender,根据短信提供方的SDK来进行功能设计。请注意autoconfigure模块的依赖几乎都是不可传递的。也就是依赖坐标配置optional为true 。
功能接口实现完后我们会编写一个自动配置类 SmsAutoConfiguration 。除了@Configuration注解外,@ConfigurationProperties会帮助我们将我们的配置类SmsProperties加载进来。然后将我们需要暴露的功能接口声明为Spring Bean 暴露给Spring Boot应用 。有时候我们还可以通过一些条件来控制SmsAutoConfiguration或者SmsSender ,比如根据某个条件是否加载或加载不同的SmsSender。有时间你可以看看redis-starter就能很明显感觉到,它会根据luttuce、redisson、jedis 的变化实例化不同的客户端链接。实现方式是使用了@Conditional系列注解,有时间可以学习一下该系列的注解。好了我们的SmsAutoConfiguration声明如下:

a9204a6d80a3df1a7e1a2ac7704c3664.png

3.2.3 主动生效和被动生效

starter集成入应用有两种方式。我们从应用视角来看有两种:

  • 一种是主动生效,在starter组件集成入Spring Boot应用时需要你主动声明启用该starter才生效,即使你配置完全。这里会用到@Import注解,将该注解标记到你自定义的@Enable注解上:
    be07d9a2aa637b267ae9cba39b8b6064.png
    我们将该注解标记入Spring Boot应用就可以使用短信功能了。
  • 另一种被动生效,在starter组件集成入Spring Boot应用时就已经被应用捕捉到。这里会用到类似java的SPI机制。在autoconfigure资源包下新建META-INF/spring.factories写入SmsAutoConfiguration全限定名。
    d3422497106918aadf5237c75f5d66ad.png

多个配置类逗号隔开,换行使用反斜杠。

3.3 sms-spring-boot-starter

该模块是一个空jar。它唯一目的是提供必要的依赖项来使用starter。你可以认为它就是集成该starter功能的唯一入口。不要对添加启动器的项目做出假设。如果您自动配置的依赖库通常需要其他启动器,请同时提及它们。如果可选依赖项的数量很高,则提供一组适当的默认依赖项可能很难,因为您应该避免包含对典型库的使用不必要的依赖项。换句话说,您不应该包含可选的依赖项。
无论哪种方式,您的starter必须直接或间接引用核心Spring Boot启动器(spring-boot-starter)(如果您的启动器依赖于另一个启动器,则无需添加它)。如果只使用自定义启动器创建项目,则Spring Boot的核心功能将通过核心启动器的存在来实现。
我们的sms-spring-boot-starter仅仅是以下的pom:

5f45659e22f942fde9c31ee6103bac21.png

到此为止,我们的整个短信Starter就开发完成了。

4.总结

自定义starter对于我们项目组件化、模块化是有很大帮助的。同时也是Spring Boot一大特色。相信通过小胖的介绍你已经蠢蠢欲试了,那么就赶紧开始写一个吧。如果觉得对你有用可以点个赞关注一下。

おすすめ

転載: www.cnblogs.com/felordcn/p/12133481.html