Spring Boot 配置文件

news2025/1/15 6:43:45

Spring Boot 配置文件

  • 一、配置文件作用
  • 二、配置文件的格式
  • 三、properties 配置文件说明
    • 3.1 properties 基本语法
    • 3.2 读取配置文件
    • 3.3 properties 优缺点分析
  • 四、yml 配置文件说明
    • 4.1 yml 优点分析
    • 4.2 yml 基本语法
    • 4.3 yml 基本配置读取
    • 4.4 配置对象与读取
    • 4.5 配置集合与读取
  • 五、设置不同环境的配置文件
    • 5.1 创建不同环境的配置文件
    • 5.2 在 application.yml 中设置运行环境
  • 附录
    • 1）Spring Boot 读取配置文件的 N 种方法
    • 2）更多系统配置项

一、配置文件作用

整个项目中所有重要的数据都是在配置文件中配置的，例如：

  • 数据库的连接信息（包含⽤户名和密码的设置）；
  • 项⽬的启动端⼝；
  • 第三⽅系统的调⽤秘钥等信息；
  • ⽤于发现和定位问题的普通⽇志和异常⽇志等。

想象⼀下如果没有配置信息，那么 Spring Boot 项⽬就不能连接和操作数据库，甚⾄是不能保存可以⽤于排查问题的关键⽇志。所以配置⽂件是⾮常重要的。

二、配置文件的格式

Spring Boot 配置⽂件主要分为以下两种格式：

  • .properties
  • .yml

如下图所示：
在这里插入图片描述

properties 类型的配置⽂件属于老款式 (创建 Spring Boot 项⽬默认的配置⽂件格式)；而 yml 属于新款式 ~~

配置文件内容：

  1. Spring Boot (Spring) 内置的配置项，例如 server.port
  2. 用户自定义的配置项 (要符合格式)

约定大于配置：

  • 配置文件都必须以 “application” 起始。
  • properties 是创建 Spring Boot 项⽬默认的配置⽂件格式。
  • 理论上讲 properties 可以和 yml ⼀起存在于⼀个项⽬当中，当 properties 和 yml ⼀起存在⼀个项⽬中时，如果配置⽂件中出现了同样的配置，例如 properties 和 yml 中都配置了“server.port”，那么这个时候会以 properties 中的配置为主，也就是 .properties 配置文件的优先级更高，但加载完 .properties 文件之后，也会加载 .yml 文件的配置信息。
  • 虽然理论上来讲 .properties 可以和 .yml 共存，但在实际的业务中，我们通常会采取一种统一的配置文件格式，这样可以更好地维护（降低故障率）。

三、properties 配置文件说明

properties 配置⽂件是最早期的配置⽂件格式，也是创建 Spring Boot 项⽬默认的配置⽂件。

3.1 properties 基本语法

properties 是以键值对的形式配置的，key 和 value 之间是以“=”连接的，如：

# 配置项⽬端⼝号
server.port=8084
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root

配置⽂件中使⽤ “#” 添加注释。

3.2 读取配置文件

在项⽬中想要主动读取配置⽂件中的内容，可以使⽤ @Value 注解来实现。

@Value 注解使⽤ “ ${} ” 的格式读取！否则只是把字符串赋值给了变量。

server.port=9090

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Value("${server.port}")
    private int port;

    @RequestMapping("/hi")
    public String postConstruct() {
        return "Hi," + port;
    }
}

启动后，通过 http://localhost:9090/hi 访问：
在这里插入图片描述
成功打印出来了配置信息。

无论是内置的还是自定义的配置信息都可以这样打印出 ~~

3.3 properties 优缺点分析

properties 是以 key-value 的形式配置的，如下图所示：
在这里插入图片描述

优点：
写法简单，不易出错：等号前面是 key 值，等号后面是 value 值。

缺点：
properties 配置文件中可能会有很多的冗余信息，比如这些：
在这里插入图片描述

可以使用 yml 配置文件的格式化来解决这个问题 ~

四、yml 配置文件说明

yml 是 YAML 的缩写。全称为 Yet Another Markup Language，翻译成中文就是“另⼀种标记语⾔”。

创建配置文件为 application.yaml 效果一模一样！

4.1 yml 优点分析

  • yml 是⼀个可读性⾼，写法简单、易于理解，它的语法和 JSON 语⾔类似。
  • yml ⽀持更多的数据类型，它可以简单表达清单（数组）、散列表，标量等数据形态。它使⽤空⽩符号缩进和⼤量依赖外观的特⾊，特别适合⽤来表达或编辑数据结构、各种配置⽂件等。
  • yml ⽀持更多的编程语⾔，它不⽌是 Java 中可以使⽤在 Golang、PHP、Python、Ruby、JavaScript、Perl 中。

4.2 yml 基本语法

yml 是树形结构的配置文件，基础语法为“key: value”，注意 key 和 value 之间是 英文冒号加空格，其中的空格不可省略！

  • 一级目录：
    在这里插入图片描述
    第⼀项配置为正确的，key 也是高亮显示的；第⼆项没有空格为错误的使用，key 也没有高亮显示。

  • 多级目录：(使用 yml 连接数据库)
    在这里插入图片描述
    与 properties 的格式相比简化很多。

yml 配置不同数据类型及 null：
在这里插入图片描述

4.3 yml 基本配置读取

针对简单数据类型， yml 读取配置的方式和 properties 相同，使用 @Value 注解即可。

注意事项：value 值加单双引号
字符串默认不⽤加单引号 / 双引号，如果加 英文单双引号 可以表示特殊的含义。在这里插入图片描述

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Value("${mykey.str1}")
    private String str1;

    @Value("${mykey.str1}")
    private String str2;

    @Value("${mykey.str1}")
    private String str3;

    @RequestMapping("/hi")
    public void postConstruct() {
        System.out.println("str1:"+str1);
        System.out.println();
        System.out.println("str2:"+str2);
        System.out.println();
        System.out.println("str3:"+str3);
    }
}

启动后，通过 http://localhost:8080/hi 访问，这时控制台：
在这里插入图片描述

得出结论：

  • 字符串默认不⽤加上单引号 / 双引号。
  • 单引号会转义特殊字符，特殊字符最终只是⼀个普通的字符串数据。
  • 双引号不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思。

在这里插入图片描述

有时候设置完配置并没有生效，可能是缓存导致的。解决方案：
删除项目中的 target 文件夹，然后重新运行程序 (target 会重新生成)！

4.4 配置对象与读取

前面提到 yml ⽀持更多的数据类型。
我们还可以在 yml 中配置对象，如下配置：

student:
  id: 1
  name: Java
  age: 18

或者是使用行内写法 (与上面的写法作用一致)：

student: {id: 1,name: Java,age: 18}

这个时候就不能⽤ @Value 来读取配置中的对象了，此时要使⽤另⼀个注解 @ConfigurationProperties 来读取，具体实现如下：

package com.example.demo.model;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "student") // 将配置文件中的 student 配置赋值给当前的对象
public class Student {
    private int id;
    private String name;
    private int age;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

package com.example.demo;

import com.example.demo.model.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Autowired
    private Student student;

    @RequestMapping("/hi")
    public String postConstruct() {
        return "Hi," + student.getName() + " | age: " + student.getAge();
    }
}

启动后，通过 http://localhost:8080/hi 访问，结果：
在这里插入图片描述
成功读取到了！

约定大于配置：(注意事项)

  • 配置对象的属性(字段)赋值是通过 setter 方法实现的。所以 setter 方法不能忽略，否则启动就会报错！
  • @Component (五大类注解) 不能没有。既然要用，就要先放入 Spring 中。

4.5 配置集合与读取

配置⽂件也可以配置 List 集合，如下所示：

mylist:
  dbtype:
    - mysql
    - sqlserver
    - db2

或者是使⽤⾏内写法（与上⾯的写法作⽤⼀致）：

mylist: {dbtype: [mysql,sqlserver,db2]}

集合的读取和对象⼀样，也是使⽤ @ConfigurationProperties 来读取的，具体实现如下：

package com.example.demo.model;

import lombok.Data;
import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.List;

@Setter
@Getter
@ConfigurationProperties(prefix = "mylist")
@Component
public class MyList {
    private List dbtype;
}


package com.example.demo;

import com.example.demo.model.MyList;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    @Autowired
    private MyList myList;

    @RequestMapping("/hi")
    public String postConstruct() {
        return "Hi,"+ myList.getDbtype().size()+" | get(0):"+myList.getDbtype().get(0);
    }
}

通过 http://localhost:8080/hi 访问：
在这里插入图片描述
成功读取到了！

约定大于配置：(注意事项)

  • 配置集合名 与 类属性名…等 一定要对应准确，一字不差！
  • 配置集合的赋值同样是通过 setter 方法实现的。
  • 不需要设置List泛型；若设置了一定要对应。

五、设置不同环境的配置文件

5.1 创建不同环境的配置文件

在这里插入图片描述

环境是很多的，这里只是举这三个为例 ~~

除了主配置文件 application.yml，创建 application-dev.yml (开发环境)；application-test.yml (测试环境)；application-prod.yml (生产环境) 的配置文件。

application- 这个格式不能变！

5.2 在 application.yml 中设置运行环境

在 application.yml 中设置运行环境：

spring:
  profiles:
    active: dev # test / prod

设置为 dev 的话，此时配置信息就是 application.yml 和 application-dev.yml 的配置信息 ~~

某级目录重复的话，必须要合并在一起！

附录

1）Spring Boot 读取配置文件的 N 种方法

https://juejin.cn/post/7132641888166739982

2）更多系统配置项

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/156217.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

时序预测 | Python实现XGBoost极限梯度提升树股票价格预测

时序预测 | Python实现XGBoost极限梯度提升树股票价格预测

时序预测 | Python实现XGBoost极限梯度提升树股票价格预测 目录 时序预测 | Python实现XGBoost极限梯度提升树股票价格预测预测效果基本描述环境配置模型描述程序设计参考资料预测效果 基本描述 Python实现XGBoost极限梯度提升树股票价格预测 环境配置 XGboost (0.7) numpy (1.…
阅读更多...
负载均衡器Ribbon原理及实战演练

负载均衡器Ribbon原理及实战演练

目录 一、负载均衡原理 二、Ribbon 原理及使用 三、Loadbalancer 原理及使用 负载均衡器Ribbon在微服务领域是很常用的服务调用、负载均衡的中间件,其面包含Loadbalancer专门负载负载均衡；比如Eureka、Fegin,Nacos的注册中心jar包里面均包含Ribbon相关的jar,如图…
阅读更多...
python实战案例：采集某漫客《网游之近战法师》所有章节

python实战案例：采集某漫客《网游之近战法师》所有章节

前言 嗨喽~大家好呀，这里是魔王呐 ❤ ~! 环境使用: Python 3.8 Pycharm 模块使用: requests >>> pip install requests 数据请求模块 parsel >>> pip install parsel 数据解析模块 如果安装python第三方模块: win R 输入 cmd 点击确定, 输…
阅读更多...
C++学习之旅 第五章(字符应用:小写字母转大写字母)

C++学习之旅 第五章(字符应用:小写字母转大写字母)

开头： 上一节我们讲了关于char类型许多知识，今天我们来更深层的学习一下字符实际上面的应用！ ASCII码简介： 我们要进行字符的应用，首先就是要了解一下ACSII码: ASCII(全名：American Standard Code for Inf…
阅读更多...
win10如何安装多个jdk并实时进行切换【建议收藏】

win10如何安装多个jdk并实时进行切换【建议收藏】

在windows10的系统中，如何安装jdk或者安装多个jdk版本，博主在这里整理了一份非常完美的jdk版本安装教程，且jdk版本可以随时切换，切换过程不超过10秒，让你在jdk版本中穿梭自如，直接可以食用，掌握…
阅读更多...
【前端】ES6

【前端】ES6

let 和 const 类似var定义变量&#xff0c;但是let修饰的变量仅在声明的代码块中有效&#xff1b; var声明的变量&#xff0c;在全局有效 for (let i 0; i < 3; i) {let i abc;console.log(i); }js中的for循环声明循环变量的部分也作为一个父作用域&#xff0c;即(let i…
阅读更多...
虹科方案|数据中心虚拟化和 HK-ATTO 产品—旨在协同工作的端到端解决方案

虹科方案|数据中心虚拟化和 HK-ATTO 产品—旨在协同工作的端到端解决方案

一、概述虚拟化技术正迅速成为现代数据中心的基础&#xff0c;因为IT 管理寻求显着提 高资源和运营效率以及对业务需求的响应能力。三个关键技术非常重要&#xff1a;服务器虚拟化、结构虚拟化和存储虚拟化。 本次介绍了 HK-ATTO 产品如何作为这些虚拟化解决方案中 每一个的关键…
阅读更多...
【图像处理OpenCV(C++版)】——4.1 对比度增强之灰度直方图

【图像处理OpenCV(C++版)】——4.1 对比度增强之灰度直方图

前言&#xff1a; &#x1f60a;&#x1f60a;&#x1f60a;欢迎来到本博客&#x1f60a;&#x1f60a;&#x1f60a; &#x1f31f;&#x1f31f;&#x1f31f; 本专栏主要结合OpenCV和C来实现一些基本的图像处理算法并详细解释各参数含义&#xff0c;适用于平时学习、工作快…
阅读更多...
声纹识别与声源定位（二）

声纹识别与声源定位（二）

一、引言 什么是声源定位(Sound Source Localization&#xff0c;SSL)技术&#xff1f;声源定位技术是指利用多个麦克风在环境不同位置点对声信号进行测量&#xff0c;由于声信号到达各麦克风的时间有不同程度的延迟&#xff0c;利用算法对测量到的声信号进行处理&#xff0c;由…
阅读更多...
【瑞萨RA4系列】使用TinyMaix识别手写数字

【瑞萨RA4系列】使用TinyMaix识别手写数字

文章目录一、TinyMaix简介1.1 TinyMaix开源项目1.2 下载TinyMaix源码二、TinyMaix移植2.1 创建TinyMaix移植项目2.2 添加TinyMaix源码三、TinyMaix测试准备3.1 SysTick计时3.2 printf打印3.4 修改tm_port.h文件3.6 增大堆内存空间四、手写数字识别4.1 添加示例源码4.2 运行示例…
阅读更多...
突破6.8关口 人民币汇率快速升值，释放什么信号？

突破6.8关口 人民币汇率快速升值，释放什么信号？

近期以来&#xff0c;人民币表现强劲。2023年开年6个交易日&#xff0c;人民币对美元汇率中间价实现“六连涨”&#xff0c;累计上调2035个基点&#xff0c;升破6.8关口&#xff0c;展现出全新面貌。哪些因素影响近期人民币对美元汇率上涨&#xff1f;人民币兑美元汇率未来走势…
阅读更多...
漏洞复现--xss

漏洞复现--xss

目录 一、实验目的 二、实验环境 三、 实验过程 搭建XSS平台 制作XSS脚本并注入 利用Cookie登录用户账号 一、实验目的 实验目的 本实验学习如何搭建个人的XSS平台以及如何使用XSS平台盗用用户Cookie登录。 二、实验环境 服务器&#xff1a;Windows 7 Target IP:10.1.…
阅读更多...
【笔记：第5课】学习开发一个RISC-V上的操作系统 - 汪辰 - 2021春

【笔记：第5课】学习开发一个RISC-V上的操作系统 - 汪辰 - 2021春

文章目录前言来源正文小结前言 创作开始时间&#xff1a;2023年1月11日16:55:32 如题&#xff0c;学习一下RISC-V。 来源 https://www.bilibili.com/video/BV1Q5411w7z5?p5&vd_source73a25632b4f745be6bbcfe3c82bb7ec0 刚刚才知道老师是PLCT实验室的&#xff0c;牛。…
阅读更多...
C 程序设计教程（16）—— 循环结构程序设计

C 程序设计教程（16）—— 循环结构程序设计

C 程序设计教程&#xff08;16&#xff09;—— 循环结构程序设计 该专栏主要介绍 C 语言的基本语法&#xff0c;作为《程序设计语言》课程的课件与参考资料&#xff0c;用于《程序设计语言》课程的教学&#xff0c;供入门级用户阅读。 目录C 程序设计教程&#xff08;16&…
阅读更多...
Vue3之对Dialog的简单封装

Vue3之对Dialog的简单封装

之前使用的UI框架,无论是Element UI/Plus 还是 Ant design&#xff0c;其中Dialog组件中的结构和样式都难以修改&#xff0c;无论是使用less、deep还是其他方法&#xff0c;对其组件中css的修改都不生效&#xff08;不确定是否有其他解决方法&#xff09;&#xff0c;所以我就自…
阅读更多...
【小白必看】2023年PMP考试报名时间，报考条件，超全PMP备考指南

【小白必看】2023年PMP考试报名时间，报考条件，超全PMP备考指南

PMP 考试一年能考四次&#xff0c;分别是3月、6月、9月、12月&#xff0c;提前 2 个月开始报名&#xff0c;但还是要关注PMI/基金会官网的信息&#xff0c;有特殊情况的会在官网公布。现在放开了&#xff0c;2023年PMP 考试应该不会再延期了&#xff0c;之前没考上的&#xff0…
阅读更多...
重装系统win11的步骤和详细教程

重装系统win11的步骤和详细教程

想要给电脑重装系统win11使用&#xff0c;但是自己对于相关的重装操作不熟悉怎么样?我们可以网上的小白装机工具实现&#xff0c;那么具体怎么重装系统win11?下面就演示下重装系统win11的步骤和详细教程。 工具/原料&#xff1a; 系统版本&#xff1a;Windows 11 品牌型号…
阅读更多...
js使用小顶堆构建优先级队列

js使用小顶堆构建优先级队列

什么是优先级队列? 优先级队列是队列的一个变种,队列是一个先进先出的结构,在头部出队元素在尾部入队元素, 优先级队列顾名思义就是给每个元素具备了优先级,优先级决定了元素在队列中的存储位置,优先级越高的越靠前越先出队 小顶堆又是什么? 小顶堆是堆结构的一个分支,堆…
阅读更多...
浙大MEM提面优秀成功上岸经验分享——完全准备才能“聊”的好

浙大MEM提面优秀成功上岸经验分享——完全准备才能“聊”的好

近期元旦放假&#xff0c;终于有时间写一写关于自己浙大MEM提面上岸的一些经验分享了。这篇可能对接下来参加2024年浙大mem考试的考生会有一些作用。因为我是参加了提前批面试&#xff0c;并在面试中取得了优秀的资格&#xff0c;所以这也为我后续的联考和录取环节减轻了不少的…
阅读更多...
[JAVA安全]filter 内存马

[JAVA安全]filter 内存马

原理&#xff1a; Servlet 有自己的过滤器 filter &#xff0c; 可以通过自定义的过滤器&#xff0c;来对用户的请求进行拦截等操作。 经过filter 之后才会刀Servlet &#xff0c;如果我们动态创建一个 filter 并且将其放在最前面&#xff0c;我们的filter 就会最先被执行&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023