详解 Spring Boot 项目中的配置文件

news2024/10/7 4:25:14

目录

1. Spring Boot 项目中配日文件的作用是什么

2. Spring Boot 配置文件的两种格式

3. properties 配置文件

3.1 properties 配置文件的基本语法

 3.2 properties 配置文件的分类

3.3 如何读取配置文件

3.4 properties 配置文件的优缺点分析

4. yml 配置文件

4.1 yml 的基本语法

4.2 yml 配置文件的优点

4.3 yml 配置基本数据类型

4.4 yml 配置对象

4.5 yml 读取对象

4.6 yml 配置集合

5. 设置多平台的配置文件

1. Spring Boot 项目中配日文件的作用是什么

配置文件中最主要的两个作用: 连接数据库和用于定位问题的关键日志.

一个项目中没有数据库的话那就谈不上一个完整的项目,假如今天王者出新皮肤了, 你心智勃勃花了一千多块钱买了好几款喜欢的皮肤, 没有数据库的话, 过两天你上线发现皮肤没了, 你心里肯定有一万只 XXX 奔腾而过. 如果没有配置文件 , 程序出问题, 很难查找时, 都无法定位到关键日志, 所以配置文件还是相当的重要的.

配置文件的作用:

  • 连接数据库的信息
  • 用于发现和定位问题的关键日志
  • 设置项目的启动端口
  • 第三方系统的调用密钥等信息 (例如老师在某平台给我们上课时, 他能在平台上拿到我们的数据, 就是通过配置文件中设置的标识来调用第三方接口获取的)

2. Spring Boot 配置文件的两种格式

Spring Boot 中有两种格式的配置文件:

  • properties  (application.properties)
  • yml (application.yml)

Spring Boot 中这两种格式的配置文件的命名方式必须以 application 开头,  否则配置就不会生效, 这就牵扯到了高级框架中的 "约定大于配置" , 我们要做的事情越来越少了, 但是要遵守的约定越来越多了.

【问题】为什么需要两种格式的配置文件呢 ? 仅仅是为了提供更多的选择 ?

1. yml 相比于 properties 在写法上简化了许多 (后面会演示代码)

2. 在跨平台等问题上也是有很大的优势 (后面会讲到)

【问题】两种格式的配置文件如果同时存在, 会以哪种格式为主?

1. 当一个项目中出现了两种格式的配置文件时, properties 格式的配置文件优先级高, 所以会以 properties 格式的配置文件为主. 例如 properties 配置文件中设置了端口为 8081, .yml 配置文件中也设置了端口, 为 8082, 那么最终程序启动时的端口就是 8081, 但是加载完 properties 文件之后, 也会加载 .yml 文件中的配置信息.

2.理论上是这两种格式的配置文件可以出现在一个项目中, 但是一般都会统一配置文件,如果两种格式都写了, 可能会有增加排查问题的风险; 就好比衣服种类有很多, 但是一个餐厅里的服务员一般都会统一服装, 否则会显得杂乱无章, 不正式.

3. properties 配置文件

3.1 properties 配置文件的基本语法

# 设置端口号
server.port=8081
#设置数据库的连接信息
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/book?characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=123456

properties 配置文件中是以键值对的格式进行配置的, "key" 和 "value" 通过 "=" 来连接.

更多系统配置:  Spring Boot 中更多系统配置

【整个花活】通过配置文件来设置 Spring Boot 项目启动的 log:

1. 在 resource 文件夹下创建一个 banner.txt 文件, 命名必须是 banner.txt , 否则读取不到.

2. 把你想要的 log 复制进去, 然后启动 IDEA 就能看到.

 下载 log 相关网址 : https://www.bootschool.net/ascii-art

 效果图: 

 3.2 properties 配置文件的分类

1. Spring Boot 内置的配置项, 比如 server.port, 等等...

2. 用户自定义的配置项: mykey.key1=zhangsan,  mykey.key2=lisi .....

# 设置端口号
server.port=8081

# 用户自定义的配置项
mykey.key1=zhangsan
mykey.key2=lisi

3.3 如何读取配置文件

通过使用 @Value 注解来实现, 基本格式:  

@Value("${server.port}")

【代码示例】

自定义配置项：

key1=zhangsan
key2=lisi

读取配置文件：

@RestController
public class TestController {
    // 读取自定义配置项
    @Value("key1")
    private String key1;

    // 读取系统配置项
    @Value("${server.port}")
    private Integer port;

    @RequestMapping("/key")
    public String readKey() {
        return "key1: " + key1 + " | port: " + port;
    }
}

运行程序， 此时在浏览器输入 URL， 就能拿到相关 key 对应的 value 值。

 

【注意事项】

还是那句话, "约定大于配置", 我们一定要遵守这种写法: ${},  如果我们写成这样 @Value("key1"), 那么读取的时候, 虽然不会报错, 但是它会将 key1 当做字符串赋值给 key1, 那么此时你再运行程序, 就会输出以下结果, 就拿不到自定义配置中 key 对应的 value 值了.

 

 

3.4 properties 配置文件的优缺点分析

【优点】

  • 格式简单, 不易出错.
  • 写法上更加直观

【缺点】

  • 写法不够灵活, 不够简便, 例如下面的数据库相关配置, 同样的前缀信息, 需要写多遍.

  •  乱码问题:

使用 properties 格式的配置文件, 我们加注释的中文, 以及头比较铁的时候, 给键或值写成中文的时候, 我们关闭项目后再打开项目时, 这些中文就会乱码; 甚至是我没关闭项目, 我通过 @Value 等注解的方式去读的时候, 也有可能出现乱码的问题,而且是不可逆的, 因为 IDEA 会默认给 properties 配置文件设置 IOS-8859-1 的编码格式. 而 yml 格式的配置文件就不存在这个问题, 它默认是 UTF-8 的编码格式.

如何解决 propeties 配置文件乱码问题:

第一步: 进入当前项目的 settings 和 新项目的 settings

第二步: 按照下图的方式去更改当前项目的 settings 和新项目的 settings.

4. yml 配置文件

yml 是 YAML 的缩写, 全称 -> Yet Another Markup Language.  中文意思为 "另一种语言".

4.1 yml 的基本语法

yml 不像 properties 那中键值对的方式, 而是树形结构的格式, 基本格式 : 

写法规范注意: 

  • 一级目录下: 键和值之间的冒号后面要有空格, 千万不能省略!!
  • 多级目录下: 从第二级目录开始, 相较于上一级目录, 最前面要带有 tab 键

对比数据库连接的写法后, 发现 yml 的写法省略了重复的前缀信息, 写法上更加简便了.

 

单从写法简便这一点上来说, yml 还不足以打败 properties, 那么下面来分析 yml 还有哪些优点: 

4.2 yml 配置文件的优点

1. yml 可读性高, 写法上相较于 properties 更加简洁的, 语法和 JSON 高度相似.

2. yml 支持更多的数据类型, 它不仅支持基本数据类型, 它还可以表达数组, 散列表, 标量等数据形态, 还特别适合用来表达数据结构(各种集合), 各种配置文件等等.

3. yml 支持更多的编程语言, 它是跨语言的, 它不仅仅只是在 Java 中可以使用, 还可以在 Golang, PHP, Python, Ruby, JavaScript 等语言中使用. (质的提升)

4.3 yml 配置基本数据类型

前边演示了 String 类型, 其他像 boolean, int, float, 甚至 null 都是 类似的.

【代码示例】

# 布尔类型
boolean: false

# 整数
int.value1: 20
int.value2: 0b1010_0111_0100_1010_11010  # 二进制

# 浮点型
float.value: 3.14

# null
null.value: ~

yml 配置 String 类型注意事项：

yml 在配置 String 类型的时候有三种写法

  • 默认不用加单双引号
  • 加单引号
  • 加双引号

【代码示例】

yml 配置文件 

 

读取配置文件（和 properties 相同）

@RestController
public class TestController {
    @Value("${key2}")
    private String key2;

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

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

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

    @RequestMapping("/key")
    public String readKey() {
        System.out.println();
        System.out.println("String.str1: " + str1);
        System.out.println("String.str2: " + str2);
        System.out.println("String.str3: " + str3);
        return "key2: " + key2;
    }
}

运行结果: 

 【结论】

1. 字符串默认不⽤加上单引号或者双引号.
2.  单引号会转义特殊字符，特殊字符最终只是⼀个普通的字符串数据.
3.  双引号不会转义字符串⾥⾯的特殊字符；特殊字符会作为本身想表示的意思.

4.4 yml 配置对象

yml 配置对象有两种写法: 1. 原始写法 2. 行内写法

1. 原始写法:

student:
  id: 1
  name: zhangsan
  age: 18

2. 行内写法:

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

4.5 yml 读取对象

读取对象的时候, 我们不再使用 @Value("${}") 注解了, 因为这个注解每次只能读到一个 value, 如果我们要读的对象有一百个属性, 我们是不可能去写一百遍重复的代码的. 此时我们需要使用到 @ConfigurationProperties 注解来实现.

基本格式:

@ConfigurationProperties(prefix = "student")

【代码示例】 读取上述 student 对象

Bean 对象

@Data
@Component
@ConfigurationProperties(prefix = "student") 
// 读取 yml 中的 student 属性, 赋值给 Student 对象
public class Student {
    private Integer id;
    private String name;
    private Integer age;
}

@ConfigurationProperties 注解的作用就是从 yml 中读取 student 属性, 然后复制给 bean 对象.

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

    @RequestMapping("/student")
    public String readKey() {
        return "userId: " + student.getId() + 
                " | userName: " + student.getName();
    }
}

 运行程序, 通过 url 访问:

 yml 读取对象的注意事项

1. yml 配置对象的时候, 键名不能出现大写, 也不能出现下划线, 只能小写或者写成 stu-name.

2. 读取配置文件的实体类不能没有 setter 方法, @ConfigurationProperties 注解在实现时是通过 setter 将配置文件中的内容赋值给字段的. (可以通过 Generate 生成 Getter 和 Setter 方法, 或者通过 lombok 中的 @Data 注解来设置)

3. @ConfigurationProperties 需要配置五大类注解使用.

4.6 yml 配置集合

yml 配置集合也有两种格式: 1. 原始写法 2.行内写法

1. 原始写法

mylist:
  dbtype:
    - mysql
    - sqlserver
    - db2

2. 行内写法

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

4.7 yml 读取集合

yml 读取集合和读取对象的方式是类似的, 也是通过 @ConfigurationProperties 注解来实现的.

【代码示例】读取上述 mylist 集合

Bean 对象

@Data
@Component
@ConfigurationProperties(prefix = "mylist2")
public class MyList {
    private List<String> dbtype;  // 泛型可加可不加
}

读取集合：

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

    @RequestMapping("/student")
    public String readKey() {
        return "list-Size: " + mylist.getDbtype().size()
                + " | list.get(0): " + mylist.getDbtype().get(0);
    }
}

启动服务器, 浏览器输入 url :

5. 设置多平台的配置文件

对于公司级别的环境而言, 最小的公司一般都会分三种环境来进行管理:

多平台配置文件设置

  • 开发环境的配置文件 [application-dev.yml]
  • 测试环境的配置文件 [application-text.yml]
  • 生产环境的配置文件 [application-prod.yml]

【注意】不同环境配置文件的命名必须以 application- 开头

【如何设置多平台的配置文件】

1. 使用一份 yml 配置文件, 不同的环境, 通过修改和注释来解决.(麻烦)

就拿数据库连接来说, 假如我连接的是开发环境的数据库, 我数据库的信息写好了, 我下次再连接测试环境的数据库, 我又把开发环境的数据库的相关信息给注释掉, 再去写我连接测试数据库的信息. 这样会面临两个问题:

  • 极端一点来说, 万一我配置文件连接了生产环境上的数据库, 我手动修改, 就总是会有改错的风险的, 如果改错了, 就会污染生产环境的库.
  • 第二, 不同环境的配置可能会非常繁琐, 改来改去有时候可能不止改一点点代码, 难度太大.

2. 不同的运行环境, 设置不同的配置文件.(更优)

而我们使用不同环境对应不同的配置文件, 这样就优雅方便很多了, 我不同的环境, 有着不同的代码, 不需要去修改, 只需要在主配置文件中去设置它需要运行的平台就行了.所以我们一般都是主配置文件搭配我们所需要的配置环境一起去使用的.

【代码示例】

测试环境配置文件 application-test.yml

server:
  port: 7777

Spring:
  datasource:
    url: jdbc:mysql://yyyy:3306/book?characterEncoding=utf8
    username: root
    password: aaaaa

开发环境配置文件 application-prod.yml

server:
  port: 8888

Spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/book?characterEncoding=utf8
    username: root
    password: 123456

生产环境配置文件 application-prod.yml

server:
  port: 9999

Spring:
  datasource:
    url: jdbc:mysql://xxxx:3306/book?characterEncoding=utf8
    username: root
    password: bbbbbb

在主配置文件中设置运行环境:

# 运行环境设置
Spring:
  profiles:
    active: prod

active 后面写 prod, test 和 dev, 就表示当前主配置文件要搭配那个运行环境来使用.

以生产环境为例, 启动程序, 观察端口号来区别运行环境.

  • 7777: 测试环境
  • 8888: 开发环境
  • 9999: 生产环境

 观察结果可以对应上当前环境是生产环境, 测试环境和开发环境都是类似的做法.

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

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

相关文章

【JavaSE】初识泛型

【JavaSE】初识泛型

大家好&#xff01;我是保护小周ღ&#xff0c;本期为大家带来的是 Java的泛型&#xff0c;会来大家初步了解什么是泛型&#xff0c;以及泛型的使用&#xff0c;感受一手泛型的思想&#xff0c;面向对象编程太爽了~ 目录 一、泛型是什么&#xff1f; 二、泛型的语法 三、包…
阅读更多...
Java给图片增加水印，根据图片大小自适应，右下角/斜角/平铺

Java给图片增加水印，根据图片大小自适应，右下角/斜角/平铺

Hi&#xff0c;I’m Shendi 最近写自己的文件服务器&#xff0c;上传图片时需要自动增加水印&#xff0c;在这里记录一下 文章目录效果展示读取图片从 byte[] 读取图片获取画板绘制水印根据图片大小自适应水印大小右下角文字水印斜角水印平铺水印图片水印输出图片水印就是在图片…
阅读更多...
《剑指 Offer 》—58 - I. 翻转单词顺序

《剑指 Offer 》—58 - I. 翻转单词顺序

《剑指 Offer 》—58 - I. 翻转单词顺序 注意&#xff1a;本题与151 题相同&#xff1a;https://leetcode-cn.com/problems/reverse-words-in-a-string/ 注意&#xff1a;此题对比原题有改动 文章目录《剑指 Offer 》—58 - I. 翻转单词顺序一、题目内容二、个人答案&#xf…
阅读更多...
Git 打patch (打补丁)的使用

Git 打patch (打补丁)的使用

patch 的使用 一般是diff ,apply ,format-patch,am 1 生成patch git diff > test.patch 这个是打补丁(test.patch自己取的名字,这个命令可以看出没有指定修改的问题所以默认把所有修改的文件都打patch了,同时还需要注意,这里是本地修改的没有执行add缓存的) 如果想指定某…
阅读更多...
FPGA实现图像对比度自动调整，提供2套工程源码和技术支持

FPGA实现图像对比度自动调整，提供2套工程源码和技术支持

目录1.算法原理介绍2.HLS算法实现3.工程1介绍&#xff1a;zynq7100实现4.工程2介绍&#xff1a;Kintex7实现5.上板调试验证6.福利&#xff1a;工程源码获取1.算法原理介绍 使用直方图均衡技术实现 使用直方图均衡技术将原始图像的灰度直方图从比较集中的某个灰度区间变成在全部…
阅读更多...
学习axure都要经历哪个阶段，如何快速入门

学习axure都要经历哪个阶段，如何快速入门

作为初学Axure同学们&#xff0c;正在学习AxureRP在这个过程中&#xff0c;我们应该经历每个阶段&#xff0c;掌握每个阶段的特点&#xff0c;明确如何在不同阶段学习&#xff0c;这样我们才能快速做到axure快速掌握这个工具。还能根据自己的实际工作需要&#xff0c;掌握自己的…
阅读更多...
关系抽取（二）远程监督方法总结

关系抽取（二）远程监督方法总结

目录 前言 1. 远程监督关系抽取开山之作 1.1 介绍 1.2 训练过程 1.2.1 数据标注方法 1.2.2 训练方法 1.3 测试过程 1.4 思考 1.5 总结 2. PCNN 2.1 介绍 2.2 模型结构 2.2.1 文本特征表示 2.2.2 卷积 2.2.3 分段最大池化 2.2.4 softmax多分类 2.3 多实例学习的…
阅读更多...
【elementUI样式】模态框中的el-select下拉框不跟随页面滚动问题

【elementUI样式】模态框中的el-select下拉框不跟随页面滚动问题

文章目录1.在el-select标签中设置:popper-append-to-body"false"2.样式穿透&#xff08;比较普遍的写法&#xff09;模态框中的el-select下拉框不跟随页面滚动问题在使用elementUI写界面的时候&#xff0c;偶然遇到了如下图所示bug当页面滚动的时候&#xff0c;el-se…
阅读更多...
JVM之类加载子系统

JVM之类加载子系统

JVM类加载子系统类的加载过程类加载器双亲委派机制类的加载过程 初始化阶段解读 初始化阶段就是执行构造类加载器<clinit>()的过程 该方法不需要定义&#xff0c;是javac编译器自动收集类中所有类变量的赋值动作和静态代码中的语句合并而来 构造方法中指令按照语句在源文…
阅读更多...
学习Retrofit后，你还需要明白这些……

学习Retrofit后，你还需要明白这些……

在学习Retrofit后&#xff0c;由于它本身就是OKHttp的封装&#xff0c;面试中也经常会被一起问到&#xff1b;单纯的解析它的源码学习难免会有点无从下手&#xff0c;往往让人抓不住重点&#xff0c;学习效率并不是很高&#xff0c;本文从提出几个问题出发&#xff0c;带着问题…
阅读更多...
[附源码]SSM计算机毕业设计校园新闻管理系统JAVA

[附源码]SSM计算机毕业设计校园新闻管理系统JAVA

项目运行 环境配置&#xff1a; Jdk1.8 Tomcat7.0 Mysql HBuilderX&#xff08;Webstorm也行&#xff09; Eclispe&#xff08;IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持&#xff09;。 项目技术&#xff1a; SSM mybatis Maven Vue 等等组成&#xff0c;B/S模式 M…
阅读更多...
SpringBoot、EasyPoi、Echarts 实现文档导入、出、图表显示 (饼状图、柱状图) 保姆级教程

SpringBoot、EasyPoi、Echarts 实现文档导入、出、图表显示 (饼状图、柱状图) 保姆级教程

一、介绍环境 EasyPOI: 现在我们就来介绍下EasyPoi,首先感谢EasyPoi 的开发者​。EasyPoi开源 easypoi 是为了让开发者快速的实现excel&#xff0c;word,pdf的导入导出&#xff0c;基于Apache poi基础上的一个工具包。easypoi教程 Echarts: …
阅读更多...
c++ - 第15节 - 二叉树进阶

c++ - 第15节 - 二叉树进阶

1. 二叉搜索树 1.1.二叉搜索树概念 二叉搜索树又称二叉排序树&#xff0c;它或者是一棵空树&#xff0c;或者是具有以下性质的二叉树: 若它的左子树不为空&#xff0c;则左子树上所有节点的值都小于根节点的值若它的右子树不为空&#xff0c;则右子树上所有节点的值都大于根节…
阅读更多...
一次 Netty 代码不健壮导致的大量 CLOSE_WAIT 连接原因分析

一次 Netty 代码不健壮导致的大量 CLOSE_WAIT 连接原因分析

背景 我们线上有一个 dubbo 的服务&#xff0c;出现大量的 CLOSE_WAIT 状态的连接&#xff0c;这些 CLOSE_WAIT 的连接出现以后不会消失&#xff0c;这就有点意思了&#xff0c;于是做了一下分析记录如下。 首先从 TCP 的角度看一下 CLOSE_WAIT CLOSE_WAIT 状态出现在被动关闭…
阅读更多...
数据分析之金融数据分析

数据分析之金融数据分析

一 前言 金融业是一个持续发展的行业&#xff0c;金融业正在使用数据分析进行金融&#xff0c;以最大程度地减少管理各种金融活动所需的精力和时间。这些公司正在利用数据分析和机器学习原理的力量。这有助于他们发现金融行业各个领域所需的进步&#xff0c;以重塑其业务战略。…
阅读更多...
虹科分享 | 网络仿真器 | 预测云中对象存储系统的实际性能

虹科分享 | 网络仿真器 | 预测云中对象存储系统的实际性能

对象存储是一种在云中存储非结构化数据的方法&#xff0c;从理论上讲&#xff0c;它使得以其原始格式存储几乎无限量的数据成为可能。在这种存储架构中&#xff0c;数据被作为对象进行管理&#xff0c;而传统的系统则将数据作为块或分层文件进行处理。对象存储可以在内部使用&a…
阅读更多...
一条Select语句在MySQL-Server层的执行过程

一条Select语句在MySQL-Server层的执行过程

select customer_id,first_name,last_name from customer where customer_id14;先连接到数据库&#xff0c;连接器 负责跟客户端建立连接、获取权限、维持和管理连接。 客户端再次发送请求&#xff0c;就会使用同一个连接&#xff0c;客户端如果长时间没动静&#xff0c;就会断…
阅读更多...
用R Shiny生态快速搭建交互Web网页APP应用

用R Shiny生态快速搭建交互Web网页APP应用

什么是Shiny&#xff1f; Shiny包可以快速搭建基于R的交互网页应用。对于web的交互&#xff0c;之前已经有一些相关的包&#xff0c;不过都需要开发者熟悉网页编程语言&#xff08;html,CSS,JS&#xff09;。最近我们被客户要求撰写关于R Shiny的研究报告&#xff0c;包括一些…
阅读更多...
使用 Huggingface Trainer 对自定义数据集进行文本分类

使用 Huggingface Trainer 对自定义数据集进行文本分类

文本分类是一项常见的 NLP 任务&#xff0c;它根据文本的内容定义文本的类型、流派或主题。Huggingface&#x1f917; Transformers 提供 API 和工具来轻松下载和训练最先进的预训练模型。Huggingface Transformers 支持 PyTorch、TensorFlow 和 JAX 之间的框架互操作性。模型还…
阅读更多...
JAVA学习-java基础讲义01

JAVA学习-java基础讲义01

java基础讲义一 java语言1.1 java语言介绍1.1.1 什么是java1.1.2 java之父1.1.3 java语言发展史1.2 java语言的特点二 java环境搭建相关2.1 Java环境介绍2.1.1 虚拟机介绍2.1.2 JVM介绍2.2 Java跨平台2.2.1 跨平台2.2.2 跨平台原理2.3 java运行过程2.4 JDK、JRE、JVM关系图2.4.…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023