记录错误代码设计，需要输入

Question

所以，我陷入了一个小问题。我很好奇是否有人愿意对此设计提供一些额外的意见。

我有一个 ILog 接口，其中有两种用于设计的错误代码日志记录部分的方法。 FlagError 和 GetErrorCode； FlagError 在整数上设置一个位，每个位代表抛出了某个错误。GetErrorCode（这将是 Main 方法的返回值）返回该整数。

我首先推测在每个应用程序中使用enum来包含可能的错误代码列表。

但问题是，我究竟如何以友好的方式向用户传达错误代码“XYZ”表示应用程序在执行过程中遇到了这些非正常状态？

日志接口： （写入方法有重载）

interface ILog
{
    void FlagError (int errorCode);
    int GetErrorCode ();

    #region Other ILog Methods

    void WriteError(string  message);
    void WriteWarning(string  message);
    void WriteInfo(string  message);
    void WriteDebug(string  message);

    #endregion
}

日志类：

abstract class Log : ILog
{
    public void
    FlagError (int errorCode)
    {
        if (errorCode == 0 || errorCode == int.MinValue || errorCode != (errorCode & -errorCode))
        {
            throw new IndexOutOfRangeException ();
        }

        if ((m_errorCode & errorCode) == errorCode)
             return;

        m_errorCode += errorCode;
    }

    public int
    GetErrorCode ()
    {
        return m_errorCode;
    } 


    #region Other ILog Methods    

}

我推测在每个枚举值上使用一个属性以及该错误的描述，然后只需进行一些处理或其他操作来帮助将错误代码“解析”为人类可读的描述。

但我不知道，有什么想法吗？

Answer 1

感谢你们的评论，我考虑了它们，并找到了一个解决方案（虽然不是最好的），可以满足我需要完成的任务。

我最终创建了一个添加到每个枚举值的描述​​属性，然后在枚举上创建了一个“GetDescription”扩展方法。然后，每当我标记一个错误时，它的描述就会被写到控制台/文件/窗口或 w/e.

我想我应该公开更多 ILog 的方法才能找到这个解决方案。

新的 FlagError 方法：

public void
FlagError (Enum  errorCode)
{
   int  errorValue = Convert.ToInt32 (errorCode);

   if (errorValue == 0 || errorValue == int.MinValue
      || errorValue != (errorValue & -errorValue))
   {
      WriteError ("ErrorCode {0}: {1}",
                  errorValue,
                  errorCode.GetDescription ());

      m_errorCode = int.MinValue;

      throw new IndexOutOfRangeException ();
   }

   if ((m_errorCode & errorValue) == errorValue)
      return;

   WriteError ("ErrorCode {0}: {1}",
               errorValue,
               errorCode.GetDescription ());

   m_errorCode += errorValue;
}

GetDescription 扩展方法：

public static string 
GetDescription (this Enum  @enum)
{
   StringBuilder  builder;

   var  descriptionAttributes = @enum.GetType ()
                                     .GetCustomAttributes (
                                          typeof (DescriptionAttribute),
                                          false) as DescriptionAttribute [];

   if (descriptionAttributes == null || descriptionAttributes.Length == 0)
      return string.Empty;

   builder = new StringBuilder ();

   foreach (DescriptionAttribute  description in descriptionAttributes)
   {
      builder.Append (description.Description);
      builder.AppendLine ();
   }

   return builder.ToString ();
}

Description 属性：

public sealed class DescriptionAttribute : Attribute
{
   public 
   DescriptionAttribute (string  description)
   {
      m_description = description;
   }

   public string 
   Description
   {
      get
      {
          return m_description;
      }
   }


   private readonly string m_description;
}

如果有人有任何其他输入，我很乐意听到。

Answer 2

我可能会使用枚举，将这些值和日志记录代码放入每个应用程序都可以调用的通用程序集中。它可能不是有史以来最优雅的解决方案，但它可以完成工作，让您继续处理更重要的事情 - 比如不会引发太多错误的良好核心业务逻辑:-)。

另一种选择可能是将错误代码和人类可读的描述放入配置文件中。这样您就可以灵活地改进错误消息。我从来没有尝试过，但现在想起来，我发现它在很多情况下都是一个真正的好处。