AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

springboot学习三：Spring Boot 配置文件语法、静态工具类读取配置文件、静态工具类读取配置文件

2024-10-18 63
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 这篇文章介绍了Spring Boot中配置文件的语法、如何读取配置文件以及如何通过静态工具类读取配置文件。

导言

一、配置文件语法

1. 了解配置文件

当我们使用spring 初始化器构建完一个Spring Boot项目后，只需引入一个web启动器的依赖，它就变成一个web项目了，而且呢我们 什么都没有配置就能通过localhost:8080进行访问了，那这是为什么呢?

那是因为Spring Boot在底层已经把配置信息都给我们自动配置好了。 那我们怎么去修改默认配置信息?

在使用Spring 初始化器创建一个Springboot项目的时候会在resources目录下自动生成一个文件 application.properties，这是一个空 文件，它的作用是提供我们修改默认配置信息的入口。

Spring Boot还提供给我们另外一种风格的配置文件 application.yml，虽然是两个不同的文件但是本质是一样的，区别只是其中的语法 略微不同。下面我们就来一一介绍一下这两种不同风格的配置文件。

2. Properties 语法

application.properties 配置文件比较简单，形式如下

  • key = value

不需要空格进行区分，父属性和子属性之间是以“.”进行区分的

3. YML 语法

  1. 大小写敏感。
  2. k:(空格)v:表示一对键值对(空格必须有)，以空格的缩进来控制层级关系。
  3. 只要是左对齐的一列数据，则表示都是同一个层级的。
  4. “#” 表示注释，从这个字符一直到行尾，都会被解析器忽略。

4. 例子

我们写一个简单的例子看看它们之间的区别：配置端口号

  • 以前是这样配置的

    <server>
  <port>8080</port>
</server>

  • 现在是这样配置的

    • application.yml

      server:
  port: 8080

    • application.properties

      server.port=8080

二、配置文件读取

1. 创建工程

  • 项目细节
    在这里插入图片描述

  • 项目依赖
    在这里插入图片描述

  • 项目结构
    在这里插入图片描述

  • 配置流程

    1. 在配置文件加上配置信息
    2. 创建一个Person实体类用来验证@Value 读取配置文件属性是否成功
    3. 创建一个PersonConfig 配置类读取属性
    4. 把属性set到Person注入到容器
    5. 单元测试拿到person实例打印它

2. 简单的数据类型读取-@Value

a、修改配置文件 application

我这里使用第一种方式

  • 修改 application.properties

    #基本类型 
person.userName=zhangsan 
person.age=29 
person.salary=22000 
person.sex=male

  • 或者 修改为 application.yml (和application.properties本质一样 两者选其一 )

    person:
  userName: zhangsan
  age: 29
  salary: 220000
  sex: male

b、属性注入类

创建: bean.Person.java javabean

package com.feng.springBoot_configuration_properties.Bean;

public class Person {
    private String userName;
    private int age;
    private double salary;
    private String sex;

    @Override
    public String toString() {
        return "Person{" +
                "userName='" + userName + '\'' +
                ", age=" + age +
                ", salary=" + salary +
                ", sex='" + sex + '\'' +
                '}';
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public double getSalary() {
        return salary;
    }

    public void setSalary(double salary) {
        this.salary = salary;
    }

    public String getSex() {
        return sex;
    }

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

c、 声明配置类

创建 config.PersonConfig.java 配置类

package com.feng.springBoot_configuration_properties.config;

import com.feng.springBoot_configuration_properties.bean.Person;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class PersonConfig {
    @Value("${person.userName}")
    private String userName;
    @Value("${person.age}")
    private int age;
    @Value("${person.salary}")
    private double salary;
    @Value("${person.sex}")
    private String sex;

    @Bean
    public Person getPerson(){
        Person person=new Person();
        person.setSex(sex);
        person.setAge(age);
        person.setUserName(userName);
        person.setSalary(salary);
        return person;
    }
}

d、单元测试

创建 SpringBootConfigurationPropertiesApplicationTests Junit 单元测试

package com.feng.springBoot_configuration_properties;

import com.feng.springBoot_configuration_properties.bean.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBootConfigurationPropertiesApplicationTests {

    @Autowired
    private Person person;

    @Test
    void contextLoads() {
    }

    @Test
    public void testPerson(){
        System.out.println(person.toString());
    }

}

测试输出
在这里插入图片描述

e、解读

  • @Configuration :声明我们PersonConfig 是一个配置类
  • 通过 @Value 为属性注入值
  • 通过 @Bean Spring会自动调用该方法，将方法的返回值加入Spring容器中

f、项目结构

在这里插入图片描述

3. 配置文件读取- @ConfigurationProperties

  • 配置流程
    1. 配置文件配置复杂的内容
    2. 创建映射实体
    3. 屏蔽PersonConfig 配置类的代码
    4. 修改 Person 实体类
    5. 打印person实体

a、修改配置文件 application

我这里使用第二种方式

  • application.Properties

    #基本类型 
person.userName=zhangsan 
person.age=29 
person.salary=22000 
person.sex=male
#array
person.pets=dog,cat
#map 
person.friend.userName=wangwu 
person.friend.age=28
#list
person.list[0]=value1 
person.list[1]=value2 
#list嵌套Map/对象 
person.children[0].name=ting 
person.children[0].weight=2 
person.children[1].name=hao 
person.children[1].weight=5 
#对象嵌套对象 
person.employee.name=lisi 
person.employee.age=21

  • 或者是 修改为 application.yml

#基本类型
#person.userName=zhangsan
#person.age=29
#person.salary=22000
#person.sex=male

persontwo:
  userName: zhangsan        # String userName
  age: 29
  salary: 220000
  sex: male
  pets: cat,dog             # String[] pets
  friend:                   # Map<String,String> friend;
    userName: wangwu
    age: 27
  list:                     # List<String> list;
    - value1
    - value2
  children:                 # List<Map<String,String>> children
    - name: ting
      weight: 2
    - name: hao
      weight: 5
  employee:                 # Employee employee
    name: lisi
    age: 21

b、修改 PersonConifg

在这里插入图片描述

c、创建 Employee 实体类

package com.feng.springBoot_configuration_properties.bean;

public class Employee {
    private String name;
    private String age;

    @Override
    public String toString() {
        return "Employee{" +
                "name='" + name + '\'' +
                ", age='" + age + '\'' +
                '}';
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAge() {
        return age;
    }

    public void setAge(String age) {
        this.age = age;
    }
}

d、创建 PersonTwo 实体类

  1. 在Person类的基础上 增加了几个集合属性 变为 PersonTwo
  2. 并添加了两个注解 @ConfigurationProperties(prefix = "personTwo") 和 @Component
  3. 代码
package com.feng.springBoot_configuration_properties.bean;

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

import java.util.Arrays;
import java.util.List;
import java.util.Map;

@ConfigurationProperties(prefix = "personTwo")
@Component
public class PersonTwo {
    private String userName;
    private int age;
    private double salary;
    private String sex;
    //array
    private String[] pets;
    //map
    private Map<String,String> friend;
    //list
    private List<String> list; //list嵌套对象或者map
    private List<Map<String,String>> children; //对象嵌套对象
    private Employee employee;

    @Override
    public String toString() {
        return "PersonTwo{" +
                "userName='" + userName + '\'' +
                ", age=" + age +
                ", salary=" + salary +
                ", sex='" + sex + '\'' +
                ", pets=" + Arrays.toString(pets) +
                ", friend=" + friend +
                ", list=" + list +
                ", children=" + children +
                ", employee=" + employee +
                '}';
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public double getSalary() {
        return salary;
    }

    public void setSalary(double salary) {
        this.salary = salary;
    }

    public String getSex() {
        return sex;
    }

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

    public String[] getPets() {
        return pets;
    }

    public void setPets(String[] pets) {
        this.pets = pets;
    }

    public Map<String, String> getFriend() {
        return friend;
    }

    public void setFriend(Map<String, String> friend) {
        this.friend = friend;
    }

    public List<String> getList() {
        return list;
    }

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

    public List<Map<String, String>> getChildren() {
        return children;
    }

    public void setChildren(List<Map<String, String>> children) {
        this.children = children;
    }

    public Employee getEmployee() {
        return employee;
    }

    public void setEmployee(Employee employee) {
        this.employee = employee;
    }
}

e、单元测试

需要将原来的Person 给注释掉，因为application的后缀变了，所以PersonConfig连带起来都要改变。

package com.feng.springBoot_configuration_properties;

import com.feng.springBoot_configuration_properties.bean.PersonTwo;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBootConfigurationPropertiesApplicationTests {

//    @Autowired
//    private Person person;

    @Autowired
    private PersonTwo personTwo;

    @Test
    void contextLoads() {
    }

    @Test
    public void testPerson(){
//        System.out.println(person.toString());
    }

    @Test
    public void testPersonTwo(){
        System.out.println(personTwo.toString());
    }

}
  • 测试结果
    在这里插入图片描述

f. 注解解读

  • @ConfigurationProperties 注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。
    • prefix = "person" :声明配置前戳，将该前戳下的所有属性进行映射。
  • @Component 将该组件加入Spring Boot容器，只有这个组件是容器中的组件，配置才生效。

g、项目结构

在这里插入图片描述

三、 静态工具类读取配置文件

在日常开发中经常会遇到这种情况，就是有一些方法经常用到但是呢又需要外部的一些静态常量(各个环境的值是不一样的)进行组装， 所以呢我们会把这些方法抽出来统一放在一个工具类里面，大家也知道通常来说工具类里面都是一些静态的方法，后续在其它地方使 用的时候直接工具类.方法就可以了。但是呢我们的方法改成静态方法后，里面用到的变量也同样要改成静态的变量，这里就涉及到了 静态属性的注入问题了，如果我们还像上小节那样用 @Value 直接注入是注入不进来的。
那么我们怎么去改造呢?怎么才能把它 注入到静态的变量 呢?好下面我们就来实践一下。

  1. 加入配置文件信息
  2. 新增一个配置读取类:TokenSettings
  3. 新增静态工具类 :JwtTokenUtil
  4. 创建一个代理工具类:StaticInitializerUtil
  5. 单元测试

1. 配置文件信息application.yml

以后都采用application.yml方式进行配对

#JWT 密钥 
jwt:
  secretKey: xxxxfjcxxx
  issuer: fengjianchi.com

2. 新增 配置读取类 TokenSettings

package com.feng.springBoot_configuration_properties.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "jwt")
public class TokenSettings {
    private String secretKey;
    private String  issuer;

    @Override
    public String toString() {
        return "TokenSettings{" +
                "secretKey='" + secretKey + '\'' +
                ", issuer='" + issuer + '\'' +
                '}';
    }

    public String getSecretKey() {
        return secretKey;
    }

    public void setSecretKey(String secretKey) {
        this.secretKey = secretKey;
    }

    public String getIssuer() {
        return issuer;
    }

    public void setIssuer(String issuer) {
        this.issuer = issuer;
    }
}

3. 创建一个 JwtTokenUtil

package com.feng.springBoot_configuration_properties.config;

public class JwtTokenUtil {
    private static String secretKey;
    private static String  issuer;

    public static void setTokenSettings(TokenSettings tokenSettings){
        secretKey = tokenSettings.getSecretKey();
        issuer = tokenSettings.getIssuer();
    }

    public static String getSecretKey(){
        return secretKey;
    }

    public static String getIssuer(){
        return issuer;
    }
}

4. 创建一个代理类 StaticInitializerUtil

package com.feng.springBoot_configuration_properties.config;

import org.springframework.stereotype.Component;

@Component
public class StaticInitializerUtil {
    private TokenSettings tokenSettings;

    public StaticInitializerUtil(TokenSettings tokenSettings) {
        JwtTokenUtil.setTokenSettings(tokenSettings);
    }
}

5. 单元测试

@Test
public void testStaticUtil(){
    System.out.println("secretKey="+JwtTokenUtil.getSecretKey());
    System.out.println("issuer="+JwtTokenUtil.getIssuer());
}

6. 测试结果失败，原因不详

文章标签：
Java
Spring
测试技术
容器
关键词：
Spring配置文件
Spring boot学习
Spring Boot spring
学习Spring
Spring Boot学习spring
java冯坚持
目录
相关文章
我是快乐的嘟嘟
|
2月前
|
Java API Spring
在 Spring 配置文件中配置 Filter 的步骤
【10月更文挑战第21天】在 Spring 配置文件中配置 Filter 是实现请求过滤的重要手段。通过合理的配置，可以灵活地对请求进行处理，满足各种应用需求。还可以根据具体的项目要求和实际情况，进一步深入研究和优化 Filter 的配置，以提高应用的性能和安全性。
我是快乐的嘟嘟
146 59
喜欢猪猪
|
21天前
|
前端开发 Java 开发者
Spring生态学习路径与源码深度探讨
【11月更文挑战第13天】Spring框架作为Java企业级开发中的核心框架，其丰富的生态系统和强大的功能吸引了无数开发者的关注。学习Spring生态不仅仅是掌握Spring Framework本身，更需要深入理解其周边组件和工具，以及源码的底层实现逻辑。本文将从Spring生态的学习路径入手，详细探讨如何系统地学习Spring，并深入解析各个重点的底层实现逻辑。
喜欢猪猪
44 9
蓝易云
|
16天前
|
Java 数据库连接 数据库
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项，在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件，可以确保应用程序在启动阶段加载正确的配置，并顺利启动运行。
蓝易云
41 2
刘大猫.
|
28天前
|
Java Spring 容器
SpringBoot读取配置文件的6种方式，包括：通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式，包括：通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
刘大猫.
56 3
iamzfh
|
2月前
|
前端开发 Java 数据库
SpringBoot学习
【10月更文挑战第7天】Spring学习
iamzfh
36 9
iamzfh
|
2月前
|
XML Java 数据格式
Spring学习
【10月更文挑战第6天】Spring学习
iamzfh
21 1
java冯坚持
|
2月前
|
Java 测试技术 开发者
springboot学习四：Spring Boot profile多环境配置、devtools热部署
这篇文章主要介绍了如何在Spring Boot中进行多环境配置以及如何整合DevTools实现热部署，以提高开发效率。
java冯坚持
70 2
java冯坚持
|
2月前
|
前端开发 Java 程序员
springboot 学习十五：Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
java冯坚持
114 1
艾利克斯冰
|
3月前
|
消息中间件 NoSQL 安全
（转）Spring Boot加载 不同位置的 application.properties配置文件顺序规则
这篇文章介绍了Spring Boot加载配置文件的顺序规则，包括不同位置的application.properties文件的加载优先级，以及如何通过命令行参数或环境变量来指定配置文件的名称和位置。
艾利克斯冰
81 0
叶落闲庭
|
7月前
|
Java 容器 Spring
Spring的加载配置文件、容器和获取bean的方式
Spring的加载配置文件、容器和获取bean的方式
叶落闲庭
54 3
Spring的加载配置文件、容器和获取bean的方式

热门文章

最新文章

  • 1
    SpringBoot 实战：加载和读取资源文件
  • 2
    SpringBoot项目中使用request.getInputStream()获取参数时出现java.io.IOException: Stream closed
  • 3
    SpringBoot集成Flyway
  • 4
    13.14 SpringBoot集成JSP模板引擎：JSP页面样式乱掉
  • 5
    java springboot集成微信小程序【详细教程】
  • 6
    springboot实现用户统一认证、管理（单点登录）
  • 7
    SpringBoot3整合SpringSecurity，实现自定义接口权限过滤（二）
  • 8
    Java 毕业设计，基于 SpringBoot 的前后端分离的高校招生管理系统（一）
  • 9
    【Shiro】Springboot集成Shiro（四）
  • 10
    SpringBoot实现文件的上传下载
  • 1
    Spring高手之路18——从XML配置角度理解Spring AOP
    91
  • 2
    Spring Boot中一般如何使用线程池？
    716
  • 3
    Spring Boot 源码面试知识点
    94
  • 4
    【MongoDB 专栏】MongoDB 与 Spring Boot 的集成实践
    241
  • 5
    深入探索Spring Boot Web应用源码及实战应用
    98
  • 6
    ruoyi-nbcio从spring2.7.18升级springboot到3.1.7，java从java8升级到17（二）
    320
  • 7
    springboot全局自定义异常
    39
  • 8
    RabbitMQ的springboot项目集成使用-01
    143
  • 9
    什么是Spring Boot 自动配置？
    50
  • 10
    Spring cloud原理详解
    72

    • 相关课程

    更多
  • 全面讲解Spring Cloud Alibaba技术栈（知识精讲+项目实战）第二阶段
  • 精通Spring Cloud Alibaba
  • 微服务框架 Spring Cloud 快速入门
  • Java Web开发系列课程 - Spring框架入门
  • Spring Boot 2.5.x开发实战
  • Spring Cloud微服务架构设计与开发实战

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库

    • 相关实验场景

    更多
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月