SpringBoot - @Configuration注解使用详解

水深无声 2023-10-08 14:47 41阅读 0赞

## 写在前面 ##

> 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;
            }
        }
    }