SpringBoot2
1.Springboot自动配置原理分析
SpringApplication.run()启动应用
扫描到@SpringBootApplication注解
调用@EnableAutoConfiguration注解
扫描@Import({AutoConfigurationImportSelector.class})
进入AutoConfigurationImportSelector
调用selectImports()方法中的获取所有配置集合
List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
调用SpringFactoriesLoader.loadFactoryNames()读取了ClassPath下面的META-INF/spring.factories文件
读取文件中org.springframework.boot.autoconfigure.EnableAutoConfiguration里面所有的参数,开始运行预设好的配置类
各个配置类根据@Conditional,决定是否实例化配置类内部定义的bean,避免在bean初始化过程中由于条件不足,导致应用启动失败
1.1 @Conditional
使用
Conditional要配和Condition的实现类(ClassCondition)进行使用
实现一个Condition接口,并且重写matchs方法
@Conditional注解中指定Condition接口的实现即可
案例1:需求
在spring的IOC容器中有一个User的Bean,现要求:
导入Jedis坐标后,加载该Bean,没导入,则不加载。
- 实现一个Condition接口,并且重写matchs方法
public class ClassCondition implements Condition {
/**
* @param conditionContext 上下文对象。用于获取环境,IOC容器,ClassLoader对象
* @param annotatedTypeMetadata 注解元对象。 可以用于获取注解定义的属性值
* @return
*/
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
try {
Class<?> cls = Class.forName("redis.clients.jedis.Jedis");
return true;
} catch (ClassNotFoundException e) {
return false;
}
}
}
- @Conditional注解中指定Condition接口的实现
@Configuration
public class UserConfig {
@Bean
@Conditional(ClassCondition.class)
public User user(){
return new User();
}
}
- 验证
@SpringBootApplication
public class SpringbootTestApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(SpringbootTestApplication.class, args);
Object user = context.getBean("user");
System.out.println(user);
}
}
案例2:需求
在spring的IOC容器中有一个User的Bean,现要求:
导入Jedis坐标后,加载该Bean,没导入,则不加载。 将类的判断定义为动态的。判断哪个字节码文件存在可以动态指定。
- 编写自定义条件注解类
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassCondition.class)
public @interface ConditionOnClass {
String[] value();
}
- 修改ClassCondition
public class ClassCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
try {
Map<String, Object> map = annotatedTypeMetadata.getAnnotationAttributes(ConditionOnClass.class.getName());
String[] value = (String[]) map.get("value");
for (String className : value) {
Class<?> cls = Class.forName(className);
}
return true;
} catch (ClassNotFoundException e) {
return false;
}
}
}
- 修改注解类中的UserConfig
@Configuration
public class UserConfig {
@Bean
@ConditionOnClass("redis.clients.jedis.Jedis")
public User user(){
return new User();
}
}
- 验证
@SpringBootApplication
public class SpringbootTestApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(SpringbootTestApplication.class, args);
Object user = context.getBean("user");
System.out.println(user);
}
}
springboot中的条件注解有很多,常用的条件注解
ConditionalOnProperty:判断配置文件中是否有对应属性和值才初始化Bean
ConditionalOnClass:判断环境中是否有对应字节码文件才初始化Bean
ConditionalOnMissingBean:判断环境中没有对应Bean才初始化Bean
1.2 @EnableAutoConfiguration
@EnableXXXX常用来开启某些功能,其实底层就是使用@Importe来导入配置类
问题:springboot工程是否可以直接获取jar包中定义的Bean
三种解决方案:
- 使用@ComponentScan扫描config包
- 可以使用@Import注解,加载类。
- 自定义注解,对@Import进行封装
@Import的四种用法
- 直接导入bean
@Import(User.class)
public class EnableApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(EnableApplication.class, args);
Map<String, User> map = context.getBeansOfType(User.class);
System.out.println(map);
}
}
- 导入配置类
@Import(UserConfig.class)
public class EnableApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(EnableApplication.class, args);
Map<String, User> map = context.getBeansOfType(User.class);
System.out.println(map);
}
}
- 导入 ImportSelector 实现类
/**
* ImportSelector 实现类
*/
public class UserImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
return new String[]{"com.itheima.springboot_test.domain.User"};
}
}
@Import(UserImportSelector.class)
public class EnableApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(EnableApplication.class, args);
Map<String, User> map = context.getBeansOfType(User.class);
System.out.println(map);
}
}
- 导入 ImportBeanDefinitionRegistrar 实现类
/**
* ImportBeanDefinitionRegistrar 实现类
*/
public class UserImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.class).getBeanDefinition();
registry.registerBeanDefinition("user",beanDefinition);
}
}
@Import(UserImportBeanDefinitionRegistrar.class)
public class EnableApplication {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(EnableApplication.class, args);
Map<String, User> map = context.getBeansOfType(User.class);
System.out.println(map);
}
}
小结
- @EnableAutoConfiguration 注解内部使用 @Import(AutoConfigurationImportSelector.class)来加载配置类
- 配置文件位置:META-INF/spring.factories,该配置文件中定义了大量的配置类,当 SpringBoot 应用启动时,会自动加载这些配置类,初始化Bean
- 并不是所有的Bean都会被初始化,在配置类中使用Condition来加载满足条件的Bean
1.3 自定义starter
需求:自定义redis-starter。要求当导入redis坐标时,SpringBoot自动创建Jedis的Bean。
创建 springboot_test 模块
创建 redis-spring-boot-starter 模块,依赖 springboot_test的模块
在 springboot_test模块中初始化 Jedis 的 Bean。并定义META-INF/spring.factories 文件
在redis-spring-boot-autoconfigure创建RedisProperties类,方便从配置文件注入值,创建RedisAutoConfiguration自动配置类
@ConfigurationProperties(prefix = "redis")
public class RedisProperties {
private String host="localhost";
private int port=6379;
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
}
public int getPort() {
return port;
}
public void setPort(int port) {
this.port = port;
}
}
@Configuration
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {
@Bean
public Jedis jedis(RedisProperties redisProperties){
return new Jedis(redisProperties.getHost(),redisProperties.getPort());
}
}
在resource目录下创建META-INF文件夹并创建spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.itheima.springboot_test.config.RedisAutoConfiguration
- 在测试模块中引入自定义的 redis-starter 依赖,测试获取 Jedis 的Bean,操作 redis
2. SpringBoot事件监听
springboot的监听机制就是对java提供的时间监听机制的封装
SpringBoot 在项目启动时,会对几个监听器进行回调,我们可以实现这些监听器接口,在项目启动时完成一些操作。
- ApplicationContextInitializer:要在resource文件夹下添加META-INF/spring.factories
- SpringApplicationRunListener:使用要添加构造器
- CommandLineRunner:当项目启动后执行run方法
- ApplicationRunner:当项目启动后执行run方法
3. springboot部署
SpringBoot 项目开发完毕后,支持两种方式部署到服务器:
- 打jar包
java -jar 文件路径
- 打war包
引导类继承SpringBootServletInitializer
@SpringBootApplication public class SpringbootDeployApplication extends SpringBootServletInitializer { public static void main(String[] args) { SpringApplication.run(SpringbootDeployApplication.class, args); } @Override protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { return builder.sources(SpringbootDeployApplication.class); } }
指定打包的名称
<build> <finalName>springboot</finalName> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build>