用途:本手册基于阿里巴巴Java开发手册(嵩山版),将Java开发规约分为编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约七个维度,供编写或审查Java代码、检查命名与代码规范、处理异常日志、编写单元测试、安全编码及数据库设计时参考。规约按约束力分为【强制】【推荐】【参考】三级。
主要能力:提供命名规范速查(类名UpperCamelCase、方法与变量lowerCamelCase、常量全大写加下划线、包名全小写);禁止事项速查(拼音命名、魔法值、SELECT *、Executors创建线程池、字符串拼接SQL、finally中return、foreach中remove);必须事项速查(覆写方法加@Override、表必备id/create_time/update_time三字段、敏感数据脱敏、参数校验、ThreadLocal回收、日志用占位符);异常处理、数据库建表与索引命名、并发处理(线程池创建、ThreadLocal回收)等速查示例。
使用方式:按场景查阅对应章节文档,如代码审查查coding-convention.md、exception-log.md、security.md;新项目搭建查design.md、project-structure.md、mysql.md、unit-test.md;问题排查查NPE防护、索引规约、并发处理等章节。
适用场景:Java代码编写与审查、命名与规范检查、异常日志处理、单元测试、安全编码、数据库设计。
限制:资料未提供具体安装命令、收费方式、平台支持及实际效果说明,相关内容暂未提供。