SpringBoot学习笔记5-SpringBoot的外化配置

2024-01-15 23:50
文章标签 java 配置 学习 springboot 笔记 spring 外化

本文主要是介绍SpringBoot学习笔记5-SpringBoot的外化配置，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

前言

以spring官方文档为基础，官方地址：Spring Boot
目前官方正式版本最新为：2.5.6（这个学习笔记系列基本是以翻译为主，不用浪费时间期望获取更多。更多是给自己看官方文档做的的一个笔记）
当前篇的内容：介绍官方文档2.5.6的第七章之SpringApplication特性_外化配置

SpringBoot允许配置外部化，即允许使用各种外部配置源，包括Java 属性文件、YAML 文件、环境变量和命令行参数等。
官方建议整个项目最好使用同一种配置格式，且当同一位置同时具有.properties和.yml格式，.properties则优先。

1. 配置项/文件的优先级

但是当多种配置源同时存在时，存在优先级。以下优先级由低到高，低的会被高的覆盖：

  1. 默认属性(通过 SpringApplication.setDefaultProperties 指定)
  2. @Configuration类上的@PropertySource注解。需要注意，在ApplicationContext刷新之前，是不会将这个类中的属性加到环境中的，像 logging.,spring.main. 之类的属性，在这里配置为时已晚。
  3. 打包在应用程序内的application.properties或者appliaction.yml文件
  4. 应用程序以外的application.properties或者appliaction.yml文件
  5. 打包在应用程序内的application-{profile}.properties或者application-{profile}.yml文件
  6. 应用程序以外的application-{profile}.properties或者application-{profile}.yml文件
  7. 仅具有 random.* 属性的 RandomValuePropertySource
  8. 操作系统环境变量
  9. JVM系统属性 System.getProperties()
  10. java:comp/env 里的JNDI属性
  11. ServletContext 初始化参数
  12. ServletConfig 初始化参数
  13. SPRING_APPLICATION_JSON 中的属性(环境变量或系统属性中的内联JSON嵌入)
  14. 命令行参数
  15. 测试中的@SpringBootTest#properties注解特性
  16. 测试中的@TestPropertySource注解
  17. devtool处于active状态时， $HOME/.config/spring-boot 目录中的Devtool全局配置

配置文件按照以下顺序（由低到高）：

  1. 打包在 jar 中的应用程序属性（application.properties和 YAML 变体）
  2. 打包在 jar 中的特定于配置文件的应用程序属性（application-{profile}.properties和 YAML 变体）
  3. 打包 jar 之外的应用程序属性（application.properties和 YAML 变体）
  4. 打包在 jar之外的特定于配置文件的应用程序属性（application-{profile}.properties和 YAML 变体）

比如，当前指定了profile属性（–spring.profiles.active={profile}），那么相同位置的 application-{profile}.properties优先级大于application.properties的（yaml同样）。

举例来说，假设我们当前执行 java -jar demo.jar –spring.profiles.active=dev，此时application.properties和application-dev.properties文件如下：
application.properties

app.name=MyApp
server.port=8080

application-dev.properties

server.port=8081

那么最终 的server.port 的值为8081，而app.name不会变，被覆盖只有server.port。

​2. 属性文件的加载

Spring查找/加载属性文件的顺序如下：

  • classpath:/
  • classpath:/config
  • 当前目录
  • 当前目录的“/config”子目录

优先级越来越高，即classpath和当前目录同时存在，那么classpath会被当前目录覆盖。

如果不喜欢application作为配置文件名，你可以通过指定一个spring.config.name环境属性来切换到另一个文件名。

3. 在属性文件中配置随机值

SpringBoot支持在配置文件中配置随机值，主要是靠RandomValuePropertySource的支持。它可以支持生成int,long,uuid或者字符串。
使用格式为：

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number-less-than-ten=${random.int(10)}
my.number-in-range=${random.int[1024,65536]}

RandomValuePropertySource截图如下：
在这里插入图片描述

4. 使用Profile区分配置环境

通常情况下，我们开发的应用程序需要部署到不同的环境下，属性的配置自然也需要不同。如果每次在发布的时候替换配置文件，过于麻烦。SpringBoot的多环境配置为此提供了便利。具体做法如下：

我们之前在介绍各种配置的优先级的时候说过， application-{profile}.properties或者application-{profile}.yml文件 的优先级高于 application.properties或application.yml 配置，这里的profile就是我们定义的环境标识：

我们在resource目录下创建三个文件：
application.properties：默认的配置，default。
application-dev.properties：开发环境，dev。
application-prod.properties：生产环境，prod。
我们可以通过指定 spring.profiles.active 属性来激活对应的配置环境：

spring.profiles.active=dev

或使用命令行参数的配置形式：

$ java -jar hyh.jar --spring.profiles.active=dev

如果没有profile指定的文件于profile指定的文件的配置属性同时定义，那么指定profile的配置优先。

除了区分配置环境，还可以区分日志打印/Java代码的执行环境。

Java类中@Profile注解。下面2个不同的类实现了同一个接口，@Profile注解指定了具体环境。

// 接口定义
public interface SendMessage {// 发送短信方法定义public void send();}

// Dev 环境实现类
@Component
@Profile("dev")
public class DevSendMessage implements SendMessage {@Overridepublic void send() {System.out.println(">>>>>>>>Dev Send()<<<<<<<<");}}

// Stg环境实现类
@Component
@Profile("stg")
public class StgSendMessage implements SendMessage {@Overridepublic void send() {System.out.println(">>>>>>>>Stg Send()<<<<<<<<");}}

// 启动类
@SpringBootApplication
public class ProfiledemoApplication {@Value("${app.name}")private String name;@Autowiredprivate SendMessage sendMessage;@PostConstructpublic void init(){sendMessage.send();// 会根据profile指定的环境实例化对应的类}}

logback-spring.xml也支持有节点来支持区分

<?xml version="1.0" encoding="UTF-8"?>
<configuration><include resource="org/springframework/boot/logging/logback/base.xml" /><logger name="org.springframework.web" level="INFO"/><springProfile name="default"><logger name="org.springboot.sample" level="TRACE" /></springProfile><springProfile name="dev"><logger name="org.springboot.sample" level="DEBUG" /></springProfile><springProfile name="staging"><logger name="org.springboot.sample" level="INFO" /></springProfile></configuration>

参考文章：

  1. Spring Boot 配置优先级顺序
  2. LOOK ! SpringBoot的外部化配置最全解析
  3. SpringBoot_2.5.6官方文档

这篇关于SpringBoot学习笔记5-SpringBoot的外化配置的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


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

相关文章

HarmonyOS学习(七)——UI（五）常用布局总结

HarmonyOS学习(七)——UI（五）常用布局总结

自适应布局 1.1、线性布局（LinearLayout） 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列，Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距，达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式，且在各类尺寸屏幕上表现一致，其中交叉轴为垂直时，取值为Vert
阅读更多...
Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya-AI分享的他在OpenAI学习到的15个提示工程技巧

Ilya（不是本人，claude AI）在社交媒体上分享了他在OpenAI学习到的15个Prompt撰写技巧。 以下是详细的内容： 提示精确化:在编写提示时,力求表达清晰准确。清楚地阐述任务需求和概念定义至关重要。例:不用"分析文本",而用"判断这段话的情感倾向:积极、消极还是中性"。 快速迭代:善于快速连续调整提示。熟练的提示工程师能够灵活地进行多轮优化。例:从"总结文章"到"用
阅读更多...
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 声明式事物
阅读更多...
Zookeeper安装和配置说明

Zookeeper安装和配置说明

一、Zookeeper的搭建方式 Zookeeper安装方式有三种，单机模式和集群模式以及伪集群模式。 ■ 单机模式：Zookeeper只运行在一台服务器上，适合测试环境； ■ 伪集群模式：就是在一台物理机上运行多个Zookeeper 实例； ■ 集群模式：Zookeeper运行于一个集群上，适合生产环境，这个计算机集群被称为一个“集合体”（ensemble） Zookeeper通过复制来实现
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2