javaweb开发规范.docx

1、javaweb开发规范Java web开发规范1 前言为了使软件开发过程有章可循，保证软件质量，加强开发管理。2 整体规范更新规范 当去对文档或者代码进行修改时，先将原目录或者代码进行checkout，保证更新的是最新版本开发规范 主要针对开发人员，开发人员的更新不应仅限代码，还应包含文档。例如详细设计，概要设计，需求文档，变更文档等。3 编码规范项目整体采用UTF-8编码。修改工作空间默认编码在菜单导航栏上Window-Preferences 打开首选项对话框，左侧导航树，导航到General-Workspace修改文件的编码修改文件类型的编码 如果项目已经提供了公共js脚本，则优先使用公共

2、js脚本中提供的函数。 所有定义方法的元素定义在中或后。3、javascript脚本内部变量与参数 单词之间用下划线分隔且全部小写，例如： var file_size。 表单name属性 统一以“form_”开头，其后加该表单所需收集的信息的作用或动作，例如：form_file_upload 或 form_send_mail。 表单elements 表单element的名称以element需收集的信息标示命名（与struts中的属性名对应），其他element单词之间使用下划线分隔且全部小写，例如： -username为struts中的属性名username -不与struts对应表单元素名4

3、、cookie命名 命名格式：模块名_存储信息名词(多个单词用下划线分隔) ，全部大写，例如：EBWEBMAIL_SORT_TYPE。5、window.open中name参数的命名 javascript的window.open方法中有一个name的参数，浏览器约定同样的名字的窗口只能打开一个，如果程序间名字重复将相互冲突。如果不限制打开窗口数，可以指定或“”（不是null），否则需要加上模块名，例如ebwebmail_viewmail。4 数据库命名规范数据库表名规范 模块名_存储信息名词(多个单词用下划线分隔)，全部大写，例如：SYSM_ROLE数据库字段名规范 存储信息名词(多个单词用下划

4、线分隔)，全部小写，例如：message_id。5 文档规范1. 编写文档目前主要使用的工具是Word（项目计划文档例外，需要使用Project制作），辅助使用的工具有Visio，PowerPoint，Excel等。2. 文档务必保持段落格式整齐，文字字体，颜色，大小统一。3. 修改文档时，需要在文档的第2页填写修改或者增减内容，以及修改时间，修改人。文档采用新增的方式进行修改。修改规则如下1. 细小变动，如错别字修改等，直接在原版本的基础上进行修改2. 变动内容较小，但是有新增内容，保留原版本，在原版本上进行修改，并将版本号的第三位向前滚动1位。在提交3. 变动内容较多，有较多的增补和变化，

5、版本号第2位向前滚动4. 文档发生根本性变化，例如整体结构和目录发生了重大变更，版本号向前滚动1位。6 编码码规范Java代码规范命名规范Package 的命名Package 的名字应该都是由一个小写单词组成，例如：net.venustech.modules。java类的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成，例如：DataFile或InfoParser。Class 变量的命名变量的名字必须用一个小写字母开头。后面的单词用大写字母开头，例如：debug 或 inputFileSize。方法的命名 方法的命名以一个小写字母开头。后面的单词用大写字母开头，例如：debu

6、gMethod()或 inputFile()。Static Final 变量的命名Static Final 变量的名字应该都大写，并且指出完整含义，例如：MAX_UPLOAD_FILE_SIZE=1024。参数的命名参数的名字必须和变量的命名规范一致。使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：setSize(int size)this.size = size;数组的命名数组应该总是用下面的方式来命名：byte buffer;而不是：byte buffer;代码格式规范文件头声明源文件的头部需要一个history段，对于每次对源文件的重大改动，都需要在history段中注

7、明。该段定义在package和import之间，例如：* HISTORY* * 2002/01/29 Biz 创建文件* * 2002/02/19 kevin 增加XX功能*2002/03/01 ben 增加xx功能*/代码块书写格式主要为大括号的方式if (true)/body对于代码块过长，超过1屏以上，后面要说明属于那个代码块，例如：if (i 100)/too many lines more than one screen/ if (i 100)操作符赋值，判断等符号需要在2边的变量加1各空格int a = b;if (a 0);SQL语句代码中书写的sql语句要求sql关键字全部大写

8、，表名和字段名小写。例如：SELECT user_id, name FROM account WHERE user_id ? AND depart = ? ORDER BY name类和方法定义类定义或方法定义过长需要换行书写注释每个方法前最少需要添加功能说明的注释其他关于属性类中的属性不能定义为public变量直接存取，而是定义成protect变量并编写get/set方法，例如：protect String myName;public String getMyName()return myName;public void setMyName(String myName)this.myName

9、=myName;jsp/html代码规范jsp/html描述注释jsp/html页面顶部必须存在一个基本描述注释，包含功能描述、参数列表和历史修改信息，例如：Html/jsp格式html头格式：some title/some javascript注意：必须指定一个有意义的，严禁出现“Untitled”或“未命名”之类的。所有html标签使用小写Html/jsp语法校验 在默认的ide设置中，不允许出现html和jsp的语法错误注释一般不使用html注释，除非是有必要让最终用户看到的内容。对于包含JSP代码的html块，必须使用JSP注释。对于没有必要的注释，在发行版本中必须移除。form属于域

10、的maxlength对于text类型的输入域，必须根据数据库字段的长度设置相应的maxlength，例如数据库类型是VARCHAR(64)，那么maxlength是32（因为中文浏览器对于中文也认为是一个字符）。7 6、项目规范6.1应用程序目录规范6.1.1 Java源文件目录目录名说明src（Java源代码）|_cn域名倒置|_farmers域名|_common公用包|_util工具包|_db数据库访问类|_其他公用包|_action公用的action类包|_模块名模块功能实现包|_dao数据库访问类包|_biz模块业务实现类包|_action模块专用action类包6.1.2 Web应用程序目录规范目录名说明webpage（Web页面源代码）|_images页面图片|_jsJavascript源代码|_css样式表文件|_admin系统管理功能|_模块名系统管理模块功能实现页面|_模块名业务模块功能实现页面 |_web-infWeb.xml等文件存放目录 |_classesJava类class文件目录 *.properties配置文件|_lib应用程序所需类包|_config系统配置信息8 IDE规范 对于IDE的使用,限制使用为eclipse。9 外部包的使用 开发员如果需要使用一个外部包需要听取项目经理的意见。在项目经理批准以前，严禁擅自使用一个外部的包。