Java开发规范.docx

《Java开发规范.docx》由会员分享，可在线阅读，更多相关《Java开发规范.docx（18页珍藏版）》请在优知文库上搜索。

1、北京韩金网络技术有限公司JaVa项目开发规范（2015版）北京韩金网络技术有限公司二O一五年十二月审定,审核:编写:第一章引言4第一节编写目的4其次节预期读者4第三节本文的约定5第四节本文的内容5第五节适用范围6其次章开发环境7笫一节操作系统环境7其次节开发工具7第三节版本管理工具8第三章软件开发框架9第一节整体结构规范9其次节开发框架的运用H第三节代码结构规范11第四个模块命名规范13第五节配置文件位置及规范13第四率公共组件的选用15第一节基础框架组件的选用15其次节日志组件的选用16第三节jquery的选用16第五章公司开发技术组件17第六章公司开发模块18第一节模块开发规范18其次节模

2、块应用规范18第三节模块的运用19第七章技术支持和信息反馈20第一章引言第一节编写目的本规范的目的是使本公司全部的软件开发部门能以统一的、规范的方式开发应用软件系统。通过建立编码规范，提高代码的牢靠性、可读性、可修改性、11J维护性和一样性等，增进团队协作实力，保证软件产品的质量。通过建立统一的JaVa软件开发框架，树立公司清楚的、有远见的技术方向，明确JaVa软件项目的基础构件和接口,削减基础框架探讨和构建的成本，统一的开发接口和规范还能保证公司软件模块在不同的项目中可以共享，从而供应开发效率和软件产品质量。同时本文也是一份J2EE开发指南，用于指导公司软件工程师开发java软件项目。第二节

3、预期读者本文预期读者为公司的参加软件项目开发的项目经理、开发人员及质量管理部门相关人员。Mybits等组件的选用：2、定义常用组件的选用，如数据访问驱动，文档上传组件的选用。4公司开发组件公司内部开发组件的规范和定义，如文件上传、字符处理等组件。5公司开发模块公司开发各个模块的规范和定义，如权限管理模块、短信模块。表IJaVa项目涉及到的主要方面本文定义的内容将依据须要，定期进行修订和补充。第五节适用范围本文规定的全部规范适用于公司全部JaVa软件项目。对于特别状况未能遵守本规范的项目，请保留项目技术评审相关结果记录。第二章开发环境统一规定公司的全部软件项0的开发环境，使公司的全部软件项目都在

4、统一的开发环境下进行开发，以便于软件项目的移植，同时也避开了因为环境不一样而导致的软件项目不能共享和开发不能协作等问题。第一节操作系统环境JaVa开发操作系统环境为WindOWS环境（32位或64位）。任何运用第三方文本编辑系统的状况，请运用UTF8编码。第二节开发工具开发工具的指定，是从开发工具的版权、开发工具的功能以及软件的可扩展性等多方面进行考虑的，集成开发环境、JRE、应用服务器分别指定如下：集成开发环境：ECliPSCEE5（ECliPSCWCb开发版本）在ECIiPSC发行新版本后，由公司统升级版本。MyEeIiPSe涉及版权问题，不作为公司指定开发工具，只能作为开发人员学习探讨的

5、工具。JRE：JDK1.8.0（对于指定JDK版本的项目，请运用指定版本的JDK,应用服务器：Tomcat7（对于须要运行在指定应用服务器的项目，须要同时具备指定应用服务器的运行环境）。开发工具、JRE、应用服务器都运用文件夹拷贝方式进行部署，最新的开发工具部署包从技术研发一部获得。开发工具中已经集成部分本规范规定的插件，如Grr插件、maven同步工具插件。第三节版本管理工具2.3.1 代码管理服务器公司全部软件项目采纳统一的代码管理服务器存储，新建项目和安排权限由项目经理提出申请，配置管理员操作执行。2.3.2 代码管理工具公司全部java项目开发版本管理运用gil版本限制工具。服务器端：

6、GITSERvER该软件部署在公司的开发服务器上。客户端：sourcetree第三章软件开发框架本章主要阐述java项目书目结构的规定及各部分命名规范。关于框架的组件选用将后面的章节给出规定。第一节整体结构规范java项目采纳统一结构，以便于系统项目的维护以及多个项目之间共享资源。该项目规范是指mavenWcb应用的项目（客户端应用程序的结构规范属于集，即不包括app部分的规范）。项目整体书目结构规范如下：国文件书目合，HUserMangerusermangermasterif-src/main/javG-犬Va代码书目岛src/main/resources埠src/teRjavaMMaven

7、Dependencies费试用例书目系境内库入口t.JRESystemGbraryJavaSE-1.7，储”C斓-main一_：-UrtesttargetWebaPP书目&classes：1.m2e-jee四test-classes品pomxml图IJaVa项目基本结构图编号目录书目说明SrcJmairViavaJaVa代傅书目,存放java代码2SrCJnWinyresources系统xml配置文件2SrCZmaiiVcss样式文件存放书目,相应存储规则如下:1）全部公共样式文件存在根书目下：2）各个模块私力.样式存在独立的书Il,即在样式文件根书目下建立子书目，书目名和模块名称相同.3Sr

8、cZmaiiVimages图片文件存放书目，相应存储规则如下：1）系统框架部分的图片存在图片文件根书目或依据须要维独建立子书目：2）全陆模块公用的书目存储在图片文件根书目或依据须要单独建立子书目：3）各个模块私有的图片文件存储在独立的书目，即在图片文件根书目下建立子书目,书目名和模块名称相同.4SrdnWilVjS脚本文件存放书目，相应存储规则如下：全部模块公用的脚本存储在脚本文件根书目；各个模块私有的脚本文件存储在独立的书目，即在脚本文件根书目下建立子书目,书目名和模块名称相同，5SrcZmaiaMewJSP文件存放书目6WEB-INFZlib系统库统一由maven管理7Pom.xml系统库

9、配置接口表2书目结构说朗注：项目文档统一运用公司项目管理系统一文档管理来实现，临时项目文件由各项目经理自行支配存储与交换方式。第二节开发框架的运用项目起先开发（编码）时，项目组首先从代码服务器上获得最新版本的系统框架，系统框架包括系统整体框架、相关组件包（jar包）、框架界面、登录界面等。系统框架默认包括权限管理模块的最新版本，用于管理系统用户、模块及权限。项目开发的卜.一步工作是依据项目需求加入公司已经开发完成的模块，以及依据项目需求开发新的业务模块。第三节代码结构规范本文阐述公司java项目的书目及命名规范。其中java代码书目规范如下图所示：项目公共书目，存放通用类和工具类限制层业务层，

10、温UserManger；usermangermaster,哥Asrc/main/java，出,com.hajing.gqzcSgenerator田login，舟,controllerl*jIoginControIIerJava0TuserVojava,由dao/y1.oginMapper.xml【优1.oginMapperJava，由modelO国1.oginJava*service，电impMybatis代码生成H1.文件Mvbatlsscl配置文件实体类【，if1.ogiSerivcesIml.java/tQj1.oginSerivcesJavaAEfiuser/*UtU:-二长久层公共责

11、11E*文件OJsonUti1.java(MdSutiIjava7)ObjectsTranscoder.javaS2J2EE代码飨构号包名书目说明I.util项目通用包,用来存放项目工具类、通用类Md5util.javaJsonUciIjava等2com.hanjin.Userconierlogin.,controller项目限制包，用来处理da。页面跳转的实现类3.loji11.dao项目长久层包4login.dao.sql配置sql的Xml包5.login.model项目实体类包6.Iogii1.scrvicc项目业分层包，用来存放模块处理业务逻辑的实现类*3java代码包结构说明基于ja

12、va平台的项目，全部包名均以Com.hanjin.业务模块开头。命名规则是：COmhanjin业务模块.模块名称，如用户登录模块名称为：Com.0第四节模块命名规范模块是指系统中的各个业务功能模块，各个模块在组织上和功能上相对独立。模块的命名要有含义，各个模块的名称统一采纳小写英文字母命名，如：号模块名模块用途Icommon公共模块2security权限管理模块3login登录模块4message短信模块表4模块命2举例第五节配置文件位置及规范java项目的配徨文件主要涉及SSM框架配置、口志组件配置文件及其他配置文件。配置文件位置及命名规范，定义了各类配置文件存放的位置及这些文件如何命名：D

13、SPring配置文件位置及命名规范：SPring配置文件统一存储在srcmainresources书目位置,命名为：applicationContext.xml.spring-servlet.xml,系统默认公共的配置文件为alicationContext-common.xnlo2）日志组件配置文件：日志组件配置文件统一规定为log4j.ProPerties,存放在srcnainresources书目位置。3）数据库配置文件：数据库组件配置文件统一规定为jdbc.pr。PCrIiCs,存放在srcmainresources书目位置。第四章公共组件的选用JaVa平台是个开放的平台，java开发有

14、许多成熟的开发组件，同一类组件不同的厂商有不同的实现方式。为了统一公司的开发技术，达到技术共享的目的，本章规定了公共组件的选用。公共组件在本文中是指第三方供应的、J2EE开发通常运用的组件，如数据访问组件（或框架）、日志组件、文件上传组件等等。第一节基础框架组件的选用java项目基础框架组件选用当前流行的SSM框架，所以模块的开发须要依据SSM的开发模式进行。对于有特别技术须要的项目在技术委员会评定确认以后可以不采纳SSM作为基础开发框架，但假如须要引用其他在该框架下开发的模块，必需保留各框架组件的类库以保证系统能够正常运行。2015年版本的公司JAVA开发框架的SSM框架的各组件版本说明如下：一号组件版本组件用途ISpringMVC2Spring3Mybatis&5SSM框架的件原则上基础框架组件能够完成的技术实现不得采纳其他同类组件来实现。SSM应用还做了如下规范：DSpring的配置文件可以基于注解和配置文件两种