实习日志day6--实习日志day6--title命名规范化businessType纠正补充缺失的@Log注解报警与通信模块补充产出阶段总结文档-北京尧图网络

日期2026.7.8今日任务对照着Qoderwork刷算法题制定 title 命名规范统一为模块名操作描述格式如用户管理-列表查询、“设备管理-新增”修改系统模块 Controller 的 titleSysUserController.java将 12 处 title 统一为用户管理-XXX格式SysRoleController.java将 7 处 title 统一为角色管理-XXX格式SysMenuController.java将 11 处 title 统一为菜单管理-XXX格式修改设备模块 Controller 的 titleInstrumentsController.java将 24 处 title 统一为设备管理-XXX格式InsTypeController.java将 11 处 title 统一为设备类型-XXX格式InsPointController.java将 11 处 title 统一为测点管理-XXX格式InsLayoutController.java将 7 处 title 统一为设备布局-XXX格式修改报警模块 Controller 的 titleInsAlarmLogController.java7 处统一为报警日志-XXXInsAlarmFalseController.java9 处统一为误报管理-XXXInsAlarmEventCenterController.java4 处统一为报警事件-XXXInsAlarmRuleSnapshotController.java3 处统一为报警规则-XXX修改网关模块 Controller 的 titleGatewayOnlineLogController.java1 处统一为网关日志-导出GatewayCommandExecutionLogController.java1 处统一为网关指令日志-XXX修改通信模块 Controller 的 titleMqttController.java6 处统一为MQTT通信-XXXSerialPortController.java14 处统一为串口通信-XXXSerialPortAlarmBindingConfigController.java7 处统一为串口报警绑定-XXXSerialPortCommandConfigController.java7 处统一为串口指令配置-XXXSerialPortProfileController.java7 处统一为串口配置-XXX修改其他模块 Controller 的 title剩余的约 30 处检查所有使用 BusinessTypeEnum.OTHER 的接口判断是否应该改为更精确的类型例如MqttController 中 “MQTT消息视图清空” 应改为 DELETE 而非 OTHER“MQTT主题订阅/取消订阅” 可以保持 OTHER确实属于特殊操作检查所有使用 BusinessTypeEnum.SELECT 的接口确认是否真的是查询操作有没有把增删改误标为 SELECT 的情况检查 “新增或修改” 类接口的 businessType确认是否统一用 UPDATE 还是 INSERT为查询大数据量的接口设置 isSaveResponseData false避免日志表膨胀例如设备列表分页查询返回数据量大报警日志分页查询操作日志分页查询为文件上传/下载接口设置合理的 isSaveRequestData 和 isSaveResponseData为敏感操作重置密码、强制退出等确认 isSaveRequestData true 确保审计完整为以下 Controller 的所有接口补充 Log 注解这些是确认没有 Log 的关键业务 ControllerInsDataHistoryController.java设备历史数据查询title“设备历史数据-XXX”InstrumentsControlController.java设备控制操作title“设备控制-XXX”businessType 用 OPERATINGDeviceRealtimeController.java实时数据查询title“实时数据-XXX”DeviceLinkDiagnosisController.java链路诊断title“链路诊断-XXX”DataQualityDashboardController.java数据质量看板title“数据质量-XXX”为网关模块缺失 Log 的 Controller 补充注解GatewayInfoController.javatitle“网关管理-XXX”GatewayConfigController.javatitle“网关配置-XXX”GatewayDeviceRelationController.javatitle“网关设备关联-XXX”GatewayCommandFieldController.javatitle“网关指令字段-XXX”GatewayCommandTemplateController.javatitle“网关指令模板-XXX”为摄像头模块缺失 Log 的 Controller 补充注解AvCameraInstrumentsController.javatitle“摄像头管理-XXX”AvCameraCfgController.javatitle“摄像头配置-XXX”为通信模块缺失 Log 的 Controller 补充注解ProtocolTemplateController.javatitle“协议模板-XXX”SysMessageController.javatitle“消息管理-XXX”SmsController.javatitle“短信通知-XXX”businessType 用 SEND_DATAWeChatController.javatitle“微信通知-XXX”businessType 用 SEND_DATA为 AI 模块缺失 Log 的 Controller 补充注解AiSmartAlarmController.javatitle“AI智能报警-XXX”AiChatController.javatitle“AI对话-XXX”AiModelConfigController.javatitle“AI模型配置-XXX”整理所有修改的代码形成代码变更清单撰写《操作日志注解使用规范》文档包括title 命名规范“模块名-操作描述”businessType 选择指南什么操作用什么枚举isSaveRequestData/isSaveResponseData 使用建议新增接口 Log 注解添加模板今日完成完成多个业务模块 Controller 的title命名规范统一覆盖系统管理、设备管理、报警管理、网关管理、通信管理及其他业务模块共涉及180 处接口统一采用“模块名-操作描述”的命名格式提高日志可读性和维护性。全面检查项目中BusinessTypeEnum的使用情况对误用OTHER、SELECT等枚举的接口进行修正使业务操作类型与实际功能保持一致提高日志统计及审计准确性。对新增、修改等业务接口进行了统一规范保证同类接口使用一致的业务类型枚举。针对分页查询、历史数据查询、操作日志查询等大数据量接口合理配置isSaveResponseDatafalse减少日志表冗余数据存储降低数据库存储压力。对文件上传、下载以及敏感操作接口如重置密码、强制退出等重新评估日志记录策略合理设置请求参数及响应数据保存配置提高系统审计能力。为多个缺失Log注解的重要业务 Controller 补充日志埋点覆盖设备管理、网关管理、通信管理、摄像头管理、AI 模块等核心业务提高系统操作日志覆盖率。整理全部代码修改内容形成完整的代码变更清单。编写《操作日志注解使用规范》文档统一团队后续开发过程中Log注解的使用标准。学到的新知识1. 企业项目中的操作日志不仅用于记录更承担审计职责企业级项目中的Log注解不仅仅是为了方便开发人员查看日志更重要的是满足系统的审计需求。合理记录操作人、操作时间、请求参数、操作类型等信息可以帮助后续定位问题、分析用户行为以及满足安全合规要求。2. 一个优秀的日志系统需要统一规范今天最大的收获不是修改代码而是理解了为什么需要制定统一规范。例如title 统一采用“模块名-操作描述”BusinessType 使用统一标准查询接口统一标记为 SELECT删除接口统一标记 DELETE导出统一 EXPORT统一规范之后日志查询更加直观后续统计分析更加方便新人开发不会出现命名混乱的问题3. 日志并不是记录得越多越好今天了解到很多分页接口、历史数据接口返回的数据量非常大。如果仍然保存完整 Response日志表会快速膨胀数据库存储压力增大查询日志效率下降因此对于大数据量查询应合理关闭isSaveResponseData false这是一种典型的企业级性能优化思想。4. BusinessTypeEnum 的设计思想以前认为只是一个普通枚举。今天了解到它实际上承担着日志分类操作统计权限审计数据分析因此不同操作应该对应不同业务类型例如INSERTUPDATEDELETEEXPORTIMPORTSEND_DATAOPERATINGSELECT而不是全部使用 OTHER。今日BugBug项目中部分接口存在日志注解配置不规范的问题例如BusinessType使用错误查询接口误标为OTHER特殊操作未使用更准确的业务类型部分核心 Controller 缺少Log注解。原因随着项目不断迭代不同开发人员的编码习惯不同缺乏统一的日志规范导致日志注解配置存在不一致的情况。解决逐个检查所有 Controller对日志注解进行统一规范包括统一 title 命名修正 BusinessType补充缺失日志优化请求、响应数据保存策略总结企业项目中的代码规范不仅体现在编码风格更体现在统一的设计规范上。提前制定规范可以有效降低后续维护成本提高整个团队的开发效率。今日技术总结今天主要围绕企业级项目中的操作日志设计进行了深入学习对Log注解的使用有了更加系统的认识。总结下来一套优秀的操作日志需要重点考虑以下几个方面统一命名规范所有接口采用统一的title命名格式保证日志易于检索和统计。合理选择业务类型根据业务行为选择合适的BusinessTypeEnum提高日志分析价值。控制日志存储粒度针对大数据量接口关闭响应数据保存兼顾系统性能和审计需求。完善日志覆盖范围核心业务接口应全部补充Log注解确保关键操作均可追踪。形成团队开发规范通过编写《操作日志注解使用规范》文档将个人实践沉淀为团队规范提升项目整体代码质量和一致性。可写进简历参与企业级物联网平台操作日志模块规范化建设统一180 个接口的操作日志命名规范及业务类型配置提高日志一致性和可维护性。完善多个核心业务模块设备管理、报警管理、网关管理、通信管理、AI 模块等的Log日志埋点实现关键业务操作全链路日志覆盖。优化操作日志存储策略针对大数据量查询接口关闭响应数据记录降低日志表存储压力提升系统运行效率。编写《操作日志注解使用规范》文档沉淀团队开发规范为后续功能开发提供统一标准。STAR素材Situation项目中大量 Controller 的操作日志注解配置不统一不同模块存在命名混乱、业务类型使用不规范、部分接口缺失日志等问题影响日志查询、统计分析以及系统审计。Task负责统一整个项目的操作日志规范完善日志埋点并形成团队统一的开发规范。Action制定统一的title命名规则全面检查并修正BusinessTypeEnum使用优化请求、响应数据保存策略为多个核心业务模块补充Log注解编写《操作日志注解使用规范》文档沉淀最佳实践。Result完成全项目180 个接口的日志规范化改造实现核心业务日志全覆盖提高了日志可读性、系统审计能力和团队开发一致性同时形成了可持续复用的日志开发规范。今日成长一句话个人复盘今天最大的收获不是完成了大量接口的修改而是理解了企业级开发中的“规范”比“功能”更重要。统一的日志设计能够显著提升系统的可维护性、可审计性和团队协作效率这也是从“会写代码”迈向“会做项目”的重要一步。

实习日志day6--实习日志day6--title命名规范化businessType纠正补充缺失的@Log注解报警与通信模块补充产出阶段总结文档

相关推荐

数据科学家必学：用Docker实现ML模型可复现交付

鸿蒙新特性：TextPicker 滚轮选择器——构建三级地址选择器

Windows防撤回神器：如何让微信、QQ、TIM消息永久保存不再消失？

更多资讯

SpringBoot+Vue驾校预约系统开发实战

电商Java技术栈：Spring Boot与微服务实战解析

ClickHouse存储引擎：Partition与Part机制解析

i-have-adhd：一种可工程化的神经工作流操作系统

Spring Boot集成Thymeleaf模板引擎实战指南

游戏引擎工具链设计：从模块化架构到AI辅助开发

今日更新

SpacetimeDB C++ 模块库实战：用 C++20 在数据库内构建 WebAssembly 模块

别踩雷！不是所有 AI 写作工具都靠谱，2026 高校认可工具精选

SSM+MySQL幼儿园管理系统源码解析：从部署到优化

本周精选

超人会飞不算本事：系统稳定依赖清晰规则与边界设计

超人VS蜘蛛侠：拆解超级IP的影响力与传播方法论

基于CNN的调制信号识别：MATLAB实现时频图分类实战

本月热门

基于YOLO的焊缝缺陷检测：从数据标注到工业部署全流程实践

分布式服务的决策记录

创业产品的首版范围

读完文章，想聊聊您的网站？