Java编程的规范.docx

工程管理系统工程规划一般地，开发一个产品或项目时，需要对整个应用程序有一个整体上的或者说全局上的规划。比如，层次划分和模块化。按分层进行组织的设计结构中，只允许上层的程序引用下层的程序，而不允许出现下层的程序引用上层的程序，依赖关系要做到单向化（偏序依赖）。另 一个概念模块化，主要是指把程序组织成多个逻辑概念相对独立的单元，便于维护和管理。这些单元在物理上的体现主要是程序工程（也有叫作项目的，英文表示是 Project）。单元的划分要遵从高内聚低耦合的原则进行。单元之间的依赖关系也必须是单向的，并且不与系统整体上的层次关系产生冲突。以上内容主要在开发周期中的设计阶段完成，还有一些其它内容，概括起来，需要明确的主要有以下一些内容：系统的层次结构及工程存放目录组织构成系统的所有工程的清单，包括各工程的类型、所处位置、内容与其它说明等工程之间的依赖关系图，包括依赖的第三方组件依赖的第三方组件或类库的清单，包括名称、版本、官方网站地址、其所依赖的其它组件和类库，以及详细的修改记录（如果有修改的话）工程与配置管理Java 各类工程（Project）都包含特定的内容，依工程类型（最常见的有类库、控制台程序和 WEB 应用程序三类）不同，内容也会有不同，但一些基本内容是都有的，比如工程文件、Java 源程序文件、二进制输出目录等。我 们利用配置库来达到统一管理和相互协作的目的。但 Java 工程中，并不是所有的内容都需要或者说适合纳入配置库，比如说二进制输出目录，它们只是一些临时生成的数据或文件，并不需要持久保留，还有一些文件是用户 使用的 IDE 或构建工具存储的特定文件等，同样不应该签入配置库。配置库处理原则是，只把需要及合适的内容签入配置库，其它内容一律不入库，以避免不必要的“垃圾”内容和对他人的干扰。Java 工程中可能出现的，一定不要签入配置库的目录及文件，包括但不限于以下所列：maven 相关target/Eclipse 相关bin/.settings/.project.classpathIDEA 相关.idea/*.ipr*.iml*.iws临时性文件*.log*.cache*.diff*.patch*.tmp系统相关.DS_StoreThumbs.db代码风格命名风格在使用 Java 语言编程的时候，尽量坚持以下的原则进行命名：名称尽量要直接表明其含义，并且要使用英文单词表述，尽量避免使用汉语拼音命名。名字的意思清楚比长度更重要，应该与场景、系统的逻辑组成或物理组成以及为人熟知的概念相对应，而不是与技术或架构相对应；除一些约定俗成的单字母变量（如 i, j, k, v, x, y 等），禁止使用单字母变量。在使用单字母变量时，也仅限于表示约定的含义，如 i, j, k 表示循环；v 表示取值；x, y 表示两个操作数；命名时可以适当使用单词缩写，但一定要含义明确，如 exec；在命名的过程中要使用语义上有意义的名字，而不要使用编程语言特有的关键字。如：getLength() 比 getInt() 要好得多；类命名尽量使用名词性短语，如：FileCreator, HotelListManager, TaskWorker 等。方 法命名一律以小写字母开头，命名时尽量不超过 3 个单词，第一个单词后的每个单词首字母需要大写。执行操作命令类型的方法命名时一般用动词或动词短语命名，如 Executor.execute() 等；执行转化命令类型的函数命名时一般用 toXxx(), parseXxx(), valueOf() 的形式命名，如：Object.toString(), Integer.parseInt(), Enum.valueOf()；类成员的命名尽量避免再使用类名（包括缩写形式）做前缀，例如 User.getUserId() 命名为 User.getId() 更加合适;避免使用 Java 预定义的类型名称命名自己的类型。代码组织包尽 量将功能相近或同属一个性质的类型放在同一包中（同属一个性质特指 util 或类似的包，并不是指 controller, service, model 等），这样在开发的时候，就可以避免导入过多的包，且减少查找适用于特定任务的正确类型时所必须检查的包的数量，也可以避免不相干内容之间的相互干扰。从 一定程度上来说，就是包级别的高内聚、低耦合。类Java 的类型分为引用类型和值类型两类（正因为有值类型的存在，所以 Java 并不是纯面向对象的语言）。除 Java 预定义的 8 个基本类型是值类型之外，其它所有类型都是引用类型。引用类型在堆中分配，内存管理由垃圾回收器处理。值类型在栈上或以内联方式在堆中分配。通常，值类型 的内存分配和释放开销更小，所以，只要能够采用值类型的地方，应优先考虑值类型（只有当