高效的Java开发规范_第1页
高效的Java开发规范_第2页
高效的Java开发规范_第3页
高效的Java开发规范_第4页
高效的Java开发规范_第5页
已阅读5页,还剩18页未读, 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

北京韩金网络技术有限企业

Java项目开发规范

(2023版)

北京韩金网络技术有限企业

二O一五年十二月

审定:

编写:

第五章企业开发技术组件.......................................

第六章企业开发模块...........................................

第一节模块开发规范...........................................

第二节模块应用规范...........................................

第三节模块的使用.............................................

第七章技术支持却信息反馈.....................................

第一节信息反馈...............................................

第二节技术支持...............................................

第一章引言

第一节编写目的

本规范日勺目的I是使我司所有日勺软件开发部门能以统一日勺、规范日勺方式开发

应用软件系统。通过建立编码规范,提高代码的可靠性、可读性、可修改性、

可维护性和一致性等,增进团体协作能力,保证软件产品的质量。

通过建立统一口勺Java软件开发框架,树立企业清晰的、有远见的技术方向,

明确Java软件项目的基础构件和接口,减少基础框架研究和构建日勺成本,统一

W、J开发接口和规范还能保证企业软件模块在不一样W、J项目中可以共享,从而提

供开发效率和软件产品质量。同步本文也是一份J2EE开发指南,用于指导企业

软件工程师开发java软件项目。

第二节预期读者

本文预期读者为企业的参与软件项目开发H勺项目经理、开发人员及质量管

理部门有关人员。

第三节本文的约定

为了使本Java规范具有可操作、可用性、可持续等特性,本文做如下约

定:

1,统一企业Java开发技术,以企业软件资源共享、节省软件开发工作量、

提供工作效率和软件产品质量为目的;

2.本Java软件开发规范具有可操作性,软件框架要有一定的伸缩性和适应

性,可以在企业不一样的Java项目由执行;

3.针对某一问题,技术实既有诸多种方式,并且多种技术方案均有自身日勺

优缺陷,本文应当竭力选择最适合我司应用的软件技术方案,一旦技术

方案确定即成为企业技术规范的I根据;

4.本文公布后来,应当对有关开发人员进行培训;

5.本文公布后来,技术研发一部负责搜集大家反馈的问题和新需求,并在

必要时对Java规范进行修改和补充;

6.本开发规范应当根据企业的积累不停口勺补充,定期升级企业J2EE规范,

并公布新版本。

第四节本文的内容

本文W、J内容比较宽泛,波及企业Java项目各个方面,如开发工具选择、开

发框架日勺定义、组件的选择等方面,如下表所示:

序号类别说明

定义Java开发软件环境、开发工具、及版

1开发环境

本管理工具。

2软件开发框架定义Java软件项目的构造规范。

1、定义框架组件日勺选用,如SpringMVC、

Mybits等组件『、J选用;

3公共组件

2、定义常用组件的选用,如数据访问驱

动,文档上传组件日勺选用。

企业内部开发组件日勺规范和定义,如文献

4企业开发组件

上传、字符处理等组件。

企业开发各个模块的规范和定义,如权限

5企业开发模块

管理模块、短信模块。

表1java项目波及到的重要方面

本文定义的内容将根据需要,定期进行修订和补充。

第五节合用范围

本文规定的所有规范合用于企业所有Java软件项目o对于特殊状况未能遵

守本规范的项目,请保留项目技术评审有关成果记录。

第二章开发环境

统一规定企业日勺所有软件项目的开发环境,使企业日勺所有软件项目都在统

一的开发环境下进行开发,以便于软件项目日勺移植,同步也防止了由于环境不

一致而导致的软件项目不能共享和开发不能协作等问题。

第一节操作系统环境

Java开发操作系统环境为Windows环境(32位或64位)。任何使用第三

方文本编辑系统的状况,请使用UTF-8编码。

第二节开发工具

开发工具的指定,是从开发工具的版权、开发工具的功能以及软件日勺可扩

展性等多方面进行考虑的,集成开发环境、JRE、应用服务器分别指定如下:

■集成开发环境:EclipseEE5(EclipseWeb开发版本)在Eclipse发行新版

本后,由企业统一升级版本。MyEclipse波及版权问题,不作为企业指定开发工

具,只能作为开发人员学习研究的工具。

■JRE:JDK1.8.0(对于指定JDK版本口勺项目,请使用指定版本的JDK,

应用服务器:Tomcat7(对于需要运行在指定应用服务器的项目,需要同步具

有指定应用服务器日勺运行环境)。

开发工具、JRE、应用服务器都使用文献夹拷贝方式进行布署,最新的开

发工具布署包从技术研发一部获取。开发工具中已经集成部分本规范规定的插

件,如GIT插件、maven同步工具插件。

第三节版本管理工具

2.3.1代码管理服务器

企业所有软件项目采用统一的代码管理服务器存储,新建项目和分派权限

由项目经理提出申请,配置管理员操作执行。

2.3.2代码管理工具

企业所有java项目开发版本管理使用git版本控制工具。

■服务器端:GITSERVER该软件布署在企业日勺开发服务器上。

■客户端:sourcetree

第三章软件开发框架

本章重要论述java项目目录构造日勺规定及各部分命名规范。有关框架的组

件选用将背面的章节给出规定。

第一节整体构造规范

java项目采用统一构造,以便于系统项目的维护以及多种项目之间共享资

源。该项目规范是指mavenWeb应用出J项目(客户端应用程序的构造规范属于

子集,即不包括叩p部分的规范)。项目整体目录构造规范如下:

・流>userManger[usermangermaster]Java代码目录

配置文献目录合

t>汽>src/main/java

阴>src/main/resources

29src/test/java测试用例目录

*MavenDependencies

t>0JRESystemLibraryJavaSE-1,7]

■>src

>>main

0testwebapp目录

昂>target

&classes

»昂>m2e-jee

&test-classes

系统内库入口国pom.xml

图1Java项目基本构造图

编号目录目录阐明

1Src/main/javaJava代码目录,寄存java代码

2Src/main/resources系统xml配置文献

2Src/main/css样式文献寄存目录,对应存储规则如下:

1)所有公共样式文献存在根目录下;

2)各个模块私有样式存在独立的目录,即在样式文献根

目录下建立子目录,目录名和模块名称相似。

3Src/main/images图片文献寄存目录,对应存储规则如下:

1)系统框架部分H勺图片存在图片文献根目录或根据需

要单独建立子目录;

2)所有模块公用H勺目录存储在图片文献根目录或根据

需要单独建立子目录;

3)各个模块私有的图片文献存储在独立口勺目录,即在图

片文献根目录下建立子目录,目录名和模块名称相

似。

4Src/main/js脚本文献寄存目录,对应存储规则如下;

所有模块公用的脚本存储在脚本文献根目录;

各个模块私有的脚本文献存储在独立的口录,即在脚本

文献根目录下建立子目录,目录名和模块名称相似。

5Src/main/viewJsp文献寄存目录

6WEB-INF/lib系统库统一由maven管理

7Pom.xml系统库配置接口

表2目录构造阐明

注:项目文档统一使用企业项目管理系统一文档管理来实现,临时项目文

献由各项目经理自行安排存储与互换方式。

第二节开发框架的使用

项目开始开发(编码)时,项目组首先从代码服务器上获取最新版本H勺系

统框架,系统框架包括系统整体框架、有关组件包(jar包)、框架界面、登录

界面等。系统框架默认包括权限管理模块日勺最新版本,用于管理系统顾客、模

块及权限。

项目开发日勺下一步工作是按照项目需求加入企业已经开发完毕的模块,以

及按照项目需求开发新W、八忆务模块。

第三节代码构造规范

本文论述企业java项目的目录及命名规范。

其中java代码目录规范如下图所示:

项目公共目录,寄存

通用类和工具类

■扁>userManger[usermangermaster]

■:由〉src/main/java

,田〉com.hanjing.gqzcMybatis代码生成配置文献

>的generator■

控制层

■田》login

■舟》controller

[>[j®>LoginControllerJava

t>西TuserVo.java

■电daoMybatissql配置文献

GJsql

yQLoginMapper.xml

®LoginMapper.java实体类

,电model

t>血Login.java

Jservice

/03impl

业务层

〃l>LoginSerivcesImpl.java

t>区LoginSerivces.java

//b田user

'碗"il"一~

持久层t>由JsonUtil.java公共资源配置文献

JC>盅Md5util.java

0叫Objects!ranscoder.java

图2J2EE代码构造

编号包名目录阐明

1项目通用包,用来寄存项目工具类、通用类

.util

Md5util.java\JsonUtil.java等

2com.hanjin.uscrcontcr.login..项目控制包,用来处理da。页面跳转的实现类

controller

3.login.dao项目持久层包

4.login.dao.sql配置sql的xml包

5.login,model项目实体类包

6.login.service项目业务层包,用来寄存模块处理业务逻辑H勺实

现类

表3java代码包构造阐明

基于java平台的项目,所有包名均以com.hanjin.v业务模块,开头。命名规

则是:com.hanjin.业务模块.模块名称,如顾客登录模块名称为:com.。

第四节模块命名规范

模块是指系统中的各个业务功能模块,各个模块在组织上和功能上相对独

立。模块日勺命名要有含义,各个模块的名称统一采用小写英文字母命名,如:

编号模块名模块用途

1common公共模块

2security权限管理模块

3login登录模块

4message短信模块

表4模块命名举例

第五节配置文献位置及规范

java项目口勺配置文献重要波及SSM框架配置、日志组件配置文献及其他配

置文献。配置文献位置及命名规范,定义了各类配置文献寄存出J位置及这些文

献怎样命名:

1)Spring配置文献位置及命名规范:Spring配置文献统一存储在src/main/

resources目录位置,命名为:applicationContext.xml,spring-servlet.xml,

系统默认公共的配置文献为applicationContext-common.xmlo

2)日志组件配置文献:日志组件配置文献统一规定为perties,寄存

在src/main/resources目录位置。

3)数据库配置文献:数据库组件配置文献统一规定为perties,寄存

src/main/resources目录位置。

第四章公共组件的选用

Java平台是个开放W、J平台,java开发有诸多成熟出J开发组件,同一类组件

不一样日勺厂商有不一样的实现方式。为了统一企业的开发技术,到达技术共享

的目日勺,本章规定了公共组件日勺选用。公共组件在本文中是指第三方提供的、

J2EE开发一般使用日勺组件,如数据访问组件(或框架)、日志组件、文献上传

组件等等。

第一节基础框架组件的选用

java项目基础框架组件选用目前流行的SSM框架,因此模块的开发需要按

照SSM的开发模式进行。对于有特殊技术需要W、J项目在技术委员会评估确认后

来可以不采用SSM作为基础开发框架,但假如需要引用其他在该框架下开发日勺

模块,必须保留各框架组件的类库以保证系统可以正常运行。2023年版本的企

业JAVA开发框架的JSSM框架日勺各组件版本阐明如下:

编号组件版本组件用途

1SpringMVC

2Spring

3Mybatis

表5SSM框架组件

原则上基础框架组件可以完毕日勺技术实现不得采用其他同类组件来实现。

SSM应用还做了如下规范:

1)Spring的配置文献可以基于注解和配置文献两种方式。在同一种项目中,

注解和配置文献可以混合使用,但在同一模块中只容许使用其中一种方

式。

第二节日志组件的选用

第三节jquery的选用

一般状况下,防止使用ExtJs脚本组件。假如项目中需要使用jquery,统一

使用jquery1.9.0版本。

第五章企业开发技术组件

相对于公共组件来说,企业开发日勺用于处理特定技术问题日勺组件,这些组

件假如没有现成日勺(或合适日勺)第三方组件可以替代,开发完毕后来可以应用

到企业H勺多种项目中。

[编制中]

对于已经存在的组件,各项目组要充足运用已经有组件资源,不得重新单

独开发。

第六章企业开发模块

企业将逐渐开发和积累软件成果,软件成果以(业务或技术)模块日勺形式

存在,软件模块日勺复用是企业提高软件开发效率、节省开发成本、提高软件开

发质量H勺重要途径。企业开发模块的规范包括模块开发H勺规范以及模块应用的

规范。

模块开发W、J规范是指开发各个模块应当遵照W、J规范,使开发完毕的J模块符

合J2EE开发规范,并且可以应用到其他项目中。这里要遵照的规范重要是目录

构造规范、使用技术规范、组件规范、版本规范等。

模块的应用规范给出企业开发项目应当使用的成熟模块以及模块的接口和

应用条件等。模块口勺应用规范规定企业开发项目要使用日勺模块、选择合适的版

本、按照对W、JW、J方式来使用。

第一节模块开发规范

[编制中]

第二节模块应用规范

企业启动新项目后来,首先要使用本文所规定的软件框架和规范进行开发,

还要充足运用已经成熟的模块,不得单独重新开发。

当碰到特殊业务需要时,假如企业已经有模块不能满足需求,通过企业技

术委员会评估确认后来可认为特定项目单独开发某一模块。

当开发过程碰到模块中不能满足系统需要口勺缺陷时,开发人员提交给软件

技术研发一部,由软件技术研发一部根据缺陷出J严重程度和紧迫性立即更新软

件或者在模块的下一种版本中进行修复或改善。

目前企业规定统一使用日勺模块如下表所列:

编号模块版本模块阐明

1权限管理模块顾客管理、角色管理、分组管理、权限管

理

2

3

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论