尚硅谷SpringBoot3视频笔记-4

这是 SpringBoot3 第四篇视频笔记，本篇主要记录 SPringBoot 常用注解。

SpringBoot 全面摒弃了 XML 配置的方式，全部采用注解的方式进行组件注册，组件配置。

1. 用的组件注册的注解

@Configuration、@SpringBootConfiguration、@Bean、@Scope、@Controller、@Service、@Repository、@Component、@Import、@ComponentScan

2. 组件注册

使用@Bean来注册组件

新建一个实体类

@Data
public class User {
    private Long id;
    private String name;
}

新建一个配置类，并在这个配置类中将User注册为 Bean

@Configuration // 表示这是一个配置类，用于代替以前的xml配置文件，配置类本身也是容器中的组件
public class AppConfig {
    @Bean // @Bean注解代替以前的Bean标签，组件在容器中的名字默认是方法名
    // @Bean("userHa") 也可以通过这种方式来修改组件在容器中的名字
    public User user(){
        User user = new User();
        user.setId(1L);
        user.setName("haha");
        return user;
    }
}

Bean在容器中注册后，名字默认是方法的名称，也可以通过@Bean("userHa")来修改组件在容器中的名字。Bean默认是单实例的，也就是在容器中保存一份，每次获取都是同一个对象。如果想要修改组件为多实例的，可以使用@Scope注解，@Scope("prototype")表示多实例。

@Scope("prototype")
@Bean
public User user(){}

2.1 导入第三方的 Bean

第一种方式就是按照上面的方式，定义一个方法使用@Bean注解进行组件注册
第二种方式使用@Import()注解导入例如

@Import(User.class)
@Configuration // 表示这是一个配置类，用于代替以前的xml配置文件
public class AppConfig {}

这种情况下导入的组件的名称默认是全类名

3. 条件注解

@ConditionOnXXX

如果注解指定的条件成立，触发指定行为

@ConditionalOnClass: 如果类路径中存在这个类，则触发指定行为
@ConditionalOnMissingClass: 如果类路径中不存在这个类，则触发指定行为
@ConditionalOnBean: 如果容器中存在这个组件，则触发指定行为
@ConditionalOnMissingBean: 如果容器中不存在这个组件，则触发指定行为

例如下面的这段代码演示的场景

/**
 * 容器中存在 `com.alibaba.druid.FastsqlException`，就导入Cat组件，名为`cat01`
 * @return
 */
@ConditionalOnClass(name = "com.alibaba.druid.FastsqlException") //这里建议使用name导入全类名，这样如果项目中不存在
@Bean
public Cat cat01() {
    return new Cat();
}
/**
 * 容器中不存在 `com.alibaba.druid.FastsqlException`，就导入Dog组件，名为`dog01`
 * @return
 */
@ConditionalOnMissingClass(value = "com.alibaba.druid.FastsqlException")
@Bean
public Dog dog01(){
    return new Dog();
}
@ConditionalOnBean(value = Dog.class)
@Bean
public User user01(){
    return new User();
}
@ConditionalOnMissingBean(value = Dog.class)
@Bean
public User user02(){
    return new User();
}

上面的这些条件都是放在方法上的，只对方法起作用，如果将条件注解放在类上，则对整个类起作用

4. 属性绑定

@ConfigurationProperties，@EnableConfigurationProperties

将容器中任意组件的属性值和配置文件中的配置项的值进行绑定

将类注册为容器中的 Bean
使用@ConfigurationProperties 注解声明组件和配置文件的哪些配置项进行绑定

例如新建一个Cat类，在配置文件中配置对应的属性值

@Component
@ConfigurationProperties(prefix = "cat")
@Data
public class Cat {
    private Long id;
    private String name;
    private String color;
}

cat.id=1
cat.name=皮皮九
cat.color=白色

也可以通过下面这种方式进行绑定 Cat类

@Data
public class Cat {
    private Long id;
    private String name;
    private String color;
}

配置类

@Configuration
public class AppConfig2 {
    @ConfigurationProperties(prefix = "cat")
    @Bean
    public Cat cat(){
        return new Cat();
    }
}

4.2 通过`@EnableConfigurationProperties`和`@ConfigurationProperties`注解一起使用

前面要让配置文件中的值和配置类中的属性进行绑定，必须先将配置类注册为组件，还有一种实现的方式如下方代码 Cat类

@ConfigurationProperties(prefix = "cat")
@Data
public class Cat {
    private Long id;
    private String name;
    private String color;
}

因为没有被注册为组件 Bean，因此这里@ConfigurationProperties会提示报错

配置类中

@EnableConfigurationProperties(Cat.class)
@Configuration
public class AppConfig2 {}

这里对@EnableConfigurationProperties(Cat.class)作一个解释