Clear Code for Minimal API

  • Clear Code for Minimal API已关闭评论
  • 62 次浏览
  • A+
所属分类:.NET技术
摘要

我在写MinimalAPI的时候,发现不能最清晰的看到每个API,原因就是:WebAPI中不断增长逻辑处理过程

我在写MinimalAPI的时候,发现不能最清晰的看到每个API,原因就是:WebAPI中不断增长逻辑处理过程

于是我在想如何简化API至一行,在一点一点想办法中,发现了简化DotNET Minimal API的方式。特此记录下来这个思路给需要帮助的人。我的灵感来源于 C# 11 功能 - 接口中的静态虚拟成员,通过静态虚拟成员清晰整个API。


这是我思路的最终结果:在 Program.cs 中我们能通过一行代码,清晰的看到代码情况。
而无需指定平常不是很关心的处理过程和请求方式。

app.MapGroup("Connect", o => {     o.MapMethods<Authorize>("Authorize");     o.MapMethods<Authorize.Callback>("Authorize/Callback");     o.MapMethods<Token>("Token");     o.MapMethods<UserInfo>("UserInfo").RequireAuthorization(new AuthorizeAttribute()     {         AuthenticationSchemes = OpenIddictValidationAspNetCoreDefaults.AuthenticationScheme     });     o.MapMethods<Endsession>("Endsession"); }); app.MapGroup("Account", o => {     o.MapMethods<Login>("Login");     o.MapMethods<Externallogin>("Externallogin");     o.MapMethods<Externallogin.Callback>("Externallogin/Callback");     o.MapMethods<ConfirmationLogin>("ConfirmationLogin");     o.MapMethods<ForgotPassword>("ForgotPassword");     o.MapMethods<ResetPassword>("ResetPassword"); }); 

结果结束。


我们只需要简单的三步就可以做到这个事情,并且可以不用反射和其他的复杂过程。
第一步,我们需要创建(附带静态抽象函数的接口)IEndpointBase。

public interface IEndpointBase {     public static abstract IEnumerable<string> HTTPMethods();     public static abstract Delegate Handler(); } 

第二步,需要实现IEndpointBase。

public class Login : IEndpointBase {     public record AccountLoginRequest     {         [JsonPropertyName("u"), Required]         public string UserName { get; set; } = default!;          [JsonPropertyName("p"), Required]         public string Password { get; set; } = default!;          [JsonPropertyName("r"), Required]         public string ReturnUrl { get; set; } = default!;          [FromQuery]         public bool UseCookies { get; set; }     }     public static Delegate Handler()     {         var callback = async ([FromBody] AccountLoginRequest request, [FromServices] SignInManager signInManager) =>         {             // Todo: returnUrl validate is success              var result = await signInManager.PasswordSignInAsync(request.UserName, request.Password, request.UseCookies, lockoutOnFailure: true);             return Results.Text(result.ToString());         };         return callback;     }      public static IEnumerable<string> HTTPMethods() => [HttpMethods.Post]; } 

第三步:处理静态IEndpointBase,此时我们已经完成了这件事情。

public static RouteHandlerBuilder MapMethods<T>(this IEndpointRouteBuilder app, [StringSyntax("Route")] string pattern) where T : IEndpointBase {     return app.MapMethods(pattern, T.HTTPMethods(), T.Handler()); } 

单纯的使用扩展好的 MapMethods 已经足够清晰了。


但如果有对API进行分组的要求,使用原生的还是不会清晰,原因是:

  1. 要对 MapGroup 的值赋予变量名,比如说 var accountGroup = app.MapGroup("Account"),每个组都要想个名字。accountGroup

  2. 不能清楚自己的边界,比如说 写代码时,有可能出现插队的情况,本来 accountGroup下面都是属于它的端点,结果不小心插进来一个别的。

于是简单的对MapGroup进行了扩展,最终结果在本文最上面。

public static void MapGroup(this IEndpointRouteBuilder endpoints, [StringSyntax("Route")] string prefix, Action<IEndpointRouteBuilder> action) {     var group = endpoints.MapGroup(prefix);     action(group); } 

总结:通过这种方式,代码结构已经清晰多了。若是有议,可以在评论区联系我。