0

0

C# 实体框架拦截器方法 C#如何使用Interceptor记录SQL

月夜之吻

月夜之吻

发布时间:2026-02-07 12:13:02

|

178人浏览过

|

来源于php中文网

原创

EF Core 6+ 推荐用 DbCommandInterceptor 实现 SQL 日志记录,需在 AddDbContext 配置中注册线程安全实例,重写 CommandExecuting/CommandExecuted;避免 LogTo 的语义日志局限,兼顾参数安全格式化、异步落盘与采样策略。

c# 实体框架拦截器方法 c#如何使用interceptor记录sql

EF Core 中如何注册 DbCommandInterceptor 实现 SQL 日志记录

EF Core 6+ 推荐用 DbCommandInterceptor 拦截原始 SQL 执行,它比旧版的 IDbCommandTreeInterceptor 更轻量、更直接。注册必须在 DbContextOptionsBuilder 阶段完成,且拦截器实例需是线程安全的(不能带状态,或自行同步)。

常见错误:把拦截器当普通服务注入到构造函数里,或在 OnConfiguring 中重复 AddInterceptors —— 这会导致多次注册、日志重复甚至异常。

  • Startup.csProgram.csservices.AddDbContext 配置中调用 .AddInterceptors(new SqlLoggerInterceptor())
  • 拦截器类需继承 DbCommandInterceptor,重写 CommandExecuting(同步执行前)或 CommandExecuted(执行后)
  • 若只需看 SQL,CommandExecuting 足够;若还要查耗时或结果行数,用 CommandExecuted 并检查 result 是否为 DbDataReaderint

CommandExecuting 中如何安全提取参数化 SQL 和参数值

EF Core 默认使用参数化查询,DbCommand.CommandText 是带 @param 的模板,DbCommand.ParametersDbParameter 集合。直接拼接易出错,尤其遇到 DBNull.Value、二进制数据或日期时区问题。

别手动遍历 Parameters 拼字符串 —— 容易漏转义、类型不一致、日志格式混乱。推荐用现成工具辅助格式化。

  • command.Parameters.Cast().Select(p => $"{p.ParameterName} = {p.Value ?? "NULL"}").ToArray() 快速调试,但仅限开发环境
  • 生产环境建议用 Microsoft.Data.SqlClientSqlClientFactory.CreateCommand() + ToString() 行为模拟,或引入轻量库如 EFCore.SqlServer.Interceptors(非官方)做安全展开
  • 注意:p.Value 可能是 DateTimeOffsetbyte[]Guid,打印前先 ToString("O")Convert.ToString() 避免 ToString() 返回空或乱码

为什么 LogTo 不够用,还得自己写拦截器

DbContextOptionsBuilder.LogTo 确实能打日志,但它输出的是 EF Core 内部语义(如 “Executing DbCommand [Parameters=[@p0='xxx']]”),不包含真实 SQL 文本,也不方便对接 ELK、Seq 等结构化日志系统。

WOMBO
WOMBO

使用AI创作美丽的艺术品

下载

更重要的是:LogTo 不暴露命令执行耗时、影响行数、是否成功等上下文,也无法修改命令(比如统一加 SET STATISTICS IO ON 调试)。

  • LogTo 输出不可控,字段无固定 schema;拦截器中可自由构造 JSON 对象,含 commandTextparametersdurationMstimestampisSuccess
  • 某些场景需改写 SQL:比如多租户系统中自动注入 WHERE TenantId = @tenantId,这只能在 CommandExecuting 中通过修改 command.CommandText 和追加参数实现
  • LogTo 无法区分是迁移命令、查询还是 SaveChanges —— 拦截器可通过 command.CommandTypeText / StoredProcedure)和上下文判断

拦截器里写日志要注意线程安全和性能开销

每次数据库操作都会触发拦截器,高频写文件或同步 HTTP 请求会拖慢整个请求链路。日志本身不该成为瓶颈。

容易被忽略的点:拦截器方法运行在 EF Core 的同步/异步执行路径中,Console.WriteLineFile.AppendAllText 这类同步 I/O 会阻塞线程池,尤其在高并发 Web API 下极易引发线程饥饿。

  • 日志写入务必异步:用 ILogger.LogInformation(底层已适配 async logger provider),或投递到 Channel 由后台任务批量刷盘
  • 避免在拦截器里做耗时操作:如序列化大对象、查配置中心、调远程服务 —— 这些应提前缓存或降级
  • 生产环境建议加采样开关,比如只记录慢 SQL(durationMs > 500)或失败命令(result.Exception != null

最复杂的不是怎么写拦截器,而是怎么让它既看得清 SQL,又不拖垮系统 —— 参数格式化、异步落盘、采样策略,这三块漏掉任一,上线后都可能变成隐性故障源。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

856

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

331

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

351

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1468

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

365

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

1046

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

581

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

430

2024.04.29

Golang处理数据库错误教程合集
Golang处理数据库错误教程合集

本专题整合了Golang数据库错误处理方法、技巧、管理策略相关内容,阅读专题下面的文章了解更多详细内容。

39

2026.02.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.9万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号