SpringBoot中的@Configuration注解详解

2023-08-04 08:49:44 作者：cloneme01

这篇文章主要介绍了SpringBoot中的@Configuration注解详解,Spring Boot推荐使用JAVA配置来完全代替XML 配置，JAVA配置就是通过 @Configuration和 @Bean两个注解实现的,需要的朋友可以参考下

写在前面

Spring Boot推荐使用JAVA配置来完全代替XML 配置，JAVA配置就是通过 @Configuration和 @Bean两个注解实现的

也就是说：@Configuration+@Bean可以达到在Spring中使用XML配置文件的作用

@Configuration可理解为使用Spring框架时的XML文件中的<beans/>

@Bean可理解为使用Spring框架时XML里面的<bean/>标签。

使用目的

@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法

这些方法将会被AnnotationConfigWebApplicationContext或AnnotationConfigApplicationContext类进行扫描，并构建Bean定义，初始化Spring容器。

使用约束

@Configuration注解作用在类、接口（包含注解）上
@Configuration用于定义配置类，可替换XML配置文件，相当于XML形式的Spring配置
@Configuration注解类中可以声明一个或多个 @Bean 注解的方法
@Configuration注解作用的类不能是 final 类型
@Configuration不可以是匿名类；
嵌套的 @Configuration类必须是 static 的

代码示例

package com.hadoopx.mallx.data.config.redis;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisPassword;
import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
import org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
import org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration;
import org.springframework.data.redis.core.StringRedisTemplate;
import java.time.Duration;
@Configuration
public class RedisAutoConfig {
    @Bean
    public LettuceConnectionFactory defaultLettuceConnectionFactory(RedisStandaloneConfiguration defaultRedisConfig, GenericObjectPoolConfig defaultPoolConfig) {
        LettuceClientConfiguration clientConfig =
                LettucePoolingClientConfiguration.builder().commandTimeout(Duration.ofMillis(5000))
                        .poolConfig(defaultPoolConfig).build();
        return new LettuceConnectionFactory(defaultRedisConfig, clientConfig);
    }
    @Bean
    public StringRedisTemplate stringRedisTemplate(LettuceConnectionFactory defaultLettuceConnectionFactory) {
        StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
        stringRedisTemplate.setConnectionFactory(defaultLettuceConnectionFactory);
        return stringRedisTemplate;
    }
    @Configuration
    public static class DefaultRedisConfig {
        /**
         * 获取配置文件中spring.redis.host的值, 如果没有则使用默认值: 127.0.0.1
         * 使用如下:
         * @Value("${YML-KEY:DEFAULT-VALUE}")
         */
        @Value("${spring.redis.host:127.0.0.1}")
        private String host;
        @Value("${spring.redis.port:6379}")
        private Integer port;
        @Value("${spring.redis.password:}")
        private String password;
        @Value("${spring.redis.database:0}")
        private Integer database;
        @Value("${spring.redis.lettuce.pool.max-active:8}")
        private Integer maxActive;
        @Value("${spring.redis.lettuce.pool.max-idle:8}")
        private Integer maxIdle;
        @Value("${spring.redis.lettuce.pool.max-wait:-1}")
        private Long maxWait;
        @Value("${spring.redis.lettuce.pool.min-idle:0}")
        private Integer minIdle;
        @Bean
        public GenericObjectPoolConfig defaultPoolConfig() {
            GenericObjectPoolConfig config = new GenericObjectPoolConfig();
            config.setMaxTotal(maxActive);
            config.setMaxIdle(maxIdle);
            config.setMinIdle(minIdle);
            config.setMaxWaitMillis(maxWait);
            return config;
        }
        @Bean
        public RedisStandaloneConfiguration defaultRedisConfig() {
            RedisStandaloneConfiguration config = new RedisStandaloneConfiguration();
            config.setHostName(host);
            config.setPassword(RedisPassword.of(password));
            config.setPort(port);
            config.setDatabase(database);
            return config;
        }
    }
}

基础运用

@Configuration注解最常见的搭配使用有两个：@Bean和@Scope

@Bean：等价于Spring中的bean标签用于注册bean对象的，给容器中添加组件，一般以方法名作为组件的id，配置类里面使用@Bean标注在方法上给容器注册组件，默认是单实例的。

@Configuration(proxyBeanMethods = true) //告诉springboot这是一个配置类 == 配置文件
public class Myconfig {
    @Bean//给容器中添加组件，以方法名作为组件的id。
    // 返回类型为组件类型，返回的值，就是组件在容器中的实例
    public User user01(){
        User wangcai = new User("wangcai",23);
        //user组件依赖了pet组件
        wangcai.setPet(pet01());
        return wangcai;
    }
    @Bean
    public Pet pet01(){
        return new Pet("旺财");
    }
}

@Scope：用于声明该bean的作用域，作用域有singleton、prototype、request、session。

@Configuration
public class MyConfig {
    @Bean("user")
    @Scope(SCOPE_PROTOTYPE)         //多例
    public User getUser(){
        System.out.println("User对象进行创建!");
        return new User("用户", 22, getDog());
    }
    @Bean("dog")
    @Scope(SCOPE_SINGLETON)         //单例
    public Dog getDog(){
        System.out.println("Dog对象进行创建!");
        return new Dog("金毛", 3);
    }
}

@Configuration注解的属性

@Configuration注解中有@Component注解的加持，因此它自己本身也是一个bean对象，可以通过Context的进行获取。
@Configuration中的属性proxyBeanMethods是及其重要的，设置true/false会得到不同的效果。
- proxyBeanMethods = true的情况下，保持单实例对象
- proxyBeanMethods = false的情况下，不进行检查IOC容器中是否存在，而是简单的调用方法进行创建对象，无法保持单实例
- 简单来说，就相当于true只调用一次，而false会调用多次。

到此这篇关于SpringBoot中的@Configuration注解详解的文章就介绍到这了,更多相关@Configuration注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！