極簡(jiǎn) API，到底多神奇？

圖片

在傳統(tǒng)的ASP.NET Core 開(kāi)發(fā)中，構(gòu)建一個(gè) API 往往需要經(jīng)歷繁瑣的步驟。你得創(chuàng)建控制器類(lèi)，定義各種方法來(lái)處理不同的 HTTP 請(qǐng)求，還要操心路由配置、依賴(lài)注入等一系列復(fù)雜的事情。這就好比搭建一座房子，從打地基開(kāi)始，一磚一瓦地慢慢壘砌，過(guò)程復(fù)雜且耗時(shí)。

而ASP.NET Core 極簡(jiǎn) API 的出現(xiàn)，就像是給開(kāi)發(fā)者們帶來(lái)了一套神奇的 “搭建工具包”。它極大地簡(jiǎn)化了 API 的創(chuàng)建過(guò)程，讓開(kāi)發(fā)者可以用極少的代碼實(shí)現(xiàn)強(qiáng)大的功能。簡(jiǎn)單來(lái)說(shuō)，極簡(jiǎn) API 允許你在一個(gè)文件中定義整個(gè) API，通過(guò)簡(jiǎn)潔的方法調(diào)用就能完成路由映射、請(qǐng)求處理等關(guān)鍵操作 。比如，你想要?jiǎng)?chuàng)建一個(gè)簡(jiǎn)單的返回 “Hello, World!” 的 API，在極簡(jiǎn) API 中，可能只需要短短幾行代碼：

var builder = WebApplication.CreateBuilder(args);var app = builder.Build();app.MapGet("/", () => "Hello, World!");app.Run();

對(duì)比傳統(tǒng)方式，這種極簡(jiǎn)風(fēng)格的開(kāi)發(fā)是不是瞬間讓你感覺(jué)輕松了許多？它就像一把鋒利的 “手術(shù)刀”，精準(zhǔn)地切除了傳統(tǒng)開(kāi)發(fā)中那些冗余的部分，讓開(kāi)發(fā)流程變得更加流暢、高效。

傳統(tǒng)開(kāi)發(fā) VS 極簡(jiǎn) API，誰(shuí)更勝一籌？

為了讓大家更直觀地感受到極簡(jiǎn) API 的優(yōu)勢(shì)，我們不妨來(lái)一場(chǎng)傳統(tǒng)ASP.NET Core 開(kāi)發(fā)方式與極簡(jiǎn) API 的 “對(duì)決”。

代碼量：極簡(jiǎn) API 的 “輕裝上陣”

在傳統(tǒng)開(kāi)發(fā)中，創(chuàng)建一個(gè)簡(jiǎn)單的 API，光是控制器類(lèi)的定義就需要不少代碼。以一個(gè)獲取用戶(hù)信息的 API 為例，傳統(tǒng)方式可能需要這樣寫(xiě)：

[ApiController][Route("[controller]")]public class UserController : ControllerBase{[HttpGet("{id}")]public IActionResult Get(int id){// 這里是獲取用戶(hù)信息的邏輯，比如從數(shù)據(jù)庫(kù)查詢(xún)var user = new { Id = id, Name = "張三", Age = 30 };return Ok(user);}}

而在極簡(jiǎn) API 中，同樣的功能只需幾行代碼就能實(shí)現(xiàn)：

var builder = WebApplication.CreateBuilder(args);var app = builder.Build();app.MapGet("/users/{id}", (int id) =>{var user = new { Id = id, Name = "張三", Age = 30 };return Results.Ok(user);});app.Run();

很明顯，極簡(jiǎn) API 的代碼量大幅減少，讓開(kāi)發(fā)者可以更專(zhuān)注于業(yè)務(wù)邏輯的實(shí)現(xiàn)，而不是被繁瑣的代碼結(jié)構(gòu)所束縛。

項(xiàng)目結(jié)構(gòu)：極簡(jiǎn) API 的 “簡(jiǎn)潔布局”

傳統(tǒng)ASP.NET Core 項(xiàng)目結(jié)構(gòu)相對(duì)復(fù)雜，包含 Controllers、Models、Views（即使在純 API 項(xiàng)目中可能用不到）、Services 等多個(gè)文件夾和大量的配置文件。每個(gè)部分都有其特定的職責(zé)和規(guī)范，這雖然在大型項(xiàng)目中有助于代碼的組織和維護(hù)，但對(duì)于一些小型項(xiàng)目或快速迭代的項(xiàng)目來(lái)說(shuō)，顯得過(guò)于臃腫。

而極簡(jiǎn) API 項(xiàng)目結(jié)構(gòu)則極為簡(jiǎn)潔，核心代碼可以集中在 Program.cs 文件中，所有的路由定義、服務(wù)配置、中間件使用等操作都可以在這個(gè)文件中完成。這使得項(xiàng)目結(jié)構(gòu)一目了然，降低了開(kāi)發(fā)和維護(hù)的難度 。

開(kāi)發(fā)效率：極簡(jiǎn) API 的 “加速引擎”

從開(kāi)發(fā)效率上看，極簡(jiǎn) API 的優(yōu)勢(shì)也十分明顯。傳統(tǒng)開(kāi)發(fā)方式中，開(kāi)發(fā)者需要在不同的文件和類(lèi)之間來(lái)回切換，進(jìn)行各種配置和代碼編寫(xiě)，這在一定程度上會(huì)打斷開(kāi)發(fā)思路，降低開(kāi)發(fā)效率。

而極簡(jiǎn) API 的簡(jiǎn)潔語(yǔ)法和集中式的代碼結(jié)構(gòu)，讓開(kāi)發(fā)者能夠快速地完成 API 的創(chuàng)建和修改。比如，當(dāng)需要新增一個(gè) API 端點(diǎn)時(shí)，在極簡(jiǎn) API 中只需在 Program.cs 文件中添加一行 MapXXX 方法調(diào)用即可，而傳統(tǒng)方式則需要?jiǎng)?chuàng)建新的控制器方法、配置路由等多個(gè)步驟。這種高效的開(kāi)發(fā)方式，能夠大大縮短項(xiàng)目的開(kāi)發(fā)周期，讓產(chǎn)品更快地推向市場(chǎng)。

極簡(jiǎn) API 初體驗(yàn)，三行代碼構(gòu)建 Web 應(yīng)用

圖片

說(shuō)了這么多，相信大家已經(jīng)迫不及待地想要親自體驗(yàn)一下極簡(jiǎn) API 的魅力了。下面，就讓我們通過(guò)一個(gè)簡(jiǎn)單的示例，來(lái)感受一下如何用極簡(jiǎn) API 創(chuàng)建一個(gè) Web 應(yīng)用。

（一）創(chuàng)建 Web 應(yīng)用實(shí)例

首先，我們需要?jiǎng)?chuàng)建一個(gè) Web 應(yīng)用實(shí)例。在.NET 6 中，這一步變得非常簡(jiǎn)單，只需要一行代碼：

var builder = WebApplication.CreateBuilder(args);

這行代碼使用WebApplication.CreateBuilder方法創(chuàng)建了一個(gè)WebApplicationBuilder實(shí)例，它負(fù)責(zé)初始化應(yīng)用程序的配置、服務(wù)和中間件等。args參數(shù)是從命令行傳遞進(jìn)來(lái)的參數(shù)，通常用于接收啟動(dòng)應(yīng)用程序時(shí)的一些配置信息 。

（二）定義路由和處理邏輯

接下來(lái)，我們要定義一個(gè)路由和對(duì)應(yīng)的處理邏輯。假設(shè)我們要?jiǎng)?chuàng)建一個(gè)簡(jiǎn)單的 API，當(dāng)用戶(hù)訪問(wèn)根路徑/時(shí)，返回 “Hello, World!”。在極簡(jiǎn) API 中，只需要這樣寫(xiě)：

var app = builder.Build();app.MapGet("/", () => "Hello, World!");

第一行代碼調(diào)用builder.Build()方法，構(gòu)建并返回一個(gè)WebApplication實(shí)例，這個(gè)實(shí)例代表了我們的 Web 應(yīng)用。第二行代碼使用app.MapGet方法定義了一個(gè) GET 請(qǐng)求的路由，當(dāng)用戶(hù)訪問(wèn)根路徑/時(shí)，會(huì)執(zhí)行后面的匿名函數(shù)，返回 “Hello, World!” 字符串。MapGet方法是EndpointRouteBuilderExtensions類(lèi)的擴(kuò)展方法，它的第一個(gè)參數(shù)是路由模板，第二個(gè)參數(shù)是請(qǐng)求處理委托 。

（三）運(yùn)行應(yīng)用

最后，我們需要運(yùn)行這個(gè)應(yīng)用，讓它監(jiān)聽(tīng)并處理來(lái)自客戶(hù)端的請(qǐng)求。同樣，只需要一行代碼：

app.Run();

這行代碼會(huì)啟動(dòng)應(yīng)用程序，并開(kāi)始監(jiān)聽(tīng)配置中指定的 URL 地址（默認(rèn)為http://localhost:5000和https://localhost:5001）。當(dāng)有客戶(hù)端請(qǐng)求到達(dá)時(shí)，應(yīng)用會(huì)根據(jù)定義的路由規(guī)則來(lái)處理請(qǐng)求 。

把以上代碼整合起來(lái)，完整的Program.cs文件如下：

var builder = WebApplication.CreateBuilder(args);var app = builder.Build();app.MapGet("/", () => "Hello, World!");app.Run();

就是這么簡(jiǎn)單，一個(gè)完整的 Web 應(yīng)用就創(chuàng)建好了。你可以將這段代碼復(fù)制到你的項(xiàng)目中，運(yùn)行起來(lái)，然后在瀏覽器中訪問(wèn)http://localhost:5000，就能看到 “Hello, World!” 的輸出了。

深度探索：極簡(jiǎn) API 的強(qiáng)大功能

圖片

前面我們已經(jīng)初步領(lǐng)略了極簡(jiǎn) API 的風(fēng)采，接下來(lái)，讓我們深入探索一下它的強(qiáng)大功能，看看它在實(shí)際開(kāi)發(fā)中能為我們帶來(lái)哪些便利。

（一）靈活的路由定義

在極簡(jiǎn) API 中，路由定義變得非常靈活。除了前面提到的MapGet方法用于定義 GET 請(qǐng)求的路由外，還有MapPost、MapPut、MapDelete等方法，分別用于定義 POST、PUT、DELETE 請(qǐng)求的路由 。

例如，我們要?jiǎng)?chuàng)建一個(gè)新增用戶(hù)的 API，可以使用MapPost方法：

app.MapPost("/users", (User user) =>{// 這里是將用戶(hù)數(shù)據(jù)保存到數(shù)據(jù)庫(kù)的邏輯// 假設(shè)保存成功后返回一個(gè)表示成功的消息return Results.Ok("用戶(hù)添加成功");});

在這個(gè)例子中，當(dāng)客戶(hù)端向/users發(fā)送 POST 請(qǐng)求時(shí)，請(qǐng)求體中的數(shù)據(jù)會(huì)自動(dòng)綁定到User類(lèi)型的參數(shù)上，然后執(zhí)行相應(yīng)的處理邏輯 。

我們還可以使用Map方法來(lái)定義更復(fù)雜的路由規(guī)則，它可以根據(jù)請(qǐng)求的路徑和 HTTP 方法來(lái)匹配路由 。例如：

app.Map("/custom", app =>{app.MapGet("/", () => "這是自定義路由的GET請(qǐng)求處理邏輯");app.MapPost("/", () => "這是自定義路由的POST請(qǐng)求處理邏輯");});

在這個(gè)例子中，/custom路徑下定義了 GET 和 POST 兩種請(qǐng)求的處理邏輯，通過(guò)這種方式，可以將相關(guān)的路由集中管理，使代碼結(jié)構(gòu)更加清晰 。

（二）輕松處理請(qǐng)求和響應(yīng)

極簡(jiǎn) API 在處理請(qǐng)求和響應(yīng)方面也非常便捷。我們可以直接在路由處理委托中獲取請(qǐng)求數(shù)據(jù)、處理業(yè)務(wù)邏輯并生成響應(yīng) 。

比如，我們要?jiǎng)?chuàng)建一個(gè)根據(jù)用戶(hù) ID 獲取用戶(hù)信息的 API，并且在請(qǐng)求頭中傳遞了一個(gè)認(rèn)證令牌，我們可以這樣實(shí)現(xiàn)：

app.MapGet("/users/{id}", (HttpContext context, int id) =>{// 從請(qǐng)求頭中獲取認(rèn)證令牌var token = context.Request.Headers["Authorization"].FirstOrDefault();// 這里可以添加令牌驗(yàn)證邏輯// 假設(shè)這里從數(shù)據(jù)庫(kù)中查詢(xún)用戶(hù)信息var user = GetUserFromDatabase(id);if (user!= null){return Results.Ok(user);}else{return Results.NotFound();}});

在這個(gè)示例中，HttpContext參數(shù)提供了對(duì)當(dāng)前請(qǐng)求的上下文信息的訪問(wèn)，我們可以從中獲取請(qǐng)求頭、請(qǐng)求體等數(shù)據(jù)。根據(jù)業(yè)務(wù)邏輯的處理結(jié)果，我們使用Results.Ok返回成功的響應(yīng)，使用Results.NotFound返回未找到資源的響應(yīng) 。

（三）中間件的使用

中間件在ASP.NET Core 中起著至關(guān)重要的作用，它可以對(duì)請(qǐng)求和響應(yīng)進(jìn)行攔截和處理，實(shí)現(xiàn)諸如日志記錄、身份驗(yàn)證、錯(cuò)誤處理等功能。在極簡(jiǎn) API 中，中間件的使用同樣簡(jiǎn)單 。

比如，我們要添加一個(gè)日志記錄中間件，記錄每個(gè)請(qǐng)求的 URL 和處理時(shí)間，可以這樣實(shí)現(xiàn)：

app.Use(async (context, next) =>{var startTime = DateTime.Now;// 記錄請(qǐng)求的URLConsole.WriteLine($"請(qǐng)求URL: {context.Request.Path}");await next();var endTime = DateTime.Now;var elapsedTime = endTime - startTime;// 記錄請(qǐng)求處理時(shí)間Console.WriteLine($"請(qǐng)求處理時(shí)間: {elapsedTime.TotalMilliseconds} 毫秒");});

在這個(gè)例子中，Use方法用于添加中間件，它接受一個(gè)委托，委托中包含HttpContext和Func<Task>類(lèi)型的參數(shù)。HttpContext表示當(dāng)前請(qǐng)求的上下文，F(xiàn)unc<Task>表示下一個(gè)中間件或請(qǐng)求處理邏輯。在委托中，我們可以在調(diào)用下一個(gè)中間件之前和之后執(zhí)行自定義的邏輯 。

如果我們要?jiǎng)?chuàng)建一個(gè)自定義的中間件類(lèi)，也非常簡(jiǎn)單。首先創(chuàng)建一個(gè)中間件類(lèi)，例如：

public class CustomMiddleware{private readonly RequestDelegate _next;public CustomMiddleware(RequestDelegate next){_next = next;}public async Task InvokeAsync(HttpContext context){// 這里可以添加自定義的請(qǐng)求處理邏輯Console.WriteLine("自定義中間件處理請(qǐng)求前");await _next(context);// 這里可以添加自定義的響應(yīng)處理邏輯Console.WriteLine("自定義中間件處理響應(yīng)后");}}

然后，在Program.cs文件中添加這個(gè)自定義中間件：

app.UseMiddleware<CustomMiddleware>();

通過(guò)這種方式，我們就可以將自定義的中間件添加到請(qǐng)求處理管道中，實(shí)現(xiàn)對(duì)請(qǐng)求和響應(yīng)的個(gè)性化處理 。

應(yīng)用場(chǎng)景大揭秘，看看它適合哪兒

圖片

（一）快速原型開(kāi)發(fā)

在快速原型開(kāi)發(fā)階段，時(shí)間就是一切，開(kāi)發(fā)者需要快速地將想法轉(zhuǎn)化為可運(yùn)行的原型。極簡(jiǎn) API 的簡(jiǎn)潔特性使其成為快速原型開(kāi)發(fā)的理想選擇 。

比如，一家創(chuàng)業(yè)公司正在開(kāi)發(fā)一款新的移動(dòng)應(yīng)用，需要在短時(shí)間內(nèi)搭建一個(gè)后端 API 來(lái)驗(yàn)證業(yè)務(wù)邏輯和數(shù)據(jù)交互。使用極簡(jiǎn) API，開(kāi)發(fā)者可以在短短幾天內(nèi)就完成基礎(chǔ) API 的搭建，包括用戶(hù)注冊(cè)、登錄、數(shù)據(jù)獲取等功能 。這樣，團(tuán)隊(duì)可以快速地將原型展示給投資者或潛在用戶(hù)，收集反饋，進(jìn)行迭代。如果使用傳統(tǒng)的開(kāi)發(fā)方式，可能需要花費(fèi)數(shù)周的時(shí)間來(lái)完成同樣的功能，這無(wú)疑會(huì)延長(zhǎng)產(chǎn)品的開(kāi)發(fā)周期，增加項(xiàng)目的風(fēng)險(xiǎn) 。

（二）微服務(wù)架構(gòu)

在微服務(wù)架構(gòu)中，每個(gè)微服務(wù)都應(yīng)該是獨(dú)立的、可擴(kuò)展的，并且能夠快速迭代。極簡(jiǎn) API 的輕量級(jí)特性和靈活的路由定義，使其非常適合用于構(gòu)建微服務(wù) 。

以一個(gè)大型電商系統(tǒng)為例，它可能包含訂單服務(wù)、商品服務(wù)、用戶(hù)服務(wù)等多個(gè)微服務(wù)。每個(gè)微服務(wù)都可以使用極簡(jiǎn) API 來(lái)實(shí)現(xiàn)，這樣可以減少每個(gè)服務(wù)的代碼量和復(fù)雜度，提高系統(tǒng)的可維護(hù)性。當(dāng)某個(gè)微服務(wù)需要擴(kuò)展時(shí)，由于其代碼簡(jiǎn)潔，更容易進(jìn)行性能優(yōu)化和水平擴(kuò)展。如果訂單服務(wù)的流量突然增加，開(kāi)發(fā)團(tuán)隊(duì)可以快速地對(duì)訂單服務(wù)的極簡(jiǎn) API 進(jìn)行優(yōu)化，增加服務(wù)器實(shí)例，以應(yīng)對(duì)高并發(fā)的請(qǐng)求 。

（三）簡(jiǎn)單 HTTP API

對(duì)于只需要基本 CRUD 操作的 API，極簡(jiǎn) API 提供了一種簡(jiǎn)潔高效的解決方案。比如，一個(gè)小型的博客系統(tǒng)，它只需要提供文章的創(chuàng)建、讀取、更新和刪除功能 。使用極簡(jiǎn) API，開(kāi)發(fā)者可以輕松地實(shí)現(xiàn)這些功能，代碼量少，且易于理解和維護(hù)。

app.MapGet("/articles/{id}", (int id) =>{// 從數(shù)據(jù)庫(kù)中查詢(xún)文章var article = GetArticleFromDatabase(id);if (article!= null){return Results.Ok(article);}else{return Results.NotFound();}});app.MapPost("/articles", (Article article) =>{// 將文章保存到數(shù)據(jù)庫(kù)SaveArticleToDatabase(article);return Results.Created($"/articles/{article.Id}", article);});app.MapPut("/articles/{id}", (int id, Article updatedArticle) =>{// 更新數(shù)據(jù)庫(kù)中的文章var success = UpdateArticleInDatabase(id, updatedArticle);if (success){return Results.NoContent();}else{return Results.NotFound();}});app.MapDelete("/articles/{id}", (int id) =>{// 從數(shù)據(jù)庫(kù)中刪除文章var success = DeleteArticleFromDatabase(id);if (success){return Results.NoContent();}else{return Results.NotFound();}});

在這個(gè)例子中，通過(guò)極簡(jiǎn) API 的MapGet、MapPost、MapPut和MapDelete方法，清晰地定義了文章相關(guān)的 CRUD 操作，代碼簡(jiǎn)潔明了，沒(méi)有多余的冗余代碼 。

總結(jié)與展望，極簡(jiǎn) API 的未來(lái)之路

圖片

ASP.NET Core 極簡(jiǎn) API 以其簡(jiǎn)潔的代碼結(jié)構(gòu)、高效的開(kāi)發(fā)方式和靈活的功能特性，為開(kāi)發(fā)者帶來(lái)了全新的開(kāi)發(fā)體驗(yàn)。它不僅簡(jiǎn)化了傳統(tǒng) API 開(kāi)發(fā)中的繁瑣流程，還在性能和可維護(hù)性上有著出色的表現(xiàn)。無(wú)論是快速原型開(kāi)發(fā)、微服務(wù)架構(gòu)的構(gòu)建，還是簡(jiǎn)單 HTTP API 的實(shí)現(xiàn)，極簡(jiǎn) API 都展現(xiàn)出了強(qiáng)大的優(yōu)勢(shì) 。

對(duì)于廣大開(kāi)發(fā)者來(lái)說(shuō)，不妨在接下來(lái)的項(xiàng)目中嘗試使用ASP.NET Core 極簡(jiǎn) API，親身體驗(yàn)它帶來(lái)的便捷與高效。相信隨著.NET 技術(shù)的不斷發(fā)展，極簡(jiǎn) API 也將不斷完善和進(jìn)化，為我們帶來(lái)更多的驚喜和可能 。讓我們一起期待極簡(jiǎn) API 在未來(lái)的.NET 開(kāi)發(fā)中綻放更加耀眼的光芒，助力我們打造出更加優(yōu)秀、高效的應(yīng)用程序 。