讲师中心 微信公众号
AI工具推荐 视频效率加速

c#如何使用日志框架Serilog_c#日志框架Serilog的几种常见写法

陌晨吖_5057

陌晨吖_5057

发布时间:2026-05-01 12:44:40

|

211人浏览过

|

来源于php中文网

原创

Serilog必须显式配置sink(如Console/File)且ASP.NET Core中需通过UseSerilog()接入DI容器,否则ILogger<T>注入失败;日志按Controller分离应利用SourceContext+Conditional,滚动策略推荐RollingInterval.Day。

c#如何使用日志框架serilog_c#日志框架serilog的几种常见写法

为什么直接 new LoggerConfiguration().CreateLogger() 会报错

Serilog 的 Logger 是单例设计,但 LoggerConfiguration.CreateLogger() 返回的是一个可被多次使用的 ILogger 实例——它本身不报错;真正常见报错是「未配置任何 sink,调用 Log.Information() 时静默失败」或「在 ASP.NET Core 外部手动创建后,跨线程/作用域使用导致 NullReferenceException」。

根本原因:Serilog 默认不输出日志,必须显式添加 sink(如控制台、文件);且若没通过依赖注入注册,手动创建的 logger 不参与生命周期管理,容易在对象销毁后仍被调用。

  • 务必至少调用一次 WriteTo.Console() 或 WriteTo.File()
  • 非 ASP.NET Core 环境下,建议将 ILogger 存为静态字段或全局变量,避免反复创建
  • ASP.NET Core 项目中,绝不要在 Startup / Program 中只调用 CreateLogger() 就完事——要走 UseSerilog() 扩展方法接入 DI 容器

ASP.NET Core 6+ 中正确注册 Serilog 的三步写法

.NET 6 起 Program.cs 是隐式主函数,Serilog 必须在 WebApplication 创建前完成初始化,否则中间件、控制器里的 ILogger<T> 注入会失败。

using Serilog;
using Serilog.Events;

var builder = WebApplication.CreateBuilder(args);

// 1. 配置 Serilog(必须在 builder.Build() 前)
Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .MinimumLevel.Override("Microsoft", LogEventLevel.Warning)
    .Enrich.FromLogContext()
    .WriteTo.Console()
    .WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day)
    .CreateLogger();

// 2. 将 Serilog 接入 DI 容器(关键!)
builder.Host.UseSerilog(); // ← 这行不能漏

// 3. 后续正常注册服务
builder.Services.AddControllers();

var app = builder.Build();
app.MapControllers();
app.Run();
  • builder.Host.UseSerilog() 是核心,它把 Serilog 绑定到 Microsoft.Extensions.Logging.ILogger 抽象层
  • 如果跳过这步,Controller 构造函数注入的 ILogger<WeatherForecastController> 仍是 Microsoft 默认 logger,和 Serilog 无关
  • Log.Logger 全局静态实例仅用于提前记录启动日志(比如配置加载失败),业务代码应始终依赖 DI 注入的 ILogger<T>

如何让不同 Controller 输出不同格式的日志

Serilog 本身不支持按类型动态切换输出格式,但可通过 Enrich.WithProperty() + 自定义 sink 过滤,或更实际的做法:用 SourceContext 字段做区分,再配合 WriteTo.Conditional() 控制输出目标。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

最轻量可控的方式是利用 ILogger<T> 的泛型类型名自动注入 SourceContext,然后在 sink 中过滤:

Log.Logger = new LoggerConfiguration()
    .WriteTo.Conditional(
        evt => evt.Properties.ContainsKey("SourceContext") && 
              evt.Properties["SourceContext"].ToString().Contains("AdminController"),
        wt => wt.File("logs/admin-.log", rollingInterval: RollingInterval.Day))
    .WriteTo.Conditional(
        evt => evt.Properties.ContainsKey("SourceContext") && 
              evt.Properties["SourceContext"].ToString().Contains("UserController"),
        wt => wt.File("logs/user-.log", rollingInterval: RollingInterval.Day))
    .CreateLogger();
  • SourceContext 是 Serilog 自动写入的字段,值就是 typeof(T).FullName,无需手动设置
  • 条件判断必须用 evt.Properties.ContainsKey() 防空,否则日志事件可能无 SourceContext(如直接调 Log.Information())
  • 不推荐为每个 Controller 新建独立 ILogger 实例——破坏 DI 原则,也难统一管理日志级别

文件日志滚动策略选 RollingInterval.Day 还是 RollingInterval.Infinite

RollingInterval.Day 每天生成新文件(如 log-20240520.txt),适合需要按日期归档、配合运维脚本清理的场景;RollingInterval.Infinite 则永不切分,只靠 retainedFileCountLimit 控制保留几个历史文件——但它其实不会“无限追加”,而是达到上限后删除最旧文件。

  • 生产环境强烈建议用 RollingInterval.Day 或 RollingInterval.Hour,避免单文件过大导致打开/传输/分析困难
  • 若选 RollingInterval.Infinite,必须配 retainedFileCountLimit: 30,否则磁盘会被撑爆
  • 注意 Windows 下文件名中的冒号 : 不合法,所以 RollingInterval.Hour 生成的文件名是 log-20240520_14.txt(用下划线替代冒号)

日志路径里带中文或空格一般没问题,但绝对路径开头别写 ~\——Serilog 的 WriteTo.File() 不解析 tilde,要用 AppContext.BaseDirectory 拼接。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

1012

2023.08.08

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2871

2023.08.31

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

865

2024.03.13

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2615

2024.03.14

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

312

2026.02.03

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

389

2026.02.06

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

631

2026.03.11

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

329

2026.04.13

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn