实习日志day5——熟悉检查项目日志注解
发布时间:2026/7/8 6:00:55
分类:文化教育
浏览:1234

日期2026.7.7今日任务刷数组和链表用Grep扫描所有Controller文件整理出缺失Log的两个清单对已有Log的83个文件逐一检查titile和businessType是否合理标记问题点输出《操作日志注解现状分析表》和《操作日志注解Log现状分析报告》列出文件名、接口数、已有Log、缺失Log、titile问题、businessType问题今日完成用QoderWork完成扫描所有的Controller文件并整理出缺失的Log的两个清单用excel文件来进行演示对已有的Log的83个文件逐一检查title和businessType是否合理并转化为markdown形式的文档来进行演示综合上述两点问题产出《操作日志注解现状分析表》同时列出文件名、接口数、已有Log、缺失Log、title问题、businessType问题学到的新知识合理运用AI来进行效率提升减少重复性工作增加个人排查bug和代码逻辑问题效率50%结束工作之后要有对应的合理产出不然就是白费功夫单纯完成任务成为工具人今日BugBug部分缺失和完全缺失Log、title前缀不统一、businessType不匹配原因上任后端开发不规范解决对不同级别的问题进行分类处理总结合理安排流程同时在开发时应该合理标注好今日技术总结今天完成了 mentor 布置的「操作日志注解」专题学习任务核心产出有两份第一份产出《Log 操作日志注解理解指南》按「注解定义 → 枚举分类 → 标杆示例 → 切面源码」的顺序逐层深入系统梳理了 Log 从标记到最终写入 sys_log 表的完整数据流包含 7 个自检问题可作为团队新人的学习参考文档。第二份产出《Log 注解现状分析报告》通过扫描全项目 114 个 Controller、1076 个接口方法得到以下关键数据指标 数值已有 Log 的接口 58454%缺失 Log 的接口 49246%完全缺失 Log 的文件 31 个title 前缀不统一的文件 43 个businessType 有误的文件 1 个按 P0-P3 优先级对问题进行分类P0完全缺失31 个文件约 300 个接口优先处理 device/gateway、device/camera、device/report、task、bigdata 等核心模块P1部分缺失75 个文件492 个接口缺失重点关注缺失数 ≥5 的文件P2title 不统一43 个文件统一格式为模块中文名 动作词P3businessType 有误仅 1 个文件SysUserOnlineController.export 应改为 EXPORT核心收获 整个日志模块的设计处处体现着「日志是旁路功能不能拖垮主流程」的原则——异步写库、异常安全整个 handleLog 被 try-catch 包裹、脱敏处理、长度截断这些都是生产级代码应有的严谨度。可写进简历独立完成企业级 Spring Boot AOP 操作日志模块的源码级学习深入理解自定义注解Log的设计模式、枚举分类26 种 BusinessType、切面执行链路并输出结构化学习笔记可作为团队新人的参考文档对全项目 114 个 Controller、1076 个接口方法进行 Log 使用情况扫描与统计分析识别出 492 个缺失 Log 的接口按 P0-P3 优先级分类并给出修复建议为后续系统化补齐操作日志提供决策依据掌握生产级 AOP 切面的安全设计实践敏感参数自动脱敏password/token → ******、请求/响应长度截断保护防数据库爆表、异步写库解耦不阻塞业务主流程STAR素材Situation入职第一周mentor 布置了「操作日志注解」专题学习任务。操作日志是系统可观测性的重要组成部分需要深入理解 Log 注解的工作原理、切面执行机制并对全项目的 Log 使用现状进行全面评估为后续统一补齐遗漏的日志注解做准备。Task在两周内完成以下工作系统阅读 4 个核心源文件Log.java / BusinessTypeEnum.java / SerialPortAlarmBindingConfigController.java / LogAspectj.java输出结构化的《Log 操作日志注解理解指南》学习笔记对全项目所有 Controller 进行 Log 使用情况扫盲统计覆盖率识别缺失、title 不统一、businessType 有误等问题按优先级分类并给出修复建议Action深入源码层采用「注解定义 → 枚举分类 → 标杆示例 → 切面源码」的阅读顺序逐行跟踪 handleLog 的六步执行流程用流程图记录数据从 Log 到 sys_log 表的完整链路明确规范以 mentor 指定的 SerialPortAlarmBindingConfigController 为标杆提炼出 4 条 Log 使用规范全覆盖、title 格式、businessType 语义一致、注解顺序全量扫描用 Python 脚本逐行解析 114 个 Controller 源文件按注解归属关系精确匹配每个接口的 Log 状态统计出 584/107654%的覆盖率和 492 个缺失接口分类分级按 P0完全缺失 31 个文件、P1部分缺失 75 个文件、P2title 不统一 43 个文件、P3businessType 有误 1 个文件建立优先级矩阵为后续修复提供 roadmapResult产出《Log 操作日志注解理解指南》学习笔记包含 7 个自检问题可作为团队新人学习参考产出《Log 注解现状分析报告》包含 114 个文件的详细扫描结果和按优先级分级的修复建议清单提炼出 Log 注解的 4 条使用规范和 26 种 BusinessType 枚举分类说明对日志模块的掌握程度可通过自检清单全部确认为后续在业务开发中正确使用 Log 注解以及参与系统化补齐工作打下扎实基础