Java开发规范解析.doc

北京韩金网络技术有限公司 Java项目开发规范 （2015版） 北京韩金网络技术有限公司 二○一五年十二月  审定： 审核： 编写： 目 录 第一章 引言 4 第一节 编写目的 4 第二节 预期读者 4 第三节 本文的约定 5 第四节 本文的内容 5 第五节 适用范围 6 第二章 开发环境 7 第一节 操作系统环境 7 第二节 开发工具 7 第三节 版本管理工具 8 第三章 软件开发框架 9 第一节 整体结构规范 9 第二节 开发框架的使用 11 第三节 代码结构规范 11 第四节 模块命名规范 12 第五节 配置文件位置及规范 13 第四章 公共组件的选用 14 第一节 基础框架组件的选用 14 第二节 日志组件的选用 15 第三节 jquery的选用 15 第五章 公司开发技术组件 16 第六章 公司开发模块 17 第一节 模块开发规范 17 第二节 模块应用规范 17 第三节 模块的使用 18 第七章 技术支持和信息反馈 19 第一节 信息反馈 19 第二节 技术支持 19  引言 编写目的 本规范的目的是使本公司所有的软件开发部门能以统一的、规范的方式开发应用软件系统。通过建立编码规范，提高代码的可靠性、可读性、可修改性、可维护性和一致性等，增进团队协作能力，保证软件产品的质量。 通过建立统一的Java软件开发框架，树立公司清晰的、有远见的技术方向，明确Java软件项目的基础构件和接口，减少基础框架研究和构建的成本，统一的开发接口和规范还能保证公司软件模块在不同的项目中可以共享，从而提供开发效率和软件产品质量。同时本文也是一份J2EE开发指南，用于指导公司软件工程师开发java软件项目。 预期读者 本文预期读者为公司的参与软件项目开发的项目经理、开发人员及质量管理部门相关人员。  本文的约定 为了使本Java规范具有可操作、可用性、可持续等特性，本文做以下约定： 统一公司Java开发技术，以公司软件资源共享、节省软件开发工作量、提供工作效率和软件产品质量为目标； 本Java软件开发规范具有可操作性，软件框架要有一定的伸缩性和适应性，能够在公司不同的Java项目中执行； 针对某一问题，技术实现有很多种方式，并且各种技术方案都有自身的优缺点，本文应该尽力选择最适合本公司应用的软件技术方案，一旦技术方案确定即成为公司技术规范的依据； 本文发布以后，应该对相关开发人员进行培训； 本文发布以后，技术研发一部负责收集大家反馈的问题和新需求，并在必要时对Java规范进行修改和补充； 本开发规范应该根据公司的积累不断的补充，定期升级公司J2EE规范，并发布新版本。 本文的内容 本文的内容比较宽泛，涉及公司Java项目各个方面，如开发工具选择、开发框架的定义、组件的选择等方面，如下表所示： 序 号 类 别 说 明 1 开发环境 定义Java开发软件环境、开发工具、及版本管理工具。 2 软件开发框架 定义Java软件项目的结构规范。 3 公共组件 定义框架组件的选用，如SpringMVC、Mybits等组件的选用； 定义常用组件的选用，如数据访问驱动，文档上传组件的选用。 4 公司开发组件 公司内部开发组件的规范和定义，如文件上传、字符处理等组件。 5 公司开发模块 公司开发各个模块的规范和定义，如权限管理模块、短信模块。 表1 java项目涉及到的主要方面 本文定义的内容将根据需要，定期进行修订和补充。 适用范围 本文规定的所有规范适用于公司所有Java软件项目。对于特殊情况未能遵守本规范的项目，请保留项目技术评审相关结果记录。  开发环境 统一规定公司的所有软件项目的开发环境，使公司的所有软件项目都在统一的开发环境下进行开发，以便于软件项目的移植，同时也避免了因为环境不一致而导致的软件项目不能共享和开发不能协作等问题。 操作系统环境 Java开发操作系统环境为Windows 环境（32位或64位）。任何使用第三方文本编辑系统的情况，请使用UTF-8编码。 开发工具 开发工具的指定，是从开发工具的版权、开发工具的功能以及软件的可扩展性等多方面进行考虑的，集成开发环境、JRE、应用服务器分别指定如下： 集成开发环境：　Eclipse EE5 (Eclipse Web开发版本)在Eclipse发行新版本后，由公司统一升级版本。MyEclipse涉及版权问题，不作为公司指定开发工具，只能作为开发人员学习研究的工具。 JRE：JDK 1.8.0 （对于指定JDK版本的项目，请使用指定版本的JDK， 应用服务器：Tomcat 7 （对于需要运行在指定应用服务器的项目，需要同时具备指定应用服务器的运行环境）。 开发工具、JRE、应用服务器都使用文件夹拷贝方式