Java项目开发规范的基础知识

Java项目开发规范的基础知识
一、 概述：

以Java项目开发规范的基础知识为主线逐步展开说明，分析制订项目开发规范对于项目开发质量和交付质量管理的重要性。同时遵循统一的项目开发规范进行开发，可以大幅降低源代码的日常管理与维护成本，缩短新需求的开发响应时长。
二、 项目开发规范的分类：

1、 行业规范：

即行业要求，通俗的说就是行业对Java项目的所有要求；

2、 业务规范：

根据不同行业的业务要求，对于功能场景的要求；

3、 开发规范：

针对开发者的工作习惯和代码开发的要求；

4、 厂商规范：

根据不同厂商之间的协议或约定，经整理后形成的规范或相关文档；
三、 行业规范：

行业要求与项目开发规范的关系如下：

1、 时效性和数据追溯性：

医疗和医院项目；

2、 高并发和实时性：

金融和银行项目，视频、论坛、帖吧等等项目；

3、 吞吐量较高或大量数据交互：

搜索引擎和数据挖掘项目；

4、 高稳定性和安全性：

通信、金融和银行、政企、大型企业管理项目；

5、 高速数据响应能力：

门户网站、视频、自媒体平台、流媒体网站等等项目；
四、 业务规范：

特殊功能或场景的要求如下：

1、 数据计算场景：

需经过大量计算后方可得到结果的场景；

2、 资源消耗管控：

占用系统资源较大的场景；

3、 图形处理场景：

复杂图形展示的场景；

4、 输出结果处理：

输出结果复杂或无规律的场景；
五、 开发规范：

1、 工作习惯：

公司或开源社区的内部要求和工作手册；

2、 源代码开发与管理要求：

1. 代码开发规范；

2. 代码书写规范；

3. 代码审查规范；

4. 版本管理规范；

5. 自动构建规范；

3、 项目管理规范：

1. 接口规范；

2. 测试规范；

3. 发布规范；

4. 文档规范；

5. 运维规范；

六、 厂商规范：

1、 厂商协议文档制定规范；

2、 厂商接口规范；

3、 厂商数据传递规范；

4、 厂商故障情况预警规范；

5、 厂商故障自查规范；
七、 规范或标准的制定：

1、 需要采用的管理规则：

例如操作流程、交流方式、工作纪律等。

2、 各种文档的编制标准：

包括文档体系、文档格式、图表样式等。

3、 信息编码形式：

硬件、操作系统的接口规约，命名规则等。

4、 目标或原则的制定；
八、 项目开发规范涵盖范围：

1、 编程规约：

1. 命名风格；

2. 常量定义；

3. 代码格式；

4. OOP规约；

5. 集合处理；

6. 并发处理；

7. 控制语句；

8. 注释规约；

9. 其它；

2、 异常日志规约：

1. 异常处理；

2. 日志规约；

3、 单元测试规约；

4、 安全规约；

5、 数据库规约：

1. 建表规约；

2. 索引规约；

3. SQL语句；

4. ORM映射；

6、 工程规约：

1. 应用分层；

2. 类库依赖；

3. 服务器规约；

7、 设计规约；