文盘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 上编译执行通过,咱们下期见

作者:京东科技 贾世闻

来源:京东云开发者社区

相关推荐
代码不停3 分钟前
Spring 原理
java·spring
企业数字化笔记24 分钟前
报表上线怎么对账?口径回归、权限抽检与差异定位
java·spring boot·mysql
乌暮29 分钟前
少写重复 CRUD:用大白话搞懂 MyBatis-Plus
java·开发语言·spring boot·面试·mybatis
CoderYanger1 小时前
Java EE 进阶:9.MyBatis 操作数据库(进阶)(第四弹):图书管理系统(用户登录+添加图书)
java·数据库·spring boot·mysql·面试·java-ee·mybatis
goyeer1 小时前
【Kubernetes】Kubernetes之CRI详解
java·容器·kubernetes
牧瀬クリスだ1 小时前
从零手写博客系统:分层架构与统一响应(一)
java·数据库·架构·mybatis·springboot·安全架构
Rain的Java大神之路2 小时前
LeetCode 40 组合总和 II:面试官想听的不是回溯,而是那行去重代码
java·leetcode·面试
wno7043 小时前
Centos下PostgreSQL安装部署详细步骤
java·数据库·spring boot
wflynn3 小时前
GitHub 今日推荐|rust-anything:录制真实输入输出,渐进式重写热点函数到 Rust
rust·开源·github·cli·claude-code·agent-skills
nice_lcj5203 小时前
【从零理解计算机网络 · 04】TCP 三次握手:为什么恰好是三次
java·后端·tcp/ip·计算机网络·面试·tcp·三次握手