Menu
CoddyTech

ILoggerを使ったログ記録

CoddyのASP.NET Coreジャーニー「Minimal API」セクションの一部。レッスン 15/20。

Console.WriteLineはテキストを出力するだけです。ロガーは各行にレベルとカテゴリを付けて書き込み、どの行を保持するかはアプリの設定で決まります。エンドポイントはパラメーターとして名前を指定することでロガーを受け取ります。ASP.NET Coreは、ILogger<T>のようなサービスを、それを要求する任意のラムダに渡します。

app.MapPost("/orders", (NewOrder input, ILogger<Program> logger) =>
{
    logger.LogInformation("Order of {Count} items for {Customer}", input.Count, input.Customer);
    return Results.Ok();
});

メッセージはテンプレートです。各{Name}には、次の引数が順番に代入されます。ロガーは値を名前付きフィールドとして保持するため、ログツールで検索できます。コンソールにはinfo: Program[0]が表示され、その下の行にメッセージが表示されます。レベル、カテゴリ(ILogger<Program>に由来するProgram)、イベントIDが含まれます。

challenge icon

チャレンジ

簡単

アプリは追加したレシピをそれぞれログに記録します。

  1. Program.csで、POST /api/recipesのラムダに2つ目のパラメーターILogger<Program> loggerを追加します。
  2. recipes.Add(recipe);の直後に、logger.LogInformation("Added recipe {Id}: {Name}", recipe.Id, recipe.Name);を呼び出します。

試してみましょう:「実行」を押して、{"name":"Waffles","category":"breakfast","minutes":20}を/api/recipesにPOSTします。Consoleにはinfo: Program[0]とAdded recipe 4: Wafflesが表示されます。{"minutes":5}をPOSTします: ステータスは400で、ログには何も記録されません。

自分で試してみよう

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) =>
{
    var recipe = recipes.FirstOrDefault(r => r.Id == id);
    if (recipe is null)
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    return Results.Ok(recipe);
});

app.MapPost("/api/recipes", (NewRecipe input) =>
{
    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);
    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のすべてのレッスン