java开发规范指导说明书

### Java开发规范指导说明书知识点概览 #### 一、引言 - **目的**: 本指导说明书旨在确保项目的开发成本得到优化，同时有利于未来的扩展和重用。 - **适用范围**: 项目成员需要严格遵守本手册中的开发规范，以达成一致的开发标准。 #### 二、设计约定 - **统一错误处理机制**: 系统应当具备统一且灵活的错误处理机制，以统一管理组件的返回信息。 - **松耦合原则**: 组件设计遵循松耦合原则，以提高重用性和适应未来的变化。 - **移植性**: 设计中应避免对存储过程的依赖以及本地SQL的使用，从而增强系统的移植性。 - **减少数据库连接请求**: 组件设计时应尽量减少创建数据库连接的次数。 - **详细设计**: 设计文档需要详尽到每一个组件、方法和接口。 - **辅助工具**: 使用Together和Visio等工具辅助系统分析和设计。 - **需求管理**: 设计工作需要与项目管理相结合，支持需求管理人员提供需求基线依据。 #### 三、开发规范 - **3.1 基本规则** - **命名规则**: 类名和方法名使用英文缩写或全称，并遵循一定的大小写规则。 - **避免缩写冲突**: 避免使用大小写相似的命名方式。 - **首字母缩写**: 对于首字母缩写词，仅大写其第一个字母。 - **禁止使用System.out.println**: 代码中不得出现直接使用`System.out.println`进行输出的操作。 - **3.2 包** - **包名前缀**: 所有包名均以前缀`com.bringspring`开头。 - **开发目录规范**: 需要遵循特定的开发目录规范。 - **3.3 类/接口** - **显式导入**: 尽可能显式导入类而不是使用通配符`*`。 - **实现类与接口命名**: 实现类名称后缀添加`Impl`，接口名称前缀添加`I`。 - **单一实现类**: 当一个接口只有一个实现类时，除了`impl`和`I`前后缀外，接口与实现类的名称应完全相同。 - **类名规范**: 避免使用数字标识类名，且不应以“A”、“An”或“The”开头，也不应使用复数形式。 - **3.4 方法** - **命名规范**: 方法命名采用英文序列或简称表达，首字母小写，其他单词首字母大写。 - **方法长度限制**: 单个方法的代码行数不超过200行，单个类不超过800行。 - **参数限制条件**: 明确输入参数的限制条件，如不允许为null等。 - **特定命名模式**: - 判断类方法: 以`is`或`has`开头。 - 访问类方法: 以`get`开头。 - 修改类方法: 以`set`、`update`或`modify`开头。 - **3.5 变量/常量** - **变量命名**: 变量名以小写字母开头。 - **容器变量**: 如果变量表示容器类型（如数组、列表等），在变量名后加上“List”。 - **3.6 注释** - **代码注释**: 提供必要的注释以解释代码逻辑。 - **JavaDoc注释**: 对于复杂的类和方法，使用JavaDoc注释进行说明。 - **3.7 异常处理** - **异常捕获**: 在适当的场景中捕获并处理异常。 - **自定义异常**: 根据业务需求定义自定义异常类。 - **3.8 日志记录** - **日志级别**: 使用合适级别的日志记录关键信息。 - **异常信息**: 记录异常信息以方便问题定位。 #### 四、JAVA编码习惯 - **4.1 缩进** - **标准缩进**: 每一层缩进四个空格。 - **4.2 空隙** - **操作符两侧空格**: 在操作符两侧各留一个空格。 - **4.3 断行** - **行长度限制**: 行长度不应超过80个字符。 - **合理断行**: 合理地断开长行以保持良好的可读性。 - **4.4 控制结构** - **块体缩进**: if、else、for、while等控制语句中的块体应正确缩进。 - **4.5 变量** - **变量声明位置**: 在使用前声明变量。 - **作用域最小化**: 变量的作用域应尽可能小。 - **4.6 异常处理** - **异常抛出**: 明确抛出异常的情况。 - **异常捕获**: 捕获并处理异常，必要时重新抛出。 - **4.7 典型例子** - **实例展示**: 提供典型例子帮助理解规范应用。 - **4.8 对象** - **对象初始化**: 明确对象初始化的方式。 - **对象复用**: 鼓励对象复用以减少资源消耗。 #### 五、Code Style模版 - **代码风格模板**: 提供了代码风格的参考模板，用于规范代码书写格式。 #### 六、开发制度 - **版本控制**: 使用版本控制系统管理源代码。 - **代码审查**: 定期进行代码审查以提高代码质量。 - **文档编写**: 编写详细的开发文档以支持团队协作。 以上是对《java开发规范指导说明书》的主要内容总结和解读，涵盖了设计约定、开发规范、编码习惯等多个方面，旨在提高代码的质量和项目的整体管理水平。