探索 .NET团队对API的设计流程

最新推荐文章于 2024-01-20 14:13:31 发布

dotNET跨平台

最新推荐文章于 2024-01-20 14:13:31 发布

阅读量184

点赞数

文章标签：编程语言 python 人工智能 java 大数据

原文作者：steve gordon 原文链接: https://www.stevejgordon.co.uk/how-are-dotnet-apis-designed

在这篇文章中，我想介绍一些我觉得非常有趣的东西，.NET 团队是如何设计API的？我们先来看下.NET团队面临的有哪些挑战，您正在设计一套API库，每天有数百万的开发人员在使用这些库，它们在世界各地运行在重要的应用程序上面，您要对其进行改进并添加新功能或增强功能，而且不能破坏数百万个现有应用程序，这确实让人头大。

null

我喜欢编写C＃代码，自己也写过很多API库，其中很多都是内部使用的库，而使用这个库的不到30人，即使这样，我仍然写了bug，那我得修啊，但我没有意识到所有的环境下这个库都是否可以使用，以过去我的经验，我觉得设计公共API很困难。

在本文的其余部分中，我将按照我的理解来解释.NET API设计过程，这些是我根据对这一过程进行了几年的观察而得出的自己的解释，团队所做的大部分工作都是公开发布的，因此可以从他们如何组织.NET Core（和.NET 5）的API设计中学到很多东西。

为了使解释更具体，我将遵循最近的新库的设计，该库将作为.NET 5的.NET BCL（基类库）的一部分包括在内，比如，System.Net.Http.Json 这个库优化了 HttpClient 处理Json，我今天不讲这个库如何使用，我们将专注于它是如何产生的。

1.设计阶段 - Design

最开始，Immo Landwerth 发现在HttpClient中处理Json很麻烦，于是他在github提了一个json扩展的建议，里面包含了遇到了哪些问题，然后如何改进。

null

用简单明了的术语，描述了这个设计如何变得更好，以及用户（开发人员）对该功能的使用体验，包括示例代码，表达了开发人员会在什么情况下使用这个API。

在明确方案的情况下，接着继续介绍新的API的要求,它必须实现什么目标，在什么时间范围内？然后是设计本身，该设计包括建议的公共API，但是没有任何实现细节, 这包括设计引入的所有公共方法和类型。

2.NET设计审查阶段 - Review

.NET流程的下一个阶段是进行API设计审查, 这在Github上面进行，团队创建了一个 Issue，https://github.com/dotnet/runtime/issues/32937, 大家都有权限看到，这是公开的，因此社区可以征询反馈和建议，我真的很喜欢这些.NET开放的氛围！

API开始审查，在此会议上，.NET团队的核心专家汇聚一堂，评估方案并确保公共API适合目标框架，这是至关重要的一步，为了兼容性，设计中的错误或疏忽可能会持续很长时间，这意味着API决策需要彻底，团队也希望该API易于使用。

在API审核期间，会有人代表提案，并说明拟议设计的目标和原因，然后，团队将对其进行讨论，并确定提案是否需要进一步的工作，然后再批准，在被认为可以接受之前，可以在多次设计评审中提出一个API。

我真正欣赏团队的一点是，他们在YouTube上现场直播了这次会议，任何人都可以观看，尽管有时在会议期间聊天中留下的评论和反馈可能被认为是讨论的一部分，但这主要是一种仅查看的方法，在YouTube上，.NET Foundation 频道下的所有播放记录都可以去浏览。

您可以在YouTube上查看HttpClient JSON扩展方法的设计的讨论，https://www.youtube.com/watch?v=_AHbjIS8_0I

null

当我感兴趣的API有讨论的时候，我就会经常上去看这些，我发现听到讨论并观看.NET团队对设计框架的想法非常有趣，在此过程中必须考虑许多细微的差异，这里面包含了大量的.NET 方面的知识，通常会提出一些细微的实现细节行为，例如现有API的历史方面及其行为，可能观看这样一次会议，要花一两个小时，但我还是建议您有空可以参加其中的一些会议，来真正欣赏.NET框架的设计。

在审查期间，通常会使用GitHub Issue的标准做法, .NET的程序经理 Immo Landwerth 通常主持会议并在讨论过程中做笔记, 任何关注,反馈和更改都将记录为设计审查的输出。

3. 提交阶段 - PR

一旦获得批准，开发人员开始写写写，来实现这个API，就像这个示例一样，可能某些工作已经试验完成，然后还将需要把一些更改的内容，记录到设计评审的反馈中。

该功能的大部分工作由David Cantu完成，可以在GitHub上的拉取请求（PR）这里看到，https://github.com/dotnet/runtime/pull/33459 ，同样的它在Github，公开透明，任何人都可以订阅通知，甚至发表评论。

我建议开发人员应该很熟悉这个阶段，开发人员在git分支上完成了一些工作，一旦该工作完成并准备好考虑合并，就可以创建一个PR，一般可以直接合并到项目，但是出于质量考虑，其他开发人员通常会进行一个或多个代码审查，在Microsoft .NET世界中，这必须要考虑全面，因为不一致和性能问题可能是以后要解决的问题。

在这个例子中（Json扩展库），我们可以看到很多评论，包扩多个有经验的专家，您将看到有关代码复杂性的详细反馈，这是我从提出和讨论的小项目中学到很多东西的地方，随着时间的推移，您可以观看PR，甚至可以查看较新的提交，这些提交可以解决反馈并解决任何问题。