VSIX项目向导扩展中app.config加载失败及log4net配置问题

我之前在开发VSIX项目向导扩展时，也碰到过一模一样的app.config读取问题，结合踩过的坑给你梳理下原因和解决办法：

为什么ConfigurationManager.AppSettings读不到值？ #

VSIX扩展是运行在Visual Studio主进程（devenv.exe）中的，默认情况下ConfigurationManager会读取Visual Studio自身的配置文件（比如devenv.exe.config），而不是你扩展包中的app.config。哪怕你把app.config复制到了扩展安装目录，它也不会被自动加载。

手动加载扩展的app.config解决方案 #

如果你还是想使用自己的app.config，可以通过手动指定配置文件路径的方式加载：

using System.Configuration;
using System.IO;
using System.Reflection;

// 获取扩展程序集的路径
var assemblyPath = Assembly.GetExecutingAssembly().Location;
// 拼接对应的.config文件路径（和dll同目录）
var configFilePath = Path.ChangeExtension(assemblyPath, ".config");
// 加载自定义配置文件
var customConfig = ConfigurationManager.OpenExeConfiguration(configFilePath);
// 读取appSettings中的值
var testValue = customConfig.AppSettings.Settings["test"]?.Value;

VSIX扩展中配置log4net的正确方式 #

既然默认的app.config机制不适用，我们可以换两种方式配置log4net：

方式1：使用独立的log4net配置文件 #

1. 在项目中添加log4net.config文件，内容就是你的log4net配置（比如输出到文件、控制台等）
2. 设置文件的属性：
   • 生成操作：Content
   • 复制到输出目录：始终复制
   • 包含在VSIX中：True
3. 在扩展初始化时手动加载这个配置文件：

using log4net;
using log4net.Config;
using System.IO;
using System.Reflection;

// 获取扩展程序集所在目录
var assemblyDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
// 拼接log4net配置文件路径
var logConfigPath = Path.Combine(assemblyDir, "log4net.config");
// 加载配置
XmlConfigurator.Configure(new FileInfo(logConfigPath));

// 后续就可以正常使用log4net了
var logger = LogManager.GetLogger(typeof(YourWizardClass));
logger.Info("Log message from VSIX extension");

方式2：将log4net配置嵌入为资源文件 #

如果不想让配置文件暴露在扩展目录中，可以把它嵌入到程序集里：

1. 添加log4net.config文件，设置属性：
   • 生成操作：Embedded Resource
2. 在扩展初始化时从资源流加载配置：

using log4net;
using log4net.Config;
using System.IO;
using System.Reflection;

var assembly = Assembly.GetExecutingAssembly();
// 注意资源名称格式：命名空间.文件名（比如你的扩展命名空间是MyProjectWizard，资源名就是MyProjectWizard.log4net.config）
using (var configStream = assembly.GetManifestResourceStream("YourExtensionNamespace.log4net.config"))
{
    if (configStream != null)
    {
        XmlConfigurator.Configure(configStream);
    }
}

// 使用log4net
var logger = LogManager.GetLogger(typeof(YourWizardClass));
logger.Debug("Embedded config loaded successfully");

额外注意事项 #

• 调试时可以检查扩展的输出目录，确认配置文件是否存在；安装后可以去C:\Users\<user>\AppData\Local\Microsoft\VisualStudio\<version>\Extensions\<your-extension>目录验证文件是否存在
• 如果使用方式2，要确保资源名称拼写正确（可以通过assembly.GetManifestResourceNames()方法列出所有资源，确认名称）

内容的提问来源于stack exchange，提问作者jdylanmc