功能？班级？

Question

我正在编写一个应用程序 (C#)，有时我需要记录到 Windows 事件日志。因此，我想到的第一件事就是在我唯一的类中编写一个函数，并在需要时调用它。像这样的事情：

private void Write_Event_Log(string log, string source, string message, EventLogEntryType type, int eventid)
    {
        if (!EventLog.SourceExists(source))
            EventLog.CreateEventSource(source, log);

        EventLog.WriteEntry(source, message, type, eventid);
    }

我的一位同事问，“为什么不为事件日志编写器创建一个新类？”所以我的问题是，我为什么要这样做？这个类会是什么样子呢？当我的函数运行良好时，为什么我需要它？好吧，这是 3 个问题，但你明白了:)

Answer 1

我为什么要这么做？

将日志记录功能封装到它自己的类中。为什么？单一职责原则 http://en.wikipedia.org/wiki/Single_responsibility_principle。如果将它混合到您的类中，您将使该类负责至少两 (2) 件事：无论它做什么和记录。

这个类会是什么样子？

public class LogWriter
{
    public static Log(string log, string source, string message, EventLogEntryType type, int eventid)
    {
        if (!EventLog.SourceExists(source))
            EventLog.CreateEventSource(source, log);

            EventLog.WriteEntry(source, message, type, eventid);
    }
}

当我的函数运行良好时，为什么还需要它？

想想什么时候你不再对代码负责。提前考虑代码何时增长。最终，除了日志记录之外，它可能还包含许多其他非常有用的功能。下一个程序员会更高兴不必重构你的工作，因为设计先例已经确定。

Answer 2

这是关于 OO 设计的一个非常普遍的问题。你的同事指的是职责分离；他认为事件日志写入器的想法不适合您放入的类的抽象，并且它值得拥有自己的抽象。

如果这就是您要使用它的全部目的（这一个方法），并且该程序足够简单，您可以在一个类中实现它，则无需使用另一个类与您的事件编写器交互。如果您可以设想您的事件编写器将来可能会以不同的方式或由不同的类使用，那么是的，绝对将其设为自己的类，这样您就可以避免将来出现必须更改源代码的问题使用它。

您编写的函数是一个不保持状态的小函数，因此除非是为了避免将来出现问题，否则实际上不需要另一个类。

Answer 3

很简单，如果您希望在代码库的所有其他部分的任何地方都使用此方法怎么办？您再次复制-粘贴。相反，在类中添加一个助手或 Add，只需实例化并继续调用即可。

另外，如果它在一个类中，您可以拥有更多属性并在记录数据时提供更多自定义方法。

看看是否可以使用内置的事件日志/跟踪内容。

Answer 4

如果它是一个小型应用程序（它必须是一个类），那么它可能并不重要。

但在较大的应用程序中，明智的设计是，您可能需要考虑将日志记录功能单独放在一个类中，以使每个类尽可能集中。

Answer 5

出于同样的原因，有人将 SourceExists(Source) 和 CreateEventSource(source, log) 放入自己的类中，因此您只需引用具有该类的程序集即可调用它们定义类，并写入

 EventLog.SourceExists(source);

或

 EventLog.CreateEventSource(source, log);

因此，如果您永远不会需要在您编写的任何其他应用程序中写入事件日志，那么您所做的就很好。但如果您可能再次需要这个，那么......

Answer 6

我认为你应该有单独的类，因为如果你要在应用程序中创建更多的类，你可以对所有类使用相同的日志记录，请参见下面的示例
公共静态类记录器
{
私有静态字符串 logFilePath = string.Empty;

    public static void Log(string logMessage, TextWriter w)
    {
        w.Write( logMessage);
        w.Flush();
    }


    public static void Log(string textLog)
    {
        string directoryString =
      filepath+           @"\Logging";
        Directory.CreateDirectory(directoryString);

        logFilePath = directoryString + "\\" +
          DateTime.Now.ToShortDateString().Replace("/", "") + ".txt";


        StreamWriter sw = null;
        if (!File.Exists(logFilePath))
        {
            try
            {
                sw = File.CreateText(logFilePath);
            }
            finally
            {
                if (sw != null) sw.Dispose();
            }
        }
        using (StreamWriter w = File.AppendText(logFilePath))
        {
            Log(textLog, w);
            w.Close();
        }
    }

Answer 7

我同意您不应该创建一个新类来直接写入事件日志，而是出于另一个原因。该类已经存在！

考虑使用 System.Diagnostics 中的内置调试/跟踪机制：

调试输出

跟踪输出

这些是将信息转储到 TraceListener 对象集合的标准类，其中已经存在许多有用的类型：

< a href="http://msdn.microsoft.com/en-us/library/system.diagnostics.defaulttracelistener.aspx" rel="nofollow noreferrer">DefaultTraceListener - 将输出转储到标准调试输出，我相信是通过 OutputDebugString() 实现的。

EventLogTraceListener - 转储输出到 Windows 事件日志。

因此，这会将您的输出机制从程序问题更改为配置问题。 （是的，如果您使用的是直接托管应用程序，则可以通过 app.config 填充您的 TraceListener 集合。）这意味着您在任何地方都只需使用适当的 Trace。 Write() 或 Debug.Write() 调用（取决于您是否希望在发布版本中输出），并且配置决定输出的位置。

当然，您也可以通过编程方式填充 TraceListener 集合，这既有趣又简单。

这样您就不必建立自己的本地日志记录基础设施。一切都是内置的！使用它祝身体健康！ :D

---

另一方面，如果你坚持自己推出（我认为这是一个坏主意），你的同事是对的。这是一个单独的职责，属于一个单独的类。我希望输出使用静态方法，因为调试日志可能没有概念实例。事实上，我希望有一个与 System.Diagnostics.Debug 非常相似的界面，所以是的，只需使用该界面即可。

---

根据您的方法，您可能会遇到文档中的微妙陷阱，但如果不仔细阅读，则不会立即明显。 我在其他地方找到了答案。