《java开发规范》doc版

《《java开发规范》doc版》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、北京韩金网络技术有限公司北京韩金网络技术有限公司Java项目开发规范（2015版）北京韩金网络技术有限公司二○一五年十二月Java开发规范-19-北京韩金网络技术有限公司审定：审核：编写：Java开发规范-19-北京韩金网络技术有限公司目录第一章引言4第一节编写目的4第二节预期读者4第三节本文的约定5第四节本文的内容5第五节适用范围6第二章开发环境7第一节操作系统环境7第二节开发工具7第三节版本管理工具8第三章软件开发框架9第一节整体结构规范9第二节开发框架的使用11第三节代码结构规范11第四节模块命名规范12第五节配置文件位置及规范13第四章公共组件的选用1

2、4第一节基础框架组件的选用14第二节日志组件的选用15第三节jquery的选用15第五章公司开发技术组件16第六章公司开发模块17第一节模块开发规范17第二节模块应用规范17第三节模块的使用18第七章技术支持和信息反馈19第一节信息反馈19Java开发规范-19-北京韩金网络技术有限公司第二节技术支持19Java开发规范-19-北京韩金网络技术有限公司第一章引言第一节编写目的本规范的目的是使本公司所有的软件开发部门能以统一的、规范的方式开发应用软件系统。通过建立编码规范，提高代码的可靠性、可读性、可修改性、可维护性和一致性等，增进团队协作能力，保证软件产品的质

3、量。通过建立统一的Java软件开发框架，树立公司清晰的、有远见的技术方向，明确Java软件项目的基础构件和接口，减少基础框架研究和构建的成本，统一的开发接口和规范还能保证公司软件模块在不同的项目中可以共享，从而提供开发效率和软件产品质量。同时本文也是一份J2EE开发指南，用于指导公司软件工程师开发java软件项目。第二节预期读者本文预期读者为公司的参与软件项目开发的项目经理、开发人员及质量管理部门相关人员。Java开发规范-19-北京韩金网络技术有限公司第一节本文的约定为了使本Java规范具有可操作、可用性、可持续等特性，本文做以下约定：1.统一公司Java开

4、发技术，以公司软件资源共享、节省软件开发工作量、提供工作效率和软件产品质量为目标；2.本Java软件开发规范具有可操作性，软件框架要有一定的伸缩性和适应性，能够在公司不同的Java项目中执行；3.针对某一问题，技术实现有很多种方式，并且各种技术方案都有自身的优缺点，本文应该尽力选择最适合本公司应用的软件技术方案，一旦技术方案确定即成为公司技术规范的依据；4.本文发布以后，应该对相关开发人员进行培训；5.本文发布以后，技术研发一部负责收集大家反馈的问题和新需求，并在必要时对Java规范进行修改和补充；6.本开发规范应该根据公司的积累不断的补充，定期升级公司J2E

5、E规范，并发布新版本。第二节本文的内容本文的内容比较宽泛，涉及公司Java项目各个方面，如开发工具选择、开发框架的定义、组件的选择等方面，如下表所示：序号类别说明1开发环境定义Java开发软件环境、开发工具、及版本管理工具。2软件开发框架定义Java软件项目的结构规范。3公共组件1、定义框架组件的选用，如SpringMVC、Java开发规范-19-北京韩金网络技术有限公司Mybits等组件的选用；1、定义常用组件的选用，如数据访问驱动，文档上传组件的选用。4公司开发组件公司内部开发组件的规范和定义，如文件上传、字符处理等组件。5公司开发模块公司开发各个模块的规

6、范和定义，如权限管理模块、短信模块。表1java项目涉及到的主要方面本文定义的内容将根据需要，定期进行修订和补充。第一节适用范围本文规定的所有规范适用于公司所有Java软件项目。对于特殊情况未能遵守本规范的项目，请保留项目技术评审相关结果记录。Java开发规范-19-北京韩金网络技术有限公司第一章开发环境统一规定公司的所有软件项目的开发环境，使公司的所有软件项目都在统一的开发环境下进行开发，以便于软件项目的移植，同时也避免了因为环境不一致而导致的软件项目不能共享和开发不能协作等问题。第一节操作系统环境Java开发操作系统环境为Windows环境（32位或64位

7、）。任何使用第三方文本编辑系统的情况，请使用UTF-8编码。第二节开发工具开发工具的指定，是从开发工具的版权、开发工具的功能以及软件的可扩展性等多方面进行考虑的，集成开发环境、JRE、应用服务器分别指定如下：n集成开发环境：　EclipseEE5(EclipseWeb开发版本)在Eclipse发行新版本后，由公司统一升级版本。MyEclipse涉及版权问题，不作为公司指定开发工具，只能作为开发人员学习研究的工具。nJRE：JDK1.8.0（对于指定JDK版本的项目，请使用指定版本的JDK，应用服务器：Tomcat7（对于需要运行在指定应用服务器的项目，需要同时

8、具备指定应用服务器的运行环境）。开发工