深入springboot原理——动手封装一个starter
Posted 学习、改良、极致
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了深入springboot原理——动手封装一个starter相关的知识,希望对你有一定的参考价值。
从上一篇文章《深入springboot原理——一步步分析springboot启动机制(starter机制)》
我们已经知道springboot的起步依赖与自动配置的机制。spring-boot-starter-xxx是官方提供的starter,xxx-spring-boot-starter是第三方提供的starter。starter.jar提供jar引入,autoconfigure.jar实现自动配置。下面我们就来封装一个自己的starter。
准备要封装的组件
新建组件com-itpsc-service,组件只有一个service。
pom文件
<groupId>com.itpsc</groupId> <artifactId>com-itpsc-service</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <name>com-itpsc-service</name> <description>com-itpsc-service</description>
编写UserService类
public class UserService { private String username; private String password; public void print() { System.out.println("username="+username + " password="+password); } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } }
打包发布组件
idea终端里面输入命令mvn install package打包到maven仓库。
新建一个starter
新建一个名称为itpsc-spring-boot-starter启动组件
引入spring-boot-starter、spring-boot-autoconfigure、spring-boot-configuration-processor
这些Jar在编写自动配置类、注解、生成配置元数据处理等功能依赖的jar包。
<groupId>com.itpsc.spring.boot</groupId> <artifactId>itpsc-spring-boot-starter</artifactId> <version>1.0-SNAPSHOT</version> <packaging>jar</packaging> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.0.4.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>2.0.4.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <version>2.0.4.RELEASE</version> </dependency> <dependency> <groupId>com.itpsc</groupId> <artifactId>com.itpsc.service</artifactId> </dependency> </dependencies
编写自动配置类
UserProperties.java,使用@ConfigurationProperties注解将配置文件(yml/properties)中指定前缀的配置转为bean。
package com.itpsc.spring.boot.starter; ... @ConfigurationProperties(prefix = "com.itpsc") public class UserProperties { private String username; private String password; ... }
UserAutoConfiguration.java,@Configuration 注释使类成为bean的工厂。
@EnableConfigurationProperties注解使@ConfigurationProperties注解生效。
package com.itpsc.spring.boot.starter; ... @Configuration @EnableConfigurationProperties(UserProperties.class) public class UserAutoConfiguration { @Bean public UserService getBean(UserProperties userProperties) { //创建组件实例 UserService userService = new UserService(); userService.setUsername(userProperties.getUsername()); userService.setPassword(userProperties.getPassword()); return userService; } }
配置spring.factories文件
\\META-INF\\spring.factories该文件用来定义需要自动配置的类,springboot启动时会进行对象的实例化,会通过加载类SpringFactoriesLoader加载该配置文件,将文件中的配置类加载到spring容器。
在src/main/resources新建META-INF文件夹,在META-INF文件夹下新建spring.factories文件。配置内容如下:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\\
com.itpsc.spring.boot.starter.UserAutoConfiguration
打包发布starter
idea终端里面输入命令mvn install package打包到maven仓库。
测试starter
我们在springboot-mybatis-demo项目中引入starter
<dependency> <groupId>com.itpsc.spring.boot</groupId> <artifactId>itpsc-spring-boot-starter</artifactId> <version>1.0-SNAPSHOT</version> </dependency>
当在yml中配置username、password时就可以看到有自动提示了,这是因为引入的jar中包含了元数据文件,详细见下文。
com:
itpsc:
username: "itpsc"
password: itpsc@123
元数据文件是在编译器通过处理所有被@ConfigurationProperties注解的节点来自动生成的。
测试在增加一个测试方法
@Autowired private UserService userService; @Test public void testItpscStarter() { userService.print(); }
运行结果:
2019-01-23 20:22:41.615 INFO 17184 --- [ main] .i.SpringbootMybatisDemoApplicationTests : Started SpringbootMybatisDemoApplicationTests in 11.505 seconds (JVM running for 14.582) username=itpsc password=itpsc@123
从运行结果可以看出,我们封装的starter中的jar包的bean已经完成了自动配置,说明我们的starter封装成功了。下面补充下上文提到的元数据相关知识。
元数据
springboot jar包含元数据文件,提供所有支持的配置属性的详细信息。这些文件旨在允许IDE开发人员在用户使用application.properties 或application.yml文件时提供上下文帮助和自动补全 。
主要的元数据文件是在编译器通过处理所有被@ConfigurationProperties注解的节点来自动生成的。
配置元数据位于jar文件中的META-INF/spring-configuration-metadata.json,它们使用一个具有”groups”或”properties”分类节点的简单JSON格式。
{ "sourceType": "org.springframework.boot.autoconfigure.web.ServerProperties", "defaultValue": 8080, "name": "server.port", "description": "Server HTTP port.", "type": "java.lang.Integer" }, { "defaultValue": "\\/", "deprecated": true, "name": "server.servlet-path", "description": "Path of the main dispatcher servlet.", "type": "java.lang.String", "deprecation": { "level": "error", "replacement": "server.servlet.path" }
这两个json节点server.port、server.servlet-path对应可以在yml或者properties文件中定义
server:
port: 8081
context-path: /
如果不知道spring是否支持某个配置的话,可以查看元数据文件看是否有对应的节点。
以上是关于深入springboot原理——动手封装一个starter的主要内容,如果未能解决你的问题,请参考以下文章
SpringBoot 我随手封装了一个万能的导出excel工具,传什么都能导出