实现使用的常量字符串的最佳实践

Question

说我有一个界面:

public interface IFeature
{
    Task execFeature();
}

和两个实现:

public class FirstFeature : IFeature
{
    private IWebApi webApi;
    public FirstFeature(IWebApi webApi)
    {
        this.webApi = webApi;
    }

    public async Task execFeature()
    {
        string response = await webApi.getClassName();
        IResult result;
        if(response==null)
            result = new TextResult("Error accessing api - check internet connection/api address");
        else
            result = new TextResult("Hello dear user – the selected class name is " + response);
        result.display();
    }
}

public class SecondFeature : IFeature
{
    private IWebApi webApi;
    public SecondFeature(IWebApi webApi)
    {
        this.webApi = webApi;
    }

    public async Task execFeature()
    {
        List<string> classNames = new List<string>();
        var classNameTasks = Enumerable.Range(1, 3).Select(i => webApi.getClassName()).ToArray();
        classNames.AddRange((await Task.WhenAll(classNameTasks)));
        IResult result;
        if (classNames[0] == null)
            result = new TextResult("Error accessing api - check internet connection/api address");
        else 
            result = new TextResult("Hello dear user – we’ve selected three new class names for you, and they are " + classNames[0] + ", " + classNames[1] + ", and " + classNames[2]);
        result.display();
    }
}

如您所见,在两种实现中,我都必须执行该result = new TextResult("Error accessing api - check internet connection/api address");行来报告错误.

在error_string我的所有实现中,我可以访问OOP/Good Design中的最佳实践是什么？

现在的方式,代码是重复的.

Answer 1

我认为没有最好的做法.这只是一个偏好问题.

我将常量存储在静态类中.

public static class Constants
{
   public static class Messages
   {
      public const string Error = "Error accessing api...";
      public const string Hello = "Hello ...";
   }
}

用法

var result = new TextResult(Constants.Messages.Error);

仅供参考:一些开发人员更喜欢Enum.

Answer 2

我通常会根据消息的目标受众进行区分.因此,我将它们分为两类.
无论类别如何,我都避免多次编写相同的代码(例如消息字符串).

开发者消息

• 在显示的消息的单元测试,仅在显示的消息调试,或消息记录到超详细诊断文件
• 开发人员消息不需要本地化,应该使用开发人员的语言编写.
  例如,如果开发公司位于莫斯科,那么用俄语写开发者消息就有很强的争议.
  在实践中,很多开发人员选择英语.

• 实施选项是多方面的.我通常使用静态类中的字段来保持简单.请注意,您可以为每个将显示消息的类型设置一个消息类,或者您可以在其中设置一个中央消息类,您可以在其中对多个类进行分组.您可以拥有嵌套的邮件组.您还可以添加其他类型的常量以在您的代码中使用...正如我所提到的,选项和首选项比比皆是.

  public static class FeatureMessages
  {
      #region Public Fields
  
      public const string ApiAccessError = 
          @"Error accessing api - check internet connection/api address";
      public const string SelectedClassFormatString = 
          @"Hello dear user – the selected class name is {0}";
  
      #endregion
  }
  

用户消息

• 显示给最终用户的消息.例如,安装提示,在用户GUI的菜单,对用户的警告消息框等
• 这些消息应该是本地化的.
• 实现很简单,至少需要一个默认的语言资源文件.有很多资源可以告诉你如何做到这一点,你可以在这里看到一个简单的解释

Answer 3

我通常建议使用资源文件（从您的项目设置创建）。如果您想让此代码更具可测试性，您可能需要提供某种包装器。