Spring Boot中@SpringBootApplication注解的讲解-刘宇
- 一、@SpringBootApplication的介绍
- 二、@ComponentScan的介绍
- 三、@EnableAutoConfiguration的介绍
- 3.1、@EnableAutoConfiguration代码
- 3.2、两个比较重要的注解
- 四、@SpringBootConfiguration的介绍
- 五、@Configuration的介绍
- 5.1、例:将MyBean对象加入到Spring容器中,随后在Controller中获取并使用
- 5.2、@Configuration实现原理
作者:刘宇
CSDN博客地址:
有部分资料参考,如有侵权,请联系删除。如有不正确的地方,烦请指正,谢谢。
一、@SpringBootApplication的介绍
该注解声明了一个配置类,该配置类声明了一个或多个Bean方法,并且会触发自动配置、组件扫描。是Sprnig Boot的核心注解,主要功能是为了开启自动配置。
@Target(ElementType.TYPE) // 注解的适用范围,其中TYPE用于描述类、接口(包括包注解类型)或enum声明
@Retention(RetentionPolicy.RUNTIME) // 注解的生命周期,保留到class文件中(三个生命周期)
@Documented // 表明这个注解应该被javadoc记录
@Inherited // 子类可以继承该注解
@SpringBootConfiguration // 继承了Configuration,表示当前是注解类
@EnableAutoConfiguration // 开启springboot的注解功能,springboot的四大神器之一,其借助@import的帮助
@ComponentScan(excludeFilters = { // 扫描路径设置(具体使用待确认)
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
...
}
@SpringBootApplication注解是autoconfigure包下的一个注解,他是由三个注解组成,分别是:@ComponentScan、@EnableAutoConfiguration、@SpringBootConfiguration,这样我们只需要写@SpringBootApplication一个注解就能够实现这三个注解的功能了。
二、@ComponentScan的介绍
- @ComponentScan为自动扫描注解,他用于自动扫描病加载被@Component和@Repository等注解修饰的组件或者@Bean。它会将他们加载到Spring的IoC容器中,以供后面的使用。
- 扫描包的机制:我们可以通过basePackages属性来制定扫描的包,如果不指定则扫描该注解所在类的package。
参数介绍:
basePackageClasses:对basepackages()指定扫描注释组件包类型安全的替代。
excludeFilters:指定不适合组件扫描的类型。
includeFilters:指定哪些类型有资格用于组件扫描。
lazyInit:指定是否应注册扫描的beans为lazy初始化。
nameGenerator:用于在Spring容器中的检测到的组件命名。
resourcePattern:控制可用于组件检测的类文件。
scopedProxy:指出代理是否应该对检测元件产生,在使用过程中会在代理风格时尚的范围是必要的。
scopeResolver:用于解决检测到的组件的范围。
useDefaultFilters:指示是否自动检测类的注释
三、@EnableAutoConfiguration的介绍
开始spring应用的自动配置,根据你配置的classpath以及你已经定义的一些Bean,他会尝试猜测并且去配置我们想要的一些Bean。
3.1、@EnableAutoConfiguration代码
@EnableAutoConfiguration是借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IoC容器,
@SuppressWarnings("deprecation")
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
...
}
3.2、两个比较重要的注解
@AutoConfigurationPackage:自动配置包
@Import: 导入自动配置的组件
四、@SpringBootConfiguration的介绍
添加上该注解后,表示该类添加上了@Configuration注解。可以通过@Bean注解生成IOC容器管理的bean。这个注解应该在我们整个应用中只被使用一次,通常是从@SpringBootApplication注解中继承过来。
例:
- 在springboot启动类中注册bean
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import com.example.demo.domain.BeanTest;
//因为@SpringBootApplication包含了SpringBootConfiguration
//所以我们之间可以在DemoApplication类中使用@Bean进行bean的注册
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@Bean
public BeanTest beanTest(){
return new BeanTest();
}
}
- 在controller中使用该bean
package com.example.demo.config.controller;
import com.example.demo.domain.BeanTest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(value = "/api", produces = MediaType.APPLICATION_JSON_VALUE)
public class MyController {
@Autowired
private BeanTest beanTest;
@RequestMapping(value = "/getBeanTest")
public BeanTest getMyBean(){
return beanTest;
}
}
五、@Configuration的介绍
- 该注解在spring-context包中,表示一个类声明了一个或多个@Bean方法,而且可以被Spring容器进行处理,来去生成该Bean的定义,可供后期使用。
- @Configuration是@Component的元注解,那么他就可以进行组件扫描的,因此他是可以使用@Inject、@Value、@Autowired等注解的
- @Configuration可以与@Import、@Profile等注解进行组合使用
5.1、例:将MyBean对象加入到Spring容器中,随后在Controller中获取并使用
- 编写配置类
package com.example.demo.config;
import com.example.demo.domain.MyBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class MyConfig {
@Bean
public MyBean getMyBean(){
return new MyBean("liuyu",25);
}
}
- 获取bean
package com.example.demo.config.controller;
import com.example.demo.domain.MyBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(value = "/api", produces = MediaType.APPLICATION_JSON_VALUE)
public class MyController {
@Autowired
private MyBean myBean;
@RequestMapping(value = "/getMyBean")
public MyBean getMyBean(){
myBean.toString();
return myBean;
}
}
5.2、@Configuration实现原理
@Configuration其实是通过一个AnnotationConfigApplicationContext来进行启动的,对于web应用来说则是使用AnnotationConfigWebApplicationContext来进行启动的。
例:
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
//注册配置类
ctx.register(MyConfig.class);
//刷新
ctx.refresh();
//获取bean
MyBean myBean = ctx.getBean(MyBean.class);
// use myBean ...