0


Spring Boot Application.properties和yaml配置文件

文章目录


一、全局配置文件概述

全局配置文件能够对一些默认配置值进行修改。Spring Boot使用一个application.properties或者application.yaml的文件作为全局配置文件,该文件存放在src/main/resource目录或者类路径的/config,一般会选择resource目录。

二、Application.properties配置文件

(一)创建Spring Boot的Web项目PropertiesDemo

使用Spring Initializr方式创建项目——PropertiesDemo
在这里插入图片描述
单击【Next】按钮
在这里插入图片描述

添加Web和DevTools依赖
在这里插入图片描述
单击【Create】按钮
在这里插入图片描述
设置项目编码为utf8(尤其注意复选框)
在这里插入图片描述

(二)在应用属性文件里添加相关配置

点开resource目录,查看应用程序属性配置文件
在这里插入图片描述

1、配置服务器端口号和web虚拟路径

在application.properties文件里配置
在这里插入图片描述

# 设置服务端口号
server.port=8888# 设置web虚拟路径
server.servlet.context-path=/lzy

更多配置属性,详见官网

启动应用,查看控制台
在这里插入图片描述

2、对象类型的配置与使用

(1)创建Pet类

在net.army.boot里创建bean子包,在子包里创建Pet类
在这里插入图片描述

packagenet.army.boot.bean;/**
 * 作者:梁辰兴
 * 日期:2023/5/31
 * 功能:宠物类
 */publicclassPet{privateString type;// 类型privateString name;// 名字publicStringgetType(){return type;}publicvoidsetType(String type){this.type = type;}publicStringgetName(){return name;}publicvoidsetName(String name){this.name = name;}@OverridepublicStringtoString(){return"Pet{"+"type='"+ type +'\''+", name='"+ name +'\''+'}';}}
(2)创建Person类

在net.army.boot里创建bean子包,在子包里创建Person类

在这里插入图片描述

packagenet.army.boot.bean;importjava.util.List;importjava.util.Map;/**
 * 作者:梁辰兴
 * 日期:2023/5/31
 * 功能:人类
 */publicclassPerson{privateint id;// 编号privateString name;// 姓名privateList<String> hobby;// 爱好;privateMap<String,String> family;// 家庭成员privatePet pet;// 宠物publicintgetId(){return id;}publicvoidsetId(int id){this.id = id;}publicStringgetName(){return name;}publicvoidsetName(String name){this.name = name;}publicList<String>getHobby(){return hobby;}publicvoidsetHobby(List<String> hobby){this.hobby = hobby;}publicMap<String,String>getFamily(){return family;}publicvoidsetFamily(Map<String,String> family){this.family = family;}publicPetgetPet(){return pet;}publicvoidsetPet(Pet pet){this.pet = pet;}@OverridepublicStringtoString(){return"Person{"+"id="+ id +", name='"+ name +'\''+", hobby="+ hobby +", family="+ family +", pet="+ pet +'}';}}
(3)在应用属性文件里配置对象

配置Person对象属性
在这里插入图片描述

# 配置对象
person.id=1
person.name=张三丰
person.hobby=旅游,美食,音乐
person.family.father=张云光
person.family.mother=吴文燕
person.family.grandpa=张宏宇
person.famliy.grandma=唐雨欣
person.family.son=张君宝
person.family.daughter=张晓敏
person.pet.type=泰迪犬
person.pet.name=瑞瑞
(4)给Person类添加注解

添加注解@Component,交给Spring去管理
在这里插入图片描述
添加注解@ConfigurationProperties(prefix = “person”)
在这里插入图片描述

注意:采用@ConfigurationProperties注解方式,必须要有set方法,才会自动为Person类所有属性注入相应的值,包括简单类型和复杂类型

配置Spring Boot注解处理器,去掉红色光条里的提示信息
在这里插入图片描述

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

此时,红色框警告信息不见了
在这里插入图片描述

(5)给Pet类添加注解

添加注解@Component,交给Spring去管理
添加注解@ConfigurationProperties(prefix = “person.pet”) - 可以不用添加
在这里插入图片描述

(6)从Spring容器里获取Person类的实例并输出

实现接口ApplicationContextAware,实现其抽象方法setApplicationContext
在这里插入图片描述
声明ApplicationContext对象,并在setApplicationContext里初始化
在这里插入图片描述创建测试方法testPerson(),从Spring容器中获取Person类的实例并输出
在这里插入图片描述
运行测试方法testPerson(),查看结果
在这里插入图片描述查看测试类PropertiesDemoApplicationTests代码

packagenet.army.boot;importnet.army.boot.bean.Person;importorg.junit.jupiter.api.Test;importorg.springframework.beans.BeansException;importorg.springframework.boot.test.context.SpringBootTest;importorg.springframework.context.ApplicationContext;importorg.springframework.context.ApplicationContextAware;@SpringBootTestclassPropertiesDemoApplicationTestsimplementsApplicationContextAware{privateApplicationContext context;// 应用容器@TestvoidcontextLoads(){}@OverridepublicvoidsetApplicationContext(ApplicationContext applicationContext)throwsBeansException{
        context = applicationContext;}@TestpublicvoidtestPerson(){// 按名称从应用容器中获取Person对象Person person =(Person) context.getBean("person");// 输出Person对象System.out.println(person);}}
(7)从Spring容器里获取Pet类的实例并输出

查看Pet类的注解,有配置属性的注解@ConfigurationProperties(prefix = “person.pet”)
在这里插入图片描述
在测试类里添加测试方法testPet()
在这里插入图片描述
运行测试方法testPet(),查看结果
在这里插入图片描述
注释掉Pet类的配置属性的注解@ConfigurationProperties(prefix = “person.pet”)
在这里插入图片描述再次运行测试方法testPet(),查看结果
在这里插入图片描述
修改应用属性文件,配置宠物对象
在这里插入图片描述再次运行测试方法testPet(),查看结果
在这里插入图片描述可以看到,宠物对象的属性依然没有被注入,下面我们换一种属性注解的方式,采用@Value注解方式。

给Pet类的属性添加值注解@Value
在这里插入图片描述
再次运行测试方法testPet(),查看结果
在这里插入图片描述

3、两种属性注解方式的对比

采用@ConfigurationProperties注解方式,必须要有set方法,才会自动为所注解的类的全部属性注入相应的值,包括简单类型和复杂类型(List、Map、Pet……)。

采用@Value注解方式,优点在于可以不要set方法,但是有两点不足:其一、需要一个一个地注入,显得麻烦;其二、对于复杂类型不能注入,比如Map、List、Pet等。

三、Application.yaml配置文件

1、备份application.properties文件

文件更名为application.back,即让此文件不起作用
在这里插入图片描述

2、创建application.yaml文件

在resoures目录里创建application.yaml文件
在这里插入图片描述
配置服务器属性
在这里插入图片描述

# 配置服务器
server:
  port:8888 # 配置端口号
  servlet:
    context-path:/lzy # 配置虚拟路径

# 配置person对象
person:
  id:1
  name: 张三丰
  hobby:
    旅游,
    美食,
    音乐
  family:{
    father: 张云光,
    mother: 吴文燕,
    grandpa: 张宏宇,
    grandma: 唐雨欣,
    son: 张君宝,
    daughter: 张晓敏
  }
  pet:
    type: 泰迪犬
    name: 瑞瑞

# 配置pet对象
pet:
  type: 泰迪犬
  name: 瑞瑞

3、运行测试方法testPerson(),查看结果

运行testPerson()方法
在这里插入图片描述

4、运行测试方法testPet(),查看结果

运行测试方法testPet()
在这里插入图片描述

四、两种配置文件的比较

1、application.properties配置文件

  • 采用XML语法,键值对:键=值,没有层次结构
  • 如果值里有汉字,必须得转成unicode,否则会出现乱码问题

2、application.yaml配置文件

  • 采用YAML语法,键值对:键: 值(冒号与值之间有空格),具有层次结构
  • 允许值里有汉字,不必转成unicode,也不会出现乱码问题

五、课后作业

任务:创建StudentInfo项目输出学生信息

在net.army.boot包里创建bean子包,在子包里创建Student类

添加属性

privateString id;privateString name;privateString gender;privateint age;privateString major;privateString telephone;privateString email;privateList<String> hobbies;

添加getter和setter

添加toString()方法

添加注解@Component

添加注解@ConfigureProperties

将application.properties更名为application.yaml

在应用属性文件里配置student对象

修改控制器StudentInfoController,创建getStudent()方法,返回student对象

运行入口类,在浏览器里访问http://localhost:8080/getStudent

标签: spring boot java spring

本文转载自: https://blog.csdn.net/m0_62617719/article/details/130834003
版权归原作者 梁辰兴 所有, 如有侵权,请联系我们删除。

“Spring Boot Application.properties和yaml配置文件”的评论:

还没有评论