[springboot]配置文件①(配置文件格式yaml配置及读取)(代码片段)

十八岁讨厌编程 十八岁讨厌编程     2023-04-16     121

关键词:

文章目录

配置文件格式

我们现在启动服务器默认的端口号是 8080,访问路径可以书写为

http://localhost:8080/books/1

在线上环境我们还是希望将端口号改为 80,这样在访问的时候就可以不写端口号了,如下

http://localhost/books/1

SpringBoot 程序如何修改呢?SpringBoot 提供了多种属性配置方式

  • application.properties

    server.port=80
    
  • application.yml

    server:
    	port: 81
    
  • application.yaml

    server:
    	port: 82
    

注意:SpringBoot 程序的配置文件名必须是 application ,只是后缀名不同而已。

环境准备

创建一个新工程 springboot_02_base_config 用来演示不同的配置文件,工程环境和入门案例一模一样,结构如下:

在该工程中的 com.itheima.controller 包下创建一个名为 BookController 的控制器。内容如下:

@RestController
@RequestMapping("/books")
public class BookController 

    @GetMapping("/id")
    public String getById(@PathVariable Integer id)
        System.out.println("id ==> "+id);
        return "hello , spring boot!";
    

不同配置文件演示

  • application.properties配置文件

现在需要进行配置,配合文件必须放在 resources 目录下,而该目录下有一个名为 application.properties 的配置文件,我们就可以在该配置文件中修改端口号,在该配置文件中书写 portIdea 就会提示,如下

application.properties 配置文件内容如下:

server.port=80

启动服务,会在控制台打印出日志信息,从日志信息中可以看到绑定的端口号已经修改了

  • application.yml配置文件

删除 application.properties 配置文件中的内容。在 resources 下创建一个名为 application.yml 的配置文件,在该文件中书写端口号的配置项,格式如下:

server:
	port: 81

注意: 在:后,数据前一定要加空格。

而在 yml 配置文件中也是有提示功能的,我们也可以在该文件中书写 port ,然后 idea 就会提示并书写成上面的格式

启动服务,可以在控制台看到绑定的端口号是 81

  • application.yaml配置文件

删除 application.yml 配置文件和 application.properties 配置文件内容,然后在 resources 下创建名为 application.yaml 的配置文件,配置内容和后缀名为 yml 的配置文件中的内容相同,只是使用了不同的后缀名而已

application.yaml 配置文件内容如下:

server:
	port: 83

启动服务,在控制台可以看到绑定的端口号

注意:在配合文件中如果没有提示,可以使用一下方式解决

  • 点击 File 选中 Project Structure

  • 弹出如下窗口,按图中标记红框进行选择

  • 通过上述操作,会弹出如下窗口

  • 点击上图的 + 号,弹出选择该模块的配置文件

  • 通过上述几步后,就可以看到如下界面。properties 类型的配合文件有一个,ymal 类型的配置文件有两个

三种配合文件的优先级

在三种配合文件中分别配置不同的端口号,启动服务查看绑定的端口号。用这种方式就可以看到哪个配置文件的优先级更高一些

application.properties 文件内容如下:

server.port=80

application.yml 文件内容如下:

server:
	port: 81

application.yaml 文件内容如下:

server:
	port: 82

启动服务,在控制台可以看到使用的端口号是 80。说明 application.properties 的优先级最高

注释掉 application.properties 配置文件内容。再次启动服务,在控制台可以看到使用的端口号是 81,说明 application.yml 配置文件为第二优先级。

从上述的验证结果可以确定三种配置文件的优先级是:

application.properties > application.yml > application.yaml

注意:

  • SpringBoot 核心配置文件名为 application

  • SpringBoot 内置属性过多,且所有属性集中在一起修改,在使用时,通过提示键+关键字修改属性

    例如要设置日志的级别时,可以在配置文件中书写 logging,就会提示出来。配置内容如下

    logging:
      level:
        root: info
    

    root可以设为warn(比较干净)、debug(很长)

yaml格式

上面讲了三种不同类型的配置文件,而 properties 类型的配合文件之前我们学习过,接下来我们重点学习 yaml 类型的配置文件。

YAML(YAML Ain’t Markup Language),一种数据序列化格式。这种格式的配置文件在近些年已经占有主导地位,那么这种配置文件和前期使用的配置文件是有一些优势的,我们先看之前使用的配置文件。

最开始我们使用的是 xml ,格式如下:

<enterprise>
    <name>itcast</name>
    <age>16</age>
    <tel>4006184000</tel>
</enterprise>

properties 类型的配置文件如下

enterprise.name=itcast
enterprise.age=16
enterprise.tel=4006184000

yaml 类型的配置文件内容如下

enterprise:
	name: itcast
	age: 16
	tel: 4006184000

优点:

  • 容易阅读

    yaml 类型的配置文件比 xml 类型的配置文件更容易阅读,结构更加清晰

  • 容易与脚本语言交互

  • 以数据为核心,重数据轻格式

    yaml 更注重数据,而 xml 更注重格式

YAML 文件扩展名:

  • .yml (主流)
  • .yaml

上面两种后缀名都可以,以后使用更多的还是 yml 的。

语法规则

  • 大小写敏感

  • 属性层级关系使用多行描述,每行结尾使用冒号结束

  • 使用缩进表示层级关系,同层级左侧对齐,只允许使用空格(不允许使用Tab键)

    空格的个数并不重要,只要保证同层级的左侧对齐即可。

  • 属性值前面添加空格(属性名与属性值之间使用冒号+空格作为分隔)

  • # 表示注释

核心规则:数据前面要加空格与冒号隔开

数组数据在数据书写位置的下方使用减号作为数据开始符号,每行书写一个数据,减号与数据间空格分隔,例如

enterprise:
  name: itcast
  age: 16
  tel: 4006184000
  subject:
    - Java
    - 前端
    - 大数据

yaml配置文件数据读取

我们在 resources 下创建一个名为 application.yml 的配置文件,里面配置了不同的数据,内容如下:

lesson: SpringBoot

server:
  port: 80

enterprise:
  name: itcast
  age: 16
  tel: 4006184000
  subject:
    - Java
    - 前端
    - 大数据

接下来我们尝试去读取他们:

使用 @Value注解

使用 @Value("表达式") 注解可以从配合文件中读取数据,注解中用于读取属性名引用方式是:$一级属性名.二级属性名……

我们可以在 BookController 中使用 @Value 注解读取配合文件数据,如下

@RestController
@RequestMapping("/books")
public class BookController 
    
    @Value("$lesson")
    private String lesson;
    @Value("$server.port")
    private Integer port;
    @Value("$enterprise.subject[0]")
    private String subject_00;

    @GetMapping("/id")
    public String getById(@PathVariable Integer id)
        System.out.println(lesson);
        System.out.println(port);
        System.out.println(subject_00);
        return "hello , spring boot!";
    

Environment对象

上面方式读取到的数据特别零散,SpringBoot 还可以使用 @Autowired 注解注入 Environment 对象的方式读取数据。这种方式 SpringBoot 会将配置文件中所有的数据封装到 Environment 对象中,如果需要使用哪个数据只需要通过调用 Environment 对象的 getProperty(String name) 方法获取。具体代码如下:

@RestController
@RequestMapping("/books")
public class BookController 
    
    @Autowired
    private Environment env;
    
    @GetMapping("/id")
    public String getById(@PathVariable Integer id)
        System.out.println(env.getProperty("lesson"));
        System.out.println(env.getProperty("enterprise.name"));
        System.out.println(env.getProperty("enterprise.subject[0]"));
        return "hello , spring boot!";
    

注意:这种方式,框架内容大量数据,而在开发中我们很少使用。

自定义对象

SpringBoot 还提供了将配置文件中的数据封装到我们自定义的实体类对象中的方式。具体操作如下:

  • 将实体类 bean 的创建交给 Spring 管理。

    在类上添加 @Component 注解

  • 使用 @ConfigurationProperties 注解表示加载配置文件

    在该注解中也可以使用 prefix 属性指定只加载指定前缀的数据

  • BookController 中进行注入

具体代码如下:

Enterprise 实体类内容如下:

@Component
@ConfigurationProperties(prefix = "enterprise")
public class Enterprise 
    private String name;
    private int age;
    private String tel;
    private String[] subject;

    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 getTel() 
        return tel;
    

    public void setTel(String tel) 
        this.tel = tel;
    

    public String[] getSubject() 
        return subject;
    

    public void setSubject(String[] subject) 
        this.subject = subject;
    

    @Override
    public String toString() 
        return "Enterprise" +
                "name='" + name + '\\'' +
                ", age=" + age +
                ", tel='" + tel + '\\'' +
                ", subject=" + Arrays.toString(subject) +
                '';
    

BookController 内容如下:

@RestController
@RequestMapping("/books")
public class BookController 
    
    @Autowired
    private Enterprise enterprise;

    @GetMapping("/id")
    public String getById(@PathVariable Integer id)
        System.out.println(enterprise.getName());
        System.out.println(enterprise.getAge());
        System.out.println(enterprise.getSubject());
        System.out.println(enterprise.getTel());
        System.out.println(enterprise.getSubject()[0]);
        return "hello , spring boot!";
    

注意:

使用第三种方式,在实体类上有如下警告提示

这个警告提示解决是在 pom.xml 中添加如下依赖即可

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

springboot系列——配置相关

〇、SpringBoot的全局配置文件  通过上一篇我们可以知道,构建一个SpringBoot项目时,SpringBoot已经对项目进行了默认配置。但在实际应用中,每个项目有其特殊性,不可能仅使用默认的配置,还需自行添加或修改一些配置。  ... 查看详情

spring——springboot配置文件(代码片段)

JavaEE传送门JavaEESpring——Bean作用域和生命周期Spring——SpringBoot创建和使用目录SpringBoot配置文件SpringBoot配置文件格式properties配置文件properties基本语法properties缺点yml配置文件yml基本语法yml配置不同类型数据及nullyml配置对象yml配... 查看详情

springboot配置文件

一配置文件类型    SpringBoot默认支持properties和yml两种格式的配置文件。yml格式是天然的树状接口,相对于properties,yml更加的一目了然。这也是我们推荐的配置文件格式。properties格式举例server.port=8090server.session-timeou... 查看详情

springboot之配置

 回顾:SpringBoot之基础配置文件① 两种全局配置文件(文件名是固定的)  配置文件放在src/main/resources目录或者类路径/config下  application.properties(优先级高)  application.yml/application.yaml  配置文 查看详情

springboot配置文件(代码片段)

一配置文件类型    SpringBoot默认支持properties和yml两种格式的配置文件。yml格式是天然的树状接口,相对于properties,yml更加的一目了然。这也是我们推荐的配置文件格式。properties格式举例server.port=8090server.session-timeou... 查看详情

微服务之springboot自定义配置application.properties文件

配置的文件的格式springboot可以识别两种格式的配置文件,分别是yml和properties文件。我们可以将application.properties文件换成application.yml,这两个文件都可以被SpringBoot自动识别并加载,但是如果是自定义的配置文件,就最好还是使... 查看详情

springboot-yaml配置注入

一、yaml语法①配置文件SpringBoot使用一个全局的配置文件,配置文件名称是固定的application.properties语法结构:key=valueapplication.yml语法结构:key:空格value配置文件的作用:修改SpringBoot自动配置的默认值,因为SpringBoot在底层都给... 查看详情

springboot的配置文件有哪几种格式?

SpringBoot中的配置文件主要有三种格式,properties、yaml、和xml方式。-其中properties格式配置文件后缀是.properties,配置项为:server.port=9090-yaml格式配置文件后缀是.yml,配置项是:server.port:9090在SpringBoot中,使用最广泛的配置文件是ya... 查看详情

springboot:配置文件的作用配置文件的格式properties配置文件yml配置文件(代码片段)

...统的调用密钥等信息配置日志的等级二、配置文件的格式SpringBoot配置文件主要分一下两种格式:.properties和.yml格式【properties和yml】properties可以和yml⼀起存在于⼀个项目当中,当properties和yml⼀起存在⼀个项目中时,... 查看详情

springboot配置文件详解(告别xml)

参考技术A快速学会和掌握SpringBoot的核心配置文件的使用。SpringBoot提供了丰富的外部配置,常见的有:其中核心配置文件我们并不陌生,主要以Key-Value的形式进行配置,其中属性Key主要分为两种:在application.properties添加配置如... 查看详情

springboot系统配置文件application.properties和application.yml(代码片段)

...文件的区别1.系统配置文件application.properties和application.ymlSpringBoot支持两种不同格式的配置文件:一种是Properties,另一种是YML。SpringBoot默认使用application.properties作为系统配置文件,项目创建成功后会默认在resource目录... 查看详情

springboot(代码片段)

...置application-dev.propertiesserver.port=8082配置application.properties#springboot的多环境配置:可以选择激活哪一个配置文件spring.profiles.active=testyaml文件格式配置激活:用"---"分割,表示多个文件server:port:8081spring:profiles:active:---server:port:8082---se... 查看详情

springboot项目application.properties多环境配置文件jar包外部配置文件

一、简介springboot项目application.properties文件存放及使用介绍 二、方法一多环境配置文件我们一般都会有多个应用环境,开发环境、测试环境、生产环境,各个环境的配置会略有不同,我可以根据这个创建多份配置文件,由主... 查看详情

springboot配置

一、配置文件1、SpringBoot使用一个全局的配置文件,配置文件名是固定的   application.properties:配置文件的作用:修改SpringBoot自动配置的默认值;   application.yml:标记语言,以数据为中心,比json、xml等更适合... 查看详情

springboot配置文件(代码片段)

SpringBoot配置文件2,配置文件2.1配置文件格式2.1.1环境准备2.1.2不同配置文件演示2.1.3三种配合文件的优先级2.2yaml格式2.2.1语法规则2.3yaml配置文件数据读取2.3.1环境准备2.3.2读取配置数据2.3.2.1使用@Value注解2.3.2.2Environment对象2... 查看详情

springboot学习笔记--[springboot配置文件之yaml格式,springboot自动配置浅入,springboot集成jdbc](代码片段)

在线生成启动图标https://www.bootschool.net/ascii文章目录1.springBoot配置文件2.浅入springBoot自动配置3.springboot集成JDBC1.springBoot配置文件在springboot中application.properties是默认生成的,这种格式的之前其实已经学过了;就是内容=值即可;目... 查看详情

springboot中yaml文件配置属性

参考技术A首先,在SpringBoot中,有两种配置文件的方式。一种是application.properties,另一种application.yaml(或者是application.yml)。yaml文件格式是SpringBoot支持的一种JSON超集文件格式,相对于传统的Properties配置文件,yaml文件以数据为核... 查看详情

springboot上传文件&不配置虚拟路径访问服务器图片&springboot配置日期的格式化方式(代码片段)

1.  Springboot上传文件  springboot的文件上传不用配置拦截器,其上传方法与SpringMVC一样@RequestMapping("/uploadPicture")@ResponseBodypublicJSONResultUtiluploadPicture(MultipartFilefile,IntegerviewId)if(file==null)re 查看详情