Menu
CoddyTech

使用 ILogger 记录日志

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

Console.WriteLine 只能打印文本。日志记录器会为每一行写入级别和类别,应用的设置决定保留哪些行。只需将日志记录器命名为参数,端点就能获取它:ASP.NET Core 会将 ILogger<T> 等服务传递给任何需要它们的 lambda。

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 lambda 添加第二个参数:ILogger<Program> logger。
  2. 紧接在 recipes.Add(recipe); 后面,调用 logger.LogInformation("Added recipe {Id}: {Name}", recipe.Id, recipe.Name);。

试试看:按“运行”,然后向 /api/recipes 发送 POST 请求,内容为 {"name":"Waffles","category":"breakfast","minutes":20}。Console 中会显示 info: Program[0] 和 Added recipe 4: Waffles。发送 {"minutes":5}:状态码为 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 APIs中的所有课