环境:sprinboot2.3.9
这是 Spring Boot 最最最核心的注解,用在 Spring Boot 主类上,标识这是一个 Spring Boot 应用,用来开启 Spring Boot 的各项能力。
@SpringBootApplication
public class BaseWebApplication extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
return builder.sources(BaseWebApplication.class);
}
public static void main(String[] args) {
SpringApplication.run(BaseWebApplication.class, args);
}
}
开启自动配置注解,SpringBoot 就能根据当前类路径下的包或者类来配置 Bean。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}
这是 Spring 3.0 添加的一个注解,用来代替 applicationContext.xml 配置文件,通过注解来配置Bean。
@Configuration
public class WebConfig implements WebMvcConfigurer {
}
这是 Spring 3.1 添加的一个注解,用来代替配置文件中的 component-scan 配置,开启组件扫描,即自动扫描包路径下的 @Component 注解进行注册 bean 实例到 context 中。
@ComponentScan(basePackages = {"com.pack.a", "com.jack.b"})
public class SqlSessionFactoryConfig {
}
这是 Spring 4.0 添加的新注解,用来标识一个 Spring Bean 或者 Configuration 配置文件,当满足指定的条件才开启配置。
@Bean
@Conditional({SEEConditional.class})
public ServerEndpointExporter serverEndpointExporter (){
return new ServerEndpointExporter();
}
public class SEEConditional implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
String active = context.getEnvironment().getProperty("app.profiles.active") ;
return !"prod".equals(active) ;
}
}
当容器中有指定的 Bean 才开启配置。
当容器中没有指定的 Bean 才开启配置。
@ConditionalOnMissingBean({ DataSource.class, XADataSource.class })
protected static class EmbeddedConfiguration {
}
组合 @Conditional 注解,当容器中有指定的 Class 才开启配置。
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
public class RabbitAutoConfiguration {
}
当容器中没有指定的 Class 才开启配置。
当前项目类型是 WEB 项目才开启配置。
当前项目有以下 3 种类型。
/**
* Any web application will match.
*/
ANY,
/**
* Only servlet-based web application will match.
*/
SERVLET,
/**
* Only reactive-based web application will match.
*/
REACTIVE
当前项目类型不是 WEB 项目才开启配置。
当指定的属性有指定的值时才开启配置。
@Bean
@ConditionalOnProperty(prefix = "spring.rabbitmq", name = "dynamic", matchIfMissing = true)
public AmqpAdmin amqpAdmin(ConnectionFactory connectionFactory) {
return new RabbitAdmin(connectionFactory);
}
当 SpEL 表达式为 true 时才开启配置。
当运行的 Java JVM 在指定的版本范围时才开启配置。
当类路径下有指定的资源才开启配置。
当指定的 JNDI 存在时才开启配置。
当指定的 class 在容器中只有一个 Bean,或者同时有多个但为首选时才开启配置。
用来加载额外的配置(如 .properties 文件),可用在 @Configuration 注解类,或者 @Bean 注解方法上面。
@Bean
@ConfigurationProperties(prefix = DataSourceProperties.PREFIX)
public DataSource dataSource() {
DataSourceBuilder factory = DataSourceBuilder
.create(this.properties.getClassLoader())
.driverClassName(this.properties.getDriverClassName())
.url(this.properties.getUrl()).username(this.properties.getUsername())
.password(this.properties.getPassword());
if (this.properties.getType() != null) {
factory.type(this.properties.getType());
}
return factory.build();
}
配合 @ConfigurationProperties 注解使用,用来开启对 @ConfigurationProperties 注解配置 Bean 的支持。
@Configuration
@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
@EnableConfigurationProperties(DataSourceProperties.class)
public class DataSourceAutoConfiguration {
}
用在自动配置类上面,表示该自动配置类需要在另外指定的自动配置类配置完之后。
如 Mybatis 的自动配置类,需要在数据源自动配置类之后。
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration implements InitializingBean {
}
表示该自动配置类需要在另外指定的自动配置类配置之前。
这是 Spring 3.0 添加的新注解,用来导入一个或者多个 @Configuration 注解修饰的类,这在 SpringBoot 里面应用很多。
@Import(CachingConfigurationSelector.class)
public @interface EnableCaching {
}
这是 Spring 3.0 添加的新注解,用来导入一个或者多个 Spring 配置文件,这对 Spring Boot 兼容老项目非常有用,因为有些配置无法通过 Java Config 的形式来配置就只能用这个注解来导入。
@ImportResource({ "classpath:spring/application-*.xml" })
@SpringBootApplication
public class AppApplication {
}
该注解是@ResponseBody + @Controller的组合。返回的内容是return 的内容,无法返回jsp或html页面等视图文件。
@RestController
@RequestMapping("/users")
public class UsersController {
}
映射请求路径。
映射Get请求
映射post请求
映射method为patch的请求。一般用于个别属性的修改操作
创建新的资源或替换请求负载目标资源的表示。Put幂等,POST不是
删除资源
指示接口参数接受的是该请求的主体内容。
接受请求路径中的占位符的值。