Spring5参考指南:基于注解的容器配置

简介: Spring5参考指南:基于注解的容器配置

文章目录


Spring的容器配置可以有两种方式,一种基于XML文件, 一种基于注解。注解注入在XML注入之前执行。因此,当两个同时使用时,XML配置会覆盖注解注入的属性。

本文会主要介绍 @Required,@Autowired, @PostConstruct, @PreDestroy 和 @Resource 这几个注解。


这几个注解都是由 context:annotation-config/ 来引入的。本质上引入这个配置会隐式的注册AutoWiredAnnotationBeanPostProcessor(提供@Autowired),CommonAnnotationBeanPostProcessor(提供@PostConstruct, @PreDestroy, @Resource),RequiredAnnotationBeanPostProcessor(提供 @Required),从而提供各个注解的功能。


下面我们会分别介绍各个注解的功能。


@Required


@Required 一般用在方法上面,表示该方法的参数必须能通过配置或者自动装载来填充。通常如果某个属性是必须的,我们会使用这个注解。


不过从Spring Framework 5.1开始,@Required注解正式被弃用,取而代之的是使用构造函数注入用于所需的属性,或使用InitializingBean.afterPropertiesSet()的自定义实现以及bean属性setter方法。


示例代码如下:


public class RequiredBean {
    private BeanA  beanA;
    @Required
    public void setBeanA(BeanA beanA){
        this.beanA=beanA;
    }
}

@Autowired


@Autowired 就是自动注入所需要的字段,参数等。JSR 330的@Inject注解可以代替spring的@Autowired注解。


你可以将@Autowired注解到构造器中,如下所示:


public class AutowiredBean {
    private BeanA beanA;
    @Autowired
    public AutowiredBean(BeanA beanA){
        this.beanA=beanA;
    }
}


从SpringFramework4.3开始,如果目标bean只定义了一个构造函数,那么就不再需要在此类构造函数上使用@Autowired注解。但是,如果有多个构造函数可用,则必须至少对其中一个进行注解,以告诉容器使用哪一个。


@Autowired也可以注解到传统的setter方法,如下例子所示:


public class AutowiredBean {
    private BeanB beanB;
    @Autowired
    public void setBeanB(BeanB beanB){
        this.beanB=beanB;
    }
}


也可以把注解应用到任何名字和多个参数,如下所示:


@Autowired
    public void configAB(BeanA beanA , BeanB beanB){
        this.beanA=beanA;
        this.beanB=beanB;
    }


@Autowired也可以用在字段上,如下所示:


@Autowired
    private BeanC beanC;


还可以通过将注解添加到需要该类型数组的字段或方法,那么可以从ApplicationContext中获取到该特定类型的所有bean,如下例所示:


@Autowired
    private BeanC[] beanCList;


如果希望数组或列表中的项按特定顺序排序,目标bean可以实现


org.springframework.core.Ordered接口,或者可以使用@Order或标准的@Priority注解。


否则,它们的顺序遵循容器中相应目标bean定义的注册顺序。


Map实例也可以被注入,只要key是String类型。Map value包括了所有的类型匹配的Bean,keys是该bean的名字。如下所示:


@Autowired
    public void configMapA(Map<String,BeanA> mapA){
    this.mapA=mapA;
    }


@Autowired有个required属性,如果要注入的bean有可能不存在,则可以如下所示:


@Autowired(required = false)
    public void setBeanC(BeanC beanC){
    }


建议使用@Autowired的’required’属性而不是使用setter方法上的@Required注解。“required”属性表示自动装载需要该属性, 如果无法自动装载,则忽略该属性。而对于@Required来说,如果未定义任何值,则会报异常。


也可以通过Java 8的java.util.Optional表示特定依赖项的非必需性质,如下示例显示:


@Autowired
    public void setMovieFinder(Optional<BeanC> BeanC) {
    }


在Spring Framework 5.0中,你也可以使用@Nullable注解:


@Autowired
    public void setMovieFinderC(@Nullable BeanC beanC) {
    }


Spring可以使用@Autowired来自动解析一些默认存在的bean如:BeanFactory、ApplicationContext、Environment、ResourceLoader、ApplicationEventPublisher和MessageSource。这些接口及其扩展接口(如ConfigurableApplicationContext或ResourcePatternResolver)。


如下所示,自动注入ApplicationContext:


@Autowired
    private ApplicationContext context;


注意: @Autowired, @Inject, @Value, 和 @Resource 注解是在Spring的BeanPostProcessor中处理的,这意味着你不能将这些注解用在你自己的BeanPostProcessor,BeanFactoryPostProcessor类型。


@primary


当按类型注入的时候,可能会有多个候选项,则可以通过@Primary注解表示优先的对象。如下所示:


@Configuration
public class ConfigBean {
    @Bean
    @Primary
    public BeanA firstBeanA() { return new BeanA(); }
    @Bean
    public BeanA secondBeanA() {  return new BeanA();}
}


@Qualifier


@Primary是一种在多个实例中按类型使用自动装载的有效方法,但是如果你希望对注入的Bean进行更细粒度的控制时候,可以使用@Qualifier。如下所示:


@Bean
    @Qualifier("main")
    public BeanC beanC() {  return new BeanC();}


@Autowired
    @Qualifier("main")
    private BeanA beanA;
    @Autowired
    public void setBeanA(@Qualifier("main") BeanA beanA){
    }


限定符的值并不是唯一的,它只是一个过滤标准。


@Autowired一般用来通过类型匹配,@Resource则是通过名称匹配。


也可以创建自定义注解:


@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Genre {
        String value();
}


泛型


除了@Qualifier注解外,还可以使用Java泛型类型作为隐式的限定形式。例如,假设您具有以下配置:


public class StringStore implements Store<String> {
}
public class IntegerStore implements Store<Integer> {
}


@Bean
    public StringStore stringStore() {
        return new StringStore();
    }
    @Bean
    public IntegerStore integerStore() {
        return new IntegerStore();
    }


public class GenericBean {
    @Autowired
    private Store<String> s1; // <String> qualifier, injects the stringStore bean
    @Autowired
    private Store<Integer> s2; // <Integer> qualifier, injects the integerStore bean
    // Inject all Store beans as long as they have an <Integer> generic
    // Store<String> beans will not appear in this list
    @Autowired
    private List<Store<Integer>> s;
}


@Resource


@Resource用在字段或者Setter方法上,默认情况下@Resource通过名字来注入。


public class ResourceBean {
    @Resource(name = "beanA")
    private BeanA BeanA;
}


如果未显式指定名称,则从字段名或setter方法派生默认名称.


在@Resource用法中,如果没有指定显式名称,并且类似于@Autowired,@Resource会找到一个主类型匹配,而不是指定的bean,并解析已知的可解析依赖项:BeanFactory、ApplicationContext、ResourceLoader、ApplicationEventPublisher,和MessageSource接口。


@PostConstruct和@PreDestroy


这两个注解主要用做生命周期回调。如下所示:


public class ConstructBean   {
    @PostConstruct
    public void populateMovieCache() {
        // populates the movie cache upon initialization...
    }
    @PreDestroy
    public void clearMovieCache() {
        // clears the movie cache upon destruction...
    }
}


与@Resource一样,@PostConstruct和@PreDestroy注解类型是JDK 6到8标准Java库的一部分。然而,整个javax.annotation包与JDK 9中的核心Java模块分离,并最终在JDK 11中被删除。如果需要,javax.annotation-api工件现在需要通过maven central获得,只需像其他库一样添加到应用程序的类路径中即可。


相关文章
|
7月前
|
负载均衡 监控 Java
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
本文详细介绍了 Spring Cloud Gateway 的核心功能与实践配置。首先讲解了网关模块的创建流程,包括依赖引入(gateway、nacos 服务发现、负载均衡)、端口与服务发现配置,以及路由规则的设置(需注意路径前缀重复与优先级 order)。接着深入解析路由断言,涵盖 After、Before、Path 等 12 种内置断言的参数、作用及配置示例,并说明了自定义断言的实现方法。随后重点阐述过滤器机制,区分路由过滤器(如 AddRequestHeader、RewritePath、RequestRateLimiter 等)与全局过滤器的作用范围与配置方式,提
Spring Cloud Gateway 全解析:路由配置、断言规则与过滤器实战指南
|
7月前
|
Java 关系型数据库 MySQL
Spring Boot自动配置:魔法背后的秘密
Spring Boot 自动配置揭秘:只需简单配置即可启动项目,背后依赖“约定大于配置”与条件化装配。核心在于 `@EnableAutoConfiguration` 注解与 `@Conditional` 系列条件判断,通过 `spring.factories` 或 `AutoConfiguration.imports` 加载配置类,实现按需自动装配 Bean。
|
7月前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
2429 0
|
9月前
|
Java Spring
Spring Boot配置的优先级?
在Spring Boot项目中,配置可通过配置文件和外部配置实现。支持的配置文件包括application.properties、application.yml和application.yaml,优先级依次降低。外部配置常用方式有Java系统属性(如-Dserver.port=9001)和命令行参数(如--server.port=10010),其中命令行参数优先级高于系统属性。整体优先级顺序为:命令行参数 &gt; Java系统属性 &gt; application.properties &gt; application.yml &gt; application.yaml。
1229 0
|
6月前
|
前端开发 Java 应用服务中间件
《深入理解Spring》 Spring Boot——约定优于配置的革命者
Spring Boot基于“约定优于配置”理念,通过自动配置、起步依赖、嵌入式容器和Actuator四大特性,简化Spring应用的开发与部署,提升效率,降低门槛,成为现代Java开发的事实标准。
|
6月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
669 2
|
7月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
1199 5
|
8月前
|
缓存 Ubuntu Docker
Ubuntu环境下删除Docker镜像与容器、配置静态IP地址教程。
如果遇见问题或者想回滚改动, 可以重启系统.
510 16
|
7月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
364 0
探索Spring Boot的@Conditional注解的上下文配置
|
8月前
|
安全 算法 Java
在Spring Boot中应用Jasypt以加密配置信息。
通过以上步骤,可以在Spring Boot应用中有效地利用Jasypt对配置信息进行加密,这样即使配置文件被泄露,其中的敏感信息也不会直接暴露给攻击者。这是一种在不牺牲操作复杂度的情况下提升应用安全性的简便方法。
1362 10