Spring Boot配置文件

最新推荐文章于 2024-03-06 10:10:32 发布
最新推荐文章于 2024-03-06 10:10:32 发布
阅读量285 收藏
点赞数
分类专栏： SpringBoot Java 文章标签： SpringBoot Java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chen_hao_181/article/details/100053520
版权

文章目录

1. Spring Boot配置文件

Spring Boot提供了两种常用的配置文件，分别是properties文件和yml文件。配置文件的作用是修改Spring Boot自动配置的默认值。

SpringBoot全局配置文件，配置文件名是固定的；

​ •application.properties

​ •application.yml

在SpringBoot中，这两种配置文件各有各的优点，各有各的缺点。

application.properties：属性访问结构，层级深浅对它来说是一样的，而且相较于application.yml类型的文件比较好配置，但缺点也很明显–要重复写很多遍父级属性；

application.yml：利用空格决定层次结构，层级少的时候使用比较方便，层级深的时候就比较麻烦了，需要严格控制空格的使用。

相对properties文件，yml更加年轻，yaml通过空格来确定层次关系，采用这种方式，最大的优点就是文件结构很清晰。但同时也要注意空格的使用，空格的多于或不足会导致层级关系出现混乱。

2. YAML简介和语法

2.1 yaml简介和常用配置

YAML和XML一样，也是一种可标记语言，和XML比较，yml配置起来更加方便快捷。yaml（yml）以数据为中心，比json、xml等更适合做配置文件。

下面是一个yml的常用配置

server:
  port: 8080
  servlet:
    context-path: /

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: root

mybatis:
  mapper-locations: classpath:mapping/*.xml
  type-aliases-package: com.chtw.pojo

2.2 yaml语法

2.2.1 基本语法

键值对的形式（在值和键中间需要一个空格，并且不可以少）

key:(此处需要一个空格)value

以空格来决定层次结构，保持左边对齐的就是同一层级。

下面配置服务器端口为80，默认8080，访问路径/hello，需要注意的是属性和值对大小写敏感；

server:
    port: 80
    path: /hello

前一章中创建了springboot项目，给他添加一个配置文件application.yml，添加以上类容，删除原来的配置文件application.properties这个配置文件，只需要让其中一个配置文件起作用就可以了。配置好后运行主函数。
在这里插入图片描述
在这里插入图片描述

2.2.2 值的写法

数字，字符串，布尔的写入：

直接写入，默认不用加双引号或单引号。如果加上了双引号，则不会转义字符串里面的特殊字符；如果加上单引号，会转义特殊字符。

例子如下：

server:
    port: 80
    path: /hello

对象、Map（键值对）的写入：

people:
    name: wangming
    sex: 男
    info: "I am a Java programmer,\n but I also like to use python."
    infon: 'I am a Java programmer,\n but I also like to use python.'
    maps: {k1: 59,k2: 2}

或者

server:
    port: 80
    path: /hello
people:
    name: wangming
    sex: 男
    info: "I am a Java programmer,\n but I also like to use python."
    infon: 'I am a Java programmer,\n but I also like to use python.'
    maps:
       k1: 59
       k2: 2

2.2.3 数组（List、Set）的写法：

用- 值表示数组中的一个元素

list:
      - 章
      - 成
set:
      - wu
      - li

3. 配置文件值注入

3.1 配置文件值的注入

新建一个people类

package com.chtw.entity;

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

import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * @author CHTW
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 * 除了@ConfigurationProperties注入之外还有一种@Value注入
 * prefix = "people"：选择映射位置
 * @date 2019-08-24-8:18
 */
@Component
@ConfigurationProperties(prefix = "people")
public class People {
    private String name;
    private int age;
    private String info;
    private String infon;
    private String sex;
    private Map<String ,String> maps;
    private List list;
    private Set set;

    public Map<String, String> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, String> maps) {
        this.maps = maps;
    }

    public List getList() {
        return list;
    }

    public void setList(List list) {
        this.list = list;
    }

    public Set getSet() {
        return set;
    }

    public void setSet(Set set) {
        this.set = set;
    }

    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 getInfo() {
        return info;
    }

    public void setInfo(String info) {
        this.info = info;
    }

    public String getInfon() {
        return infon;
    }

    public void setInfon(String infon) {
        this.infon = infon;
    }

    public String getSex() {
        return sex;
    }

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

    @Override
    public String toString() {
        return "People{" +
                "name='" + name +
                ", age=" + age +
                ", info='" + info +
                ", infon='" + infon +
                ", sex='" + sex +
                ", maps=" + maps +
                ", list=" + list +
                ", set=" + set +
                '}';
    }
}

application.yml

server:
    port: 80
    path: /hello
people:
    name: wangming
    sex: 男
    info: "I am a Java programmer,\n but I also like to use python."
    infon: 'I am a Java programmer,\n but I also like to use python.'
    maps:
       k1: 59
       k2: 2
    list:
          - 章
          - 成
    set:
          - wu
          - li

修改一下controller

package com.chtw.controller;

import com.chtw.entity.People;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author CHTW
 * @date 2019-08-23-17:43
 */
/*
 * @Controller
 * @ResponseBody
 */
@RestController
public class HelloController {

    //自动注入
    @Autowired
    private People people;

    @RequestMapping("/hello")
    public String hello(){
        System.out.println(people.toString());
        return "Hello World! Welcome to Spring-Boot"+people.toString();
    }
}

运行主函数，浏览器访问：localhost:80/hello

在这里插入图片描述

控制台打印输出

在这里插入图片描述

3.3.1 @Value和@ConfigurationProperties的区别

@Value写在变量前面，单一配置，是spring的底层注解，支持SpEL，不支持JSR303数据校验，不支持复制类型的封装，当我们在某一项业务逻辑中需要获取某一个属性的值的时候，可以使用@Value。

/*
*	@Component将people加入到当前容器中，在controller那边才能自动注入
*	@ConfigurationProperties方法
*/
@Component
@ConfigurationProperties(prefix = "people")
public class People {
    private String name;
    private int age;
    private String info;
	//set、get方法省略，自行补充
}

@Component
public class People {
    @Value("${people.name}")
    private String name;
    @Value("${people.age}")
    private int age;
    @Value("${people.info}")
    //set、get方法省略，自行补充
}

@ConfigurationProperties写在类前面，指定注入位置，批量注入，不支持SpEL，支持JSR303数据校验，支持复制类型的封装，如果我们有一个JavaBean来对配置文件映射的时候，使用@ConfigurationProperties。

另外，我们可以导入一个依赖，这个依赖只要我们将JavaBean进行绑定后，可以在我们写yml的时候给我们提示。

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

3.2 加载指定的配置文件@PropertySource

@PropertySource：用于加载指定的配置文件；当我们全局配置文件里面的类容过多的时候，不方便操作和修改维护等；所以我们可以自定义一些配置文件，但是springboot默认读入全局配置文件，不会读取我们自定义的配置文件，要想springboot能读取我们定义的配置文件，需要我们进行配置。@PropertySource就是其中一种方法。

下面是一个例子：将原来的application.yml文件中有关people的类容删除，只留下server相关配置。然后新建一个people.properties

people.name=lisi
people.age=21
people.info=hello world!
people.infon=hello word!
people.sex=男
people.maps.k1=56
people.maps.k2=5
people.list=1,2,3
people.set=1,2

在peoplel类上加一个注解

package com.chtw.entity;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.List;
import java.util.Map;
import java.util.Set;

@PropertySource(value = {"classpath:people.properties"})
@Component
@ConfigurationProperties(prefix = "people")
public class People {
   // @Value("${people.name}")
    private String name;
    //@Value("${people.age}")
    private int age;
    //@Value("${people.info}")
    private String info;
    private String infon;
    private String sex;
    private Map<String ,String> maps;
    private List list;
    private Set set;

    public Map<String, String> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, String> maps) {
        this.maps = maps;
    }

    public List getList() {
        return list;
    }

    public void setList(List list) {
        this.list = list;
    }

    public Set getSet() {
        return set;
    }

    public void setSet(Set set) {
        this.set = set;
    }

    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 getInfo() {
        return info;
    }

    public void setInfo(String info) {
        this.info = info;
    }

    public String getInfon() {
        return infon;
    }

    public void setInfon(String infon) {
        this.infon = infon;
    }

    public String getSex() {
        return sex;
    }

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

    @Override
    public String toString() {
        return "People{" +
                "name='" + name +
                ", age=" + age +
                ", info='" + info +
                ", infon='" + infon +
                ", sex='" + sex +
                ", maps=" + maps +
                ", list=" + list +
                ", set=" + set +
                '}';
    }
}

3.3 导入Spring的配置文件@ImportResource

**@ImportResource：**导入Spring的配置文件，让配置文件里面的内容生效；Spring Boot里面没有Spring的配置文件，当我们需要用到spring的一些配置时，就需要导入spring配置文件。

@ImportResource(locations = {"classpath:XXX.xml"})

3.4 @Configuration和@Bean

@Configuration和@Bean这两个注解嫩能够替代方法2.5中的XXX.xml文件，通过写Java代码的方式实现spring配置文件的导入。

/**
 * @Configuration：说明这是配置类；用来来替代的Spring的xml文件
 */
@Configuration
public class Config {

    //组件默认的id就是方法名
    @Bean
    public Hello hello(){
        return new Hello();
    }
}

创建一个Hello类；

package com.chtw.config;

/**
 * @author CHTW
 * @date 2019-08-24-14:30
 */
public class Hello {
    public void sys(){
        System.out.println("成功了");
    }
}

在test包下面的java文件夹下的SpringBoot02ApplicationTests类中添加一个单元测试方法：

package com.chtw.springboot02;

import com.chtw.config.Hello;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBoot02ApplicationTests {


	@Autowired
	ApplicationContext context;

	@Test
	public void contextLoads() {
	}

	@Test
	public void sys() {
        //获取一个Javabean
		Hello hello = context.getBean(Hello.class);
		hello.sys();
	}
}

单步运行sys方法，控制台打印出”成功了“则说明容器中包含Hello这个bean。配置也就成功了

在这里插入图片描述

4. Profile多环境支持

在实际开发项目中，一般情况下最少有三种环境：开发、测试、正式，各个环境之间的参数也各不相同，为了方便我们快速切换环境，spring提供了profile多环境支持的功能。

4.1 application-{profile}.properties.yml

在编写全局配置文件的时候多变写几个，通过命名不同来区分不同的环境。默认使用application.properties的配置；通常由以下几种：

application-dev.properties/yml

server:
    port: 8082

application-prod.properties/yml

server:
    port: 8083

在application.properties.yml中配置spring.profiles.active来选择激活哪一个环境

server:
    port: 8081
spring:
    profiles:
      active: dev  #启用dev环境

此时访问：localhost:8082/hello能够显示数据则说明配置成功

在这里插入图片描述

4.2 yml多文档块

只需要一个全局配置文件application.yml，不再需要其他的配置文件，一组”—“中是一个文档块

server:
  port: 8081
spring:
  profiles:
    active: dev #启用环境的名称
---
server:
  port: 8082
spring:
  profiles: dev #指定环境名称
---
server:
  port: 8083
spring:
  profiles: prod

4.3 激活指定profile

当项目已经完成并且打包好了过后，如果我们需要临时修改某修参数的时候，修改完成又需要重新打包发布，比较麻烦；这个时候我们也可以采取在命令行添加某些命令去临时改变。

java -jar spring-boot-02-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；

启动后访问:localhost:8082/hello，打印结果说明改变成功。

本人联系方式2329095893,欢迎各位进行学习讨论
欢迎关注熊熊出没ING公众号，不定时跟新Java、python、信息安全等相关知识哦。

在这里插入图片描述

IT一氪
关注
专栏目录
深入理解Spring Boot配置文件的高级用法
fudaihb的博客
08-31 2045
在Spring Boot项目中，配置文件扮演着至关重要的角色。通过配置文件，我们可以灵活地管理应用程序的各种配置项，从数据库连接到日志设置，再到自定义属性，几乎涵盖了应用的方方面面。Spring Boot提供了强大的配置文件支持，不仅仅限于简单的键值对配置，更有许多高级特性可以帮助我们更好地管理和组织配置内容。本文将深入探讨Spring Boot配置文件的高级用法，帮助你充分发挥配置文件的潜力。
Spring Boot 配置文件加密
weixin_44992607的博客
09-04 1220
（不加该注解也可实现加解密功能）属性会自动解密为“id111"。
Springboot @Value 注解
zhizhuodewo6的博客
09-18 1074
@Value注入 不通过配置文件的注入属性的情况 通过@Value将外部的值动态注入到Bean中，使用的情况有： 注入普通字符串 注入操作系统属性 注入表达式结果 注入其他Bean属性：注入beanInject对象的属性another 注入文件资源 注入URL资源 详细代码见： @Value注入 不通过配置文件的注入属性的情况 通过@Value将外部的值动态注入到Be...
详解Spring Boot中@value的使用方式
qq_43720551的博客
09-04 5250
如何在Spring Boot中使用`@value`获得配置文件中的内容
classpath:前缀，配置文件中的相对路径
最新发布
qq_31856061的博客
03-06 1415
通常指的是类路径，这是一个Java应用程序用来查找类文件、资源文件和其他所需文件的路径。在大多数情况下是等价的，它们都可以用来指定类路径中的资源。上面的配置告诉Spring Boot从类路径中加载。前缀时，相当于指定一个相对于类路径的资源位置。前缀来指定文件系统中的文件路径，或者使用。这个文件，将其内容合并到主配置文件。在SpringBoot的。目录下，那么就可以在。
10-Spring Boot配置文件
titanium的博客
01-27 2649
Spring Boot配置文件
SpringBoot简明教程-yml配置文件详解
java小白翻身
10-14 1万+
Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过这种方式，Spring Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者。以下是我个人编写的SpringBoot简明教程，方便初学者学习，如有不足，敬请指正。首先，我们需要用idea创建一个SpringBoot项目。
Spring Boot 配置文件
陌尘吖的博客
08-16 254
1、配置文件类型 1.1、 application.properties 语法： key=value 1.2、 application.yml 语法： key:[空格]value 2、 YAML 2.1、什么是 YAML YAML（/ˈjæməl/，尾音类似camel骆驼）是一个可读性高，用来表达数据序列化的格式。 YAML 参考了其他多种语言，包括： C语言 、 Python 、 Perl ，并从 XML 、电子邮件的数据格式 （RFC 2822） 中获得灵感。 Clark Evans 在2001年首次发
详解Spring Boot配置文件application.properties
08-25
Spring Boot 配置文件 application.properties 详情解析 Spring Boot 配置文件 application.properties 是 Spring Boot 项目中的核心配置文件，用于存放项目的各种配置信息。本文将深入探讨 application.properties...
Spring Boot 实现配置文件加解密原理
08-19
Spring Boot 实现配置文件加解密原理 Spring Boot 实现配置文件加解密原理是通过 EnvironmentPostProcessor 接口实现的，该接口允许在应用程序之前操作环境属性值。通过实现 EnvironmentPostProcessor 接口，可以对...
03、Spring Boot配置文件深入讲解.pdf
01-09
Spring Boot 配置文件深入讲解 Spring Boot 配置文件是 Spring Boot 框架中一个非常重要的组成部分，它提供了配置项目的各种参数和属性，帮助开发者快速构建项目。下面将对 Spring Boot 配置文件进行深入讲解。 一...
Spring boot @Value注解详解
wangooo的博客
02-24 2万+
Springboot通过@Value注解将配置文件中的属性注入到容器内组件中（可用在@Controller、@Service、@Configuration、@Component等Spring托管的类中） 1.普通字符串注入 例：yml中存在key： name: zs @Value注入 @Value("${name}") public String name; 当yml中的name没有对应值时，即yml中为： name: 此时字符串name的值为"" 可设置注入属性的默认值（当配置文件.
SpringBoot-读取classpath下文件
^_^TaeYang-Jade^_^
08-01 9736
读取方式分类 外部web容器文件 内置web容器文件 读取外部web容器文件 外部web容器会将部署的war包解压出来，读取方式无需注意 // 方法1：获取文件或流 this.getClass().getResource("/")+fileName; this.getClass().getResourceAsStream(failName); // 方法2：获取文件 File file ...
spring boot 加载资源路径配置和classpath问题
Just Play的博客
09-24 3万+
1、spring boot默认加载文件的路径： /META-INF/resources/ /resources/ /static/ /public/ 我们也可以从spring boot源码也可以看到：private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:
惊呆了! | Spring Boot 使用 @Value 读取配置还能这样用
mySoul
10-28 998
“Hi ! 我是小小，今天是本周的第三篇，Spring Boot 中使用@Value读取配置文件配置文件配置直接配置 在src/main/resources下添加配置文件，applica...
springboot中@PropertySource(value = {"classpath:FoundBean.properties"})读取不出内容
建设美丽祖国
11-22 9316
情景：因为不可能所有的属性都放在全局文件中，所以需要把一些跟springboot无关的东西放在其他文件，用 @PropertySource：加载指定的配置文件； 所以我在javabean中直接用了此注解 @PropertySource(value = {&quot;classpath:bean.properties&quot;}) @Component public class FoundBean { ...
Spring Boot系列四 Spring @Value 属性注入使用总结一
热门推荐
不积跬步无以至千里; 不积小流无以成江海
05-16 12万+
@Value注入不通过配置文件的注入属性的情况通过@Value将外部的值动态注入到Bean中，使用的情况有： 注入普通字符串 注入操作系统属性 注入表达式结果 注入其他Bean属性：注入beanInject对象的属性another 注入文件资源 注入URL资源详细代码见： @Value("normal") private String normal; // 注入普通字符串 @V
基于Java的SMTP协议邮件发送模拟系统
chtw的博客
05-07 7007
目录 1. 原理分析 2. 前端页面 3. 数据库设计 4. 后端数据处理 5. 参考文献 6. 注意事项 1. 原理分析 SMTP协议 SMTP（Simple Mail Transfer Protocol）即简单邮件传输协议,它是一组用于由源地址到目的地址传送邮件 的规则，由它来控制信件的中转方式。SMTP协议属于TCP/IP协议簇，它帮助每台计算机在发送或中转信件 ...
Spring Boot配置文件深度解析
"史上最全面的Spring Boot配置文件深入讲解" 在Spring Boot中，配置文件起着至关重要的作用，它们简化了Spring框架的传统配置流程，使得开发者能够更加高效地管理应用程序的设置。Spring Boot提供了两种主要的配置...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值