jsp制作网站程序技术编写规范.doc

JSP网站编写规范说明 目 录 1 页面书写规范 2 1.1 文件头区 2 1.2 脚本区 2 1.3 表单提交 3 2 页面整体规范 3 2.1 页面风格 3 2.2 特殊控制 3 3 页面数据输入与输出 4 3.1 必输项的标识与控制 4 3.2 输入数据项的控制 4 3.3 输出数据的格式化 4 3.4 输出数据的预处理 4 4 错误页面 5 5 过渡页面 5 6 局部刷新 5 7 弹出窗口 5 8 参数命名规范 6  页面书写规范 在JSP编写过程中为表现清晰，便于维护，JSP页面书写要求采用分区编写，即将页面代码分为文件头区、数据定义（取值）区、脚本区、展现区、表单提交区。 文件头区 在JSP文件中，有关文档声明的内容均须放在文件头部，即文件头区。对于使用include标签的部分中，file属性的值必须是绝对路径杜绝相对路径。如： %@ page languate=”java” contentType=”text/html”;charset=” UTF-8” % %@ page import=”java.util.Vector” % %@ include file=”/include/head.jsp” % %% html 脚本区 图 2-3 脚本区示意图 在数据定义部分结束后，紧接着是该页面将要引用的公共的CSS库文件与JavaScript脚本的定义，如图2-3中A所示。 自定义的JavaScript脚本须写在公共脚本引用声明之后，如图2-3中B所示。 脚本的定义必须在HTML的Head标签书写。 表单提交 对于有表单提交、页面通过Form方式跳转，则该Form必须在文档的最尾端（除非同一个页面又多个Form），坚决杜绝将提交Form或者跳转Form与用于显示的Form混杂在一起，或者将该Form至于页面其他位置。 图 2-5 提交区示意图 页面整体规范 页面风格 首先需要确定页面风格，设定初步CSS样式表文件，（另见CSS文档说明文件！）在页面中的HTML控件的样式，包括使用Tag中的样式均必须采用class=cssName的方式来定义，严格禁止在页面中使用bgColor、color等属性定义风格。如下图所示，绿色为正确写法，红色为错误写法。 页面风格示意图 特殊控制 项目应用中有些由于业务需求的限制要求页面有特殊的控制，例如禁止用户使用鼠标右键功能等，这些限制多数都可以用Javascript脚本来实现。 屏蔽鼠标右键 Javascript可以获取鼠标事件，通过判断可知是否为右键，当是右键时让其不做任何处理。这部分代码应当在Javascript脚本库中体现，并且应当在整个应用框架的主Frame中去引用。 页面关闭清除Session 当关闭浏览器时，浏览器会触发HTML的onUnload()事件，所以在onUnload()事件中去发出清Session的请求。以往的做法是采用window.open()的方式去发出HTTP请求去触发签退的事件，这种方式如果签退成功的话会自动关闭成功页面，但如果失败的话这个页面将永远也关闭不了。 利用XMLHTTP请求的异步方式去发送这个请求将不会产生任何页面的跳转，无论交易成功还是失败均不会给客户带来影响。 所以在处理例如页面关闭清除Session这类的交易时，应使用XMLHTTP技术实现，XMLHTTP请求应当在Javascript脚本库中实现，onUnload()事件应在主框架中实现。 详细XMLHTTP技术可参阅相关文档。 页面数据输入与输出 必输项的标识与控制 作为必输项的数据域，在其前面标签后必须显示的使用“*”来标示，如下图所示。既然是必输项，必须有相应的脚本对其进行控制即使用JavaScript中判断输入框是否为空即可。 必输项标示示意图 输入数据项的控制 任何输入项都会有一个输入长度的限制，例如上图中的备注信息，金额的信息也根据业务需求或多或少的有限制，为了防止由于用户的输入超过限制导致异常，则可使用相应的HTML属性进行控制。同时输入数据有要求格式的，例如：E-mail地址、金额、注册名称均需在Javascript脚本库中统一使用正则表达式制定。 另外有些数据例如备注信息中如果出现类似“＜”、“＞”等特殊字符会影响页面的展示，在录入的过程中控制或者在提交时对输入数据中的特殊字符进行过滤是非常重要的。 输出数据的格式化 最常见的需要格式化的是跟日期等有关的数据，一般业务要求用以显示的数据必须为年-月-日即“-”分隔符。应当统一使用UTB的相应Format方法来实现。 输出数据的预处理 输出数据如果为Null则必须使用UTB的nvl方法进行预处理，即将null值转换为“”空的字符串。 错误页面 系统有统一的出错页面(/error.jsp)。 过渡页面 在页面操作过程