jjzjj

SpringBoot读取.yml配置文件最常见的两种方式-源码及其在nacos的应用

小王写博客 2023-04-17 原文

一、前言

我们在开发中会经常遇到一些可能会变的值，比如数据库的密码，一些关键链接的配置等等。

都需要我们写在配置文件中，这样可以把这些配置文件放到nacos上进行管理，修改nacos的配置，咱们发布的包就可以动态的进行更新了，不需要重新修改打包在重新发包！

咱们今天就来说一说读取配置文件中的值常见的两种方法，刚刚说的动态更新配置的是第二种配置哈！@Value("${school.teacher}")不会动态更新，所以小编推荐使用第二种方式@ConfigurationProperties(prefix = "school")进行读取配置文件！下面小编 也会带大家一起演示一下不需要重启项目就可以动态的更新，在生产上非常的好用！！！

二、第一种方式

第一种方式比较场景，也是最简单的，就是@Value($(配置文件中的参数))

我们首先在application.yml文件中写一个配置：

school:
 teacher: 王老师
 student: 小明

这里key的冒号后面一定要有个空格，字符串不需要加双引号！

我们为了方便直接在controller进行演示了！！

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

    @Value("${school.teacher}")
    private String teacher;

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

    @GetMapping("/testValue")
    public Result testValue(){
        return Result.success(teacher + "--->" + student);
    }
}

我们debug看一下是否可以读取到配置中的值！

我们可以看到是有值的！

三、第二种方式（推荐）

这种方式是小编比较推荐的，虽然看似比@Value麻烦不少，但是更加的规范，在配合nacos的时候也可以动态的修改，会立即生效，一会小编带大家试一下哈！！为什么推荐这种方式呢，是因为spring他们都是使用这种方式进行配置的，所以跟着官方走不会有错的！！

1. 修改yml文件

我们刚刚修改了一下yml配置文件，让类型更加丰富！！

school:
 teacher: 王老师
 studentList:
   - 小明
   - 小刚

2. 编写读取映射的类

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

import java.util.List;

/**
 * @author wangzhenjun
 * @date 2022/8/17 9:04
 */
// 要交给spring容器，不然获取不到值
@Component
// 配置读取yml文件中前缀以 school开头的配置可以全部读取
@ConfigurationProperties(prefix = "school")
// 要有get方法，不然无法获取值
@Data
public class School {

    // 名称要与yml一致
    private String teacher;

    private List<String> studentList;
}

3. 在Controller进行测试

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

    @Autowired
    private School school;

    @GetMapping("/testProperties")
    public void testProperties(){
        log.info("读取yml的school对象：{}",school);
    }
}

4. debug进行看一下

5. 为什么推荐第二种方式

我们找到yml文件，按住Ctrl鼠标点击port，进去看一下spring官方是怎么配置的！


我们来到ServerProperties这个配置类上看到：

public void setPort(Integer port) {
	this.port = port;
}

我们发现port是一个成员变量，我们直接看一下这个类吧！

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {

	/**
	 * Server HTTP port.
	 */
	private Integer port;
}

我们看到spring也是使用第二种方式进行读取yml的内容的！！

四、验证第二种方式实时更新

nacos这里小编就不带大家整合到项目中了，小编直接演示效果哈！

1. nacos上配置yml

school:
 teacher: 王老师
 studentList:
   - 小明
   - 小刚


读取的配置和第二种方式那个School一样！

2. Controller获取

@RestController
@RequiredArgsConstructor
@RequestMapping("/zone")
public class ZoneController {
	@Autowired
    private School school;

    @GetMapping("/test")
    public R test() {
        return R.ok(school);
    }

3. postman测试

4. 修改配置

我们修改配置不重启项目

在次测试：

大功告成！完结撒花喽！！

五、总结

第二种方式：@ConfigurationProperties是非常推荐大家使用的，能够规范和生产环境中动态生效！！真的很香啊！！项目中的@Value()去修改修改吧！！如果不需要动态更新的，看个人情况修改哈！！

有缘人才可以看得到的哦！！！

点击访问！小编自己的网站，里面也是有很多好的文章哦！

SpringBoot及其codeschoolclassJava

有关SpringBoot读取.yml配置文件最常见的两种方式-源码及其在nacos的应用的更多相关文章

  1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  2. ruby - 其他文件中的 Rake 任务 - 2

    我试图在一个项目中使用rake，如果我把所有东西都放到Rakefile中，它会很大并且很难读取/找到东西，所以我试着将每个命名空间放在lib/rake中它自己的文件中，我添加了这个到我的rake文件的顶部:Dir['#{File.dirname(__FILE__)}/lib/rake/*.rake'].map{|f|requiref}它加载文件没问题，但没有任务。我现在只有一个.rake文件作为测试，名为“servers.rake”，它看起来像这样:namespace:serverdotask:testdoputs"test"endend所以当我运行rakeserver:testid时

  3. ruby-on-rails - 在 Rails 中将文件大小字符串转换为等效千字节 - 2

    我的目标是转换表单输入，例如“100兆字节”或“1GB”，并将其转换为我可以存储在数据库中的文件大小(以千字节为单位)。目前，我有这个:defquota_convert@regex=/([0-9]+)(.*)s/@sizes=%w{kilobytemegabytegigabyte}m=self.quota.match(@regex)if@sizes.include?m[2]eval("self.quota=#{m[1]}.#{m[2]}")endend这有效，但前提是输入是倍数(“gigabytes”，而不是“gigabyte”)并且由于使用了eval看起来疯狂不安全。所以，功能正常，

  4. ruby-on-rails - Rails 3 中的多个路由文件 - 2

    Rails2.3可以选择随时使用RouteSet#add_configuration_file添加更多路由。是否可以在Rails3项目中做同样的事情？ 最佳答案 在config/application.rb中:config.paths.config.routes在Rails3.2(也可能是Rails3.1)中，使用:config.paths["config/routes"] 关于ruby-on-rails-Rails3中的多个路由文件，我们在StackOverflow上找到一个类似的问题

  5. ruby - 将差异补丁应用于字符串/文件 - 2

    对于具有离线功能的智能手机应用程序，我正在为Xml文件创建单向文本同步。我希望我的服务器将增量/差异(例如GNU差异补丁)发送到目标设备。这是计划:Time=0Server:hasversion_1ofXmlfile(~800kiB)Client:hasversion_1ofXmlfile(~800kiB)Time=1Server:hasversion_1andversion_2ofXmlfile(each~800kiB)computesdeltaoftheseversions(=patch)(~10kiB)sendspatchtoClient(~10kiBtransferred)Cl

  6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  7. ruby - 使用 Vim Rails，您可以创建一个新的迁移文件并一次性打开它吗？ - 2

    使用带有Rails插件的vim，您可以创建一个迁移文件，然后一次性打开该文件吗？textmate也可以这样吗？ 最佳答案 你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件，这正是您想要的。我不能代表textmate。 关于ruby-使用VimRails，您可以创建一个新的迁移文件并一次性打开它吗？，我们在StackOverflow上找到一个类似的问题： https://sta

  8. ruby-on-rails - Rails 应用程序之间的通信 - 2

    我构建了两个需要相互通信和发送文件的Rails应用程序。例如，一个Rails应用程序会发送请求以查看其他应用程序数据库中的表。然后另一个应用程序将呈现该表的json并将其发回。我还希望一个应用程序将存储在其公共(public)目录中的文本文件发送到另一个应用程序的公共(public)目录。我从来没有做过这样的事情，所以我什至不知道从哪里开始。任何帮助，将不胜感激。谢谢! 最佳答案 无论Rails是什么，几乎所有Web应用程序都有您的要求，大多数现代Web应用程序都需要相互通信。但是有一个小小的理解需要你坚持下去，网站不应直接访问彼此

  9. ruby - 无法运行 Rails 2.x 应用程序 - 2

    我尝试运行2.x应用程序。我使用rvm并为此应用程序设置其他版本的ruby​​:$rvmuseree-1.8.7-head我尝试运行服务器，然后出现很多错误:$script/serverNOTE:Gem.source_indexisdeprecated,useSpecification.Itwillberemovedonorafter2011-11-01.Gem.source_indexcalledfrom/Users/serg/rails_projects_terminal/work_proj/spohelp/config/../vendor/rails/railties/lib/r

  10. ruby-on-rails - Rails 应用程序中的 Rails : How are you using application_controller. rb 是新手吗？ - 2

    刚入门rails，开始慢慢理解。有人可以解释或给我一些关于在application_controller中编码的好处或时间和原因的想法吗？有哪些用例。您如何为Rails应用程序使用应用程序Controller？我不想在那里放太多代码，因为据我了解，每个请求都会调用此Controller。这是真的？ 最佳答案 ApplicationController实际上是您应用程序中的每个其他Controller都将从中继承的类(尽管这不是强制性的)。我同意不要用太多代码弄乱它并保持干净整洁的态度，尽管在某些情况下ApplicationContr

随机推荐