java-读取配置文件自定义字段(yml、properties)

这篇具有很好参考价值的文章主要介绍了java-读取配置文件自定义字段(yml、properties)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、概述

在springboot项目配置文件中设置自定义字段,项目代码按需读取,想换重要参数时直接更改配置文件即可,这篇文章说一说配置文件自定义字段的方法。

二、实现方法

方法1 @Value

使用org.springframework.beans.factory.annotation包下的@Value注解读取yml文件里面的字段,代码如下:

yml文件
server:
  port: 8080

#自定义参数字段
student:
  name: Simon
  age: 23
  sex: male
  height: 185

读取
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

    @Value("${student.name}")
    private String name;

    @Value("${student.age}")
    private String age;

    @Value("${student.sex}")
    private String sex;

    @Value("${student.height}")
    private String height;

    @RequestMapping("/1")
    public Object test(){
        log.info("我叫"+name+",性别是:"+sex+",今年"+age+"岁,我还是个"+height+"cm大高个的帅小伙!");
        return "我叫"+name+",性别是:"+sex+",今年"+age+"岁,我还是个"+height+"cm大高个的帅小伙!";
    }
}
测试结果
java-读取配置文件自定义字段(yml、properties)

方法2:Environment

与@value类似,注入Environment通过配置参数的前缀拿到任何配置文件里配置参数的值,优点是随时随地,便捷,但是配置参数数量多的时候,会造成代码冗余。

/**
 * @ClassName TestController
 * @Author
 * @Date 2023/2/28 0028 16:52
 */
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private Environment environmentConfig;

    @PostMapping("/environment")
    public String testEnvironment(){
        String number = environmentConfig.getProperty("school.role.teacher.number");
        String age = environmentConfig.getProperty("student.age");
        System.out.println("number = " + number);
        System.out.println("age = " + age);
        return null;
    }
}
java-读取配置文件自定义字段(yml、properties)

方法3:@PropertySource()、@ConfigurationProperties()

组合使用@PropertySource()、@ConfigurationProperties()两个注解对springboot项目的properties配置文件的的读取。

properties文件
student.name=simon
student.age=23
student.sex=male
student.height= 185
student.self-assessment=handsome

!!!注意:这里与方法一yml文件采取@Value的方式读取不同,读取properties文件需要建一个读取类(Studentconfig),将properties文件中想读取得字段都注入进去作为该类的属性,再将Student通过@Configuration注解将其当作Bean交给容器管理,需要用的时候将Student整个类注入,在调用get方法得到其属性(即配置文件中的自定义字段)

StudentConfig类
@Configuration
@PropertySource("classpath:application.properties")//读取配置文件
@ConfigurationProperties(prefix="student")//读取节点
@Data
public class StudentConfig {

    private String name;

    private String sex;

    private int age;

    private int height;

    private String selfAssessment;


}
细节注意

Configuration注解的prefix有书写规范,据我本人经验总结

  1. 不可用大写字母

  1. 不可写下划线,两个单词需隔开的话使用横线

  1. 不能使用数字(有博主说可以用数字我自己试了下是不可以的,希望大家避坑)

java-读取配置文件自定义字段(yml、properties)
java-读取配置文件自定义字段(yml、properties)
java-读取配置文件自定义字段(yml、properties)
java-读取配置文件自定义字段(yml、properties)
读取(将StudentConfig整个类注入,再使用get方法调用)
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {
    
    @Autowired
    private StudentConfig student;

    @RequestMapping("/properties")
    public Object test2(){

        return "我叫"+student.getName()+"" +
                ",性别是:"+student.getSex()+
                ",今年"+student.getAge()+
                "岁,我还是个"+student.getHeight()+"cm大高个的帅小伙!" +
                "我对自己的评价是"+student.getSelfAssessment();
    }
得到结果
java-读取配置文件自定义字段(yml、properties)

三、使用@value注解读取yml失效的场景及解决办法(下次更新)

四、嵌套读取properties文件的方法(读取类继承HashMap类)(下次更新)

在项目中有时候需要接入许多不同的企业,每个企业需要不同的配置参数,将不同的配置参数写到配置文件,通过企业传递来的值取得不同的配置参数。

这里以学校的老师和学生为例,在不同角色和不同科目下得到的参数信息文章来源地址https://www.toymoban.com/news/detail-482121.html

配置文件
#老师
##人数
school.role.teacher.number=50
##老师着装
school.role.teacher.wearing=suit
##职责
school.role.teacher.job=teach
##科目
###数学老师的stereotype
####性格
school.role.teacher.subject.math.character=serious
####性别
school.role.teacher.subject.math.sex=male
####年龄
school.role.teacher.subject.math.age=old
###英语老师的imagination
####性格
school.role.teacher.subject.english.character= optimistic
####性别
school.role.teacher.subject.english.sex=female
####年龄
school.role.teacher.subject.english.age=young

#学生
#数量
school.role.student.number=1000
#学生着装
school.role.student.wearing=uniform
#任务
school.role.student.job=study
##科目
###数学课上表现
school.role.student.subject.math.performance=cautious
###英语课上表现
school.role.student.subject.english.performance=happy
配置类
package com.example.test.config;

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

import java.util.HashMap;

/**
 * @ClassName TestConfig
 * @Author
 * @Date 2023/2/28 0028 15:26
 */
@Configuration
@PropertySource("classpath:application.properties")
@ConfigurationProperties(prefix = "school.role")
public class TestConfig extends HashMap<String,TestConfigItem> {

}
角色层
package com.example.test.config;

import lombok.Data;

/**
 * @ClassName TestConfigItem
 * @Author
 * @Date 2023/2/28 0028 15:27
 */
@Data
public class TestConfigItem {

    /**
     * 数量
     */
    private int number;

    /**
     * 穿着
     */
    private String wearing;

    /**
     * 职责
     */
    private String job;

    /**
     * 科目
     */
    private InnerConfig subject;
}
package com.example.test.config;

import lombok.Data;

import java.util.HashMap;

/**
 * @ClassName InnerConfig
 * @Author
 * @Date 2023/2/28 0028 15:48
 */
@Data
public class InnerConfig extends HashMap<String,InnerConfigItem> {
}
科目层
package com.example.test.config;

import lombok.Data;

/**
 * @ClassName InnerConfigItem
 * @Author
 * @Date 2023/2/28 0028 15:49
 */
@Data
public class InnerConfigItem {

    /**
     * 性格
     */
    private String character;

    /**
     *性别
     */
    private String sex;

    /**
     *年龄
     */
    private String age;

    /**
     *学生表现
     */
    private String performance;
}
读取
package com.example.test.controller;

import com.example.test.config.InnerConfigItem;
import com.example.test.config.TestConfig;
import com.example.test.config.TestConfigItem;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * @ClassName TestController
 * @Author
 * @Date 2023/2/28 0028 16:52
 */
@Slf4j
@RestController
@RequestMapping("/test")
public class TestController {

    @Autowired
    private TestConfig config;

    @GetMapping("/properties/{role}/{subject}")
    public String testProperties(@PathVariable String role,@PathVariable String subject){
        String result= null;
        TestConfigItem testConfigItem = config.get(role);
        int number = testConfigItem.getNumber();
        String wearing = testConfigItem.getWearing();
        String job = testConfigItem.getJob();

        InnerConfigItem innerConfigItem = testConfigItem.getSubject().get(subject);
        String age = innerConfigItem.getAge();
        String character = innerConfigItem.getCharacter();
        String sex = innerConfigItem.getSex();


        if ("student".equals(role)){
            String performance = innerConfigItem.getPerformance();
             result = "目前角色是"+role+",人数为"+number+",职责是"+job+",穿着"+wearing+"。在"+subject+"课上的表现是"+performance+"。";
            return result;
        }
         result = "目前角色是"+role+",人数为"+number+",职责是"+job+",穿着"+wearing+"。" +
                 "在"+subject+"课上是"+character+"的,年龄是"+age+",性别是"+sex+"。";
        return result;
    }
}
结果
java-读取配置文件自定义字段(yml、properties)
java-读取配置文件自定义字段(yml、properties)
java-读取配置文件自定义字段(yml、properties)
java-读取配置文件自定义字段(yml、properties)

到了这里,关于java-读取配置文件自定义字段(yml、properties)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Spring Boot读取yml或者properties配置信息

    编写配置类 开始使用

    2024年02月14日
    浏览(58)
  • Java代码读取properties配置文件

    Properties 继承于 Hashtable。表示一个持久的属性集.属性列表中每个键及其对应值都是一个字符串。 HashTable是一个线程安全的类,它使用synchronized来锁住整张Hash表来实现线程安全,即每次锁住整张表让线程独占,相当于所有线程进行读写时都去竞争一把锁,导致效率非常低下。

    2024年02月02日
    浏览(70)
  • Java读取Properties配置文件的6种方式

    项目结构:经典的maven项目结构 配置文件1和2内容一致: 方法1和2区别: (classpath即为target/classes 这个目录) Class.getResourceAsStream() 从当前类所在的位置开始查找配置文件位置。要找到jdbc.properties和jdbc2.properties必须加/从classpath下开始查找 Class.getClassLoader().getResourceAsStream() 默

    2024年02月02日
    浏览(43)
  • SpringBoot的配置文件(properties与yml)

    SpringBoot 项目中所有重要的数据都是在配置文件中配置的,比如∶ 数据库的连接信息(包含用户名和密码的设置); 项目的启动端口; 第三方系统的调用秘钥等信息; 用于发现和定位问题的普通日志和异常日志; 还可以自定义配置,如配置上传文件的保存地址信息等。 想

    2024年02月12日
    浏览(38)
  • Spring Boot配置文件:properties 与 yml 的竞争

    本文,我们就要来介绍一下Spring Boot中的配置文件 ,在学习了本文之后,可以很清楚地知道如何在Spring Boot中去配置项目的一些系统设置 首先我们先来聊聊什么是配置文件? 配置文件是一种 文本文件 ,通常用于存储程序的参数和设置。它包含了程序运行所需的各种选项和配

    2024年02月04日
    浏览(64)
  • JavaEE进阶(6)SpringBoot 配置文件(作用、格式、properties配置文件说明、yml配置文件说明、验证码案例)

    接上次博客:JavaEE进阶(5)Spring IoCDI:入门、IoC介绍、IoC详解(两种主要IoC容器实现、IoC和DI对对象的管理、Bean存储、方法注解 @Bean)、DI详解:注入方式、总结-CSDN博客 目录 配置文件作用 SpringBoot配置文件  配置文件的格式 properties 配置文件说明 properties 基本语法 读取配置

    2024年01月23日
    浏览(67)
  • springboot的配置文件如何配置可以实现多个yml相互读取

    在Spring Boot中,可以通过多种方式来实现配置文件的相互读取和组合。如果你想要在一个Spring Boot应用中使用多个YAML( .yml )配置文件,并且希望这些配置文件可以相互读取或者互相覆盖某些配置,你可以采用以下几种方法: 1. 使用 spring.config.import 属性(Spring Boot 2.4及以上版

    2024年02月20日
    浏览(49)
  • Spring的配置文件,如何配置端口号,,properties,yml获取配置项等方法,外观模式及其优缺点,日志代表的信息

    目录 一、回顾 二.如何配置端口号 配置文件,最重要的目的:解决硬编码问题-代码写死 1.常见配置项 yml获取配置项 多次获取配置项(yml会对我们的参数情况,进行的一定类型转换比如数字10,转换成“10”) null:使用key后面+-(破折号) 空字符串:key后面之间空着,但是不易读

    2024年02月04日
    浏览(60)
  • SpringBoot支持bootstrap.yml/bootstrap.properties配置文件,需要导入spring-cloud-starter-bootstrap依赖

    说明: 在SpringBoot 2.4.x版本之后,对于bootstrap.properties/bootstrap.yaml配置文件的支持,需要导入如下依赖: 注意: 1、导入依赖后,还需要开启 spring.cloud.bootstrap.enabled=true 2、spring cloud starter alibaba nacos config,引用这个配置中心的依赖后,需要使用bootstrap.yml或bootstrap.properties 作

    2024年02月13日
    浏览(60)
  • 17、YML配置文件及让springboot启动时加载我们自定义的yml配置文件的几种方式

    其实本质和.properties文件的是一样的。 Spring Boot默认使用SnakeYml工具来处理YAML配置文件,SnakeYml工具默认就会被spring-boot-starter导入,因此无需开发者做任何额外配置。 YAML本质是JSON的超级,它在表示结构化文档时更有表现力。 ▲ properties文件使用 .分隔符 作为结构化的表现:

    2024年02月14日
    浏览(48)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包