8. Spring Boot 配置文件

news2025/5/25 1:33:44

源码地址：SpringBoot_demo

本篇文章内容源码位于上述地址的com/chenshu/springboot_demo/config包下

1. 配置文件是什么

上节说到，Spring Boot的项目分为三个部分：源代码目录、资源目录、单元测试目录。

而配置文件的位置就位于资源目录resources的第一级，名为application.properties，可见配置文件于Spring Boot项目的重要性：

在这里插入图片描述

上一篇文章提到了Spring Boot约定大于配置的思想，这里就能够体现：它的命名只能是application.xxx。

2. 配置文件的作用

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

  • 项目的启动端口：过去所有项目都是在一个本地Tomcat的配置文件中所配置的端口号，通过Context Path区分项目，如今由于内置的Tomcat，只要通过配置文件的配置就可以设定项目的启动端口号；
  • 数据库的连接信息（包含用户名和密码的设置）：过去要以代码的形式连接数据库，在Spring Boot时代只要简单的几句配置语句就可以完成；
  • 日志信息配置：如日志持久化等

3. 配置文件的两种格式

配置文件主要分为以下两种格式：

  • .properties
  • .yml

3.1 语法差别

以配置项目的启动端口号为例：

(1) properties语法

它的语法特别简单，也就是"键"=“值”

server.port=8080

观察一下它的键"server.port"，类似于java中导包时用来区分不同的包下的类（把server看成包，把port看作类）

(2) yml语法

该格式可以说是properties格式的升级，yml格式则是更改了键的形式，键的级别之间用':' + '\n' + '\t'分割，值和键之间必须用':' + '空格'分割

server:
  port: 8081

3.2 读取顺序

两种格式的配置文件可以共存在一个项目中，当一个项目有两种格式的配置文件的时候，会先去读取application.properties文件，再去读取application.yml文件，前者的优先级最高。也就是说两个文件中都配置了"server.port"这一个键的话，那么会以.properties中的配置为主

server.port=8888

server:
  port: 9999

image.png

但是实际开发中通常会使用统一的配置文件格式，这样可以更方便的维护。

4. application.properties编码问题

4.1 问题描述

在application.properties和application.yml中都可以通过'#'来写注解：

# 设置端口号
server.port=8888

但是在application.properties默认是以ISO-8859-1来编码的，而idea默认是以utf-8来解码的，有中文的情况下，如果关闭了项目下次再打开就会变成乱码：

image.png

关闭idea，并重新打开该项目：

image.png

4.2 解决方案

1、关闭项目

image.png

2、更改所有设置

在这里插入图片描述

3、更改.properties的编码方式

在这里插入图片描述

4、点击Apply+OK，这样设置完之后的项目的properties文件就都是以utf-8来编码的了，当前项目的话还需自己手动打开当前项目的设置，其他步骤和上述一样：

image.png

5. 常用配置内容

这里使用yaml的格式，简单看看，后续都会用到：

# 配置启动端口号
server:
  port: 9999
# 配置数据库的连接字符串
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/blog_system?characterEncoding=utf8&useSSL=false
    username: root
    password: root
    driver-class-name: com.mysql.jdbc.Driver
# 配置日志输出信息
logging:
  level:
    com:
      example:
        demo: debug

更多配置点这：Spring Boot 各种配置项

6. 读取配置文件的信息

配置文件内容分类：

  1. Spring Boot 内置的配置项目，比如server.port
  2. 用户自定义的配置项

我们可以自行定义配置项（下面用properties来定义，yml同理）：

# 用户自定义配置项
mykey.key1=chenshu

读取配置文件中的值：

想要读取配置文件中的值，需要在类的字段上添加一个@Value注解，@Value注解中的参数必须要使用${}将键包裹起来，如读取键为mykey.key1的值就这样写：@Value("${mykey.key1}")

@RestController
public class TestController {
    //读取配置文件中的值
    @Value("${mykey.key1}")
    private String myKey;

    //配置路由
    @RequestMapping("/getkey")
    public String getMyKey() {
        return myKey;
    }
}

浏览器中搜索该方法的路由：

image.png

7. yml 配置文件说明

yml是YAML的缩写，全称为Yet Another Markup Language（另一种标记语言）

在开发中更推荐使用yml，举个例子：

application.properties有下面配置：

# 数据库的连接配置
# 数据库的url
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/druid_test?characterEncoding=utf8
# 数据库username
spring.datasource.username=root
#数据库password
spring.datasource.password=root

在application.yml中是下面这样：

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/druid_test?characterEncoding=utf8
    username: root
    password: root

7.1 优点分析

  1. yml消除更多冗余信息，properties每次都要重新写spring.datasource
  2. yml能更直观的区分配置文件的层级结构
  3. yml 支持更多的数据类型，它可以简单表达清单(数组)、散列表，标量等数据形态。它使用空白符号缩进和大量依赖外观的特色，特别适合用来表达或编辑数据结构、各种配置文件等。
  4. yml支持更多的编程语言，它不止是Java 中可以使用在 Golang、PHP、Python、Ruby、JavaScript、Perl中。

7.2 yml字符串修饰符问题

  • 当不使用任何字符串修饰符的情况下，会将原生的值赋值给变量
  • 当使用单引号来修饰的情况下，会将原生的值赋值给变量
  • 当使用双引号来修饰的情况下，那么value值中的特殊字符就会发挥自身的用途，比如"\n"就会实现换行的效果

配置文件：

mykey:
  key1: I am \n Chenshu
  key2: 'I am \n Chenshu'
  key3: "I am \n Chenshu"

测试代码：

@RestController
public class TestController {

    @Value("${mykey.key1}")
    private String myKey1;

    @Value("${mykey.key2}")
    private String myKey2;

    @Value("${mykey.key3}")
    private String myKey3;

    //配置路由
    @RequestMapping("/getkey")
    public void getMyKey() {
        System.out.println(myKey1);
        System.out.println(myKey2);
        System.out.println(myKey3);
    }
}

输出结果：

I am \n Chenshu
I am \n Chenshu
I am 
 Chenshu

7.3 通过yml配置对象属性

yml配置对象属性支持两种写法：

原始写法：

User:
  id: 1
  name: zhangsan
  age: 20

行内写法：

User: {id: 1, name: zhangsan, age: 20}
  1. 编写一个model类：
public class User {
    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;
    }
    
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + ''' +
                ", age=" + age +
                '}';
    }
}
  1. 在model上添加注解：
    在添加@Component的基础上，还要添加@ConfigurationProperties(prefix = "user")：
@Component
@ConfigurationProperties(prefix = "user")
public class User {
  1. 在TestController中注入依赖：
@Autowired
private User user;
  1. 编写路由方法，返回配置文件中获取的对象的值：
@RequestMapping("/getuser")
public String getUser() {
    return "Hi, " + user;
}
  1. 访问对应路由：

image.png

注意事项：

  1. @ConfigurationProperties(prefix = "user")，表示从配置文件中读取键为"user"的对象，将对象中的字段赋值给Bean，其实就跟传统的Spring中的通过配置文件的setter属性注入是一样的，该注解必须要有setter方法，通过setter方法注入值，否则会报错，把setAge()屏蔽后启动项目会失败：
  2. 必须绑定五大类注解使用，因为 @ConfigurationProperties(prefix = "user")的作用只是赋值，setter()方法使用的前提是有这个对象。
Property: user.age
    Value: "20"
    Origin: class path resource [application.yml] - 15:36
    Reason: java.lang.IllegalStateException: No setter found for property: age

7.4 通过yml配置集合

7.3讲到的配置对象属性只能配置基本类型，如int，String等，其实配置集合也是配置对象属性的一种，不过属性由基本类型变成了list集合，yml配置list集合同样支持两种写法：

原始写法：

dbtypes:
  name:
    - mysql
    - sqlserver
    - sqlite

行内写法：

dbtypes: {name: [mysql,sqlserver,sqlite]}
  1. 编写一个model类（这次我们直接加上来自Lombok的@Data注解，作用是省去了编写setter、getter以及toString方法）：
@Data
public class DBTypes {
    private List name;
}
  1. 在model上添加注解：
    在添加@Component的基础上，还要添加@ConfigurationProperties(prefix = "dbtypes")：
@Data
@Component
@ConfigurationProperties(prefix = "dbtypes")
public class DBTypes {
    private List name;
}
  1. 在TestController中注入依赖：
@Autowired
private DBTypes dbTypes;
  1. 编写路由方法，返回配置文件中获取的对象的值：
@RequestMapping("/getdb")
public String getDBTypes() {
    return "Hi, " + dbTypes;
}
  1. 访问对应路由：

image.png

8. 多环境的配置文件设置

在实际开发中涉及到多环境的开发，如：

  • 开发环境的配置文件
  • 测试环境的配置文件
  • 生产环境的配置文件

而不同环境需要使用不同的配置文件设置（如不同的环境需要连接不同的数据库），通过多环境的配置文件设置，就不用再通过单一的配置文件改来改去了。

Spring Boot的约定大于配置，它们的命名也是有约定的，命名方式为：application-xxx.yml（其中只有xxx是可以修改的）

我在resources目录下新增了这三个配置文件，分别代表三种开发环境：

  • 开发环境：application-dev.yml
  • 测试环境：application-test.yml
  • 生产环境：application-prod.yml

image.png

这里我们把application.properties文件给忽视掉，resources目录下只有四个配置文件，此时application.yml是主配置文件

我在三种环境的配置文件中分别设置了启动端口为：8001、8002、8003，并且连接了不同的数据库：

application-dev.yml:

# 开发环境的配置文件
server:
  port: 8001

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/dev?characterEncoding=utf8
    username: root
    password: root

application-test.yml:

# 测试环境的配置文件
server:
  port: 8002

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8
    username: root
    password: root

application-prod.yml：

# 生产环境的配置文件
server:
  port: 8003

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/prod?characterEncoding=utf8
    username: root
    password: root

然后在主配置环境中设置运行环境为开发环境，这样Spring Boot项目在读配置文件的时候会读取主配置文件+设置的运行环境的配置文件的内容：

application.yml：

# 运行环境设置
spring:
  profiles:
    active: dev

发现确实是以application-dev.yml的配置文件中设置的启动端口号启动项目：

image.png

总结：在实际开发中可以把公共的配置写在主配置文件application.yml中，不同开发环境下需要不同的设置再分别写入application-xxx.yml中，并且在主配置文件中设置相应的运行环境，以实现多环境的配置文件设置。

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

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

相关文章

【竞技宝jjb.lol】LOL：T1成功击败HLE晋级MSI！

【竞技宝jjb.lol】LOL：T1成功击败HLE晋级MSI！

北京时间2024年4月13日,英雄联盟LCK2024春季季后赛继续进行,昨天迎来败者组决赛HLE对阵T1。本场比赛HLE率先拿下一局之后,T1连续两局在后期决策上碾压HLE拿到赛点,第四局zeus祭出上单VN在中期杀穿HLE后排,最终T1以3-1的比分击败HLE晋级春季决赛,同时也拿到了MSI的参赛资格。以下…
阅读更多...
CSS3 常用样式

CSS3 常用样式

个人主页：学习前端的小z 个人专栏：HTML5和CSS3悦读 本专栏旨在分享记录每日学习的前端知识和学习笔记的归纳总结，欢迎大家在评论区交流讨论！ 文章目录 ✍CSS3 常用样式💎1 CSS3 新增选择器🌹1.1 属性选择器…
阅读更多...
Python匿名函数4不要

Python匿名函数4不要

当你需要完成一件小工作时，在本地环境中使用这个函数，可以让工作如此得心应手，它就是Lambda 函数。 Lambda 函数是 Python 中的匿名函数。有些人将它们简称为lambdas，它们的语法如下： lambda arguments: expressionl…
阅读更多...
拥有了这24个Python接单平台，你就拥有了“钞能力”

拥有了这24个Python接单平台，你就拥有了“钞能力”

学Python能兼职挣米吗？怎么挣？ 一、Python兼职种类： 接私活刚学会python那会，就有认识的朋友介绍做一个网站的私活，当时接单赚了4K，后又自己接过开发网站后台接口、做数据处理等事情，都赚了一…
阅读更多...
Python实现外观模式、桥接模式、组合模式和享元模式

Python实现外观模式、桥接模式、组合模式和享元模式

今天介绍四种结构型设计模式：外观模式、桥接模式、组合模式和享元模式 外观模式 外观模式（Facade Pattern），它为子系统提供一个统一的接口，使得子系统更加容易使用。 在Python中，我们可以通过定义一个外…
阅读更多...
记录-若依前端集成markdown文档，自动生成文档目录

记录-若依前端集成markdown文档，自动生成文档目录

使用版本: vue 2.6.12 html-loader 1.3.2 markdown-loader 6.0.0 github-markdown-css ^5.5.1 highlight.js 9.18.5 webpack 4.47.x 一.引入loder插件，html-loader和markdown-loader //安装 pnpm install html-loader --save ; pnpm install markdown-loader --sa…
阅读更多...
Zynq学习笔记--AXI 总线概述

Zynq学习笔记--AXI 总线概述

目录 1. AXI总线概述 1.1 主要特点 1.2 通道功能 1.3 信号概览 2. AXI Interconnect 2.1 信号说明 2.2 内部结构 3. PS-PL AXI Interface 3.1 AXI FPD/LFP/ACP 3.2 Address Editor 3.3 地址空间 3.4 AXI-DDR 4. 通过ILA观察AXI信号 4.1 AXI 读通道 1. AXI总线概述…
阅读更多...
头歌-机器学习 第15次实验 朴素贝叶斯分类器

头歌-机器学习 第15次实验 朴素贝叶斯分类器

第1关：条件概率 任务描述 本关任务：根据本节课所学知识完成本关所设置的选择题。 相关知识 为了完成本关任务，你需要掌握条件概率。 条件概率 朴素贝叶斯分类算法是基于贝叶斯定理与特征条件独立假设的分类方法，因此想要了解朴素贝叶斯分类算法背后的算法原理，就不得…
阅读更多...
STM32-看门狗

STM32-看门狗

1、看门狗是什么：就是一个向下定时器，定时时间一到，就会触发一个向下的复位的中断，使单片机开始工作 2、作用：MCU微控制器构成的微型计算机系统中，由于微控制器的工作常常会受到来自外界电磁场的干 扰,造成…
阅读更多...
PostgreSQL入门到实战-第二十六弹

PostgreSQL入门到实战-第二十六弹

PostgreSQL入门到实战 PostgreSQL中数据分组操作(一)官网地址PostgreSQL概述PostgreSQL中GROUP BY命令理论PostgreSQL中GROUP BY命令实战更新计划 PostgreSQL中数据分组操作(一) 如何使用PostgreSQL GROUP BY子句将行分组。 官网地址 声明: 由于操作系统, 版本更新等原因, 文…
阅读更多...
Transformer 结构浅析

Transformer 结构浅析

Transformer 结构浅析 文章目录 Transformer 结构浅析Transformer 网络结构编码器位置编码多头注意力层Add&NormFeed Forward 解码器带掩码的多头注意力层多头注意力层 预测 Transformer 网络结构 Transformer模型的网络结构如图，且transformer结构主要分为两部…
阅读更多...
编曲知识18：EQ均衡器 齿音处理 呼吸音处理 口水音处理

编曲知识18：EQ均衡器 齿音处理 呼吸音处理 口水音处理

EQ均衡器 齿音处理 呼吸音处理 口水音处理小鹅通-专注内容付费的技术服务商https://app8epdhy0u9502.pc.xiaoe-tech.com/live_pc/l_66151c90e4b092c1187ac699?course_id=course_2XLKtQnQx9GrQHac7OPmHD9tqbv 均衡器 均衡器 Equalizer（简称EQ） 人耳接受频率：20hz—20khz …
阅读更多...
python基础——类型注解【变量，函数，Union】

python基础——类型注解【变量，函数，Union】

📝前言： 上一篇文章Python基础——面相对象的三大特征提到，python中的多态，python中，类型是动态的，这意味着我们不需要在声明变量时指定其类型。然而，这可能导致运行时错误，因为我们…
阅读更多...
【每日一算】冒泡算法

【每日一算】冒泡算法

冒泡算法就是给数据排序的意思。比如说升序，17，8，9，28，5.升序之后的结果就是5，8，9，17，28. 从我们的大脑思维来看，结果一眼就有了，可是机器要怎么才…
阅读更多...
论文阅读：Polyp-PVT: Polyp Segmentation with PyramidVision Transformers

论文阅读：Polyp-PVT: Polyp Segmentation with PyramidVision Transformers

这篇论文提出了一种名为Polyp-PVT的新型息肉分割框架，该框架采用金字塔视觉变换器（Pyramid Vision Transformer, PVT）作为编码器，以显式提取更强大的特征。本模型中使用到的关键技术有三个：渐进式特征融合、通道和空间…
阅读更多...
Linux 【进程】

Linux 【进程】

什么是进程 Linux中的进程是指正在运行的程序实例。每个进程都是操作系统内部管理的独立实体，具有自己的地址空间、代码、数据和打开的文件等资源。进程是并发执行的基本单位，可以同时运行多个进程。 Linux中的进程通过创建父子关系形成一个进程树。当一…
阅读更多...
软件测试20个基础面试题及答案

软件测试20个基础面试题及答案

什么是软件测试？ 答案：软件测试是指在预定的环境中运行程序，为了发现软件存在的错误、缺陷以及其他不符合要求的行为的过程。 软件测试的目的是什么？ 答案：软件测试的主要目的是保证软件的质量，并尽可能…
阅读更多...
Docker入门实战教程

Docker入门实战教程

文章目录 Docker引擎的安装Docker比vm虚拟机快 Docker常用命令帮助启动类命令镜像命令docker imagesdocker searchdocker pulldocker system dfdocker rmi 容器命令redis前台交互式启动redis后台守护式启动Nginx容器运行ubuntu交互式运行tomcat交互式运行对外暴露访问端口 Dock…
阅读更多...
头歌-机器学习实验 第8次实验 决策树

头歌-机器学习实验 第8次实验 决策树

第1关：什么是决策树 任务描述 本关任务：根据本节课所学知识完成本关所设置的选择题。 相关知识 为了完成本关任务，你需要掌握决策树的相关基础知识。 引例 在炎热的夏天，没有什么比冰镇后的西瓜更能令人感到心旷神怡的了。现…
阅读更多...
【深度学习实战（1）】如何使用argparse模块设置自己的训练参数

【深度学习实战（1）】如何使用argparse模块设置自己的训练参数

一、argparse模块用法 1、argparse是一个python模块，用途是：命令行选项、参数和子命令的解释。 2、argparse库下载：pip install argparse 3、使用步骤： 导入argparse模块，并创建解释器 添加所需参数 解析参数 二、…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023