【小家Spring】Spring中@Value注解有多强大?从原理层面去剖析为何它有如此大的“能耐“(下)

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 【小家Spring】Spring中@Value注解有多强大?从原理层面去剖析为何它有如此大的“能耐“(下)

自定义扩展@Value的功能


既然了解了一项技术的工作原理,那么接下里就是定制化、自己扩展自己玩了。


备注:由于本人今日身体欠佳,甚是乏累。并且我个人认为如果你对这个基本原理了解了之后,并且还对SpEL中的PropertyAccessor决策原理了解后,自己扩展@Value注解的功能并不是难事,so,I am 准备go sleep去了~


提示:因为Spring上下文默认是这么注册的beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));,所以我们的思路应该是替换掉它~


@Value中使用${}读取不存在的key时,不报错而是原样输出的问题


这个问题我觉得也是比较重要的。

如题,我们通用的一个观念是这样的:若使用@Value("${app.full2}")给字段赋值,若key不存在启动应该报错:

Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'app.full2' in value "${app.full2}"
  at org.springframework.util.PropertyPlaceholderHelper.parseStringValue(PropertyPlaceholderHelper.java:174)
  at org.springframework.util.PropertyPlaceholderHelper.replacePlaceholders(PropertyPlaceholderHelper.java:126)
  at org.springframework.core.env.AbstractPropertyResolver.doResolvePlaceholders(AbstractPropertyResolver.java:236)
  at org.springframework.core.env.AbstractPropertyResolver.resolveRequiredPlaceholders(AbstractPropertyResolver.java:210)
  at org.springframework.context.support.PropertySourcesPlaceholderConfigurer$2.resolveStringValue(PropertySourcesPlaceholderConfigurer.java:172)


这样才符合我们预期。但是我今天自己在单元测试的时候发现我误打误撞写了一个不存在的key,但是,但是启动并没有报错,而且给我原样输出了。

这个现象引发了我的兴趣,必须调查清楚啊~~~


我们上面(包括推荐博文)已经花了长篇大论知道了,解析占位符这款发生在:DefaultListableBeanFactory#resolveDependency中,里面有一句代码是:


  @Override
  public String resolveEmbeddedValue(String value) {
    if (value == null) {
      return null;
    }
    String result = value;
    for (StringValueResolver resolver : this.embeddedValueResolvers) {
      result = resolver.resolveStringValue(result);
      if (result == null) {
        return null;
      }
    }
    return result;
  }


同样的代码不同的现象,问题就出现在这里resolver.resolveStringValue(result)。这里总结一下

AbstractBeanFactory设置处理器的地方有两个:

第一处:

public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext, DisposableBean {
  protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
    ...
    // 若没有指定EmbeddedValueResolver, 这里就用个匿名函数实现  做个保底嘛~~~
    if (!beanFactory.hasEmbeddedValueResolver()) {
      beanFactory.addEmbeddedValueResolver(new StringValueResolver() {
        @Override
        public String resolveStringValue(String strVal) {
          return getEnvironment().resolvePlaceholders(strVal);
        }
      });
    }
    ...
  }
}


第二处:


//@since 3.1
public abstract class PlaceholderConfigurerSupport extends PropertyResourceConfigurer implements BeanNameAware, BeanFactoryAware {
  protected void doProcessProperties(ConfigurableListableBeanFactory beanFactoryToProcess, StringValueResolver valueResolver) {
    ...
    // Spring3.0后  加载完配置文件后,会把这个处理器放进Bean工厂里面去。
    // New in Spring 3.0: resolve placeholders in embedded values such as annotation attributes.
    beanFactoryToProcess.addEmbeddedValueResolver(valueResolver);
  }
}


它有两个子类:PropertyPlaceholderConfigurer,它的StringValueResolver实现为一个内部类实现的。

另一个子类PropertySourcesPlaceholderConfigurer,它的实现StringValueResolver为一个lambda表达式。

他俩有个共同点:最终的解析都依赖于PropertyPlaceholderHelper并且,并且ignoreUnresolvablePlaceholders属性均为默认的fasle。


所以得出结论:若你手动配置过上面两个PlaceholderConfigurerSupport子类Bean,并且没有改变过ignoreUnresolvablePlaceholders这个值,那你最终会使用它们去解析${}占位符,从而如果找不到key就启动报错了。

但是若你没有手动配置过,那将最终交给AbstractBeanFactory的那个内部类处理,也就是这句话:return getEnvironment().resolvePlaceholders(strVal);而它最终解析如下:

public abstract class AbstractEnvironment implements ConfigurableEnvironment {
  // 两个接口方法。显然AbstractBeanFactory默认实现为这个方法,而并非Required的~~~
  @Override
  public String resolvePlaceholders(String text) {
    return this.propertyResolver.resolvePlaceholders(text);
  }
  @Override
  public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
    return this.propertyResolver.resolveRequiredPlaceholders(text);
  }
}
public abstract class AbstractPropertyResolver implements ConfigurablePropertyResolver {
  // 调用的resolvePlaceholders这个方法,所以默认情况下  即使key不存在  也是没关系的
  @Override
  public String resolvePlaceholders(String text) {
    if (this.nonStrictHelper == null) {
      this.nonStrictHelper = createPlaceholderHelper(true);
    }
    return doResolvePlaceholders(text, this.nonStrictHelper);
  }
  @Override
  public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
    if (this.strictHelper == null) {
      this.strictHelper = createPlaceholderHelper(false);
    }
    return doResolvePlaceholders(text, this.strictHelper);
  }
}


如上,就能解释了为何有时候你使用@Value找不到key就启动报错,有时候却原样输出呢? 这就是其根本原因喽~

备注:此处都只指的纯Spring环境,而非Boot环境~~~

关于SpringBoot环境下,默认情况下都是key必须存在的,否则启动报错。原因如下:

@Configuration
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
public class PropertyPlaceholderAutoConfiguration {
  @Bean
  @ConditionalOnMissingBean(search = SearchStrategy.CURRENT)
  public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer() {
    return new PropertySourcesPlaceholderConfigurer();
  }
}


而在spring.factories文件里配置有它:


org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration


总之:使用@Value注入时请保证key是存在的,否则建议请使用defaultValue语法处理


总结


相信我们都有一个直观感受:@Value注解非常之简单,但功能非常之强大。

同时Spring的知识点都非常具有层次性,正所谓下层基础决定了你的上层建筑。Spring能够这么高的扩展性,得益于它根基的牢固。


本文@Value的能力,绝大部分其实都是SpEL的能力。换句话说:你对SpEL有多了解,决定了你对@Value注解的使用有多了解


Spring工程非常优秀和快速流行的原因之一也是因为如此:屏蔽了巨多复杂实现,并且对developer提供简单易用的API,从而上手非常之容易(潜台词:精通非常的难)


相关文章
|
2月前
|
Java 开发者 Spring
【SpringBoot 异步魔法】@Async 注解:揭秘 SpringBoot 中异步方法的终极奥秘!
【8月更文挑战第25天】异步编程对于提升软件应用的性能至关重要,尤其是在高并发环境下。Spring Boot 通过 `@Async` 注解简化了异步方法的实现。本文详细介绍了 `@Async` 的基本用法及配置步骤,并提供了示例代码展示如何在 Spring Boot 项目中创建与管理异步任务,包括自定义线程池、使用 `CompletableFuture` 处理结果及异常情况,帮助开发者更好地理解和运用这一关键特性。
125 1
|
2月前
|
XML Java 测试技术
Spring5入门到实战------17、Spring5新功能 --Nullable注解和函数式注册对象。整合JUnit5单元测试框架
这篇文章介绍了Spring5框架的三个新特性:支持@Nullable注解以明确方法返回、参数和属性值可以为空;引入函数式风格的GenericApplicationContext进行对象注册和管理;以及如何整合JUnit5进行单元测试,同时讨论了JUnit4与JUnit5的整合方法,并提出了关于配置文件加载的疑问。
Spring5入门到实战------17、Spring5新功能 --Nullable注解和函数式注册对象。整合JUnit5单元测试框架
|
2月前
|
缓存 Java 数据库连接
Spring Boot奇迹时刻:@PostConstruct注解如何成为应用初始化的关键先生?
【8月更文挑战第29天】作为一名Java开发工程师,我一直对Spring Boot的便捷性和灵活性着迷。本文将深入探讨@PostConstruct注解在Spring Boot中的应用场景,展示其在资源加载、数据初始化及第三方库初始化等方面的作用。
53 0
|
8天前
|
Java Spring 容器
Spring使用异步注解@Async正确姿势
Spring使用异步注解@Async正确姿势,异步任务,spring boot
|
7天前
|
XML Java 数据格式
spring复习03,注解配置管理bean
Spring框架中使用注解配置管理bean的方法,包括常用注解的标识组件、扫描组件、基于注解的自动装配以及使用注解后的注意事项,并提供了一个基于注解自动装配的完整示例。
spring复习03,注解配置管理bean
|
8天前
|
XML 前端开发 Java
控制spring框架注解介绍
控制spring框架注解介绍
|
21天前
|
Java 数据库连接 数据格式
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
IOC/DI配置管理DruidDataSource和properties、核心容器的创建、获取bean的方式、spring注解开发、注解开发管理第三方bean、Spring整合Mybatis和Junit
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
|
2月前
|
Java 数据安全/隐私保护 Spring
揭秘Spring Boot自定义注解的魔法:三个实用场景让你的代码更加优雅高效
揭秘Spring Boot自定义注解的魔法:三个实用场景让你的代码更加优雅高效
|
2月前
|
XML Java 数据库
Spring5入门到实战------15、事务操作---概念--场景---声明式事务管理---事务参数--注解方式---xml方式
这篇文章是Spring5框架的实战教程,详细介绍了事务的概念、ACID特性、事务操作的场景,并通过实际的银行转账示例,演示了Spring框架中声明式事务管理的实现,包括使用注解和XML配置两种方式,以及如何配置事务参数来控制事务的行为。
Spring5入门到实战------15、事务操作---概念--场景---声明式事务管理---事务参数--注解方式---xml方式
|
2月前
|
监控 安全 Java
【开发者必备】Spring Boot中自定义注解与处理器的神奇魔力:一键解锁代码新高度!
【8月更文挑战第29天】本文介绍如何在Spring Boot中利用自定义注解与处理器增强应用功能。通过定义如`@CustomProcessor`注解并结合`BeanPostProcessor`实现特定逻辑处理,如业务逻辑封装、配置管理及元数据分析等,从而提升代码整洁度与可维护性。文章详细展示了从注解定义、处理器编写到实际应用的具体步骤,并提供了实战案例,帮助开发者更好地理解和运用这一强大特性,以实现代码的高效组织与优化。
56 0
下一篇
无影云桌面