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注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring实现自定义注解处理器解析和处理注解

    Spring实现自定义注解处理器解析和处理注解

    这篇文章主要介绍了Spring实现自定义注解处理器解析和处理注解,注解在现代Java编程中扮演了至关重要的角色,无论是简化代码、增强可读性,还是将元数据与业务逻辑分离,注解都让我们的代码更加优雅和灵活,需要的朋友可以参考下
    2024-10-10
  • Java中File文件操作类的超详细使用教程

    Java中File文件操作类的超详细使用教程

    File类在包java.io.File下、代表操作系统的文件对象(文件、文件夹),File类提供了诸如:定位文件,获取文件本身的信息、删除文件、创建文件(文件夹)等功能,下面这篇文章主要给大家介绍了关于Java中File文件操作类的超详细使用教程,需要的朋友可以参考下
    2023-01-01
  • 使用logback实现按自己的需求打印日志到自定义的文件里

    使用logback实现按自己的需求打印日志到自定义的文件里

    这篇文章主要介绍了使用logback实现按自己的需求打印日志到自定义的文件里,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • java登录验证码实现代码

    java登录验证码实现代码

    这篇文章介绍了java实现登录验证码:用兴趣的同学可以参考一下
    2013-10-10
  • 详解Spring Boot配置使用Logback进行日志记录的实战

    详解Spring Boot配置使用Logback进行日志记录的实战

    本篇文章主要介绍了详解Spring Boot配置使用Logback进行日志记录的实战,具有一定的参考价值,有兴趣的朋友可以了解一下
    2017-07-07
  • javaweb项目如何实现手机短信登录

    javaweb项目如何实现手机短信登录

    这篇文章主要介绍了javaweb项目如何实现手机短信登录,手机号登录在现在的项目中用的场景非常多,实现起来也不难,今天我们就一起来通过演示实现登录过程,需要的朋友可以参考下
    2019-07-07
  • Idea中springboot项目的热部署无法生效问题解决

    Idea中springboot项目的热部署无法生效问题解决

    本文主要介绍了Idea中springboot项目的热部署无法生效问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-10-10
  • 使用springboot单元测试对weblistener的加载测试

    使用springboot单元测试对weblistener的加载测试

    这篇文章主要介绍了使用springboot单元测试对weblistener的加载测试,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • JAVAE中servlet的概念及使用示例详解

    JAVAE中servlet的概念及使用示例详解

    servlet是一种实现动态页面的技术,他是由tomcat提供给程序员的一组API可以帮助程序员开发一个web程序,这篇文章主要介绍了JAVAE中servlet的概念及使用,需要的朋友可以参考下
    2024-05-05
  • java String到底有多长?String超出长度该如何解决

    java String到底有多长?String超出长度该如何解决

    在Java中,由于字符串常量池的存在,String常量长度限制取决于String常量在常量池中的存储大小,下面这篇文章主要给大家介绍了关于java String到底有多长?String超出长度该如何解决的相关资料,需要的朋友可以参考下
    2023-01-01

最新评论