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参数命名规范参数命名规范..........................................................................................................................6JSP 规范第 2 页1 页面书写规范页面书写规范在 JSP 编写过程中为表现清晰，便于维护，JSP 页面书写要求采用分区编写，即将页面 代码分为文件头区、数据定义（取值）区、脚本区、展现区、表单提交区。

1.11.1 文件头区文件头区在 JSP 文件中，有关文档声明的内容均须放在文件头部，即文件头区对于使用 include 标签的部分中，file 属性的值必须是绝对路径杜绝相对路径如：1.21.2 脚本区脚本区图 2-3脚本区示意图 在数据定义部分结束后，紧接着是该页面将要引用的公共的 CSS 库文件与 JavaScript 脚 本的定义，如图 2-3 中 A 所示 自定义的 JavaScript 脚本须写在公共脚本引用声明之后，如图 2-3 中 B 所示 脚本的定义必须在 HTML 的 Head 标签书写JSP 规范第 3 页1.31.3 表单提交表单提交对于有表单提交、页面通过 Form 方式跳转，则该 Form 必须在文档的最尾端（除非同一 个页面又多个 Form） ，坚决杜绝将提交 Form 或者跳转 Form 与用于显示的 Form 混杂在一起， 或者将该 Form 至于页面其他位置图 2-5提交区示意图2 页面整体规范页面整体规范2.12.1 页面风格页面风格首先需要确定页面风格，设定初步 CSS 样式表文件， （另见 CSS 文档说明文件！）在页 面中的 HTML 控件的样式，包括使用 Tag 中的样式均必须采用 class=“cssName“的方式来定 义，严格禁止在页面中使用 bgColor、color 等属性定义风格。

如下图所示，绿色为正确写法， 红色为错误写法图 2-1页面风格示意图2.22.2 特殊控制特殊控制项目应用中有些由于业务需求的限制要求页面有特殊的控制，例如禁止用户使用鼠标右 键功能等，这些限制多数都可以用 Javascript 脚本来实现 屏蔽鼠标右键 Javascript 可以获取鼠标事件，通过判断可知是否为右键，当是右键时让其不做任何 处理这部分代码应当在 Javascript 脚本库中体现，并且应当在整个应用框架的主 Frame 中去引用 页面关闭清除 Session 当关闭浏览器时，浏览器会触发 HTML 的 onUnload()事件，所以在 onUnload()事件JSP 规范第 4 页中去发出清 Session 的请求以往的做法是采用 window.open()的方式去发出 HTTP 请求 去触发签退的事件，这种方式如果签退成功的话会自动关闭成功页面，但如果失败的话 这个页面将永远也关闭不了 利用 XMLHTTP 请求的异步方式去发送这个请求将不会产生任何页面的跳转，无论 交易成功还是失败均不会给客户带来影响 所以在处理例如页面关闭清除 Session 这类的交易时，应使用 XMLHTTP 技术实现， XMLHTTP 请求应当在 Javascript 脚本库中实现，onUnload()事件应在主框架中实现。

详细 XMLHTTP 技术可参阅相关文档3 页面数据输入与输出页面数据输入与输出3.13.1 必输项的标识与控制必输项的标识与控制作为必输项的数据域，在其前面标签后必须显示的使用“*”来标示，如下图所示既 然是必输项，必须有相应的脚本对其进行控制即使用 JavaScript 中判断输入框是否为空即可图 2-2必输项标示示意图3.23.2 输入数据项的控制输入数据项的控制任何输入项都会有一个输入长度的限制，例如上图中的备注信息，金额的信息也根据业 务需求或多或少的有限制，为了防止由于用户的输入超过限制导致异常，则可使用相应的 HTML 属性进行控制同时输入数据有要求格式的，例如：E-mail 地址、金额、注册名称均 需在 Javascript 脚本库中统一使用正则表达式制定 另外有些数据例如备注信息中如果出现类似“＜” 、 “＞”等特殊字符会影响页面的展示， 在录入的过程中控制或者在提交时对输入数据中的特殊字符进行过滤是非常重要的3.33.3 输出数据的格式化输出数据的格式化最常见的需要格式化的是跟日期等有关的数据，一般业务要求用以显示的数据必须为年- 月-日即“-”分隔符应当统一使用 UTB 的相应 Format 方法来实现。

3.43.4 输出数据的预处理输出数据的预处理输出数据如果为 Null 则必须使用 UTB 的 nvl 方法进行预处理，即将 null 值转换为“” 空的字符串JSP 规范第 5 页4 错误页面错误页面系统有统一的出错页面(/error.jsp)5 过渡页面过渡页面在页面操作过程中，无论是点击菜单、提交表单均会有页面跳转的情况发生 传统的做法是直接在点击菜单的 URL 中指定 Operation 名称，并传递交易需要的数据， 此种方式会产生白页显示在页面上 过渡页面（例如：在点击菜单需要与后台交互后才能生成显示页面的交易） ，我们通常 采用一个过渡页面的方式进行提交交易，然后跳转到需要显示的页面6 局部刷新局部刷新这里所说的局部刷新并不是简单的 Form 的 target 属性 某些特殊业务需求要求在页面中的某些显示要素按照用户的请求进行更新，而整个的交 易页面不受影响，这种需求的实现可以通过两种方式来实现 隐藏的 IFrame，当用户触发更新数据事件时，将请求 Form 的 target 设置为一个隐 藏的 IFrame 中，在 IFrame 的窗口得到返回内容后，使用 opener 属性去更新显示页 面中的要素； 同步的 XMLHttp 请求，XMLHttp 请求是通过 ActiveX 控件发送请求。

第一种利用 IFrame 应当是比较传统的方式，针对不支持 ActiveX 技术的页面可以保证实 现页面的局部刷新目前大多数浏览器包括 IE、NetScape 均已支持 ActiveX 技术，所以利用 XMLHttp 方式发送请求是理想的选择7 弹出窗口弹出窗口项目业务越来越复杂，而针对平台系统的设计又要求用户的操作越来越简单，在同一个 业务中须尽量少的发生页面跳转情况在复杂业务的数据采集过程中，应采用弹出窗口的方 式完成 弹出窗口方式通常有两种，一种为标准 JavaScript 的 window.open()方法，使用这种方法 通常为页面进入时弹出一个非模态的窗口，但这种方法经常会被浏览器或一些浏览器插件关 闭另外一种模态窗口的方法为居上的，现有的浏览器均。