springboot(24)@ConfigurationProperties 与 @Value

2024-03-07 00:48

本文主要是介绍springboot(24)@ConfigurationProperties 与 @Value,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

转载自简书本文链接地址: Spring Boot @ConfigurationProperties 与 @Value

@ConfigurationProperties@Value都是 Spring 提供的用于从配置文件注入配置信息的方式。很显然,@Value比较适用于配置比较少的场景,而@ConfigurationProperties则更适用于有很多配置的情况。之前写项目的时候从来都没有使用过@ConfigurationProperties几乎每次都是使用@Value。这次遇到了一个比较适合它的场景,在使用的时候还真遇到了一些令人讨厌的小问题,导致开发速度受到了一定的影响。这里记录下来他们之间的使用方式和可能出现的坑,加深一下印象。

注意,我们这里使用application.yml而不是application.properties不过他们基本是可以相互替代的。

Demo for @Value

sso:clientId: clientIdclientSecret: clientSecret
@Component
@Data
public class ValueConfiguration {private String clientId;private String clientSecret;@Autowired //此处必须加Autowired注解public ValueConfiguration(@Value("${sso.clientId}") String clientId,@Value("${sso.clientSecret}") String clientSecret) {this.clientId = clientId;this.clientSecret = clientSecret;}
}

可以看到@Value是使用非常的简单,只要将注解添加在参数前即可。

Demo for @ConfigurationProperties

在有大量参数的时候,一个个添加@Value就显得麻烦了一点,Spring 提供了另一种方式。

@SpringBootApplication
@EnableConfigurationProperties // 1
public class DemoForSpringBootConfigurationApplication {public static void main(String[] args) {SpringApplication.run(DemoForSpringBootConfigurationApplication.class, args);}@BeanCommandLineRunner run(ValueConfiguration valueConfiguration) {return args -> {System.out.println(valueConfiguration.toString());};}@BeanCommandLineRunner config(PropertiesConfiguration configuration) {return args -> {System.out.println(configuration);};}
}@Component
@ConfigurationProperties(prefix = "oauth") // 2
@Getter
@Setter  // 3
@ToString
public class PropertiesConfiguration {private String clientId;private String clientSecret;private String redirectUri;private String grantType;
}
sso:clientId: clientIdclientSecret: clientSecretoauth:client_id: id                           // 4client-secret: secretredirect_uri: http://aisensiy.github.iograntType: code
  1. 为了使用@ConfigurationProperties需要在spring boot application上添加EnableConfigurationProperties 的注解,这里遇到的第一个坑
  2. @ConfigurationProperties可以添加前缀,然后其属性就会按照变量的名称默认在 application.* 中寻找指定的变量。这里就是去寻找oauth.clientId这样的配置。如果想要从其他配置文件获取配置内容,可以添加一个额外的注释@PropertySource("classpath:xxx.yml")
  3. 这里的@Setter是来自lombok的注解,它可以自动的帮助添加默认的属性的setter方法。注意,这里的setter方法是必须的,如果没有setter方法,是无法成功获取配置的,这也是我在使用它的时候遇到的又一个坑
  4. @ConfigurationProperties@Value的一个重大区别在于它采用比较灵活的方式寻找配置。可以看到这里的配置可以是驼峰形式,也可以是下划线分割的,还可以是中横线分割的

添加参数验证

@ConfigurationProperties是可以和validation注解一起使用的,这样的好处显而易见:对于一些配置是必须的或者是对格式有要求的,在运行开始的时候就能检测到这些问题可以避免上线之后因为配置不符合有找不到头绪而导致的debug的痛苦过程。

@Component
@Getter
@Setter
@ToString
@ConfigurationProperties(prefix = "oauth")
public class PropertiesConfiguration {@NotBlankprivate String clientId;@NotBlankprivate String clientSecret;@URLprivate String redirectUri;@NotBlankprivate String grantType;
}

直接在成员变量上添加注解就可以了,非常的简单。然后可以去尝试添加一些非法的配置试试效果。

这篇关于springboot(24)@ConfigurationProperties 与 @Value的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/781914

相关文章

JVM 的类初始化机制

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

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

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

浅析Spring Security认证过程

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

Spring Security--Architecture Overview

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

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

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

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

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

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智听未来一站式有声阅读平台听书系统小程序源码

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

在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 确定