Clear Code for Minimal API

clear,code,for,minimal,api · 浏览次数 : 0

小编点评

**简化DotNET Minimal API的方式:** **1. 使用接口静态抽象方法** * 创建一个接口 `IEndpointBase`,其中包含 `HTTPMethods` 方法,该方法返回要处理的所有 HTTP 方法。 * 实现 `IEndpointBase` 的接口,例如 `Login` 类,其中包含 `HTTPMethods` 方法,并实现不同的 HTTP 方法的处理逻辑。 **2. 使用 MapGroup 方法创建分组** * 使用 `MapGroup` 方法将 API分组,并为每个组分配一个 `IEndpointRouteBuilder`。 * 在每个组中,使用 `MapMethods` 方法注册相应的 API 方法。 **3. 使用扩展方法简化代码** * 创建一个扩展方法 `MapMethods`,它接受一个泛型参数 `T`,其中 `T` 是 `IEndpointBase` 接口的实现类。 * 在 `MapMethods` 中,使用泛型参数绑定 `T`,并使用 `MapMethods` 方法注册 API 方法。 **示例代码:** ```csharp // IEndpointBase 接口 public interface IEndpointBase { IEnumerable HTTPMethods(); Handler Handler(); } // Login 类实现 IEndpointBase public class Login : IEndpointBase { // ... } // Map Methods 方法用于注册 API 方法 public static RouteHandlerBuilder MapMethods(this IEndpointRouteBuilder app, string pattern) where T : IEndpointBase { return app.MapMethods(pattern, T.HTTPMethods(), T.Handler()); } ``` **其他提示:** * 使用 `[HttpGet]`, `[HttpPost]` 等标签来标记 API 方法。 * 使用 `[FromQuery]` 和 `[FromBody]` 注解绑定查询参数和请求体数据。 * 使用 `[Authorize]` 和 `[Authorize.Callback]` 注解实现身份验证和回调机制。

正文

我在写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"),每个组都要想个名字。

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

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

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

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

与Clear Code for Minimal API相似的内容:

Clear Code for Minimal API

我在写MinimalAPI的时候,发现不能最清晰的看到每个API,原因就是:WebAPI中不断增长逻辑处理过程 于是我在想如何简化API至一行,在一点一点想办法中,发现了简化DotNET Minimal API的方式。特此记录下来这个思路给需要帮助的人。我的灵感来源于 C# 11 功能 - 接口中的

.NET性能优化-ArrayPool同时复用数组和对象

前两天在微信后台收到了读者的私信,问了一个这样的问题,由于私信回复有字数和篇幅限制,我在这里统一回复一下。读者的问题是这样的: 大佬您好,之前读了您的文章受益匪浅,我们有一个项目经常占用 7-8GB 的内存,使用了您推荐的ArrayPool以后降低到 4GB 左右,我还想着能不能继续优化,于是 du

转载--逍遥模拟器与burpsuite抓包配置问题

逍遥模拟器与burpsuite抓包配置问题 逍遥模拟器

抓的是周树人,与我鲁迅有什么关系?

单独拎出这个题目,是因为昨天看到一线码农大佬公众号的分享[Dictionary.Clear 和 new Dictionary() 有什么不同?](https://mp.weixin.qq.com/s/JUtr9TFRDfAvEeu6vJkI1w) ### 无心插画 ``` void Example1

.NET周刊【8月第3期 2023-08-20】

## 国内主题 ### 抓的是周树人,与我鲁迅有什么关系? https://www.cnblogs.com/JulianHuang/p/17642511.html - **问题**:作者看到了一个关于Dictionary.Clear和new Dictionary的问题,想要探究为什么在foreach

Manim使用心得

# Manim 使用心得 manim 做视频还是挺方便的。 当然,如果你每一次都从 0 开始写,那么你会崩溃。 所以需要找到自己做视频的风格,以此总结出一套通用的 python 模板代码,然后调用。 例如: ```py self.clear() prv = None for i, text in e

[转帖]Linux内存管理 -- /proc/{pid}/smaps讲解

https://www.jianshu.com/p/8203457a11cc 本文包括如下三部分: 基本介绍与输出介绍 第一行基础信息讲解 详细信息讲解3.1 Size3.2 Rss3.3 Pss、Shared/Private_Clean/Dirty3.4 Referenced3.5 Anonymo

PPT 编辑顶点

编辑顶点的N种玩法 针对特定的形状进行编辑 选中形状 -> 右键 -> 编辑顶点 如果【编辑顶点】是灰色的,需要上网下一个 office clean touris,清理一下 合并形状:多个形状,变成一个形状 编辑顶点:一个形状,点对点调整,变成另一种形状 顶点编辑 平滑顶点:两个控点必须在一条水平线