哪个选项更好 编程实践.

本文关键字:编程 更好 选项 | 更新日期: 2023-09-27 18:35:09

我正在编写一个创建Hammock REstRequest对象扩展的过程,并想知道哪种实现(非常相似)被认为是更好的编程实践。这是对象定义,它有 2 个构造函数

public class RequestObject : RestRequest
{    
    public RequestObject()
    {
        this.Encoding = System.Text.Encoding.UTF8;
        System.Net.ServicePointManager.Expect100Continue = false;
    }
    public RequestObject(WebMethod webMethod, byte[] ContentArray)
        : this()
    {
        if (webMethod == Hammock.Web.WebMethod.Put
            || webMethod == Hammock.Web.WebMethod.Post)
        {
            //encode payload string to a utf8 byte array
            this.AddPostContent(ContentArray);
            this.AddHeader("Content-Type", "application/json");
        }
    }
}

对于对象的构造,我可以通过两种方式做到这一点,内联实例化它,如下所示:

string payload = serializer.Serialize(user);
RequestObject request
    = new RequestObject(WebMethod.Put, BuildAPI.GetBytes(payload))
      {
          Credentials = new BasicAuthCredentials
          {
              Username = ConfigurationManager.AppSettings["UserName"],
              Password = ConfigurationManager.AppSettings["Password"]
          },
          UserAgent = ConfigurationManager.AppSettings["UserAgent"],
      };

或者调用"构建类"的成员来构造对象:

public static RequestObject BuildRequest(WebMethod method, byte[] byteArray)
{
    RequestObject request = new RequestObject(WebMethod.Put, byteArray)
    {
        Credentials = new BasicAuthCredentials
        {
            Username = ConfigurationManager.AppSettings["UserName"],
            Password = ConfigurationManager.AppSettings["Password"]
        },
        UserAgent = ConfigurationManager.AppSettings["UserAgent"],
        Method = method
    };
    return request;
}

并按如下方式调用它:

RequestObject request = BuildAPI.BuildRequest(WebMethod.Put, payload);

我只是想知道这两个选项中的哪一个被认为是更好的编程实践。我正在阅读 SOLID,现在我对同一个类中的多个"函数"感到紧张,但不想过度思考。

哪个选项更好 编程实践.

在 SOLID 原则之前开始,你的代码非常不连贯。你有一些静态BuildAPI - 所以要么决定坚持它,要么不使用它。因为它是静态的,所以这个决定应该基于你是否怀疑将来这些构造需要多态。

第二点注意:你真的需要两个构造函数吗?似乎只使用了一个。

第三点注意:你在构造函数中初始化了一些属性,并使用属性初始值设定项初始化了一些属性 - 为什么不只坚持一个范式(POD 对象或类)?

最后,至于 SOLID 原则 - 您的RequestObject显然违反了单一责任原则,这从您将enum传递给构造函数的事实中可以明显看出。所以这个类实际上代表几个适合在一起的类。考虑将RequestObject抽象化,并为每个请求类型实现一个单独的子类。

像这样:

abstract class RequestObject
{
    //properties and methods common to all requests
    protected RequestObject(...)
    {
        //initialize common properties
    }
}
class GetRequest : RequestObject
{
    public GetRequest()
    {
        this.Encoding = System.Text.Encoding.UTF8;
        System.Net.ServicePointManager.Expect100Continue = false;
    }
    //... other specific things for GET
}
class PutRequest : RequestObject
{
    public PutRequest()
    {
        this.AddPostContent(ContentArray);
        this.AddHeader("Content-Type", "application/json");
    }
    //... specific things for PUT
}

。你明白了。也许你也可以在RequestObjectPost之间建立另一个层次,Put因为他们也可能分享一些行为。