前台技术规范

陕西省邮政管理局电子商务系统技术规范版本1.0中国惠普有限公司企业客户事业部1999年11月01日文档修改记录版本日期说明编写者审核者0.110/28/1999项目组初稿李永武李竹华0.211/1/1999根据李竹华意见修改李永武说明本文档中所包含的信息属于机密信息，如无中国惠普有限公司的书面许可，任何人都无权复制或利用。®Copyright1999byChinaHewlettPackardCo.,Ltd前言本文档反映的是最新状况。任何以前的交付文档，如与本文档相冲突，以本文档为准。目录TOC\o"1-3"1. 总体结构42. 开发/运行环境52.1. 浏览11器52.2. WEB服务器52.3. 应用服务器52.4. 数据库服务器52.5. 开发工具/语言53. 文档63.1. 文档文件命名规则63.2. 技术手册格式63.3. 流程图64. 编程规范74.1. 源程序编辑器74.2. 命名规范74.3. 程序格式74.4. 程序中例外(Exception)的处理84.5. 程序中的可配置参数84.6. 编译84.7. 版本控制84.8. 程序框架94.9. WEB页面的生成94.9.1. 概述94.9.2. 页面生成类——VarHtml 104.9.3. 备份制度11总体结构网上邮局的主要组成部分包括外部Web信息服务器、过滤路由器、WEB服务器/应用服务器、防火墙、VirtualVault交易服务器、数据库服务器、内部管理维护工作站、业务主机。外部Web信息服务器负责提供邮政局的主页服务，供客户了解各种公共信息，如网上邮局的演示、网上邮局热点问题解答等。防火墙主要用于屏蔽Internet和邮局内部网络，增强安全性过滤路由器采用具备路由过滤功能的Cisco路由器，起到对流入邮局的数据流进行过滤的功能。只允许https的数据流向应用服务器，这样可以降低交易服务器的处理负荷，提高其性能。尽量减少网络黑客尝试攻击本系统的机会，增强其安全性。WEB服务器/应用服务器处理所有客户的交易请求，包括查询和付费等数据库服务器存放客户的注册信息、网上邮局的报刊信息、网上邮局的邮购物品信息和系统参数等VirtualVault交易服务器作为邮政绿卡主机的前置机，与应用服务器上的程序通讯，将绿卡主机的返回信息回传至应用服务器。内部管理维护工作站是网上邮局的管理人员使用的PC机，负责维护网上邮局数据库的各种数据。业务主机为邮政绿卡的主机开发/运行环境浏览器Netscape4.0以上MicrosoftIE4.0以上WEB服务器平台:HPVirtualVault应用服务器硬件平台:HP9000LClass操作系统:HPUX-11.00Java应用服务器软件:WebLogic4.5Java编译器/运行环境:JDK1.1JDBC:OracleJDBCDriver数据库服务器硬件平台:HP9000LClass操作系统:HPUX-11.00RDBMS:Oracle8forHPUX-11.00开发工具/语言浏览器页面:HTML3.2和JavaScript1.2。servlet编程:JDK1.1数据库语言:SQL文档格式:word97文档文件命名规则文档名称-作者简写-日期.扩展名技术手册格式对Java每个类的描述包括如下内容。类名概述方法1功能输入参数:输出参数:流程图(以visio5的格式嵌入文档。)方法2功能输入参数:输出参数:流程图……流程图格式:Visio5编程规范程序用Java编写。Java版本1.1。所有的程序分为公用类和非公用类两大类别。公用类是指与网上保险的业务无关的类,如数据库的访问类。非公用类是指与网上保险业务直接相关的类。公用类的设计在系统设计阶段完成,非公用类在程序设计阶段完成。源程序编辑器任何文本编辑器。命名规范类名:第一个字母大写,其余部分以易读为前提,大小写混合。如:MyClass变量名:第一个字母小写,其余部分以易读为前提,大小写混合。如:myVar方法名:第一个字母小写,其余部分以易读为前提,大小写混合。如:myMethod程序格式所有的公共类属于eservice.pubPackage.所有的非公共类属于eservice.insurancePackage.缩进:用TAB字符缩进。注释:按照javadoc的规范。示例如下:packageeservice.insurance;importeservice.pub.*;importjava.io.*;/***这是类的注释。*@author作者名字*@version$Header$*/publicclassMyClass{ /***这是变量myVar的注释。*/ intmyVar; /***这是方法myMethod()的注释。*@paramx参数x的注释。*@return返回值的注释。*@throwsExceptionException的注释*/ publicStringmyMethod(intx)throwsException { //方法中的注释. }}程序中例外(Exception)的处理当错误发生,需要终止当前进程的处理用Exception实现,Exception由最外层的程序截获处理。尽可能不使用返回错误代码的方式。Exception的处理属于公用程序,统一编写。例外的处理,使用公共类中的GException类。当错误发生时,程序要throw一个GException的对象。构造GException对象有两个构造函数。一是使用错误代码构造,这种方式适用与系统已知的可能的错误,提供错误代码的例外,有特定的处理方法。另外一种是使用字符串构造,这种方法适用于未知原因的例外,这种例外的处理是显示错误消息。程序中的可配置参数写于一个properties文件中。需要读取参数的类,在对象初始化时读取。如果从properties文件中读不到参数,则使用默认值。默认值作为静态变量写在程序中。例如:classabc{ publicstaticStringX=Property.getString("Z","abcd"); publicstaticdoublef=Property.getDouble("f",123.456);}以上的例子中,即是把类变量X初始化为在perties文件中名字为“Z”的属性值,如果没有找到,则返回默认值“abcd”。编译编写一个Makefile,由make命令完成所有程序的编译。用makeinstall命令版本控制各程序员对自己的代码进行版本控制。使用RCS进行版本控制。RCS的使用方法如下:ciaaa.java把aaa.java加入版本控制库aaa.java,v。并删除aaa.javaci–laaa.java把aaa.java加入版本控制库aaa.java,v.保留aaa.java,并对当前版本加锁。coaaa.java从版本库aaa.java,v中取出aaa.java.co–rx.yaaa.java从版本库aaa.java,v中取出版本为x.y的aaa.java.co–laaa.java从版本库aaa.java,v中取出aaa.java,并加锁。co–lx.y从版本库aaa.java,v中取出版本为x.y的aaa.java,并加锁。rlogaaa.java列出所有aaa.java的版本。rcs–ux.yaaa.java对版本库中版本为x.y的版本解锁。程序框架采用面向对象的程序设计方法。数据库的每个表,都有一个相应的Java类与之对应。表中的每个列名都有同名的变量与之对应。这样,插入数据库的操作可以由插入一个对象的方法来完成;同样,查询数据库也可以返回一个类的对象或者对象数组,以简化数据库的访问。使用这种方法比用sql语句字符串的方法有更大的灵活性和可靠性。所有的数据库访问通过JDBC类进行。WEB页面的生成概述页面生成是指servlet如何生成显示在客户浏览器上的WEB页面。页面生成所采用的策略是:用HTML编辑工具生成HTML文件,然后在HTML文件中嵌入用来表示变量的标签,形成模板；在输出的时候,Servlet读取HTML文件,把其中的标签替换为相应的值。使用这种页面生成方式的好处是:用户可以任意修改页面的格式，而不需要修改程序。一个变量可以在页面的多处被引用,同时被替换。在一个页面中可以有多个二维表。便于维护。页面生成类——VarHtml编程说明:设置HTML模板,其中包含一些变量和数组,这些变量和数组可以被替换,生成HTML页面,输出。VarHtml类说明构造方法:VarHtml(StringhtmlFileName);构造方法htmlFileName是建立这个对象所需要的HTML模板。HTML的格式的说明见下面。模板转换方法:voidsetVar(Stringname,Stringvalue);把模板中的变量name用值value替换。voidsetArray(Stringname,String[][]values);把模板中的数组name中的所有值设置为二维数组values。输出方法:voidprint();把HTML的内容输出到System.out。voidprint(PrintWriterout);voidprint(ServletOutputStreamout);把HTML的内容输出到out。StringgetContent();取得HTML的内容。HTML模板说明:HTML模板为标准的HTML格式,其中包含变量标签。所谓的变量标签是这样一些标签,它其中包含变量(包括单个变量或者数组变量)名称。这些标签可以被setVar()和setArray()方法替换为值。变量标签的格式如下:<$VarName> 表示单个变量,变量名为VarName。 <%ArrayName>…</%ArrayName> 表示一个变量数组。setArray()方法可以把<%ArrayName>和</%ArrayName>之间的属于这个数组的变量替换为相应的值。数值数组的每个行重复替换一次。 <$ArrayName.VarName> 表示二维数组中的一个列。例如:<html><body>Thisisavariable:<$var1>.<$var1>isastring.Thisisatable:<table><%arr1><tr><td><$arr1.col1></td><td><$arr1.col2></td></tr></%arr1></table>对上面的文本执行setVar(“var1”,“value1”);String[][]array1={ {“col1”,“col2”}, {“11”,“12”}, {“21”,“22”}, {“31”,“32”}};setArray(“arr1”,array1);之后,得到<html><body>T