SpringBoot学习笔记二：进阶内容
文章目录
-
-
- SpringBoot高级内容
-
- SpringBoot自动配置
-
- @Condition
- @Enable*注解
- 自动配置原理
- 日志
-
- 常见日志框架
- SLF4j使用
- SpringBoot监听机制
-
- Java监听机制
- SpringBoot监听机制
- SpringBoot启动流程分析
- SpringBoot监控
-
- 使用步骤
-
SpringBoot高级内容
SpringBoot自动配置
@Condition
Condition是在Spring4.0增加的条件判断功能，通过这个功能可以实现选择性的创建Bean操作。
案例：在Spring的IOC容器中有一个User的Bean，现要求：
- 导入Jedis坐标后，加载该Bean，没导入，则不加载。
在IOC容器中添加user的对象
@Configuration
public class UserConfig {
@Bean
public User user(){
return new User();
}
}
获取user对象
public static void main(String[] args) {
//启动SpringBoot的应用，返回Spring的IOC容器
ConfigurableApplicationContext context = SpringApplication.run(HelloApplication.class, args);
User user = (User) context.getBean("user");
System.out.println(user);
}
第一个需求：
在bean对象注入之前添加判断条件注解Condition
@Bean
@Conditional(ClassCondition.class)
public User user(){
return new User();
}
public class ClassCondition implements Condition {
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
//导入jedis坐标后创建Bean
boolean flag = true;
try {
Class<?> cls = Class.forName("redis.clients.jedis.Jedis");
} catch (ClassNotFoundException e) {
flag = false;
}
return flag;
}
}
第二个需求：将类的判断定义为动态的，判断哪个字节码文件存在可以动态指定。
自定义注解ConditionOnClass.java
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ClassCondition.class)
public @interface ConditionOnClass {
String[] value();
}
修改UserConfig.java
@Bean
@ConditionOnClass("redis.clients.jedis.Jedis")
public User user(){
return new User();
}
修改ClassCondition.java
public class ClassCondition implements Condition {
/**
* @param conditionContext 上下文对象。用于获取环境，IOC容器，ClassLoader对象
* @param annotatedTypeMetadata 注解的原对象。可以获取注解定义的属性值
* @return
*/
@Override
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
//导入通过注解属性值value指定坐标后创建Bean
Map<String, Object> map = annotatedTypeMetadata.getAnnotationAttributes(ConditionOnClass.class.getName());
String[] value = (String[]) map.get("value");
boolean flag = true;
try {
for (String className : value) {
Class<?> cls = Class.forName(className);
}
} catch (ClassNotFoundException e) {
flag = false;
}
return flag;
}
}
小结
自定义条件：
- 定义条件类：自定义类实现Condition接口，重写 matches 方法，在 matches 方法中进行逻辑判断，返回boolean值 。 matches 方法两个参数：
- context：上下文对象，可以获取属性值，获取类加载器，获取BeanFactory等。
- metadata：元数据对象，用于获取注解属性。
- 判断条件： 在初始化Bean时，使用 @Conditional(条件类.class)注解
SpringBoot提供的常用条件注解：
- ConditionalOnProperty：判断配置文件中是否有对应属性和值才初始化Bean
- ConditionalOnClass：判断环境中是否有对应字节码文件才初始化Bean
- ConditionalOnMissingBean ： 判断环境中没有对应Bean才初始化Bean
SpringBoot切换内置web服务器
SpringBoot的web环境中默认使用tomcat作为内置服务器，其实SpringBoot提供了4中内置服务器供我们选择，我们可以很方便的进行切换。
SpringBoot切换内置web服务器原理：Condition
源码位置：org.springframework.boot:spring-boot-autoconfigure:2.5.0 --> org.springframework.boot.autoconfigure --> web --> embedded --> EmbeddedWebServerFactoryCustomizerAutoConfiguration.java
在pom.xml中切换内置服务器
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-tomcatartifactId>
exclusion>
exclusions>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-jettyartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
@Enable*注解
SpringBoot中提供了很多Enable开头的注解，这些注解都是用于动态启用某些功能的。而其底层原理是使用@Import注解导入一些配置类，实现Bean的动态加载。
思考：SpringBoot工程是否可以直接获取jar包中定义的Bean？
@Import
@Enable*底层依赖于@Import注解导入一些类，使用@Import导入的类会被Spring加载到IOC容器中。而@Import提供4种用法：
① 导入Bean
② 导入配置类
③ 导入 ImportSelector 实现类。一般用于加载配置文件中的类
④ 导入 ImportBeanDefinitionRegistrar 实现类。
1、导入Bean
@Import(User.class)
2、导入配置类
UserConfig.java
@Configuration
public class UserConfig {
@Bean
public User user(){
return new User();
}
}
3、导入ImportSelector实现类
MyImportSelector.java
public class MyImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
return new String[]{"com.example.springbootenable.domain.User","com.example.springbootenable.domain.Role"};
}
}
@Import(MyImportSelector.class)
@EnableAutoConfiguration注解
- @EnableAutoConfiguration 注解内部使用 @Import(AutoConfigurationImportSelector.class)来加载配置类。
- 配置文件位置：META-INF/spring.factories，该配置文件中定义了大量的配置类，当 SpringBoot 应用启动时，会自动加载这些配置类，初始化Bean
- 并不是所有的Bean都会被初始化，在配置类中使用Condition来加载满足条件的Bean
自动配置原理
-
SpringBoot启动的时候加载主配置类，开启了自动配置功能@EnableAutoConfiguration
-
@EnableAutoConfiguration作用
-
利用EnableAutoConfigurationImportSelector给容器中导入一些组件
-
可以插进selectImports()方法的内容
-
List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);- SpringFactoriesLoader.loadFactoryNames()
- 扫描所有jar包类路径下 META-INF/spring.factories
- 把扫描到的这些文件的内容包装成properties对象
- 从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器中
将类路径下 META-INF/spring.factories里面配置的所有EnableAutoConfiguration的值加入到了容器中
-
3、每一个自动配置类进行自动配置功能；
-
自动配置原理，以HttpEncodingAutoConfiguration为例解释自动配置原理
@Configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件 @EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中 @ConditionalOnWebApplication //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否是web应用，如果是，当前配置类生效 @ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器； @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的 //即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的； public class HttpEncodingAutoConfiguration { //他已经和SpringBoot的配置文件映射了 private final HttpEncodingProperties properties; //只有一个有参构造器的情况下，参数的值就会从容器中拿 public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) { this.properties = properties; } @Bean //给容器中添加一个组件，这个组件的某些值需要从properties中获取 @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件？ public CharacterEncodingFilter characterEncodingFilter() { CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter(); filter.setEncoding(this.properties.getCharset().name()); filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST)); filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE)); return filter; }
日志
常见日志框架
JUL、JCL、log4j、log4j2、slf4j。。。
| 日志门面（日志的抽象层） | 日志实现 |
|---|---|
| Log4j、JUL、Log4j、Logback |
左边选一个门面（抽象层）、右边选一个实现；
- 日志门面：SLF4J
- 日志实现：Logback
SpringBoot：底层是Spring框架，Spring框架默认是用JCL；SpringBoot选用SLF4j和LogBack
SLF4j使用
以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；
导入 slf4j的jar包和logback的实现jar
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
Logger logger = LoggerFactory.getLogger(HelloWorld.class);
logger.info("Hello World");
}
}
每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；
如何让系统中所有的日志都统一到slf4j；
1、将系统中其他日志框架先排除出去；
2、用中间包来替换原有的日志框架；
3、我们导入slf4j其他的实现
SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；
slf4j日志使用
//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
public void test() {
//日志级别
//由低到高 trace
//可以调整输出的日志级别：日志就只会在这个级别以后的高级别生效
logger.trace("这是trace日志");
logger.debug("这是debug日志");
//SpringBoot默认使用的是info级别.没有指定级别的就用默认规定的级别：root级别
logger.info("这是info日志");
logger.warn("这是warn日志");
logger.error("这是error日志");
}
调整指定内容日志级别
logging.level.com.example=trace
# 指定路径下生成log日志
logging.file.path=F:/springboot
指定配置
给类路径下放上每个日志框架自己的配置文件即可，SpringBoot就不会使用自己默认的日志配置了。
SpringBoot监听机制
Java监听机制
SpringBoot 的监听机制，其实是对Java提供的事件监听机制的封装。
Java中的事件监听机制定义了以下几个角色：
① 事件：Event，继承 java.util.EventObject 类的对象
② 事件源：Source ，任意对象Object
③ 监听器：Listener，实现 java.util.EventListener 接口 的对象
SpringBoot监听机制
SpringBoot 在项目启动时，会对几个监听器进行回调，我们可以实现这些监听器接口，在项目启动时完成一些操作。
ApplicationContextInitializer、SpringApplicationRunListener、CommandLineRunner、ApplicationRunner
注：
- CommandLineRunner、ApplicationRunner在项目一启动后就自动执行。两者功能相似
- ApplicationContextInitializer、SpringApplicationRunListener启动步骤：
META-INF/spring.factories
org.springframework.context.ApplicationContextInitializer=\
com.example.springbootlistener.listener.MyApplicationContextInitializer
ApplicationContextInitializer、SpringApplicationRunListener在banner之前，即IOC容器建立之前执行
SpringBoot启动流程分析
SpringBoot监控
SpringBoot自带监控功能Actuator，可以帮助实现对程序内部运行情况监控，比如监控状况、Bean加载情况、配置属性、日志信息等。
使用步骤
① 导入依赖坐标
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
② 访问http://localhost:8080/acruator
actuator监控使用
# 开启健康检查完整信息
management.endpoint.health.show-details=always
# 将所有的监控endpoint暴露出来
management.endpoints.web.exposure.include=*
SpringBoot监控 - Spring Boot Admin
- Spring Boot Admin是一个开源社区项目，用于管理和监控SpringBoot应用程序。
- Spring Boot Admin 有两个角色，客户端(Client)和服务端(Server)。
- 应用程序作为Spring Boot Admin Client向为Spring Boot Admin Server注册
- Spring Boot Admin Server 的UI界面将Spring Boot Admin Client的Actuator Endpoint上的一些监控信息