教程：使用默认接口方法更新接口

项目
03/22/2023

可以在声明接口成员时定义实现。最常见的方案是安全地将成员添加到已经由无数客户端发布并使用的接口。

在本教程中，你将了解：

通过使用实现添加方法，安全地扩展接口。
创建参数化实现以提供更大的灵活性。
使实现器能够以替代的形式提供更具体的实现。

先决条件

需要将计算机设置为运行 .NET，包括 C# 编译器。 Visual Studio 2022 或 .NET SDK 随附 C# 编译器。

方案概述

本教程从客户关系库版本 1 开始。可以在 GitHub 上的示例存储库中获取入门应用程序。生成此库的公司希望拥有现有应用程序的客户采用其库。他们为使用其库的用户提供最小接口定义供其实现。以下是客户的接口定义：

public interface ICustomer
{
    IEnumerable<IOrder> PreviousOrders { get; }

    DateTime DateJoined { get; }
    DateTime? LastOrder { get; }
    string Name { get; }
    IDictionary<DateTime, string> Reminders { get; }
}

他们定义了表示订单的第二个接口：

public interface IOrder
{
    DateTime Purchased { get; }
    decimal Cost { get; }
}

通过这些接口，团队可以为其用户生成一个库，以便为其客户创造更好的体验。他们的目标是与现有客户建立更深入的关系，并改善他们与新客户的关系。

现在，是时候为下一版本升级库了。其中一个请求的功能可以为拥有大量订单的客户提供忠实客户折扣。无论客户何时下单，都会应用这一新的忠实客户折扣。该特定折扣是每位客户的财产。 ICustomer 的每个实现都可以为忠实客户折扣设置不同的规则。

添加此功能的最自然方式是使用用于应用任何忠实客户折扣的方法来增强 ICustomer 接口。此设计建议引起了经验丰富的开发人员的关注：“一旦发布，接口就是固定不变的！不要进行中断性变更！”应使用默认接口实现来升级接口。库作者可以向接口添加新成员，并为这些成员提供默认实现。

默认接口实现使开发人员能够升级接口，同时仍允许任何实现器替代该实现。库的用户可以接受默认实现作为非中断性变更。如果他们的业务规则不同，则可以进行替代。

使用默认接口方法升级

团队就最有可能的默认实现达成一致：针对客户的忠实客户折扣。

升级应提供用于设置两个属性的功能：符合折扣条件所需的订单数量以及折扣百分比。这些功能使其成为用于默认接口方法的完美方案。可以向 ICustomer 接口添加方法，并提供最有可能的实现。所有现有的和任何新的实现都可以使用默认实现，或者提供其自己的实现。

首先，将新方法添加到接口，包括方法的主体：

// Version 1:
public decimal ComputeLoyaltyDiscount()
{
    DateTime TwoYearsAgo = DateTime.Now.AddYears(-2);
    if ((DateJoined < TwoYearsAgo) && (PreviousOrders.Count() > 10))
    {
        return 0.10m;
    }
    return 0;
}

库作者编写了用于检查实现的第一个测试：

SampleCustomer c = new SampleCustomer("customer one", new DateTime(2010, 5, 31))
{
    Reminders =
    {
        { new DateTime(2010, 08, 12), "childs's birthday" },
        { new DateTime(1012, 11, 15), "anniversary" }
    }
};

SampleOrder o = new SampleOrder(new DateTime(2012, 6, 1), 5m);
c.AddOrder(o);

o = new SampleOrder(new DateTime(2103, 7, 4), 25m);
c.AddOrder(o);

// Check the discount:
ICustomer theCustomer = c;
Console.WriteLine($"Current discount: {theCustomer.ComputeLoyaltyDiscount()}");

注意测试的以下部分：

// Check the discount:
ICustomer theCustomer = c;
Console.WriteLine($"Current discount: {theCustomer.ComputeLoyaltyDiscount()}");

从 SampleCustomer 到 ICustomer 的强制转换是必需的。 SampleCustomer 类不需要为 ComputeLoyaltyDiscount 提供实现；这由 ICustomer 接口提供。但是，SampleCustomer 类不会从其接口继承成员。该规则没有更改。若要调用在接口中声明和实现的任何方法，该变量的类型必须是接口的类型，在本示例中为 ICustomer。

提供参数化

默认实现存在太多限制。此系统的许多使用者可能会选择不同的购买数量阈值、不同的会员资格时长或不同的折扣百分比。通过提供用于设置这些参数的方法，可为更多客户提供更好的升级体验。让我们添加一个静态方法，该方法可设置控制默认实现的三个参数：

// Version 2:
public static void SetLoyaltyThresholds(
    TimeSpan ago,
    int minimumOrders = 10,
    decimal percentageDiscount = 0.10m)
{
    length = ago;
    orderCount = minimumOrders;
    discountPercent = percentageDiscount;
}
private static TimeSpan length = new TimeSpan(365 * 2, 0,0,0); // two years
private static int orderCount = 10;
private static decimal discountPercent = 0.10m;

public decimal ComputeLoyaltyDiscount()
{
    DateTime start = DateTime.Now - length;

    if ((DateJoined < start) && (PreviousOrders.Count() > orderCount))
    {
        return discountPercent;
    }
    return 0;
}

这个小代码片段中展示了许多新的语言功能。接口现在可以包含静态成员，其中包括字段和方法。还启用了不同的访问修饰符。其他字段是专用的，新方法是公共的。接口成员允许使用任何修饰符。

使用常规公式计算忠实客户折扣但参数有所不同的应用程序不需要提供自定义实现；它们可以通过静态方法设置自变量。例如，以下代码设置“客户答谢”，奖励任何成为会员超过一个月的客户：

ICustomer.SetLoyaltyThresholds(new TimeSpan(30, 0, 0, 0), 1, 0.25m);
Console.WriteLine($"Current discount: {theCustomer.ComputeLoyaltyDiscount()}");

扩展默认实现

目前添加的代码提供了方便的实现，可用于用户需要类似默认实现的项目的方案，或用于提供一组不相关的规则。对于最后一个功能，让我们稍微重构一下代码，以实现用户可能需要基于默认实现进行生成的方案。

假设有一家想要吸引新客户的初创企业。他们为新客户的第一笔订单提供 50% 的折扣，而现有客户则会获得标准折扣。库作者需要将默认实现移入 protected static 方法，以便实现此接口的任何类都可以在其实现中重用代码。接口成员的默认实现也调用此共享方法：

public decimal ComputeLoyaltyDiscount() => DefaultLoyaltyDiscount(this);
protected static decimal DefaultLoyaltyDiscount(ICustomer c)
{
    DateTime start = DateTime.Now - length;

    if ((c.DateJoined < start) && (c.PreviousOrders.Count() > orderCount))
    {
        return discountPercent;
    }
    return 0;
}

在实现此接口的类的实现中，替代可以调用静态帮助程序方法，并扩展该逻辑以提供“新客户”折扣：

public decimal ComputeLoyaltyDiscount()
{
   if (PreviousOrders.Any() == false)
        return 0.50m;
    else
        return ICustomer.DefaultLoyaltyDiscount(this);
}

可以在 GitHub 上的示例存储库中查看整个完成的代码。可以在 GitHub 上的示例存储库中获取入门应用程序。

这些新功能意味着，当这些新成员拥有合理的默认实现时，接口可以安全地更新。精心设计接口，以表达由多个类实现的单个功能概念。这样一来，在发现针对同一功能概念的新要求时，可以更轻松地升级这些接口定义。