草庐IT

springBoot 读取yml 配置文件的三种方式 (包含以及非component下)

极光雨雨 2023-07-07 原文

遇到的问题

一般spring Boot 环境中可以直接通过 @Value 方式相当于读取注入的方式直接获得配置文件中的值,但实际上当处于非标准的 controller ,service 或 component 注解下的文件想要读取时,由于不是 properties 也不能直接通过properties 的方式直接加载,直接读取文件流也不知道是否可行,查找部分资料后找到了解决方式,下面做下记录

标准读取方式一(一般controller 以及 service 等包含component 可以直接获取spring 中的值)

@Value
即类似于

@Service
@Slf4j
public class AutoTestServiceImpl implements AutoTestService {

    @Value("${autotest.server.url}")
    private String baseUrl;
    
    ........

application.yml 或者 application.properties 配置文件中如下

yml

autotest:
  server:
    url: http://localhost:8080

properties

autotest.server.url=http://localhost:8080

spring的 Environment 类

SpringBoot 可以使用 @Autowired 注解注入 Environment 对象

SpringBoot 会将配置文件中所有的数据封装到 Environment 对象中,使用只需要通过调用 Environment 对象的getProperty(String name) 方法即可获取

例如上面 yml 或 properties 中的值可以通过

@RestController
@RequestMapping("/testCon")
public class BookController {
    
    @Autowired
    private Environment env;
    
    @GetMapping("/{id}")
    public void gettest(@PathVariable Integer id){
        System.out.println(env.getProperty("autotest.server.url"));

    }
}

非标准 controller 或者 service 等文件中无法直接通过 @autowired 方式获取 Environment 时的处理方式

这里可以直接通过 spring 原有的 ApplicationContext 来获取该对象从而实现从 yml 获取数据,properties 当然也可以,但properties 可以通过直接加载 properties 的方式获取值,相对来说更容易一点

实例如下:
这里先要定义一个从 spring环境上下文 获取已放到容器实体的工具类,这个是 一般的spring都支持的,也是常用的工具之一
工具定义如下:

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

import java.util.Collection;

@Component
public final class ToolSpring implements ApplicationContextAware {
    private static ApplicationContext applicationContext = null;

    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        if (ToolSpring.applicationContext == null) {
            ToolSpring.applicationContext = applicationContext;
        }
    }

    public static <T> Collection<T> getBeansOfType(Class<T> clazz) {
        return applicationContext.getBeansOfType(clazz).values();
    }
}

通过 实现 ApplicationContextAware 来获取spring 上下文对象,以此获取容器中的 Bean

实际使用时一般也用于无法直接通过 @Autowired 或 @Resource 注入的属性,都可以通过这种方式获取,由于 Environment 为springBoot 自身提供的 Bean 故可以获取到
如下:
这里我在初始化时通过该方式给予赋值

public class MyTest  {

    private String baseUrl;

    {
        Environment bean = ToolSpring.getBean(Environment.class);
        baseUrl = bean.getProperty("autotest.server.url");
    }

	// 此时下面的其他方法即可引用 baseUrl
    .........................
}

但是: 这种通过 Environment 获取数据的方式并不常用,非必要可以不用,毕竟加载了项目配置文件内的所有数据

自定义对象封装数据

这种方式没有实际使用过,但也记录一下
SpringBoot 也提供了将配置文件中的数据封装到自定义实体类对象中的方式

  1. 为了将实体类 bean 的创建交给 Spring 管理 在自定义类上添加 @Component 注解
  2. 使用 @ConfigurationProperties 注解表示加载配置文件,在该注解中也可以使用 prefix 属性指定只加载指定前缀的数据
  3. 在需要使用该类的controller, Service等中进行注入

例如:

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

@Data
@Component
@ConfigurationProperties(prefix = "auto.message")
public class WxTemplateProperties {
  private String id;
  private String akId;
}

如果没有使用过 lombok 的 @Data 可以手动引入一下,效果仅仅是自动生成 get set 方法,如果不需要也可以手动生成 get set 有快捷键也很容易。

如果
添加 @ConfigurationProperties 出现警告,则可以添加依赖

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

解决

之后改类可以通过 @Autowired 等方式注入后使用。

有关springBoot 读取yml 配置文件的三种方式 (包含以及非component下)的更多相关文章

  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 - 如何以所有可能的方式将字符串拆分为长度最多为 3 的连续子字符串? - 2

    我试图获取一个长度在1到10之间的字符串,并输出将字符串分解为大小为1、2或3的连续子字符串的所有可能方式。例如:输入:123456将整数分割成单个字符,然后继续查找组合。该代码将返回以下所有数组。[1,2,3,4,5,6][12,3,4,5,6][1,23,4,5,6][1,2,34,5,6][1,2,3,45,6][1,2,3,4,56][12,34,5,6][12,3,45,6][12,3,4,56][1,23,45,6][1,2,34,56][1,23,4,56][12,34,56][123,4,5,6][1,234,5,6][1,2,345,6][1,2,3,456][123

  8. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们? - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  9. ruby - 解析 RDFa、微数据等的最佳方式是什么,使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作,但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式,例如使用这个yaml文件,它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

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

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

随机推荐