【Spring高级】Aware与InitializingBean接口

2024-03-13 17:04
文章标签 java 接口 spring 高级 aware initializingbean

本文主要是介绍【Spring高级】Aware与InitializingBean接口，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

  • Aware接口
    • 概述
    • 为什么需要Aware接口
  • InitializingBean接口
  • @Autoware失效分析

Aware接口

概述

在Spring框架中，Aware 接口是一种常用的设计模式，用于允许bean在初始化时感知（或获取）Spring容器中的某些资源或环境信息。这些接口通常以 ...Aware 结尾，并且Spring提供了许多这样的接口。以下是一些常见的 Aware 接口及其用途：

  1. BeanNameAware：
    • 允许bean获取其在Spring容器中的名称。
    • 实现此接口的bean可以通过 setBeanName(String name) 方法设置其名称。
  2. BeanFactoryAware：
    • 允许bean获取对其创建它的 BeanFactory 的引用。
    • 实现此接口的bean可以通过 setBeanFactory(BeanFactory beanFactory) 方法设置其 BeanFactory。
  3. ApplicationContextAware：
    • 允许bean获取对其运行时的 ApplicationContext 的引用。
    • 实现此接口的bean可以通过 setApplicationContext(ApplicationContext applicationContext) 方法设置其 ApplicationContext。
  4. ResourceLoaderAware：
    • 允许bean获取 ResourceLoader，它可以用来加载类路径上的资源。
    • 实现此接口的bean可以通过 setResourceLoader(ResourceLoader resourceLoader) 方法设置其 ResourceLoader。
  5. MessageSourceAware：
    • 允许bean获取 MessageSource，它用于国际化消息解析。
    • 实现此接口的bean可以通过 setMessageSource(MessageSource messageSource) 方法设置其 MessageSource。
  6. ApplicationEventPublisherAware：
    • 允许bean获取 ApplicationEventPublisher，它用于发布应用事件。
    • 实现此接口的bean可以通过 setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) 方法设置其 ApplicationEventPublisher。
  7. EnvironmentAware：
    • 允许bean获取 Environment，它提供了对应用程序运行时的环境属性的访问。
    • 实现此接口的bean可以通过 setEnvironment(Environment environment) 方法设置其 Environment。

使用这些 Aware 接口，Spring bean可以在其生命周期的早期阶段获取到所需的资源或服务，然后利用这些资源或服务执行其逻辑。例如，ApplicationContextAware 允许一个bean访问整个应用上下文，这可能对于查找其他bean或资源非常有用。

要实现这些接口，你只需要在你的bean类中添加相应的 set 方法，并在Spring配置中声明这个bean。Spring容器会自动调用这些 set 方法，并传递相应的资源或服务。

例如，要实现 ApplicationContextAware，你可以这样做：

import org.springframework.beans.BeansException;  
import org.springframework.context.ApplicationContext;  
import org.springframework.context.ApplicationContextAware;  
import org.springframework.stereotype.Component;  @Component  
public class MyBean implements ApplicationContextAware {  private ApplicationContext applicationContext;  @Override  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {  this.applicationContext = applicationContext;  }  public ApplicationContext getApplicationContext() {  return applicationContext;  }  
}

在这个例子中，MyBean 实现了 ApplicationContextAware 接口，并通过 setApplicationContext 方法获取了 ApplicationContext 的引用。然后，这个bean就可以使用 applicationContext 属性来访问Spring容器中的其他bean或服务了。

为什么需要Aware接口

有了@Autoware注解，为什么还需要 Aware 接口？

  • 因为Aware接口提供了一种机制，让bean能够在Spring容器初始化它们的过程中获取到额外的信息或资源，这些信息或资源可能无法通过简单的依赖注入来获取。
  • @Autowired 的解析需要用到 bean 后处理器, 属于扩展功能， 而 Aware 接口属于内置功能, 不加任何扩展, Spring 就能识别。某些情况下, 扩展功能会失效, 而内置功能不会失效。
  • Aware接口提供了一种更灵活的方式来获取资源，因为它们可以在bean的初始化过程中任何时候被调用。相比之下，依赖注入通常发生在bean创建的过程中，并且受到Spring容器管理的依赖关系的限制。
  • 虽然可以通过@Autowired直接注入ApplicationContext，但这可能会增加代码的耦合度，因为任何需要访问ApplicationContext的类都必须依赖它。使用ApplicationContextAware接口可以让这种依赖更加显式，并且可以通过实现接口来控制哪些类实际上需要这种依赖。

InitializingBean接口

InitializingBean接口是Spring框架中的一个回调接口，它定义了一个afterPropertiesSet()方法。这允许bean在依赖注入完成后执行一些初始化逻辑。当一个bean的所有属性都被Spring容器通过依赖注入设置完毕之后，afterPropertiesSet()方法会被自动调用。

实现InitializingBean接口的bean可以在afterPropertiesSet()方法中编写自定义的初始化代码。通常用于执行一些在依赖注入后必须执行的设置或准备操作。这使得bean可以在其属性被设置之后执行一些初始化逻辑。

下面是一个实现InitializingBean接口的简单例子：

import org.springframework.beans.factory.InitializingBean;  public class MyBean implements InitializingBean {  private String someProperty;  public void setSomeProperty(String someProperty) {  this.someProperty = someProperty;  }  @Override  public void afterPropertiesSet() throws Exception {  // 初始化逻辑，这将在所有属性被设置之后执行  System.out.println("Properties have been set on the bean. Initializing...");  // 例如，可以在这里进行资源加载、数据初始化等操作  }  public void doSomething() {  // 业务逻辑  }  
}

在这个例子中，MyBean 类实现了 InitializingBean 接口，并覆盖了 afterPropertiesSet() 方法。当 Spring 容器创建 MyBean 的实例并设置其所有属性之后，它会调用 afterPropertiesSet() 方法。

虽然InitializingBean接口提供了一种通用的初始化机制，但Spring也支持使用@PostConstruct注解作为替代。

InitializingBean接口的使用不是强制性的。Spring也允许通过在XML配置文件中使用<bean>元素的init-method属性，或者在注解配置中使用@PostConstruct注解来指定初始化方法。@PostConstruct注解的方法会在依赖注入完成后自动被调用，这与afterPropertiesSet()方法的效果相同，但它是Java EE提供的替代InitializingBean接口的方式来执行初始化逻辑。

此外，你还可以通过实现DisposableBean接口并提供destroy()方法的实现来定义bean销毁时的逻辑。当bean不再需要并被Spring容器销毁时，destroy()方法会被自动调用。这类似于InitializingBean接口，但用于bean生命周期的结束阶段。

@Autoware失效分析

看下面一个例子：

配置类

package com.cys.demo02.Chapter06;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import javax.annotation.PostConstruct;@Configuration
public class MyConfig {private static final Logger log = LoggerFactory.getLogger(MyConfig.class);@Autowiredpublic void setApplicationContext(ApplicationContext applicationContext) {log.debug("注入 ApplicationContext");}@PostConstructpublic void init() {log.debug("初始化");}}

测试类

package com.cys.demo02.Chapter06;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor;
import org.springframework.context.annotation.CommonAnnotationBeanPostProcessor;
import org.springframework.context.annotation.ConfigurationClassPostProcessor;
import org.springframework.context.support.GenericApplicationContext;public class TestAutowiredInvalidated {private static final Logger log = LoggerFactory.getLogger(TestAutowiredInvalidated.class);public static void main(String[] args) {GenericApplicationContext context = new GenericApplicationContext();context.registerBean("myConfig1", MyConfig.class);context.registerBean(AutowiredAnnotationBeanPostProcessor.class);context.registerBean(CommonAnnotationBeanPostProcessor.class);context.registerBean(ConfigurationClassPostProcessor.class);context.refresh();context.close();}
}

运行后可以正常打印出依赖注入时打印的信息：

12:43:34.799 [main] DEBUG com.cys.demo02.Chapter06.MyConfig - 注入 ApplicationContext
12:43:34.800 [main] DEBUG com.cys.demo02.Chapter06.MyConfig - 初始化

但是当我们给配置类增加一个BeanFactoryPostProcessor，如下：

package com.cys.demo02.Chapter06;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;import javax.annotation.PostConstruct;@Configuration
public class MyConfig {private static final Logger log = LoggerFactory.getLogger(MyConfig.class);@Autowiredpublic void setApplicationContext(ApplicationContext applicationContext) {log.debug("注入 ApplicationContext");}@PostConstructpublic void init() {log.debug("初始化");}@Bean  //添加一个beanFactory的后处理器public  BeanFactoryPostProcessor processor1(){return  configurableListableBeanFactory -> {log.debug("执行processor1");};}}

运行后发现，未打印出依赖注入时打印的信息。这是为什么呢？

Java 配置类不包含 BeanFactoryPostProcessor 的情况

ApplicationContext BeanFactoryPostProcessor BeanPostProcessor Java配置类 1. 执行 BeanFactoryPostProcessor 2. 注册 BeanPostProcessor 3. 创建和初始化 3.1 依赖注入扩展(如 @Value 和 @Autowired) 3.2 初始化扩展(如 @PostConstruct) 3.3 执行 Aware 及 InitializingBean 3.4 创建成功 ApplicationContext BeanFactoryPostProcessor BeanPostProcessor Java配置类

Java 配置类包含 BeanFactoryPostProcessor 的情况，因为要创建其中的 BeanFactoryPostProcessor 必须提前创建 Java 配置类，而此时的 BeanPostProcessor 还未准备好，导致 @Autowired 等注解失效

ApplicationContext BeanFactoryPostProcessor BeanPostProcessor Java配置类 3. 创建和初始化 3.1 执行 Aware 及 InitializingBean 3.2 创建成功 1. 执行 BeanFactoryPostProcessor 2. 注册 BeanPostProcessor ApplicationContext BeanFactoryPostProcessor BeanPostProcessor Java配置类

对应代码

@Configuration
public class MyConfig1 {private static final Logger log = LoggerFactory.getLogger(MyConfig1.class);@Autowiredpublic void setApplicationContext(ApplicationContext applicationContext) {log.debug("注入 ApplicationContext");}@PostConstructpublic void init() {log.debug("初始化");}@Bean // 注释或添加 beanFactory 后处理器对应上方两种情况public BeanFactoryPostProcessor processor1() {return beanFactory -> {log.debug("执行 processor1");};}}

解决方法：

  • 用内置依赖注入和初始化取代扩展依赖注入和初始化，也就是我们前面说的Aware接口
  • 用静态工厂方法代替实例工厂方法，避免工厂对象提前被创建

这篇关于【Spring高级】Aware与InitializingBean接口的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/805559。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
在cscode中通过maven创建java项目

在cscode中通过maven创建java项目

在cscode中创建java项目 可以通过博客完成maven的导入 建立maven项目 使用快捷键 Ctrl + Shift + P 建立一个 Maven 项目 1 Ctrl + Shift + P 打开输入框2 输入 "> java create"3 选择 maven4 选择 No Archetype5 输入 域名6 输入项目名称7 建立一个文件目录存放项目，文件名一般为项目名8 确定
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2