TP6接口日志记录功能的实现

老瑶酱_4422

老瑶酱_4422

2026-08-17

193人浏览

原创

ThinkPHP6接口日志需通过中间件捕获请求响应、配置独立日志通道、结构化记录关键字段,并支持开关控制与异步写入以平衡性能。

tp6接口日志记录功能的实现

ThinkPHP6 的接口日志记录功能,核心在于拦截请求与响应过程,提取关键信息并持久化。默认日志组件不区分接口类型,需结合中间件、日志通道和自定义处理器来实现结构化、可筛选的接口日志。

使用中间件统一捕获接口请求与响应

在 app/middleware/ApiLogMiddleware.php 中编写中间件,利用 TP6 的 Request/Response 对象获取完整上下文:

  • 在 before 阶段记录请求时间、URI、方法、IP、请求头(如 token)、请求体(注意避免记录敏感字段或大文件)
  • 在 after 阶段补充响应状态码、耗时、响应大小、是否异常等信息
  • 用 Request::hasFile() 判断是否为文件上传,跳过 body 记录防止日志膨胀
  • 对 POST/PUT 的 JSON 请求,用 $request->param() 获取解析后数据;表单则用 $request->post()

配置独立日志通道专用于接口日志

在 config/log.php 中新增通道,避免与系统日志混杂:

Pi智能演示文档
Pi智能演示文档

一款AI演示文稿工具,主要用于领先的AI PPT生成工具,适合需要提升相关任务效率的用户。

下载
  • 设置 'channel' => 'api',驱动为 file 或 think(支持按日期分文件)
  • 指定 'path' => runtime_path('log/api/'),便于运维隔离归档
  • 启用 'level' => ['info', 'error'],仅记录业务级接口行为,不写 debug 级噪音

结构化日志内容,支持快速检索

不直接用 Log::info() 写字符串,而是构造标准数组,由日志处理器格式化:

  • 必含字段:method、uri、ip、status、cost_ms、user_id(从 token 解析)、trace_id(可集成 SkyWalking 或自生成)
  • 错误时追加 exception 和 file:line,方便定位
  • 日志写入前调用 json_encode($data, JSON_UNESCAPED_UNICODE),确保中文可读

按需启用与性能控制

接口日志影响性能,应提供开关机制:

  • 通过配置项 'api_log.enable' => env('API_LOG_ENABLE', false) 控制全局开关
  • 在中间件中用 in_array($request->action(), config('api_log.ignore')) 跳过健康检查、静态资源等非业务接口
  • 高并发场景下,考虑异步写入:将日志数据推入 Swoole\Table 或 Redis 队列,由协程消费者落盘

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

3188

3

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

2025.10.17

5149

12

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2025.12.29

3849

9

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2026.01.19

486

15

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

40

16

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

2026.10.28

20

15

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

2026.10.28

40

10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

140

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

80

10

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习