SpringBoot 配置⽂件

目录

[1. 配置文件作用](#1. 配置文件作用)

[2. 配置文件快速入手](#2. 配置文件快速入手)

[3. 配置⽂件的格式](#3. 配置⽂件的格式)

[4. properties 配置⽂件说明](#4. properties 配置⽂件说明)

[4.1 properties 基本语法](#4.1 properties 基本语法)

[4.2 读取配置⽂件](#4.2 读取配置⽂件)

[4.3 properties 缺点分析](#4.3 properties 缺点分析)

[5. yml 配置⽂件说明](#5. yml 配置⽂件说明)

[5.1 yml 基本语法](#5.1 yml 基本语法)

[5.2 yml 使⽤进阶](#5.2 yml 使⽤进阶)

[5.2.1 yml 配置不同数据类型及 null](#5.2.1 yml 配置不同数据类型及 null)

[5.2.1.1 yml 配置读取](#5.2.1.1 yml 配置读取)

[5.2.1.2 注意事项:value 值加单双引号](#5.2.1.2 注意事项:value 值加单双引号)

[5.2.2 配置对象](#5.2.2 配置对象)

[5.2.3 配置集合](#5.2.3 配置集合)

[5.2.4 配置Map](#5.2.4 配置Map)

[5.3 yml优缺点](#5.3 yml优缺点)

[6. 综合性练习](#6. 综合性练习)

[6.1 验证码案例](#6.1 验证码案例)

[6.1.1 需求](#6.1.1 需求)

[6.1.2 准备⼯作](#6.1.2 准备⼯作)

[6.1.3 约定前后端交互接口](#6.1.3 约定前后端交互接口)

[6.1.5 实现服务器端代码](#6.1.5 实现服务器端代码)

[6.1.6 运⾏测试](#6.1.6 运⾏测试)

[7. 总结](#7. 总结)


1. 配置文件作用

计算机上有数以千计的配置⽂件, 我们使⽤的绝⼤多数软件, ⽐如浏览器, 微信, Idea, 甚⾄电脑, ⼿机, 都离不开配置⽂件. 我们可能永远不会直接与其中的⼤部分⽂件打交道,但它们确实以不同的形式散落在我们的计算机上, ⽐如C:\Users, C:\Windows⽂件夹, 以及各种 *.config, *.xml ⽂件
配置⽂件主要是为了解决硬编码带来的问题, 把可能会发⽣改变的信息, 放在⼀个集中的地⽅, 当我们启动某个程序时, 应⽤程序从配置⽂件中读取数据, 并加载运⾏.
硬编码是将数据直接嵌⼊到程序或其他可执⾏对象的源代码中, 也就是我们常说的"代码写死".
⽐如⼿机字体⼤⼩如果采⽤硬编码的⽅式, 就直接在程序中指定字体⼤⼩, 所有的⽤⼾使⽤的都是同⼀个字体⼤⼩但是不同的⽤⼾有不同的偏好, 我们可以把⼿机字体的⼤⼩放在配置⽂件中, 当程序启动时, 读取配置, 以⽤⼾设置的字体⼤⼩来显⽰.
SpringBoot配置文件
SpringBoot⽀持并定义了配置⽂件的格式, 也在另⼀个层⾯达到了规范其他框架集成到SpringBoot的目的.
很多项⽬或者框架的配置信息也放在配置⽂件中, ⽐如:
• 项⽬的启动端⼝( S pringBoot内置 了Tomcat服务器, 默认端⼝号是8080, 但是⽤⼾电脑上8080端⼝号有可能就被其他 应⽤程序占⽤了, 所以SpringBoot需要⽀持让⽤⼾⾃定义端⼝号 )
• 数据库的连接信息(包含⽤⼾名和密码的设置)--
为了更⽅便简单的访问数据库, 出现了⼀些持久层框架, 其实就是对JDBC进⾏了更深层次的封装.让⽤⼾通过简单⼏⾏代码就可完成数据库的访问. 但是不同的应⽤程序访问的数据库不同, 这些持久层框架就需要⽀持⽤⼾可以⾃定义配置数据库的连接信息.
• 第三⽅系统的调⽤密钥等信息
• ⽤于发现和定位问题的普通⽇志和异常⽇志等.

2. 配置文件快速入手

我们在前⾯讲了Tocmat 默认端⼝号是8080, 所以我们程序访问时的端⼝号也是8080
但是如果8080端⼝号已经被其他进程使⽤了呢? 我们可以通过配置⽂件来修改服务的端⼝号
SpringBoot 在创建项⽬时, 就已经帮我们创建了配置⽂件

修改 application.yml ⽂件


重新运⾏程序, 观察⽇志

显⽰Tomcat启动端⼝号为9090
访问程序: http://127.0.0.1:9090/login.html

此时: http://127.0.0.1:808/login.html 就不能再访问了

3. 配置⽂件的格式

Spring Boot 配置⽂件有以下三种:
• application.properties
• application.yml
• application.yaml

特殊说明

  1. 理论上讲 .properties 和 .yml 可以并存在于⼀个项⽬中,当 .properties 和 .yml
    并存时,两个配置都会加载. 如果配置⽂件内容有冲突, 则以 .properties 为主, 也就是
    .properties 优先级更⾼.
  2. 虽然理论上来讲 .properties 可以和 .yml 共存,但实际的业务当中,我们通常会采取⼀种
    统⼀的配置⽂件格式,这样可以更好的维护(降低故障率).

4. properties 配置⽂件说明

properties 配置⽂件是最早期的配置⽂件格式,也是创建 SpringBoot 项⽬默认的配置⽂件

4.1 properties 基本语法

properties 是以键值的形式配置的,key 和 value 之间是以"="连接的,如:

java 复制代码
# 配置项⽬端⼝号
 server.port=8080
 #配置数据库连接信息
 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/testdb?
 characterEncoding=utf8&useSSL=false
 spring.datasource.username=root
 spring.datasource.password=root

4.2 读取配置⽂件

如果在项⽬中,想要主动的读取配置⽂件中的内容,可以使⽤ @Value 注解来实现。
@Value 注解使⽤" ${} "的格式读取,如下代码所⽰:
properties 配置如下:

java 复制代码
mykey.key1 = bite
java 复制代码
@RestController
public class PropertiesController {
    @Value("${mykey.key1}")
      private String key1;

    @RequestMapping("/key")
    public String key(){
         return "读取到值:"+key1;
    }
}

最终执行结果:

4.3 properties 缺点分析

properties 配置是以 key-value 的形式配置的,但properties 配置⽂件中会有很多的冗余的信息
想要解决这个问题,就可以使⽤ yml 配置⽂件的格式化了.

5. yml 配置⽂件说明

yml 是 YAML 是缩写,它的全称 Yet Another Markup Language 翻译成中⽂就是"另⼀种标记语⾔.
我们先来学习yml的语法

5.1 yml 基本语法

yml 是树形结构的配置⽂件,它的基础语法是"key: value".
key 和 value 之间使⽤英⽂冒号加空格的⽅式组成, 空格不可省略
使⽤ yml 连接数据库
yml 使⽤⽰例:

java 复制代码
spring:
  datasource:
    url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8&useSSL=false
    username: root
    password: 123456

yml 和 properties 连接数据库的配置对⽐
application.yml:

java 复制代码
spring:
  datasource:
    url: jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8&useSSL=false
    username: root
    password: 123456

application.properties:

java 复制代码
spring.datasource.url=jdbc:mysql://127.0.0.0:3306/dbname?characterEncoding=utf8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root

5.2 yml 使⽤进阶

5.2.1 yml 配置不同数据类型及 null

java 复制代码
# 字符串
string.value: Hello

# 布尔值,true或false
boolean.value: true
boolean.value1: false

# 整数
int.value: 10

# 浮点数
float.value: 3.14159

# Null,~代表null
null.value: ~

# "" 空字符串
#, 直接后面什么都不加就可以了, 但这种方式不直观, 更多的表示是使用引号括起来
empty.value: ''
5.2.1.1 yml 配置读取

yml 读取配置的⽅式和 properties 相同,使⽤ @Value 注解即可,实现代码如下:
yml配置:

java 复制代码
string:
  hello: hi
java 复制代码
@RestController
public class ReadYml {
    @Value("${string.hello}")
    private String hello;

    @RequestMapping("/ymlKey")
    public String key(){
        return "读取到值:"+hello;
    }
}

运行结果:

5.2.1.2 注意事项:value 值加单双引号

字符串默认不⽤加上单引号或者双引号,如果加英⽂的单双引号可以表⽰特殊的含义。
尝试在 application.yml 中配置如下信息:

java 复制代码
string:
  str1: Hello \n Spring Boot.
  str2: 'Hello \n Spring Boot.'
  str3: "Hello \n Spring Boot."

读取程序实现代码如下:

java 复制代码
@RestController
 public class ReadYml {
   @Value("${string.str1}")
   private String str1;
    @Value("${string.str2}")
    private String str2;
    @Value("${string.str3}")
    private String str3;
    @RequestMapping("/yml")
    public String readYml(){
        System.out.println(str1);
        System.out.println(str2);
        System.out.println(str3);
        return "yml";
    }
}


从上述结果可以看出:
• 字符串默认不⽤加上单引号或者双引号。
• 单引号会转义特殊字符,使其失去特殊功能, 始终是⼀个普通的字符串.
• 双引号不会转义字符串⾥⾯的特殊字符, 特殊字符会表⽰本⾝的含义.
此处的转义理解起来会有些拗⼝, \n 本意表⽰的是换⾏
使⽤单引号会转义, 就是说, \n 不再表⽰换⾏了, ⽽是表⽰⼀个普通的字符串
使⽤双引号不会转义, 表⽰ \n 表⽰的是它本⾝的含义, 就是换⾏

5.2.2 配置对象

我们还可以在 yml 中配置对象,如下配置:

java 复制代码
student:
  id: 1
  name: Java
  age: 18

或者是使⽤⾏内写法(与上⾯的写法作⽤⼀致):

java 复制代码
student: {id: 1,name: Java,age: 18}

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

java 复制代码
@ConfigurationProperties(prefix = "student")
@Component
@Data
public class Student {
    private int id;
    private String name;
    private int age;
}

调⽤类的实现如下:

java 复制代码
@RestController
public class StudentController {
    @Autowired
    private Student student;

    @RequestMapping("/readStudent")
    public String readStudent(){
        return student.toString();
    }
}

访问 http://127.0.0.1:8080/readStudent 运⾏结果如下:

5.2.3 配置集合

配置⽂件也可以配置 list 集合,如下所⽰:

java 复制代码
dbtypes:
  name:
    - mysql
    - sqlserver
    - db2

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

java 复制代码
@Component
@ConfigurationProperties("dbtypes")
@Data
public class ListConfig {
    private List<String> name;
}

访问集合的实现如下:

java 复制代码
@RestController
public class ReadYml2 {
    @Autowired
    private ListConfig listConfig;

    @RequestMapping("/readList")
    public String readList(){
        return listConfig.toString();
    }
}

访问127.0.0.1:8080/readList运行结果如下:

5.2.4 配置Map

配置⽂件也可以配置 map,如下所⽰:

java 复制代码
maptypes:
  map:
    k1: kk1
    k2: kk2
    k3: kk3

或者是使⽤⾏内写法(与上⾯的写法作⽤⼀致):

java 复制代码
maptypes: {map: {k1: kk1,k2: kk2, k3: kk3}}

Map的读取和对象⼀样,也是使⽤ @ConfigurationProperties 来读取的,具体实现如下:

java 复制代码
@Component
@ConfigurationProperties("maptypes")
@Data
public class MapConfig {
    private HashMap<String,String> map;
}

打印类的实现如下:

java 复制代码
@RestController
public class ReadYml2 {
    @Autowired
    private MapConfig mapConfig;

    @RequestMapping("/readMap")
    public String readStudent(){
        return mapConfig.toString();
    }
}

访问127.0.0.1:8080/readList127.0.0.1:8080/readMap127.0.0.1:8080/readList运行结果如下:

5.3 yml优缺点

优点:

  1. 可读性⾼,写法简单, 易于理解
  2. ⽀持更多的数据类型, 可以简单表达对象, 数组, List,Map等数据形态.
  3. ⽀持更多的编程语⾔, 不⽌是Java中可以使⽤, 在Golang, Python, Ruby, JavaScript中也可以使⽤
    缺点:
  4. 不适合写复杂的配置⽂件
    ⽐如properties格式如下
java 复制代码
keycloak.realm = demo
keycloak.resource = fm-cache-cloud
keycloak.credentials.secret = d4589683-Oce7-4982-bcd3
keycloak.security[0].authRoles[0]= user
keycloak.security[0].collections[0].name = ssologinurl
keycloak.security[0].collections[0].patterns[0] = /login/*

转换为yml

java 复制代码
keycloak:
  realm: demo
  resource: fm-cache-cloud
  credentials:
    secret: d4589683-Oce7-4982-bcd3
  security:
    - authRoles:
        - user
      collections:
        - name: ssologinurl
          patterns:
            - /login/*

转换的过程也⽐较花费精⼒, 如果配置更复杂⼀点, 可读性会更差, 代码也会更难写
2. 对格式有较强的要求(⼀个空格可能会引起⼀场⾎案)

6. 综合性练习

6.1 验证码案例

随着安全性的要求越来越⾼, ⽬前项⽬中很多都使⽤了验证码, 验证码的形式也是多种多样, 更复杂的图形验证码和⾏为验证码已经成为了更流⾏的趋势.

验证码的实现⽅式很多, 可以前端实现, 也可以后端实现. ⽹上也有⽐较多的插件或者⼯具包可以使⽤, 咱们选择使⽤Hutool提供的⼩⼯具来实现

6.1.1 需求

界⾯如下图所⽰

  1. ⻚⾯⽣成验证码
  2. 输⼊验证码, 点击提交, 验证⽤⼾输⼊验证码是否正确, 正确则进⾏⻚⾯跳转

6.1.2 准备⼯作

创建项⽬, 引⼊SpringMVC的依赖包, 把前端⻚⾯放在项⽬中

6.1.3 约定前后端交互接口

需求分析
后端需要提供两个服务

  1. ⽣成验证码, 并返回验证码
  2. 校验验证码是否正确: 校验验证码是否正确.
    接⼝定义
    1. 生成验证码
java 复制代码
请求URL: /captcha/getCaptcha

响应: 验证码图⽚内容
浏览器给服务器发送⼀个 /captcha/getCaptcha 这样的请求, 服务器返回⼀个图⽚, 浏览器显
⽰在⻚⾯上
2. 校验验证码是否正确
请求: /captcha/check

java 复制代码
请求URL: /captcha/check
请求参数: captcha=xn8d

captcha : ⽤⼾输⼊的验证码
响应:

java 复制代码
true

根据⽤⼾输⼊的验证码, 校验验证码是否正确. true: 验证成功. false: 验证失败.
咱们课程中验证码的实现, 使用Hutool提供的⼩⼯具来实现
Hutool是⼀个Java⼯具包类库,对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装,组成各种Util⼯具类.
Hutool是一个小而全的Java⼯具类库,通过静态方法封装,降低相关API的学习成本,提高⼯作效
率
Hutool官⽹: https://hutool.cn/
Hutool参考⽂档:https://hutool.cn/docs/#/
Hutool源码:https://github.com/dromara/hutool

6.1.5 实现服务器端代码

1. 引⼊依赖

java 复制代码
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-captcha</artifactId>
    <version>5.8.22</version>
</dependency>

2. 实现验证码
根据API生成验证码, 并进行测试

java 复制代码
@RequestMapping("/captcha")
@RestController
public class HuToolCaptchaController {

    @RequestMapping("/getCaptcha")
    public void getCaptcha(HttpServletResponse response){
        //定义图形验证码的长和宽
        LineCaptcha lineCaptcha = CaptchaUtil.createLineCaptcha(200, 100,4,150);

        //图形验证码写出,可以写出到文件,也可以写出到流
        try {
            lineCaptcha.write(response.getOutputStream());
            //输出code
            System.out.println("生成的验证码:"+lineCaptcha.getCode());
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
}

所有具体代码在gittee中:

验证码生成验证代码

6.1.6 运⾏测试

通过URLhttp://127.0.0.1:8080/index.html访问服务


输⼊验证码, 验证成功

7. 总结

  1. properties 是以 key=value 的形式配置的键值类型的配置文件, yml 使用的是树形配置⽅式.
  2. 读取配置文件内容, 使用 @Value 注解, 注解内使⽤" ${} "的格式读取.
  3. yml 层级之间使用换行缩进的⽅式配置, key 和 value 之间使用": "(英文冒号)加空格的方式设置, 并且空格不可省略.
  4. properties 为早期并且默认的配置⽂件格式, 其配置存在⼀定的冗余数据, 使用 yml 可以很好的解决数据冗余的问题, 但不适合复杂配置.
  5. yml 可以和 properties 共存,但⼀个项目中建议使⽤⼀种配置类型⽂件.
相关推荐
果果软件4 小时前
2026 后台管理系统选型:若依、JeecgBoot、芋道、NocoBase 和 GewuMind Boot 怎么选?
java·人工智能·后端·ai·开源
码云社区7 小时前
Java家政服务系统源码:人员技能、服务范围与多商家业务落地
java·开发语言·家政服务·家政小程序·家政系统
摇滚侠8 小时前
《On Java 中文版 基础卷》阅读笔记 接口 18
java·笔记·python
CoderYanger8 小时前
Java EE 进阶:9.MyBatis 操作数据库(进阶)(第八弹):MyBatis Generator
java·数据库·spring boot·spring·java-ee·tomcat·mybatis
jaysee-sjc11 小时前
【黑马点评】Day02:优惠券秒杀与分布式锁
java·分布式·nginx·spring·node.js·tomcat·maven
学长毕设12 小时前
基于SpringBoot 博物馆文物租赁及修复管理系统-附源码
大数据·数据库·spring boot
秋天的怀念_David12 小时前
算法一千零一夜 · 第三十五夜 · 恢复风暴
java·程序人生·算法
考虑考虑12 小时前
JDK27中的加密对象的 PEM 编码
java·后端·java ee
行者-全栈开发12 小时前
SpringBoot + GraalVM 原生编译实战:启动时间从8秒到0.5秒的极致优化
java·spring boot·后端
CoderYanger13 小时前
Java EE 进阶:10. MyBatis-Plus使用(第一弹)
java·spring boot·后端·sql·spring·java-ee·mybatis