C# 嵌入资源加载 + 外部配置文件的兜底配置

**嵌入资源:**嵌入资源无法在程序发布后随意修改(它被打包到程序集内部,而非独立文件),这看似是 "缺点",但也正是它的核心价值所在。嵌入资源有其明确的适用场景,主要用于存放无需动态修改、需要随程序集一起分发、希望被保护或避免丢失的文件。

文章主题:嵌入资源 + 外部配置文件 结合使用

在实际开发中,我们通常不会 "非此即彼",而是采用 **"嵌入资源兜底 + 外部配置文件覆盖"** 的组合方案,兼顾两者的优点:

  1. 嵌入默认资源:将核心配置 / 模板作为嵌入资源,作为程序的 "兜底配置"(确保程序在无外部配置时也能正常运行);
  2. 外部配置文件动态覆盖:允许用户在程序同级目录放置同名配置文件,程序运行时优先读取外部配置文件;若外部配置不存在,则读取嵌入资源的默认配置。

这种方案既解决了 "外部配置灵活修改" 的需求,又避免了 "外部配置缺失导致程序崩溃" 的问题

具体做法实例:

1. 添加资源文件

在项目中右键 → 新建 → 文本文件 → 重命名为 config.json,写入测试内容:

复制代码
{
  "AppName": "嵌入资源演示程序",
  "Version": "1.0.0",
  "Author": "TestUser",
  "Settings": {
    "IsDebug": true,
    "Timeout": 3000
  }
}

2. 设置文件为「嵌入资源」

这是关键步骤 (若不设置,无法通过 GetManifestResourceStream 获取资源):

  1. 在 Visual Studio 中,选中 config.json 文件
  2. 右键 → 属性(Properties)
  3. 在「高级」(Advanced)选项中,找到「生成操作」
  4. 将其值改为「嵌入的资源」
  5. 保存设置(其他默认即可)

3.本地程序执行debug文件夹内新建config.json文件,配置内容如下:

4.实现代码:

cs 复制代码
       Console.WriteLine("读取config配置");      
       LoadEmbeddedResource("config.json");
       Console.WriteLine("读取完成");



        /// <summary>
        /// 通用方法:加载当前类所在命名空间下的嵌入资源
        /// </summary>
        /// <param name="resourceName">资源文件名(如 "config.json")</param>
        /// <returns>资源流</returns>
        public string LoadEmbeddedResource(string resourceName)
        {
            string fileContent;

           // 1. 优先读取外部同级目录的config.json
            string exeDirectory = AppDomain.CurrentDomain.BaseDirectory;
            string fullFilePath = Path.Combine(exeDirectory, resourceName);

            // 验证文件是否存在
            if (File.Exists(fullFilePath))
            {
                using (var stream = new FileStream(fullFilePath, FileMode.Open, FileAccess.Read))
                using (var reader = new StreamReader(stream, System.Text.Encoding.UTF8))
                {

                    fileContent = reader.ReadToEnd();
                    textBox1.Text += fileContent;
                    Debug.WriteLine("===== 读取到本地资源(config.json)内容 =====");
                    Debug.WriteLine(fileContent);
                }

                return fileContent;
            }

            // 2. 外部配置不存在时,读取嵌入资源的默认配置(兜底)
            string fullResourceName = $"{GetType().Namespace}.{resourceName}";
            using (var stream = GetType().Assembly.GetManifestResourceStream(fullResourceName))
            // 使用 StreamReader 读取流内容
            using (var reader = new StreamReader(stream))
            {
                fileContent = reader.ReadToEnd();
                textBox1.Text += fileContent;
                Debug.WriteLine("===== 读取到嵌入资源(config.json)内容 =====");
                Debug.WriteLine(fileContent);
            }

            return fileContent;

        }
 
相关推荐
剩下了什么38 分钟前
float32 与 float64 精度陷阱:如何在 Go 中避免错误使用
开发语言·后端·golang
指尖时光.1 小时前
Three.js 超全入门综合案例
开发语言·javascript·ecmascript
暴力求解1 小时前
Linux网络---传输层协议TCP(二)
linux·服务器·开发语言·网络·tcp/ip
吴声子夜歌1 小时前
Java面试题——基础(一)
java·开发语言
小庞在加油2 小时前
WinDbg实战:QT/跨平台项目死锁与无响应问题排查指南
开发语言·qt·windbg·工具
Vae_Mars2 小时前
C#中的delegate委托
开发语言·c#
一直走下去-明3 小时前
简单的http抓包解包完整代码
开发语言·python
caimouse3 小时前
ReactOS 图形系统分析(51):元文件子系统 — metafile.c
c语言·开发语言
学习星球4 小时前
Solid.js 实战:拆解官方 RealWorld 项目
开发语言·javascript·vue.js
OPEN-F4 小时前
Python进阶教程:正则表达式进阶与文本处理
开发语言·python·正则表达式