[译]使用DOT语言和GraphvizOnline来可视化你的ASP.NETCore3.0终结点01

第2部分-向ASP.NET Core应用程序添加终结点图

第3部分-使用ImpromptuInterface创建一个自定义的DfaGraphWriter，以便于反射

作者：依乐祝
原文：https://andrewlock.net/visualizing-asp-net-core-endpoints-using-graphvizonline-and-the-dot-language/
译文：https://www.cnblogs.com/yilezhu/p/13301981.html

在这篇文章中，我将展示如何在ASP.NETCore3.0应用程序中使用GraphvizOnline服务。这使您可以创建如下所示的图表，这些图表描述了应用程序中的所有端点：

用GraphvizOnline和DOT语言绘制图形

GraphvizOnline是一个GitHub上的开源项目，它为DOT图形描述语言 提供了一个在线可视化工具。这是一种简单的语言，它允许您定义各种类型的图形，它将节点与边连接起来。

例如，一个基本的无向图可以定义为

graph MyGraph { a -- b -- c; b -- d; }

它描述了以下图表：

每个节点都有一个名称(a, b, c, d)，并且--定义节点之间的边缘。边定义节点之间的连接，但它们没有方向(因此名称，无向【undirected】).

当然，你也可以定义一个有向图，其中边是有方向的。对于有向边，使用->而不是--。例如：

digraph MyGraph { a -> b -> c; d -> b; }

它描述了以下图表：

您可以自定义节点和边缘以多种方式显示的方式。例如，可以标记节点和边缘：

digraph MySimpleGraph { // The label attribute can be used to change the label of a node... a [label="Foo"]; b [label="Bar"]; // ... or an edge a -> b [label="Baz"]; }

你可以使用DOT图形描述语言做更多的事情，这正是我们现在所需要的。那么，这如何应用于ASP.NET Core应用程序呢？

使用有向图来可视化ASP.NET Core终结点

ASP.NETCore中的终结点路由系统通过创建端点URL段的有向图来有效地工作。然后将传入的请求与图进行匹配（一次一个段），以确定要执行的终结点。

例如，以下简单有向图表示ASP.NET Core3.0 RazorPages 默认应用程序模板中的终结点(dotnet new webapp)，其中包含三个Razor页面：Index.cshtml, Error.cshtml和Privacy.cshtml:

digraph DFA { 1 [label="/Error/"] 2 [label="/Index/"] 3 [label="/Privacy/"] 4 -> 1 [label="/Error"] 4 -> 2 [label="/Index"] 4 -> 3 [label="/Privacy"] 4 [label="http://www.likecs.com/"] }

其中描述为如下图表：

.

在上面的DOT文件中，节点被赋予顺序的整数名，1, 2, 3等，并使用端点名称进行标记。这是ASP.NET Core用于表示终结点图的格式。

对于Razor页面，路由非常简单，所以图非常明显。ASP.NET Core WebAPI应用程序生成了一个更有趣的图表。例如，下面显示的ASP.NET Core 2.0默认模板中包含的ValuesController。它使用多个HTTP谓词，以及稍微复杂的URL结构：

[Route("api/[controller]")] [ApiController] public class ValuesController : ControllerBase { // GET api/values [HttpGet] public ActionResult<IEnumerable<string>> Get() => new string[] { "value1", "value2" }; // GET api/values/5 [HttpGet("{id}")] public ActionResult<string> Get(int id) => "value"; // POST api/values [HttpPost] public void Post([FromBody] string value) { } // PUT api/values/5 [HttpPut("{id}")] public void Put(int id, [FromBody] string value) { } // DELETE api/values/5 [HttpDelete("{id}")] public void Delete(int id) { } }

为了更好地度量，我还添加了一个基本的健康检查端点。UseEndpoints():

app.UseEndpoints(endpoints => { endpoints.MapHealthChecks("/healthz"); endpoints.MapControllers(); });

此应用程序生成以下图表：

digraph DFA { 1 [label="/healthz/"] 2 [label="/api/Values/{...}/ HTTP: GET"] 3 [label="/api/Values/{...}/ HTTP: PUT"] 4 [label="/api/Values/{...}/ HTTP: DELETE"] 5 [label="/api/Values/{...}/ HTTP: *"] 6 -> 2 [label="HTTP: GET"] 6 -> 3 [label="HTTP: PUT"] 6 -> 4 [label="HTTP: DELETE"] 6 -> 5 [label="HTTP: *"] 6 [label="/api/Values/{...}/"] 7 [label="/api/Values/ HTTP: GET"] 8 [label="/api/Values/ HTTP: POST"] 9 [label="/api/Values/ HTTP: *"] 10 -> 6 [label="/*"] 10 -> 7 [label="HTTP: GET"] 10 -> 8 [label="HTTP: POST"] 10 -> 9 [label="HTTP: *"] 10 [label="/api/Values/"] 11 -> 10 [label="/Values"] 11 [label="/api/"] 12 -> 1 [label="/healthz"] 12 -> 11 [label="/api"] 12 [label="http://www.likecs.com/"] }

表现为如下图表：