面试题- 总结开发规范 包括代码规范、数据库规范、设计规范等所有方面

开发规范

目的

1. 养成良好的编程习惯
2. 写出易读、易维护的程序代码
3. 提高软件质量与生产率
4. 减少软件编码中不必要的错误
5. 提供完整的软件产品编码和文档
6. 可以促进团队合作
7. 可以减少bug处理
8. 可以降低维护成本
9. 有助于代码审查
   10.有助于自身成长

1. 代码规范

1. 命名规范
   1. 方法命名
   2. 类名
   3. 文件名
   4. 参数与变量名
   5. 如果在模块或者接口，类，方法中使用了设计模式，那么请在命名的时候体现出来
2. 注释规范
3. 缩进排版规范
4. 声明规范
5. 语句规范

2. 数据库规范

1. 索引命名规范（pk主键、uk唯一、idx普通）
2. 数据库命名规范（尽量与项目工程一致）

3. 设计规范

Java开发手册1.5.0

编程规约

1. 命名风格
2. 常量定义
3. 代码格式
4. OOP规约
5. 集合处理
6. 并发处理
7. 控制语句
8. 注释规约

异常日志

1. 异常处理
2. 日志规约

单元测试

安全规约

MySQL数据库

1. 建表规约
2. 索引规约
3. SQL语句
4. ORM映射

工程结构

1. 应用分层
2. 二方库依赖
3. 服务器

设计规约

Google Java Style

Google的java开发规范主要分为6大部分：源文件基本规范、源文件结构、代码格式、命名、编程实践和Javadoc，各部分概要如下：
1、源文件基本规范（source file basics）：文件名、文件编码、特殊字符的规范要求
2、源文件结构（source file structure）：版权许可信息、package、import、类申明的规约
3、代码格式（formatting）：大括号、缩进、换行、列长限制、空格、括号、枚举、数组、switch语句、注4、解、注释、和修饰符等格式要求
5、命名（Naming）：标识符、包名、类名、方法名、常量名、非常量成员名、参数名、局部变量的命名规范
6、编程实践（Programming Practices）：@override、异常捕获、静态成员、Finalizers等用法规约

阿里巴巴Java开发手册

阿里的Java开发手册相对于前者更上一层楼，它除了基本的编程风格的规约外，还给出了日志、单元测试、安全、MySQL、工程结构等代码之外的规约，据说是阿里近万名开发同学集体智慧的结晶，相当了得，还是挺值得借鉴一下的。各部分概要如下：
1、编程规约：命名风格、常量、代码格式、OOP、集合处理、并发、控制语句、注释等
2、异常日志：异常处理、日志的命名、保留时间、输出级别、记录信息等
3、单元测试：AIR原则（Automatic,Independent,Repeatable）、单侧的代码目录、目标，单侧的写法，即BCDE原则（Border,Correct,Design,Error）
4、安全规约：权限校验、数据脱敏、参数有效校验、CSRF安全过滤、防重放限制、风控策略等
5、MySQL数据库：建表、索引、SQL语句、ORM映射等
6、工程结构：应用分层、二方库依赖（坐标命名、接口约定、pom配置）、服务器端各项配置（TCP超时、句柄数、JVM参数等）

参考

代码规范的重要性
谈谈ali与Google的Java开发规范
Google Java Style Guide