SuperAPI AI 工具集

java-development-manual

编程与开发

查看项目

更新于 10-15 17:26

技能介绍

用途:本手册基于阿里巴巴Java开发手册(嵩山版),将规约分为7个维度,规约按约束力分【强制】【推荐】【参考】三级,用于Java代码编写与审查、命名与代码规范检查、异常日志处理、单元测试、安全编码、数据库设计等。

主要能力:一是编程规约,含命名、格式、OOP、并发、集合处理;二是异常日志,含错误码、异常处理、日志规范;三是单元测试,含测试用例、覆盖率、Mock;四是安全规约,含SQL注入、XSS、CSRF、脱敏;五是MySQL数据库,含建表、索引、SQL、ORM;六是工程结构,含分层架构、依赖管理、服务器;七是设计规约,含UML、设计模式、设计原则。各章节对应编码规范文档、异常日志文档、单元测试、安全、MySQL、工程结构、设计文档。

用法:代码审查时按命名、并发、异常、安全问题分别查对应规约章节;新项目搭建时依次查阅设计、工程结构、MySQL、单元测试文档;问题排查时NPE查异常日志,性能查MySQL索引规约,并发查编程规约并发处理。命名速查:类名用UpperCamelCase,DO/DTO/VO例外;方法变量用lowerCamelCase;常量全大写加下划线;包名全小写。数据库建表必备id、create_time、update_time三字段;索引命名主键pk_、唯一uk_、普通idx_。日志使用占位符,参数校验,敏感数据脱敏,ThreadLocal用后remove。

限制:本资料仅提供规约内容与示例,未说明具体安装发布方式;规约约束力分级之外的具体执行工具与自动化检查方式暂未提供;部分规约细节需参考对应章节文档。