c# - 支持从 VSTO 加载项进行日志记录的最简单方法

Question

我在 Visual Studio 2013 中编写了一个简单的 MS Word 插件，我希望能够记录事件，最好是 Windows 事件查看器。如果我尝试为我的应用程序创建新的事件源，我似乎会遇到权限问题。我正在寻找最简单的方法来从我的 VSTO 启用日志记录事件，并且不违反良好的编程准则。

选项 1:使用 VSTO 4.0 源

我从关于 Event Logging for Office Solutions 的 MSDN 文档中看到那:

You can use the event viewer in Windows to see exception messages that are captured by the Visual Studio Tools for Office runtime when you install or uninstall Office solutions. You can use these messages from the event logger to resolve installation and deployment problems.

这些事件是使用 VSTO 4.0 源记录的。我可以使用 VSTO 4.0 源记录来 self 自己的加载项的错误吗，或者这会被视为不好的做法吗？

编辑:从 Eugene Astafiev 的回答和我在其他地方读到的内容来看，这似乎是一个糟糕的方法，因为 VSTO 4.0 源代码只应该处理AddIns 的管理，而不是 AddIns 本身。 Answers to other questions还建议不要使用“通用”资源。

选项 2:创建要包含在安装程序中的 Bootstrap

作为替代方案，我可以包括一个简单的 Bootstrap 应用程序，它在安装期间创建源代码，但我看不到如何使用 Visual Studio 中“属性”>“发布”下的“安装设置”添加我自己的先决条件。可以吗？还有另一种方法吗？我宁愿不必创建 InstallShield Windows Installer因为在其他方面，默认创建的安装程序对我来说效果很好。创建一个完整的安装程序只是为了让事件日志正常工作似乎有点矫枉过正。

编辑:到目前为止，似乎没有“简单”的方法来做到这一点，尽管按照链接的说明创建安装程序并不太复杂。

选项 3:使用日志记录框架并记录到文件

第三种选择是使用 log4net 或类似的日志记录框架，并配置一个 File Appender 来记录到一个文件。

最初我不太热衷于实现文件日志记录，因为 a) 我的应用程序不会非常频繁地记录日志，并且 b) 我想避免将日志文件分散在难以找到的各个位置。

编辑:这是我目前采用的选项，因为它需要最少的配置，并且如果我的日志记录要求将来发生变化，它也可以适应。

Answer 1

设置 log4net 来处理简单(或复杂)的日志记录要求相对简单。 log4net Tutorial CodeProject 上提供了有用的引用。

1. 如果您愿意，可以使用 NuGet 包管理器或包管理器控制台将 log4net 安装到您的项目。
2. 添加 App.config如果您还没有文件(右键单击您的项目，选择添加 > 新项目...，然后从 Visual C# 项目中选择应用程序配置文件)。

3. 编辑App.config文件看起来像这样(在 <file /> 标签中适本地替换 MyAddIn):

   <?xml version="1.0" encoding="utf-8" ?>
   <configuration>
     <configSections>
       <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" requirePermission="false" />
     </configSections>
     <log4net>
       <root>
         <level value="ALL"/> 
         <appender-ref ref="RollingFileAppender"/>
       </root>
       <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
         <file value="${APPDATA}\My AddIn\MyAddin-log.txt" />
         <appendToFile value="true" />
         <rollingStyle value="Size" />
         <maxSizeRollBackups value="5" />
         <maximumFileSize value="5MB" />
         <staticLogFileName value="true" />
         <layout type="log4net.Layout.PatternLayout">
           <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
         </layout>
       </appender>
     </log4net>
   </configuration>
   

   日志文件将保存到用户的漫游 AppData ( %appdata% ) 文件夹，最多保留 5 个滚动日志文件，每个文件不超过 5MB。

4. 将以下行添加到 ThisAddIn_Startup()在 ThisAddIn.cs 中(您需要添加 using log4net; 指令):

   log4net.Config.XmlConfigurator.Configure();
   

5. 在任何需要实现日志记录的类中添加如下语句:

   private static readonly log4net.ILog log = 
       log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
   

6. 然后可以使用 log.Info 记录事件, log.Warn , log.Error , log.Fatal以及 log4net 提供的其他方法。

您可能会收到架构警告消息，因为 log4net 不包含架构，然后 Visual Studio 无法验证配置部分。在这种情况下，从 http://csharptest.net/downloads/schema/log4net.xsd 下载模式文件。到某个可以访问的地方。所在地C:\Program Files\Microsoft Visual Studio 10.0\Xml\Schemas has been suggested别处。

选择您的 App.config在 Visual Studio 中创建文件，然后单击进入编辑器。您应该得到一个 XML 菜单项。从那里，选择 Schemas... 并从保存它的位置添加 log4net.xsd 文件。

请注意，您还可以使用 log4net 来 log to the Event Viewer但是您会遇到与最初问题中提出的相同的权限问题。