SpringBoot的@ConfigurationProperties、@Autowired、@Conditional注解

1. @ConfigurationProperties + @EnableConfigurationProperties + @Autowired注解

在resources/application.properties文件中，定义key和value，格式为：前缀.类属性 = 值。如下所示：

server.port = 8088

# 格式：前缀.类属性 = 值
user.test.name = user1

如果User类的属性为userName，则参数为user.test.user-name

使用@ConfigurationProperties注解修饰User类，将application.properties中匹配前缀的值赋值给User类属性。User类必须要有无参构造器

package com.hh.springbootTest.myBean;

import org.springframework.boot.context.properties.ConfigurationProperties;

// 将application.properties中user.test前缀对应的值赋值给User类属性
@ConfigurationProperties(prefix = "user.test")
public class User {

    private String name;

    public User() {

    }

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    @Override
    public String toString() {
        return "User{" + "name='" + name + "'}";
    }
}

使用@EnableConfigurationProperties开启User类的配置绑定功能。User类会自动添加到容器中。必须和@Configuration注解一起使用。如下所示：

package com.hh.springbootTest.myConfig;

import com.hh.springbootTest.myBean.User;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;

// 开启User类的配置绑定功能。User类会自动添加到容器中
@EnableConfigurationProperties(User.class)
@Configuration
public class MyConfig {

}

除了使用@EnableConfigurationProperties将User添加到容器中，在User类上直接使用@Component注解等，也会将User添加到容器

使用@Autowired注解从IOC容器自动获取User类对象，如下所示：

package com.hh.springbootTest.myController;

import com.hh.springbootTest.myBean.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    // 从IOC容器自动获取User类对象
    @Autowired
    User user;

    @RequestMapping("/user")
    public User userName1() {
        return user;
    }

}

然后访问http://localhost:8088/user，显示的效果如下：

1.1 configuration自定义配置参数自动补全功能

为了提高我们的开发效率，对application.properties或application.yaml中，我们自定义的配置参数，实现自动补全功能，操作如下：

在pom.xml中添加依赖

......省略部分......
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

......省略部分......
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
            
......省略部分......

然后重新运行springboot项目。之后application.properties或application.yaml中，我们自定义的配置参数就有自动补全功能了

2. @Conditional注解

@Conditional有很多注解，常用的如下所示：

• @ConditionalOnBean：IOC容器中有规定的组件，才执行操作
• @ConditionalOnMissingBean：IOC容器中没有规定的组件，才执行操作
• @ConditionalOnClass(name = “com.hh.xxx”)：maven有依赖规定的类，才执行操作
• @ConditionalOnMissingClass(value = “com.hh.xxx”)：maven没有依赖规定的类，才执行操作
• @ConditionalOnWebApplication：程序是springboot的web应用，才执行操作
• @ConditionalOnNotWebApplication：程序不是springboot的web应用，才执行操作
• @ConditionalOnProperty：程序中有规定的属性，才执行操作
• @ConditionalOnResource：程序中有规定的配置文件，才执行操作
• @ConditionalOnJava：程序是基于规定的java版本，才执行操作
• @ConditionalOnSingleCandidate：IOC容器中规定的类只有一个实例，才执行操作

下面以@ConditionalOnMissingBean为例，进行讲解：

User类，如下所示：

package com.hh.springbootTest.myBean;

public class User {

    private String name;

    public User(String name) {
        this.name = name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    @Override
    public String toString() {
        return "User{" + "name='" + name + "'}";
    }
}

@ConditionalOnBean可以修饰类也可以修饰方法。characterEncodingFilter这个bean在执行完该操作后，才添加到IOC容器，所以这里的条件结果为false。则不会向IOC容器添加MyConfig和userName1。如下所示：

package com.hh.springbootTest.myConfig;

import com.hh.springbootTest.myBean.User;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

// characterEncodingFilter这个bean在执行完该操作后，才添加到IOC容器，所以这里的条件结果为false
// 则不会向IOC容器添加MyConfig和userName1
@ConditionalOnBean(name = "characterEncodingFilter")
@Configuration
public class MyConfig {

    @Bean
    public User userName1() {
        return new User("user1");
    }


}

执行程序，查看IOC容器是不存在name为userName1的组件的，如下所示：

package com.hh.springbootTest;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {

        ConfigurableApplicationContext applicationContext =
                SpringApplication.run(MyApplication.class, args);

        // 判断IOC容器是否包含指定name的组件
        boolean containsUser1 = applicationContext.containsBean("userName1");
        System.out.println(containsUser1);      // 返回的结果是：false
    }
}