WEB开发编程规范总体.docVIP

WEB开发编程规范

(界面及编程)

TOC\o1-3\h\zWEB开发编程规范 1

前言 1

术语解释 1

范围界定 2

相关开发环境(建议环境，不做强制要求) 2

开发工具： 2

数据库： 3

WEB服务器(仅做开发测试用)： 3

应用服务器： 3

界面开发规范 3

基本要求 3

其它注意事项 6

编程规范 7

基本要求 7

可读性要求 7

正确性与容错性要求 8

可重用性要求 8

变量命名 8

常量命名 8

函数命名 8

注释 8

程序 10

WEB开发编程规范

前言

J2EE是一种功能完备、稳定可靠、安全快速的企业级计算平台，它由多种基于JAVA的技术组成：EnterpriseJavaBeans(EJB),JavaServerPages(JSP),servlets,JavaNamingandDirectoryInterface(JNDI),andtheJDBCdataaccessAPI等。

本规范针对从事资源管理开发中前端WEB站点开发设计人员。要求使用者对J2EE架构有所了解，具有一定的HTML、CSS基础知识，对交互式网页JSP及javabeans的开发有较深认识。本规范的目的是为了开发出通用的、易于维护的高效率的J2EE应用。

术语解释

表示层：即系统与系统使用者通过各终端进行交互时对数据内容的表现层，同时负责输入数据的格式合法性校验。该层次根据用户的需要完全个性化。

应用表示逻辑层：根据个体应用系统的约束条件，实现表示层数据的组织和包装；根据应用逻辑对表示层输入的数据进行逻辑合法性检验。

应用逻辑组件层：实现特定于个体系统的应用逻辑和算法(EJB)。

持久存储层：可以实现所有实体数据的数据库集中存储。通过该层对持久存储的CRUD(create,read,updatedelete)操作，负责实体对象的创建、状态维护、删除等功能。

范围界定

根据J2EE技术框架的体系结构和WEB应用的特点，我们在项目的开发过程中将项目分成两个层次：与系统用户交互的网站页面系统（含静态页面结构和动态页面结构），以及实现用户业务逻辑的系统（含支持数据永久存储的数据库系统）。对于这两个层次，我们根据其特点采用不同的开发过程，而本规范只针对前一部分。

在这一部分的开发中，需要如下开发人员：

Javabeans(包括无输出用户界面的servlet)开发人员

JSP开发人员(包括客户端的JavaScript)

HTML设计人员

美工

Javabeans开发人员建立表现层的逻辑，而其他人员建立表现的形式。因为这一层的开发可能会有几个人来承担不同的角色，也可能有些人需要兼顾到所有的方面，所以为了有针对性，下面我们分别就这几种角色在开发中应注意的事项提出要求：

相关开发环境(建议环境，不做强制要求)

开发工具：

Javabeans的编写调试可用任何编辑器或JBuilder等，其它网站界面及管理部分用DreamweaverMX，主要是做为一个大型的应用，网站管理是一个很重要的内容，采用DWMX可以通过内定的工作流程保证我们整个应用中模板、javascripts脚本、css样式表、JSP页面控件及XML、TLD等技术的实现保持一致，并无须设专人维护测试这些必须统一的公共部分。另一方面的优势是在JSP页面的开发上，不但提供JSP标记库支持，而且提供完全JavaBeans自省功能，即除了在数据绑定面板中显示JavaBeans的getProperty和setProperty方式之外，DreamweaverMX还有一个能显示JavaBean所有方式和属性的服务器行为面板，可充分集成Beans和JSP应用程序，另外DWMX也支持WebService的开发。(将在近期安排DreamweaverMX针对JSP开发的相关培训)

数据库：

Oracle8i/9i(只安装客户端及相应JDBC驱动class12.zip)

WEB服务器(仅做开发测试用)：

Tomcat/Websphere/Resin等，建议用Tomcat4.0(这一层的开发做测试足够了，且占用系统资源少)，为了能测试包含访问EJB的代码，需安装j2ee.jar或其它包含有javax.ejb.*的包。

应用服务器：

可不安装，通过远程访问Websphere即可(指编写调用EJB的JAVABEANS部分)。

界面开发规范

基本要求

网站目录命名规则

1．所有目录名称使用小写英文字母的组合，绝对禁止包含汉字、空格和特殊字符及大写字母（WEB-INF目录除外），可以添加数字