现在,我们来实现这一一个功能,当SiteInformation类在classpath下的时候,系统自动配置SiteInformation类的Bean,并且SiteInformation类中的属性可以在application.properties文件中进行配置。
首先,使用IntelliJ IDEA创建一个Maven工程,在当前Project上选择新建Module,在弹出面板中填写相关信息,如下图所示:
点击下一步,选择module存放路径,如下图所示:
点击完成按钮,生成新的Module,然后修改module中的pom.xml,添加spring-boot-autoconfigure依赖,完整的配置代码如下所示:
添加spring-boot-autoconfigure依赖的目的是让自定义的starter具有自动配置的能力
然后,创建一个名为:com.ramostear.spring.boot.starter.site的包,并在包下创建SiteInformation.java文件,这个类提供了站点的一些基本属性,源码如下:
@ConfigurationProperties(prefix = "site")注解的作用是当我们需要覆盖站点信息时,在application.properties文件中需要使用“site”作为属性的前缀,如site.name = ramostear。如果不做任何配置,站点信息将使用默认值:unknown
接下来,创建一个SiteInformationProvider.java文件,用于返回站点信息,其源码如下所示:
SiteInformationProvider.java是自动配置的依据类,当引用此自定义Starter时,会依据SiteInformationProvider是否存在类创建这个类的Bean。
准备好上述两个类之后,需要创建一个自动配置类,如SiteInformationAutoConfiguration.java,其源码如下所示:
@ConditionalOnWebApplication注解表名此自动配置可以在Web应用中进行使用,@EnableConfigurationProperties(SiteInformation.class)注解指明提供自动配置的属性对象@ConditionalOnMissingBean(SiteInformationProvider.class)指明当容器中没有SiteInformationProvider这个类的Bean时,自动配置这个类的Bean
最后,需要将此配置类进行注册,Spring Boot才能完成自动配置工作。在resources资源文件夹下创建名为META-INF的文件夹,并添加名为spring.factories的文件,修改其内容为:
若有多个自动配置项,请用“,”进行分割,此处的“/”是为了换行后任然能够读取到属性。
完成上述的所有工作后,点击IDEA右侧Maven工具栏,选择当前项目,找到Plugins中的install选项并点击执行安装,如下图所示:
上述操作运行成功后,你可以在控制台看到如下所示的提示信息:
提示,请使用maven自带的插件对项目进行打包和安装,切勿使用spring-boot-maven-plugin进行打包安装,否则打包后的jar无法使用,请将下面的代码从你的pom文件中剔除:
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> 复制代码
至此,自定义的spring boot starter制作完成。接下来创建一个web工程,引入spring-boot-starter-site,测试此starter是否能够正常使用。
新建一个测试用的Module,并使用IDEA自带的Spring Initializr创建一个Web工程,如下图所示:
选择Module SDK的版本,选择下一步,填写Module相关信息,如下图所示:
然后点击下一步,将Web依赖添加到项目中,然后点击保存按钮,生成新的Module。如下如所示:
接下来,将spring-boot-starter-site依赖添加到测试用的Web工程中,pom.xml源码如下:
修改CustomStarterTestApplication.java中的源码,添加@RestController注解,并创建一个获取站点信息的方法,源码如下:
接下来在application.properties文件中添加如下的类容:
site.name = 谭朝红的技术分享博客 site.domain = www.ramostear.com site.keywords = blog site.description = 谭朝红的技术分享博客 site.copyright = Copyright 2019-Ramostear logging.level.org.springframework = debug 复制代码
配置logging.level.org.springframework= debug属性的作用是能够在控制台日志中查看自定义的starter是否生效。
点击运行CustomStarterTestApplication主类,并观察控制台输出,当自定义的starter生效后,你可以在控制台看到如下的信息:
============================ CONDITIONS EVALUATION REPORT ============================ Positive matches: ----------------- ... SiteInformationAutoConfiguration matched: - @ConditionalOnWebApplication (required) found 'session' scope (OnWebApplicationCondition) SiteInformationAutoConfiguration#provider matched: - @ConditionalOnMissingBean (types: com.ramostear.spring.boot.starter.site.SiteInformationProvider; SearchStrategy: all) did not find any beans (OnBeanCondition) ... 复制代码
最后,使用Postman工具请求http://localhost:8080/site/info 并观察返回的信息:
请求成功、并返回了站点的配置信息,详细信息如下所示:
{ "name": "谭朝红的技术分享博客", "domain": "www.ramostear.com", "copyright": "Copyright 2019-Ramostear", "keywords": "blog", "description": "谭朝红的技术分享博客" } 复制代码