API控制器方法传入CancellationToken的作用与合理性探讨

我正在维护一个刚开发完成的代码库，发现所有控制器方法的最后一个参数均为CancellationToken ct = default，示例代码如下：

public async Task<ActionResult<List<City>>> GetCitiesAsync(CancellationToken ct = default)

我想知道这种写法是否正确？开发人员为何要这么做？我能想到的唯一原因是方便单元测试调用，但测试项目中并未找到相关用例，否则似乎完全没必要。原开发人员已离职，无法咨询。

写法是否正确？ #

这种写法完全正确，是ASP.NET Core控制器处理异步操作的标准实践之一。

开发人员这么做的核心原因 #

• 响应客户端请求取消：在ASP.NET Core中，当用户关闭浏览器、主动中断请求或请求超时后，框架会自动生成对应的取消令牌。控制器方法声明该参数后，框架会自动注入请求级别的CancellationToken，你可以把这个令牌传递给方法内部的异步操作（比如数据库查询、第三方API调用），一旦请求被取消，就能立刻终止这些耗时操作，避免浪费服务器资源。
• 为后续扩展预留空间：就算当前方法没用到取消令牌，提前声明它也能避免后续修改方法签名。如果之后需要在方法里添加支持取消的异步逻辑，直接用已有的ct参数即可，不用改动方法的调用方。
• 统一异步代码规范：.NET生态里的异步API大多都支持CancellationToken，控制器方法统一声明这个参数，能让代码风格保持一致，团队其他成员接手时也更容易理解和维护。

你提到的单元测试只是小众场景，这种写法的核心价值还是处理请求取消和规范异步代码。

内容的提问来源于stack exchange，提问作者advapi