从 Outlook 加载项调用时，NLog 不写入日志文件答案

【问题标题】：NLog does not write to log file when called from Outlook Add-in从 Outlook 加载项调用时，NLog 不写入日志文件
【发布时间】：2016-11-15 05:39:25
【问题描述】：

我有一个用于 Outlook 的 C# 插件（Add-In Express），我试图从中存储一些日志数据，但即使对 logger 的调用没有失败，也没有创建日志文件。我在 Win 10 环境中使用 VS 2013。

我的 NLog.Config 文件（存放在文件夹 OutlookAddin\bin\Debug，与 OutlookAddIn.dll.config 相同的位置）如下：

<?xml version="1.0" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<targets>
    <target name="file" xsi:type="File"
        layout="${longdate} ${logger} ${message}" 
        fileName="${specialfolder:ApplicationData}\FindAlike\NewMails.txt"
        keepFileOpen="false"
        encoding="iso-8859-2" />
</targets>

<rules>
    <logger name="*"  writeTo="file" />
</rules>

插件中的代码是声明：

public AddinModule()
    {
        Application.EnableVisualStyles();
        InitializeComponent();
        // Please add any initialization code to the AddinInitialize event handler
    }

    private ADXOutlookAppEvents adxOutlookEvents;
    private DateTime LastReceivedDate = DateTime.Now;
    private Timer mailCheckTimer;
    public static RegistryKey SoftwareKey = Registry.CurrentUser.OpenSubKey("Software", true);
    public static RegistryKey AppNameKey = SoftwareKey.CreateSubKey("FindAlike");
    public static Logger logger = LogManager.GetCurrentClassLogger();

测试日志文件写入的例程是：

public static void TestNLog()
    {
        try
        {
            NLog.LogManager.ThrowExceptions = true;

            logger.Info("test1");
            logger.Warn("test2");
            logger.Error("test3");

            var fileTarget1 = (FileTarget)NLog.LogManager.Configuration.FindTargetByName("file");
            var logEventInfo = new LogEventInfo { TimeStamp = DateTime.Now };
            string fileName = fileTarget1.FileName.Render(logEventInfo);
            if (!System.IO.File.Exists(fileName))
                throw new Exception("Log file does not exist.");
        }
        catch (Exception Ex)
        {
            MessageBox.Show(Ex.Message);
        }
    }

调用TestNLog时，出现日志文件不存在的Message，虽然目标文件是正确的，说明配置文件已经读取成功。

当包含在可执行文件中时，相同的代码会按预期工作。

【问题讨论】：

请标记一个为答案:)

标签： c# outlook add-in nlog

【解决方案1】：

除了@SimonKarvis 的回答，nlog.config 的位置可能很困难。单元测试也是如此。

我会推荐：

从 C# 创建配置，例如

 var target = new FileTarget
 {
       FileName = logfile,
       ReplaceFileContentsOnEachWrite = true,
       CreateDirs = createDirs
 };
 var config = new LoggingConfiguration();

 config.AddTarget("logfile", target);

 config.AddRuleForAllLevels(target);

 LogManager.Configuration = config;

或者从字符串加载配置：

string configXml = "<nlog>...<nlog>";
XmlDocument doc = new XmlDocument();
doc.LoadXml(configXml);
var config = new XmlLoggingConfiguration(doc.DocumentElement, Environment.CurrentDirectory);
LogManager.Configuration = config;

或者至少但不是最后，找到 nlog.config 的正确路径并将其“提供”给 NLog。

var pathToNlogConfig = "c:\..";
var config = new XmlLoggingConfiguration(pathToNlogConfig);
LogManager.Configuration = config;

【讨论】：

方法 2 的尝试变体 - 成功从 Outlook 加载项登录，无需复制 Nlog.config。答案中使用的代码

【解决方案2】：

另一个 StackOverflow 问题 (How to use NLog for a DLL) 建议 NLog.config 需要放在与调用插件的可执行文件相同的目录中。这解决了问题。但是，这使得分发变得非常困难，因为 Outlook 可执行文件的位置会根据 Outlook 版本而有所不同，并且需要管理员权限才能将文件复制到其中。也许另一个记录器不需要这个。

感谢@Julian 的建议，以下代码以编程方式指定了 NLog 配置并从插件成功运行：

    using NLog;
    using NLog.Config;
    using NLog.Targets;
    using System.Xml;
...

public static Logger logger = LogManager.GetCurrentClassLogger();

....   
    public static void ConfigNLog()
            {

            string xml = @"
            <nlog xmlns=""http://www.nlog-project.org/schemas/NLog.xsd""
                xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">
                <targets>
                    <target name=""file"" xsi:type=""File""
                            layout=""${longdate} ${logger} ${message}"" 
                            fileName=""${specialfolder:ApplicationData}\FindAlike\NewMails.txt""
                            keepFileOpen=""false""
                            encoding=""iso-8859-2"" />
                </targets>
                <rules>
                    <logger name=""*""  writeTo=""file"" />
                </rules>
            </nlog>";

            StringReader sr = new StringReader(xml);
            XmlReader xr = XmlReader.Create(sr);
            XmlLoggingConfiguration config = new XmlLoggingConfiguration(xr, null);
            NLog.LogManager.Configuration = config;
        }

【讨论】：