H2010编码规范JavaScript分册.doc

H2010编程规范 JavaScript开发分册  文档修改记录 版本更新摘要 NO. H2010-DEV -2010-0000002 版本号 日期 修改人 更新摘要 0.1.0 2010-03-20 王翔 创建 0.1.1 2010-03-22 王翔 补充异常事件处理  目录 概要 4 背景介绍 5 命名规范 7 主要的命名样式 7 命名空间 7 顶层命名空间 7 平台框架类 7 工具类 8 业务应用类 8 培训和教程示例类 8 单元测试类 8 变量 9 基本编码规范 10 性能要求 11 事件处理 16 异常处理 19 参考资料 21  概要 本文档是《H2010工程信息系统设计和开发标准》中的JavaScript开发分册，用于指导H2010工程实施组浏览器端JavaScript开发部分。 本文读者适用于H2010工程开发人员和代码复查人员，对于中国海关自建、合建信息系统中使用JavaScript设计应用的设计、开发人员也有一定的借鉴作用。 本系列文档有如下其他分册，读者可以根据开发需要进行参阅： 《编程规范和开发指南——.Net开发》 《编程规范和开发指南——Java 分册》 《编程规范和开发指南——JavaScript 分册》 《编程规范和开发指南——T-SQL 分册》 《编程规范和开发指南——PL/SQL 分册》 《编程规范和开发指南——.Net安全编码指南》  背景介绍 随着海关基于浏览器平台项目的普及，如何在浏览器端提供更好的交互机制及用户体验，适应海关应用“服务化”特点，成为海关应用开发人员需要面临的主要问题。为了实现浏览器客户端运行平台的无关性，项目普遍采用JavaScript语言完成UI及UIP部分逻辑，并且配合AJAX技术实现浏览器客户端与海关后台“服务”Endpoint的有效衔接。 如图1是一个典型Web应用的分层结构。本文所介绍的JavaScript开发规范主要面对UI和UIP（UIP：位于UI层，协调调度UI组件的客户端控制机制）部分的JavaScript开发，对于采用JavaScript作为服务端代码的应用，可以主要参考“命名规范”、“基本编码规范”、“性能要求”、“事件处理”、“异常处理”的适用部分。 图1：典型Web应用的分层结构 为了便于海关对外技术合作和系统集成，本文介绍的JavaSript内容基于ECMA 262 language标准，同时适于中国海关.NET、Java Java EE、REST平台项目。 为了便于项目协作，中国海关涉及JavaScript的开发、调试、库代码共享统一基于下列工具平台。 平台 开发工具 Windows Visual Studio 2008、Visual Studio 2010 Visual Studio 2008 Web Developer Express Visual Studio 2010 Web Developer Express Macintosh BBEdit 表1：推荐的开发工具 为了帮助读者了解本文对于不同内容的约束性强度，采用下列标志区分： ? 强制要求 ?虽然不强制，但强烈建议 □建议 本文读者适于中国海关各类信息系统的设计、开发人员。对于系统管理、运行维护人员也有一定的借鉴意义。  命名规范 主要的命名样式 Pascal 标示命名的每个单词都是首字母大写。 例如：BackColor、EntryHead Camel 标示命名的首单词首字母小写，其余的每个单词均首字母大写。 例如：backColor、entryHead Upper 标示的每个字母均大写。 例如：IO、ENTRYHEAD Lower 标示的每个字母均小写。 例如：io、entryhead 命名空间 命名空间参考《编程规范和开发指南——.Net开发分册》，所有命名空间的根为 chinaCustoms.，命名方式采用首字母小写的骆驼型命名方式。 顶层命名空间 按照开发的主要类型，顶层命名空间分别为 chinaCustoms.framework chinaCustoms.utility chinaCustoms.application chinaCustoms.tutorial 平台框架类 chinaCustoms.framework代表所有海关平台类项目的父节点 例如： 风险平台命名为 chinaCustoms.framework.risk DSS命名为 chinaCustoms.framework.dss 安全运维平台命名为 chinaC