首页 > 解决方案 > 当涉及到具有大量可选参数的函数时,惯例是什么?

问题描述

我有一个简单的 HttpsGet 函数,它需要大约 20 个可选参数。

现在,我正在考虑让每个参数都是可选的,还是让用户创建一个他们将与该函数一起使用的自定义 Options 对象。创建 200 个重载是不可能的。

使该功能对其他用户可读且易于使用的最佳方法是什么?我错过了另一个解决方案吗?

为了便于阅读,这里是代码的简化版本。

static List<Assignments> GetAllAssignments([Optional] string levels, [Optional] string passed, [Optional] stringresurrected)
{               
    var json = Get($"assignments?{levels}&{passed}&{resurrected}");
    var assignments = JsonConvert.DeserializeObject<CollectionResponse<Assignments>>(json).Data;
    return assignments;            
}

标签: c#conventionsoptional-parameters

解决方案


通常最好有一个“选项对象”来传递它而不是单个值。否则调用者很容易传递错误的值。

static List<LevelProgression> GetLevelProgressions(LevelProgressionOptions options) 
{ 
}

选项可能看起来像这样

public class LevelProgressionOptions
{
    public LevelProgressionOptions()
    {
        // Set any default values
        SomeProperty = 1;
    }

   public int SomeProperty { get; set; }
   public string AnotherOption { get; set; }
   //  other values omitted
}

推荐阅读