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

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

2024-10-18 6
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 这篇文章介绍了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
测试技术
容器
java冯坚持
目录
相关文章
石臻臻的杂货铺
|
1天前
|
编解码 Java 程序员
写代码还有专业的编程显示器？
写代码已经十个年头了, 一直都是习惯直接用一台Mac电脑写代码 偶尔接一个显示器, 但是可能因为公司配的显示器不怎么样, 还要接转接头 搞得桌面杂乱无章，分辨率也低，感觉屏幕还是Mac自带的看着舒服
石臻臻的杂货铺
3679 2
绿水长流*z
|
3天前
|
存储 缓存 关系型数据库
MySQL事务日志-Redo Log工作原理分析
事务的隔离性和原子性分别通过锁和事务日志实现，而持久性则依赖于事务日志中的`Redo Log`。在MySQL中，`Redo Log`确保已提交事务的数据能持久保存，即使系统崩溃也能通过重做日志恢复数据。其工作原理是记录数据在内存中的更改，待事务提交时写入磁盘。此外，`Redo Log`采用简单的物理日志格式和高效的顺序IO，确保快速提交。通过不同的落盘策略，可在性能和安全性之间做出权衡。
绿水长流*z
1540 5
弹性计算-百晓生
|
1月前
|
弹性计算 人工智能 架构师
阿里云携手Altair共拓云上工业仿真新机遇
2024年9月12日，「2024 Altair 技术大会杭州站」成功召开，阿里云弹性计算产品运营与生态负责人何川，与Altair中国技术总监赵阳在会上联合发布了最新的“云上CAE一体机”。
弹性计算-百晓生
82310 25
阿里云携手Altair共拓云上工业仿真新机遇
乘风直上
|
7天前
|
人工智能 Rust Java
10月更文挑战赛火热启动，坚持热爱坚持创作！
开发者社区10月更文挑战，寻找热爱技术内容创作的你，欢迎来创作！
乘风直上
577 22
绿水长流*z
|
3天前
|
存储 SQL 关系型数据库
彻底搞懂InnoDB的MVCC多版本并发控制
本文详细介绍了InnoDB存储引擎中的两种并发控制方法：MVCC（多版本并发控制）和LBCC（基于锁的并发控制）。MVCC通过记录版本信息和使用快照读取机制，实现了高并发下的读写操作，而LBCC则通过加锁机制控制并发访问。文章深入探讨了MVCC的工作原理，包括插入、删除、修改流程及查询过程中的快照读取机制。通过多个案例演示了不同隔离级别下MVCC的具体表现，并解释了事务ID的分配和管理方式。最后，对比了四种隔离级别的性能特点，帮助读者理解如何根据具体需求选择合适的隔离级别以优化数据库性能。
绿水长流*z
201 3
大模型服务小助手
|
10天前
|
JSON 自然语言处理 数据管理
阿里云百炼产品月刊【2024年9月】
阿里云百炼产品月刊【2024年9月】，涵盖本月产品和功能发布、活动，应用实践等内容，帮助您快速了解阿里云百炼产品的最新动态。
大模型服务小助手
355 6
阿里云百炼产品月刊【2024年9月】
爱吃龙利鱼
|
10天前
|
Linux 虚拟化 开发者
一键将CentOs的yum源更换为国内阿里yum源
一键将CentOs的yum源更换为国内阿里yum源
爱吃龙利鱼
571 5
Ganos全空间数据库
|
23天前
|
存储 关系型数据库 分布式数据库
GraphRAG：基于PolarDB+通义千问+LangChain的知识图谱+大模型最佳实践
本文介绍了如何使用PolarDB、通义千问和LangChain搭建GraphRAG系统，结合知识图谱和向量检索提升问答质量。通过实例展示了单独使用向量检索和图检索的局限性，并通过图+向量联合搜索增强了问答准确性。PolarDB支持AGE图引擎和pgvector插件，实现图数据和向量数据的统一存储与检索，提升了RAG系统的性能和效果。
Ganos全空间数据库
1593 119
椰椰椰耶
|
6天前
|
XML 安全 Java
【Maven】依赖管理，Maven仓库，Maven核心功能
【Maven】依赖管理，Maven仓库，Maven核心功能
椰椰椰耶
233 3
瓴羊Dataphin
|
9天前
|
存储 人工智能 搜索推荐
数据治理，是时候打破刻板印象了
瓴羊智能数据建设与治理产品Datapin全面升级，可演进扩展的数据架构体系为企业数据治理预留发展空间，推出敏捷版用以解决企业数据量不大但需构建数据的场景问题，基于大模型打造的DataAgent更是为企业用好数据资产提供了便利。
瓴羊Dataphin
327 2