Menu
CoddyTech

すべてのリクエストをログに記録する

CoddyのASP.NET Coreジャーニー「Minimal API」セクションの一部。レッスン 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

チャレンジ

簡単

コンソールには、GET /api/recipes/2 -> 200のように、リクエストごとに1行表示されます。

  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で、コンソールには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 APIのすべてのレッスン