文盘Rust -- 如何把配置文件打包到二进制文件里 | 京东云技术团队

在实际开发中,经常会遇到各种不同的配置文件。通常,程序运行的各种配置从外部读取,以增强应用配置的灵活性。java 生态中的 springboot 提供了这种设计的典范。springboot 的应用程序,默认通过 application.yml 加载配置。默认的 application.yml 文件打进 jar 包,如果想改变程序的行为,可以在jar 包的同级目录下创建 application.yml 文件或者通过参数指定配置文件位置。那么在 rust 生态里有没有办法把默认配置文件打包到二进制文件呢。

我们可以通过 rust-embed 第三方库来实现这一效果。

在实际开发中的典型场景是: 不指定任何配置文件时,使用默认配置文件;当应用程序同级目录下包含配置文件时加载该配置文件。

  • 定义嵌入文件的位置及获取函数

    src/resources/embed_resource.rs 中定义了嵌入文件的位置及获取函数

    rust 复制代码
    use rust_embed::RustEmbed;
    
    #[derive(RustEmbed)]
    #[folder = "src/embedfiles/"]
    struct Asset;
    
    pub fn get_app_default() -> Option {
      Asset::get("./app_default.yml")
    }

    宏定义了嵌入文件的目录 '#[folder = "src/embedfiles/"]',获取文件函数以该目录为根。

  • 使用嵌入文件

    rust 复制代码
    fn main() {
      if Path::new("./app.yml").exists() {
          let contents =
              fs::read_to_string("./app.yml").expect("Read file error!");
          println!("{}", contents);
          return;
      }
      let app = get_app_default().unwrap();
      let f = std::str::from_utf8(app.data.as_ref()).unwrap();
      println!("{}", f);
    }

按照优先级,我们先检查应用同级目录下有没有app.yml文件,如果有就加载,否则加载默认配置文件。我们先前定义的获取嵌入文件的函数会返回rust_embed::EmbeddedFile 的 struct。通过解析该 struct 的 data 成员,获取文件内容。

  • 测试

    为了避免干扰,我们把编译好的应用 mv 到 /tmp 目录

    bash 复制代码
    cargo build
    mv target/debug/embed /tmp

先执行 embed ,可以看到,输出的是默认配置文件的内容;在应用程序同级目录建立 app.yml 文件,随便填写些内容,再执行 embed 则输出的是 app.yml 文件的内容。

源码地址

以上示例在 macos 上编译执行通过,咱们下期见

作者:京东科技 贾世闻

来源:京东云开发者社区

相关推荐
雪球工程师团队7 分钟前
代码“蝴蝶效应”终结者:AI Review + AST 联展,构建智能测试防御新体系
java·ai编程·测试
你喜欢喝可乐吗?14 分钟前
RuoYi-Cloud ruoyi-gateway 网关模块
java·spring cloud·gateway
典孝赢麻崩乐急35 分钟前
Java学习---JVM(1)
java·jvm·学习
m0_5973453144 分钟前
【Android】安卓四大组件之广播接收器(Broadcast Receiver):从基础到进阶
android·java·boradcast·安卓四大组件
程序员的世界你不懂1 小时前
基于Java+Maven+Testng+Selenium+Log4j+Allure+Jenkins搭建一个WebUI自动化框架(5)失败用例截图与重试
java·selenium·maven
喧星Aries1 小时前
进程调度的时机,切换与过程方式(操作系统OS)
java·服务器·前端·操作系统·进程调度
JouJz1 小时前
Spring事务管理深度解析:原理、实践与陷阱
java·spring
此乃大忽悠1 小时前
身份认证缺陷
java·数据库·webgoat·身份认证缺陷
Honyee1 小时前
java使用UCanAccess操作Access
java·后端