Menu
CoddyTech

记录每个请求

本课属于 Coddy ASP.NET Core 学习旅程的“Minimal APIs”单元。第 17 课,共 20 课。

中间件可以监视应用的响应。app.Logger 是应用已有的日志记录器,可用于端点之外的代码。这个中间件会对未找到资源的请求发出警告:

app.Use(async (context, next) =>
{
    await next();
    if (context.Response.StatusCode == 404)
        app.Logger.LogWarning("Nothing at {Path}", context.Request.Path);
});

它会在 await next() 之后,也就是返回时读取状态码,此时端点或后续中间件已经设置了状态码;在调用 next() 之前,状态码仍为 200。中间件的位置也很重要。最先添加的中间件会处理每个请求,包括被后续中间件提前终止的请求,并且在响应返回时最后运行。

challenge icon

挑战

简单

每个请求都会在 Console 中显示一行,例如 GET /api/recipes/2 -> 200。

  1. 在 Program.cs 中,紧接着 var app = builder.Build(); 之后,在 X-Api-Version 中间件上方添加一个中间件。
  2. 它会先调用 await next();,然后调用 app.Logger.LogInformation("{Method} {Path} -> {Status}", context.Request.Method, context.Request.Path, context.Response.StatusCode);。

试试看:按下“运行”。第一个请求是 GET /recipes/2,Console 会显示 GET /recipes/2 -> 301。发送 GET /api/recipes/99:先显示上一课中的警告,然后显示 GET /api/recipes/99 -> 404。发送 GET /index.html:显示 GET /index.html -> 200。

亲手试试

using Microsoft.AspNetCore.Http.HttpResults;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.Use(async (context, next) =>
{
    context.Response.Headers["X-Api-Version"] = "1";
    await next();
});

app.Use(async (context, next) =>
{
    if (context.Request.Path.StartsWithSegments("/recipes"))
    {
        context.Response.Redirect("/api" + context.Request.Path + context.Request.QueryString, permanent: true);
        return;
    }
    await next();
});

app.UseStaticFiles();

var recipes = new List<Recipe>
{
    new(1, "Tomato Soup", "soup", 25),
    new(2, "Pancakes", "breakfast", 15),
    new(3, "Lentil Soup", "soup", 40),
};
var nextId = 4;
var favoriteIds = new List<int>();

app.MapGet("/", () => "Recipe API is running");
app.MapGet("/api/recipes", (string? category) =>
    recipes.Where(r => category is null || r.Category == category));
app.MapGet("/api/recipes/{id:int}", (int id, ILogger<Program> logger) =>
{
    var recipe = recipes.FirstOrDefault(r => r.Id == id);
    if (recipe is null)
    {
        logger.LogWarning("Recipe {Id} was not found", id);
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    }
    return Results.Ok(recipe);
});

app.MapPost("/api/recipes", (NewRecipe input, ILogger<Program> logger) =>
{
    if (string.IsNullOrWhiteSpace(input.Name))
        return Results.BadRequest(new { error = "Name is required" });
    if (input.Minutes <= 0)
        return Results.BadRequest(new { error = "Minutes must be more than 0" });
    var recipe = new Recipe(nextId++, input.Name, input.Category, input.Minutes);
    recipes.Add(recipe);
    logger.LogInformation("Added recipe {Id}: {Name}", recipe.Id, recipe.Name);
    return Results.Created($"/api/recipes/{recipe.Id}", recipe);
});

app.MapPut("/api/recipes/{id:int}", (int id, NewRecipe input) =>
{
    var index = recipes.FindIndex(r => r.Id == id);
    if (index == -1)
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    var recipe = new Recipe(id, input.Name, input.Category, input.Minutes);
    recipes[index] = recipe;
    return Results.Ok(recipe);
});

app.MapDelete("/api/recipes/{id:int}", Results<NoContent, NotFound> (int id) =>
{
    var removed = recipes.RemoveAll(r => r.Id == id);
    return removed > 0 ? TypedResults.NoContent() : TypedResults.NotFound();
});

var favorites = app.MapGroup("/api/favorites");
favorites.MapGet("/", () => recipes.Where(r => favoriteIds.Contains(r.Id)));
favorites.MapPost("/{id:int}", (int id) =>
{
    if (!recipes.Any(r => r.Id == id))
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    if (!favoriteIds.Contains(id))
        favoriteIds.Add(id);
    return Results.NoContent();
});
favorites.MapDelete("/{id:int}", (int id) =>
{
    favoriteIds.Remove(id);
    return Results.NoContent();
});

app.Run();

Minimal APIs中的所有课