Spring Boot 框架（三）—— Spring Boot 之配置文件详解

最新推荐文章于 2023-06-29 14:05:20 发布
最新推荐文章于 2023-06-29 14:05:20 发布
阅读量562 收藏
点赞数 1
文章标签： Spring Boot 配置 Spring Boot 框架 Java 框架 application.yml application
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/baidu_27414099/article/details/105519063
版权

Spring Boot 配置文件详解

一、Spring Boot 配置文件

1.1 配置文件类型

1.1.1 配置文件介绍
在使用IntelliJ IDEA创建Spring Boot项目时，IDE会在src/main/java/resources目录下创建一个application.properties文件。
在这里插入图片描述
该文件是 SpringBoot 的配置文件，所有的配置信息都在该文件中配置，包括对服务器的配置、spring 的配置、springmvc 的配置、mybatis 的配置等等。

这个配置文件也可以换成为applicaiton.yml文件，application.yml 配置文件拥有更为简洁的配置语法，但是对书写的格式要求更加严格，不过无论是用那种配置文件最终效果都是一致的。

1.1.2 配置文件语法
（1）application.properties文件语法
示例

server.port=8080
server.error.include-stacktrace=always
server.error.include-exception=true
server.compression.enabled=true
spring.resources.static-locations=classpath:/static/, classpath:/templates/
spring.resources.chain.cache=true
spring.resources.chain.compressed=true
spring.aop.auto=true

显示效果
在这里插入图片描述

（2）application.yml文件语法
示例

server:
  port: 8080
  error:
    include-stacktrace: always
    include-exception: true
  compression:
    enabled: true
spring:
  resources:
    static-locations: classpath:/static/, classpath:/templates/
    chain:
      cache: true
      compressed: true
  aop:
    auto: true

显示效果
在这里插入图片描述
2.3.4 YAML
YAML（YAML Ain’t Markup Language），以数据为中心，比json, xm|等更适合做配置文件。

示例

server:
  port: 8080
spring:
  resources:
    static-locations: classpath:/static/

说明
（1）k(空格)v：表示一堆键值对，中间以空格隔开，以空格的缩进来控制层级关系，只要左对齐的一列数据都是属于同一个层级的。

（2）数字、字符串、布尔值的写法：k(空格)v，字符串默认不用加上单引号或者双引号

  • 双引号不会转义字符串里面的符号，而是会以其本身的意思来表达
  • 单引号会将引号内的符号进行转译。

（3）对象、Map（属性和值）的写法：k(空格)v，对象仍旧是以键值对的方式属性

student:
  name: zhangsan
  age: 18
或者
student： {name: zhangsan,age: 18}

（3）数组（List、Set）
用-来表示数组中的元素

person:
 - girl
 - boy
 - others
或者
person: [girl,boy,others]

注意：yml 文件书写格式要求非常严格，具体要求如下：

  • 绝对不能使用tab键来创建空格，如果下一行是一个子级别的属性名按回车后输入一个空格然后继续填写属性值。
  • 文件的最后不能有空行（无内容的行），有的话通过delete键删除
  • 每个:后边都要空一格（注意一定要用空格键来操作，不能用Tab键来空格）
  • 每个级别的属性名要严格对齐
  • 配置文件中间也不能有空行（无内容的行）

1.2 自定义属性

1.2.1 自定义属性示例
配置文件除了有系统的属性外，还可以自定义属性，以application.properties配置文件为例进行示例。

自定义示例

student.name=张三
student.age=18
student.sex=Man
student.email=11234567@163.com

显示结果
在这里插入图片描述

1.2.2 读取自定义属性
在类中，如果需要读取配置文件的内容，那么只需要在属性上使用@Value("${属性名}")，新建一个TestController，在其中创建一个test方法进行测试。

TestController的内容如下。

@RestController
public class TestController {

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

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

    @Value("${student.name}")
    private String sex;

    @Value("${student.name}")
    private String email;

    @GetMapping("test")
    public String test(){
        return "student.name = " + name +
                "  student.age = " + age +
                "  student.sex = " + sex +
                "  student.email = " + email;
    }
}

网页访问http://localhost:8080/test，得到如下结果
在这里插入图片描述

在application.properties中配置中文值，读取时会出现中文乱码问题。因为Java默认会使用ISO-8859-1的编码方式来读取*.properties配置文件，而SpringBoot应用则以UTF-8的编码方式来读取，就导致产生了乱码问题。

对于这个问题，官方推荐的做法是：“Characters that cannot be directly represented in this encoding can be written using Unicode escapes”，大致意思就是使用Unicode的方式来展示字符。例如上述代码中的student.name=张三应该配置成student.name=\u5f20\u4e09。
在这里插入图片描述
再次访问得到如下结果
在这里插入图片描述

1.3 使用随机数

1.3.1 使用随机数示例
在配置文件中，还提供了随机数供我们使用，即在配置文件中使用${random}来生成不同类型的随机数，大致分为随机数、随机uuid、随机字符串等。

示例

Student.name=\u5f20\u4e09
student.age=18
student.sex=Man
student.email=11234567@163.com

# 随机uuid        
test.uuid=${random.uuid}
# 随机int值
test.intNum=${random.int}
# 100以内的随机int值
test.randomNum=${random.int(100)}
# 随机long值
test.longNum=${random.long}
# 随机字符串
test.value=${random.value}
# 自定义属性间引用
test.name=${student.name}
test.age=${student.age}
test.sex=${student.sex}
test.email=${student.email}

显示结果
在这里插入图片描述
1.3.2 获取随机属性
在配置属性后，可以使用JavaBean模式来给属性赋值，创建一个ConfigBean实体类。由于自定义属性的前缀都是由test开头的，因此我们可以在实体类上加入注解@ConfigurationProperties(prefix = "test")，同时需要在启动类上加入注解@EnableConfigurationProperties(ConfigBean.class)，表明启动这个配置类。

ConfigBean实体类

@ConfigurationProperties(prefix = "test")
public class ConfigBean {
    private String uuid;
    private int intNum;
    private int randomNum;
    private long longNum;
    private String value;
    private String name;
    private int age;

    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

    public int getIntNum() {
        return intNum;
    }

    public void setIntNum(int intNum) {
        this.intNum = intNum;
    }

    public int getRandomNum() {
        return randomNum;
    }

    public void setRandomNum(int randomNum) {
        this.randomNum = randomNum;
    }

    public long getLongNum() {
        return longNum;
    }

    public void setLongNum(long longNum) {
        this.longNum = longNum;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    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;
    }
}

@ConfigurationProperties注解对应的依赖如下

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

在TestController中利用@Autowired注解注入ConfigBean类，并且创建一个test方法进行测试。

@RestController
public class TestController {

    @Autowired
    private ConfigBean configBean;

    @GetMapping("test")
    public ConfigBean test(){
        return configBean;
    }
}

在浏览器上访问http://localhost:8080/test进行测试，显示结果如下：
在这里插入图片描述

1.4 多环境配置

1.4.1 多环境配置介绍
在开发Spring Boot项目的时候，可能有这样的情况，一套程序需要在不同的环境中发布，数据库配置、端口配置或者其他配置各不相同，如果每次都需要修改为对应环境配置，不仅耗费人力，而且特别容易出现错误，造成不必要的麻烦。

通常情况下，我们可以配置多个配置文件，在不同的情况下进行替换。而在Spring Boot项目中，我们新建几个配置文件，文件名以application-{name}.properties的格式，其中的{name}对应环境标识，比如：

  • application-dev.properties：开发环境。
  • application-test.properties：测试环境。
  • application-prod.properties：生产环境。
    • application-local.properties：本地环境。

然后，可以在主配置文件（application.properties）中配置spring.profiles.active来设置当前要使用的配置文件，比如：

spring.profiles.active=dev

1.4.2 多环境配置示例
创建application-dev.properties配置文件，在文件中配置端口号为8081。
在这里插入图片描述

创建application-test.properties配置文件，在文件中配置端口号为8082。
在这里插入图片描述

创建application-prod.properties配置文件，在文件中配置端口号为8083。
在这里插入图片描述

创建application-local.properties配置文件，在文件中配置端口号为8084。
在这里插入图片描述

在application.properties配置文件中设置当前要使用的配置文件
在这里插入图片描述
启动项目，可以在控制台看到当前启动的端口
在这里插入图片描述

1.5 自定义配置文件

1.5 自定义配置文件示例
前面介绍了多环境配置文件，我们也可以使用自定义配置文件，比如新建一个test.properties，配置文件内容下。
在这里插入图片描述
1.5.2 获取自定义配置文件的内容
新建一个javabean来读取配置文件。新建一个ConfigBean，在类上加上注解@PropertySource(value = "classpath:test.properties")，并且和之前一样需要加入@ConfigurationProperties(prefix = "test")

@RestController
public class TestController {

    @Autowired
    private ConfigBean configBean;

    @GetMapping("test")
    public ConfigBean test(){
        return configBean;
    }
}

在TestController中注入bean并且创建测试方法test

@Component
@ConfigurationProperties(prefix = "test")
@PropertySource(value = "classpath:test.properties")
public class ConfigBean {
    private String uuid;
    private int intNum;
    private int randomNum;
    private long longNum;
    private String value;
    private String name;
    private int age;
    private String sex;
    private String email;

    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

    public int getIntNum() {
        return intNum;
    }

    public void setIntNum(int intNum) {
        this.intNum = intNum;
    }

    public int getRandomNum() {
        return randomNum;
    }

    public void setRandomNum(int randomNum) {
        this.randomNum = randomNum;
    }

    public long getLongNum() {
        return longNum;
    }

    public void setLongNum(long longNum) {
        this.longNum = longNum;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    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;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

使用浏览器访问http://localhost:8080/test，可以看到显示如下内容：
在这里插入图片描述

TwoYellowGuns
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
SpringBoot从小白到大牛——第四节 多环境配置与配置文件变量
weixin_41982983的博客
08-19 410
多环境——开发、生产 可配置多个application.properties，分别命名为application.properties，application-local.properties，application-prod.properties。application.properties作为最根本的配置，将其他“衍生物”放进来，application.properties配置如下 #spring.profiles.active=prod spring.profiles.active=local 当前表
用Spring区分开发环境、测试环境、生产环境
u013196789的专栏
03-23 6310
我们在项目开发过程中，经常需要往开发环境、测试环境、生产环境部署程序。随着程序越来越复杂，配置文件的增多，如果每次部署都去改一遍配置文件，这种重复的工作会把程序员逼疯。     好在spring提供了这一自动切换的功能，简要说明如下：     1. 首先在applicationContext中，对需要配置的参数进行配置，以下图为例： scope="singleton" lazy-init
Spring Boot2 常用应用程序属性
q_0718的博客
08-27 1225
可以在application.properties文件内部application.yml，文件内部或命令行开关中指定各种属性。本附录提供了常用Spring Boot属性的列表以及对使用它们的基础类的引用。 [注意] 属性贡献可以来自类路径上的其他jar文件，因此您不应将此视为详尽的列表。此外，您可以定义自己的属性。 [警告] 此示例文件仅供参考。千万不能复制和粘贴的全部内容到应用程序中。相反，...
java类 获取application-local.properties配置，并使用配置值
java_study_的博客
03-28 530
java 获取 application-local.properties 配置
SpringBoot配置文件application.yml属性解读及使用学习记录
weixin_49045960的博客
10-28 3894
【代码】java项目中application.yml配置详解记录。
springboot 错误页面/消息配置增加异常信息输出
路过君的博客
03-12 616
现象 springboot中，请求错误，或者在controller抛出异常后将自动跳转到默认错误页面，或者返回默认错误消息 { "timestamp": "2020-11-19T12:15:34.957+00:00", "status": 400, "error": "Bad Request", "message": "", "path": "/comments" } 其中消息始终为空 解决 增加配置 server: error: include-bindi.
SpringBoot全局异常处理(优缺点)以及统一返回对象、错误码按业务模块设计示例，序列化后与数据库数据时间差8小时
Be_insighted的博客
08-22 3437
项目工程中的全局异常处理原理 在开发过程中，不管是Dao、Servie、Controller,层都有可能发生异常，对于异常处理，通常是try－catch或者直接throw，这会让try－catch的代码在代码中任意出现，系统的代码耦合度高，代码不美观，统一异常处理可以美化代码。 错误处理 Spring Boot/error默认提供了一个映射，以合理的方式处理所有错误，并在 servlet 容器中注册为“全局”错误页面。对于机器客户端，它将生成一个 JSON 响应，其中包含错误的详细信息、HTTP 状
详解Spring Boot配置文件之多环境配置
08-29
本篇文章主要介绍了详解Spring Boot配置文件之多环境配置 ，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
详解Spring-boot中读取config配置文件的两种方式
08-29
主要介绍了详解Spring-boot中读取config配置文件的两种方式，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
详解Spring Boot读取配置文件与配置文件优先级
08-27
主要介绍了详解Spring Boot读取配置文件与配置文件优先级，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Spring Boot 配置文件详解(小结)
08-27
Spring Boot提供了两种常用的配置文件，分别是properties文件和yml文件。本章重点介绍yml的语法和从配置文件中取值。小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
详解spring boot starter redis配置文件
08-30
spring-boot-starter-Redis主要是通过配置RedisConnectionFactory中的相关参数去实现连接redis service。下面通过本文给大家介绍在spring boot的配置文件中redis的基本配置，需要的的朋友参考下
SpringBoot无法读取.propertis中的配置信息
孤夜的博客
11-30 3874
SpringBoot无法读取.propertis中的配置信息
IDEA启动选择properties配置文件
qq_36640480的博客
11-09 6089
比如我的项目下有2个.properties文件，一个是application.properties，一个是application-local.properties，在本地的时候想指定用application-local.properties，那么 那么如何在本地以某个properties配置文件启动呢？ 解决方案如下： 配置如下： --spring.profiles.active=local ...
Spring Boot 常用配置(properties、yml)
ljk168的专栏
01-23 984
SPRING CONFIG (ConfigFileApplicationListener) spring.config.name 配置文件名称，默认为applicationspring.config.location 配置文件存放位置，默认为classpath目录下 若想知道SpringBoot为我们做了哪些自动配置，可以在application.properties里添加此参数 运行Spr...
SpringBoot项目属性配置
dht91597的博客
10-25 217
如果使用IDEA创建Springboot项目,默认会在resource目录下创建application.properties文件,在SpringBoot项目中,也可以使用yml类型的配置文件代替properties文件,下面我们具体介绍: 1.应用配置文件(.properties或.yml): 1.在resource目录下创建application.properties文件,并添加一...
java：@PostConstruct注解使用
a232884c的博客
01-25 6362
java：@PostConstruct注解使用 1 使用条件 1.1 方法是非静态方法 1.2 注解修饰的方法，不可以具有参数 否则抛错： Lifecycle method annotation requires a no-arg method 1.3 注解修饰的方法，返回值是void 实际上，可以有返回值，springboot启动没有抛错，但一般仅用于初始化bean，添加些缓存数据用，故而一般不需要返回值： @PostConstruct public String Yhinit(){ log.er
（渗透测试）Spring Boot内置Tomcat屏蔽错误异常信息
最新发布
qq_55076730的博客
06-29 729
include-stacktrace: ALWAYS ：异常堆栈，强制Spring Boot始终包含堆栈跟踪信息，无论应用程序的配置和环境如何。在一次渗透测试中，发现Springboot。在yml配置文件中添加。
Grails配置-基本配置-如何覆盖默认配置，在哪里进行自定义配置
umbrella_show的专栏
08-10 1082
文章目录Grails配置⎮基本配置Grails4风格配置Grails2风格的Groovy配置使用GrailsApplication对象访问配置信息在控制器中使用grailsApplication对象能获取到的配置信息有哪些在业务层中使用grailsApplication对象方式一在业务层中使用grailsApplication对象方式二使用Spring值注解注入配置信息在application.yml中访问命令行参数或者系统参数使用外部application.yml文件内置的一些设置，了解一下有好处Logg
spring boot kafka配置文件详解
06-09
当我们使用 Spring Boot 搭建 Kafka 生产者和消费者时，需要在配置文件中进行相关配置。下面是一个简单的 Kafka 配置文件示例： ``` # Kafka 集群地址 spring.kafka.bootstrap-servers=127.0.0.1:9092 # 消费者组 ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

TwoYellowGuns

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值