Hidewnd Docs Hidewnd Docs
首页
  • 常用开发环境
  • 常用提示词
  • 常用Linux命令
  • 常用Git规范及命令
  • Java开发聊天机器人
  • word模板生成实现方案
  • 基于Go写一个极简的通讯demo
  • SpringBoot配置文件加密处理
  • SpringBoot优雅的抛出业务异常
  • 通用大模型适配器
  • 10分钟快速搭建个人博客
  • [学习笔记]Lua
  • [学习笔记]JVM
  • [学习笔记]设计模式
  • [部署笔记]搭建Typecho博客
  • [部署笔记]部署Qsign签名机
  • [部署笔记]安装PVE系统
  • [部署笔记]部署KingBaseV9电科金仓
  • 技艺成本
  • Rules
  • Setting
  • Skill
  • 剑三网站合集
  • 合并大区角色数据处理
  • 25PT冷龙峰教学笔记
  • 25PT太极宫教学笔记
  • 25PT弓月城教学笔记
关于
GitHub (opens new window)
首页
  • 常用开发环境
  • 常用提示词
  • 常用Linux命令
  • 常用Git规范及命令
  • Java开发聊天机器人
  • word模板生成实现方案
  • 基于Go写一个极简的通讯demo
  • SpringBoot配置文件加密处理
  • SpringBoot优雅的抛出业务异常
  • 通用大模型适配器
  • 10分钟快速搭建个人博客
  • [学习笔记]Lua
  • [学习笔记]JVM
  • [学习笔记]设计模式
  • [部署笔记]搭建Typecho博客
  • [部署笔记]部署Qsign签名机
  • [部署笔记]安装PVE系统
  • [部署笔记]部署KingBaseV9电科金仓
  • 技艺成本
  • Rules
  • Setting
  • Skill
  • 剑三网站合集
  • 合并大区角色数据处理
  • 25PT冷龙峰教学笔记
  • 25PT太极宫教学笔记
  • 25PT弓月城教学笔记
关于
GitHub (opens new window)
  • Cursor
  • Rules

    • caching-and-distributed-lock
    • database-entity-annotations
    • design-patterns
    • idempotency-specification
    • java-21-language-specification
    • java-clean-code-effective-java-spec
    • java-entity-vo-specification
    • java-language-specification
    • logging-specification
      • 日志级别使用
      • 日志内容规范
      • 日志位置选择
      • 占位符与性能
      • 日志配置建议
    • openapi-and-api-doc-spec
    • persistence-repository-specification
    • rest-api-specification
    • springboot-architecture-layering
    • springboot-config-and-profiles
    • springboot-exception-and-error-code
    • springboot-testing-specification
    • validation-specification
  • Setting

  • Skill

  • Cursor
  • Rules
hidewnd
目录

日志规范

# 日志规范

# 日志级别使用

  • TRACE:极细粒度调试信息,仅在特殊场景临时开启
  • DEBUG:调试信息,用于开发与测试环境
  • INFO:关键业务流程与状态变化,默认生产环境保留
  • WARN:潜在问题或非预期但未影响主流程的情况
  • ERROR:业务失败或系统错误

# 日志内容规范

  • 关键日志中包含以下字段:
    • traceId 或 requestId
    • 用户标识或主体标识
    • 业务主键或重要资源标识
  • 日志文案简洁,描述事件与结果,不记录无用信息
  • 避免在日志中输出明文密码、密钥等敏感信息

# 日志位置选择

  • 在接口入口记录请求概要与关键参数
  • 在重要业务分支记录决策结果
  • 在异常处理处记录异常堆栈与业务上下文

# 占位符与性能

  • 使用参数化日志写法,避免字符串拼接
log.info("创建订单成功, orderId={}, userId={}", orderId, userId);
1
  • 对高频调用的日志进行采样控制或降低级别
  • 避免在循环中打印大量日志

# 日志配置建议

  • 不同环境使用不同日志配置文件,开发环境保留 DEBUG 级别,生产环境以 INFO 为主
  • 输出 JSON 格式日志时统一字段名称,便于日志平台解析
java-language-specification
openapi-and-api-doc-spec

← java-language-specification openapi-and-api-doc-spec→

github
Theme by Vdoing | Copyright © 2024-2026 Hidewnd
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式