专题资料（2021-2022年）Hipay系统自助终端页面开发流程和规范06版.doc

《专题资料（2021-2022年）Hipay系统自助终端页面开发流程和规范06版.doc》由会员分享，可在线阅读，更多相关《专题资料（2021-2022年）Hipay系统自助终端页面开发流程和规范06版.doc（37页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、 终端页面开发流程和规范终端页面开发流程和规范 0 0.6 6 版版文件状态：草稿 正式发布 正在修改文件标识：当前版本：0.6撰 稿 人：李水生完成日期：发布时间：编号：2005 年 12 月 23 日版版 本本 历历 史史版本/状态作者参与者起止日期备注草稿Hipay 系统自助终端页面开发流程和规范系统自助终端页面开发流程和规范一：一：Hipay 页面开发页面开发1 目录结构：目录结构：1.1：顶层目录结构：顶层目录结构 图（图（1）所示）所示Applications:目录里放着我们创建的应用板块。Framework:里是 Hipay 系统应用，包含实体和服务板块Base:里放着启动，容器

2、和配置和组件加载等公共类。Data:是 Hipay 内建的数据库。Logs:是系统日志文件夹。Hipay.bat 是启动文件。图（1）1.2：applications 目录目录图（图（2）所示）所示Accounting:帐务管理，支付信息，发票等。Content:内容管理，调查等。Ecommerce:电子商务应用。Order:订单管理。Party：人员组织管理Securityext:安全管理拓展Product:产品管理。Component-load.xml:板块加载配置文件。图（2）1.3：ecommerce 目录目录 图（图（3）所示）所示Src:java 源文件。Config:配置文件，主

3、要是多语言的配置文件Data:系统运行时需要导入的数据文件Script:Hipay 系统 mini-lang 文件（简单 Java 方法）Templates:模板页面Webapp:web 服务需要用到的页面和脚本Widget:用 xml 描述的页面Build.xml:用 ant 工具编译 src 文件夹的源文件生成的 classes 文件和 jar 包放在 build 中。giantstone-component.xml:电子商务板块加载配置文件。图（3）1.4：webapp 目录目录Webapp 下有一个应用文件夹为 ecommerce，其目录结构如图（4）所示:除了 WEBINF 文件夹以

4、外，其他的文件都是页面文件，页面文件都是以 ftl 为后缀的freemaker 模板页面。图（4）1.5：WEBINF 目录如图（目录如图（5）所示）所示Actions:系统脚本文件夹，beanshell 脚本controller.xml：流程控制器web.xml：网站参数设置图（5）1.6：actions 目录目录 如图（如图（6）其文件结构和图（4）中的 ftl 页面结构是对应的。比如说显示购物车信息的页面 showcart.ftl 放在图（4）cart 文件夹中，则对应的脚本showcart.bsh 放在图（6）的 cart 文件夹中，这样做不是必需的，但是是规范的，易于维护的。图（6）

5、1.7：widget 目录目录Widget 是把 ftl 页面和 bsh 脚本组合起来供前端显示的工具。它用 xml 语言和特定标签描述页面和页面，页面和脚本之间如何组合和定制。CommonScreens.xml 是公共模板定制页面CartScreen.xml 是购物车相关页面定制CatalogScreens.xml 是产品，目录的显示的页面定制CustomerScreens.xml 是有关调查，寻价和客户方面的页面定制ContentScreens.xml 是跟内容管理相关的页面定制OrderScreens.xml 是跟订单和支付相关的页面定制EcommerceSetup.bsh 是公共模板加

6、载的脚本图（7）其他板块的目录结构和 ecommerce 是相似的。2 开发内容开发内容2.1：对：对 widget 组合页面要熟练掌握。组合页面要熟练掌握。Web Widget 是轻量级的 Web 应用程序，为使用者提供一键式的服务。它通常被设计为具有特定的功能，如提供天气、股票、拍卖等的信息。它与网页一样，使用标准的 Web 技术开发，如 XHTML，CSS，javascript 等。从这方面看，Widget 是脱离浏览器 UI 运行的网页。beanshell 脚本准备数据，freemaker 页面显示数据，而 widget 工具正是组合脚本和页面的，它规定了哪个脚本为哪个页面组织数据，即

7、起到绑定脚本和页面的作用，同时也可以定义某些变量供页面使用，当然有些页面可以没有脚本，简单的来说，widget 就是用户请求页面，它把变量，标签和 freemaker 模板语言组合生成 HTML 页面，当用户请求时就发送给用户浏览器。Widget 用到的标签在 framework/widget/dtd 里的 xsd 文件里，如图（8）图（8）在 eclipse 开发环境下，有代码预示的功能，如图（9）图（9）图（10）图（10）的!-的内容是注释，从图中的注释清楚地介绍的用 widget 如何定制一个模板。screenScreen 标签对应的是前端请求的页面，页面的名称 name 属性是必须的

8、。sectionScreen 下有一个唯一的 section，section 下包含 condition，actions，widgets 和 fail-widgets 标签。condition如果 condition 存在，并且 condition 是 true 则页面显示 widgets 内容，否则显示 fail-widgets。如果 condition 不存在，则 fail-widgets 标签也就没有必要。以下是对 attrName 非空的判断：是检查当前用户是否拥有对 order 的 VIEW（查看）的权限 是把变量跟某个常量进行比较，操作包括 less greater equals

9、less-equals greater-equals not-equals contains,分别表示，小于大于 等于 小于等于 大于等于 不等 包含。是把两个变量进行比较,type 类型值可以为 Float Double Integer Long Boolean String PlainStringDate Time Timestamp 和 Object，如果没有 type 默认为 String。and 是对多个条件进行与操作or 或操作 xor 异或not 非其他的标签请查看图（8）所示的文件中内容。actionsactions 是加载页面之前的动作。常用的动作是：set:set 定义一个

10、变量并赋值 field 的值就是变量名 value 是变量值；script:script 加载一个 beanshell 脚本文件，location 是脚本的位置，位置以”component:/xyz/”开头，意思是在 xyz 这个板块下，xyz 是在 Hipay 的安装目录下的 applications 和 framework 下的第一层子目录文件夹，如图（2）得文件夹都可以作为这里的 xyz。property-map:property-map 加载一个属性文件，resource 的值是文件的名称，文件后缀为 properties,可省略不写，对于多语言，比如要加载简体中文配置文件 TMSBa

11、seUiLabels_zh_CN.properties和美国英语配置文件 TMSBaseUiLabels_en_US.properties，并把配置文件的键值对放在一个Map 即 uiLabelMap 中，作为全局变量是用，只需要这样一行代码：这行代码会加载所有各种语言的配置文件，然后根据用户的 locale，读取当时当地的语言配置。还有一点需要注意，如果 uiLabelMap 在 TMSBaseUiLabels_zh_CN.properties 中找不到键 值，它 会 去 TMSBaseUiLabels_zh.properties 查 找，如 果 没 找 到，则 继 续 查 找TMSBase

12、UiLabels.properties，如果仍然没有值则返回键本身，如果有则返回文件中定义的值；widgetsWidgets 是对页面的加载和布局。常用的加载页面的方法包括1：platform-specificcomponent:/TMSBase/webapp/TMSBase/includes/header.ftl 为要加载的文件路径和名称。即TMSBase 这个板块下 webapp 文件夹的子文件夹 TMSBase 下的子文件夹 includes 下的header.ftl 文件。2：include-screen这行代码的意思是加载一个页面，这个页面是在 TMSBase 这个板块下的 widg

13、et 文件夹下的bcd.xml 文件里定义的 abc 页面。abc 是 screen 的 name 的值。3：decorator另外，模板常用到这行代码 ，意思是页面的 body 部分是空的，其他页面使用以下代码使用这个模板，main-decorator 是模板的名称（screen 的 name 的值）则其他页面的内容出现在 body 部分。4：containerWidget 中可以加载容器 容器里面可以加载其他页面，这类似于HTML 中的 DIV 层。以下代码是合法的：和效果是等同的，其他类似。5：widget 中的中的 sectionwidgets中可以放置多个section6：其他：其他

14、加载一个图片可以使用 页面上显示一行文字可用其他的标签请查看图（8）所示的文件中内容。fail-widgets等同于 widget 标签，是条件不满足时给用户显示的页面。2.2：对：对 freemaker 模板语言的熟练掌握模板语言的熟练掌握2.2.1：各页面功能及存放位置：各页面功能及存放位置页面文件后缀为 ftl，存放在图（4）所示的目录中，即 webapp 下的应用文件夹中图（4）自助终端目前用到的页面中有图（4）中的部分页面：main.ftl 是主页面，用户返回时会到此页面，该页面左边显示分类，右边显示推广产品。mainframe.ftl 框架页面分三个部分 框架上面部分占 99.98

15、%是用户操作的业务页面，框架中间占 0.01%，是用来加载终端插件，框架下部是用来加载加密插件和进行加密验证的。mainup.ftl 是语言选择页面。login.ftl 是用户刷卡登陆页面。cart 下的 showcart.ftl 页面(购物车页面)catalog 下的 sidedeepcategory.ftl(终端屏幕的左边目录翻页页面)customer 下的 survey.ftl（调查页面即用户的密码，号码输入页面）error 下的 error.ftl（错误页面）includes 下的：header.ftl 模板头部导航栏 加载样式表 定制页面超时脚本footer.ftl模板底部留个按钮h

16、idebottom.ftl 加载终端插件，是页面底部框架固定不动的部分，对于不同的终端，申明和条用插件的方式可能不同，此时需要编写多个厂家的底部框架页面。jiami.ftl 工行自助终端用到的加密插件页面。order 下的checkoutoptions.ftl 该页面显示正在支付中，请用户等候，该页面向后台传递了用户的支付方式，货物的运送方式，联系方式等等重要信息，不可或缺。ordercomplete.ftl 该页面是支付完成页面，显示支付结果，成功则用户可以选择打印凭条。另外还用到了 order 板块的 webapp 下 ordermgr 的字文件夹 entry 的 catalog 的部分文

17、件，如图（11）图（11）calldetailIE.ftl 是天一终端的 IE 浏览器在进行银行卡打电话业务时显示的页面。calldetailNE.ftl 是芙蓉终端 mozzila 浏览器银行卡打电话页面category.ftl是显示产品分类的页面 其指向 categorydetailcategorydetail.ftl 是产品分类的详细信息页面 其指向 productsummary.ftlproductsummary.ftl 是某一个分类下所有产品的简要介绍页面，在终端上就是显示在屏幕右边的四个按钮上的内容。product.ftl 是产品页面 其指向 productdetail.ftl 页

18、面productdetail.ftl 页面是根据对产品的配置的详情页面来展示产品。比如银行卡打电话这个产品就是配置成了 calldetail.ftl,如果没有配置则默认显示 productdetail.ftl 页面2.2.2：常用的页面标签：常用的页面标签以下例子中可以见到常用到了页面标签。$uiLabelMap.chooseLanguage#-$uiLabelMap.firstPagedownInformation-input type=button id=$styleValueclass=buttonImgClassvalue=$uiLabelMaplanguage.description

19、?if_existsname=$index*2onclick=window.location=$language.requestUri?if_exists;/2.2.2.1 注释注释 注释的内容不能出现-字样#-$uiLabelMap.firstPagedownInformation-要注意区分 HTML 页面的注释 2.2.2.2赋值赋值 assign设置变量页面使用变量时用$index,将会显示 52.2.2.3 条件判断条件判断 if else使用时以尖括号和#开头 并以 结尾b)A 比 B 大A 不比 B 大2.2.2.4 列表列表 listsizeindexlanguagesList

20、 size=$languagesList?size$language 位置是$language_index,则最后显示的结果是：Chinese 位置是 0,English 位置是 1,French 位置是 2,2.2.2.5 异常处理异常处理如果变量值没有定义页面就会报错，加上以下一些判断，可以消除页面上的错误：existsif_existshas_contentdefaultexists 是对某个变量进行判断，返回值是布尔型 true or false;if_exists 返回是字符串，对某个变量进行判断 如果值或引用不存在则显示空串，相当于“”；has_content 对变量进行判断，如果

21、值或引用存在并且不为空时才为 true 否则为 false。default如果变量无值就设定默认值。$someparameter$someparameter$someparameter?if_exists$someparameter?default(“defaultValue”)2.2.2.6 其他其他对于自助终端页面目前常用就是上面介绍的这些标签更多请参考 FreeMarker 设计指南.doc推荐登陆官方网站 www.freemaker.org 查看详细手册。2.3：对：对 beanshell 脚本的熟悉脚本的熟悉Beanshell 是宽松的 Java，使用变量前无需定义，它完全兼容 Ja

22、va 语法。详情请登陆官方网站 www.beanshell.orgFlt 页面负责显示后台传来的数据，对页面来说 beanshell 脚本是重要的后端数据源，在 beanshell 里可以直接引用 request 变量和 context 变量；通过 request 的 getParameter(“name”)方法 bsh 脚本可以获取前端页面传来的参数通过 context 的 put(“name”,value)方法 bsh 脚本可以把经过处理的数据送回前端页面显示。页面使用$name 即可显示。request 可以得到 delegator 和 dispatcherdelegatorbsh 脚本

23、中得到 delegator：delegator=request.getAttribute(delegator);delegator 是实体引擎对数据库增删查改的代理器；数据库查找数据库查找根据主键查找：根据主键查找：Bsh 脚本中最常做的事情是到数据库中查找数据供前台页面展示。value=delegator.findByPrimaryKey(数据库表名,inMap);inMap 放置主键键值对.UtilMisc.toMap(name,value)方法是把键值对放入 Map 中比如：orderHeader=delegator.findByPrimaryKey(OrderHeader,UtilMi

24、sc.toMap(orderId,1000);意思是在表 OrderHeader 中查找主键（orderId）等于 1000 的记录，查出后赋给 orderHeader。根据某几个字段交集查询：根据某几个字段交集查询：valueList=delegator.findByAnd(数据库表名,inMap);orderHeader=delegator.findByAnd(OrderHeader,UtilMisc.toMap(statusId,APPROVE，grandTotal,200);意思是在表 OrderHeader 查询状态是 APPROVE 并且交易金额是 200 元的记录列表。根据某几个

25、字段并集查询：根据某几个字段并集查询：valueList=delegator.findByOr(数据库表名,inMap);orderHeader=delegator.findByOr(OrderHeader,UtilMisc.toMap(statusId,APPROVE，grandTotal,200);意思是在表 OrderHeader 查询状态是 APPROVE 或者交易金额是 200 元的记录列表。根据条件查询：根据条件查询：delegator.findByCondition(数据库名,条件列表,需要查询出来的字段列表,字段排序列表)需要查询出来的字段列表如果设置为 null 则默认查出所

26、有字段。创建条件比如产品号等于 10001：Condition1=new EntityExpr(productId,EntityOperator.EQUALS,10001);状态是 ACTIVE：Condition2=new EntityExpr(statusId,EntityOperator.EQUALS,ACTIVE);生产日期大于某个日期 date1：Condition3=new EntityExpr(munaDate,EntityOperator.GREATER_THAN,date1);过期时间小于或等于某个日期 data2：Condition4=new EntityExpr(over

27、Date,EntityOperator.LESS_THAN_EQUAL_TO,date2);总条件：Conds=new LinkedList();添加条件：Conds.add(Condition1);Conds.add(Condition2);Conds.add(Condition3);Conds.add(Condition4);设置条件之间的关系为与关系：findCondition=new EntityConditionList(Conds,EntityOperator.AND);设置排序：按产品号倒序排列。orderby=UtilMisc.toList(-productId)；开始查询：f

28、indResultList=delegator.findByCondition(Product,findCondition,null,orderby);其他查询方法请参考 com.giantstone.entity.GenericDelegator 类的方法。删除数据库记录删除数据库记录在查询方法中介绍的比较详细，此处不再赘述相关内容。根据主键删除：根据主键删除：GenericPK pk=(GenericValue)it.next().getPrimaryKey();delegator.removeByPrimaryKey(pk);根据某几个字段交集删除根据某几个字段交集删除delegator

29、.removeByAnd(TermService,UtilMisc.toMap(DEVTYPEID,sDEVTYPEID);根据条件删除根据条件删除delegator.removeByCondition(“数据库表”,“条件列表”);删除列表删除列表delegator.removeAll(List);可以先查出一个列表，然后删除。其他删除方法请参考 com.giantstone.entity.GenericDelegator 类的方法。增加数据库记录增加数据库记录delegator.create(数据库表名,inMap);比如：nowTimestamp 是当时时间delegator.creat

30、e(Product,UtilMisc.toMap(productId,10002,statusId,CREATE,fromDate,nowTimestamp);意思是往表 Product 中插入一条产品号是 10002 状态是 CREATE，开始日期是nowTimestamp的记录。更改数据库中的记录更改数据库中的记录value 是数据库的一条记录。fields 是实据库字段的键值对 Mapvalue=makeValue(“数据库表”,fields)delegator.store(value);根据条件更新：根据条件更新：delegator.storeByCondition();delegat

31、or.storeByCondition(数据库表名,要更新的字段,更新条件);dispatcherbsh 脚本中得到 dispatcher：dispatcher=request.getAttribute(dispatcher);dispatcher 是服务引擎的调度器。调用服务方法：调用服务方法：同步调用服务：outMap=dispatcher.runSync(服务名,inMap);inMap 是输入参数组成的 Map；outMap 是输出参数组成的 Map；2.4：熟悉流程控制器：熟悉流程控制器 controller.xmlhandler控制器定义了对于各种类型请求或响应采用何种方法来处理。

32、在 controller.xml 里有大量的uri 是页面的请求。request-map上面代码的意思是：如果有请求是 main，第一步安全验证，https=true，表示要走 https 安全协议，https=false就走 http 协议，auth=true 强制调用 checkLogin 请求，验证用户是否已登录，auth=false则不检查此项，第二步意思是如果成功则到请求 main 页面。main 页面在 view-map 中介绍。再看看 checkLogin：验证用户是否登陆这个请求中 https=true，走 https 协议，auth=false,它当然不能递归调用自己。eve

33、nt 是对该请求的响应事件 type=”java”表示后台用 java 方法来处理这个请求，path是 java 的路径，invoke 的值是 java 类的某个静态方法。方法会返回“success”或者error，如果是前者，则页面转到 main 页面，否则到 login页面。处理请求的事件除了 java 还有 service，用一个服务来响应一个请求，服务会返回“success”或者error。常用的还有 simple 是 mini-lang，即简单 java 语言，详情参看安装目录frameworkminilangdtdsimple-methods.xsd 及各板块中 script 文件

34、夹的例程。当一个请求的 response 的 type 是“request”的时候 会根据 value 的值来继续找 request-map的对应值，这样就形成了链式请求，即多个请求连续调用。当最后一个请求的值肯定会落在type 是“view”上。应为 HTTP 请求肯定会给用户一个回应。view-map当一个请求的 response 的 type 是“view”的时候 就会根据 value 的值来找 view-map 的对应值。response name=success type=view上面代码的意思是如果来了 view 的页面请求，就去 accounting 这个板块的 widget 文

35、件夹下的 CommonScreens.xml 文件中定义的 main 的页面。type=“screen”表示使用 widget 工具生成页面。其他依次类推。具体标签请参看:安装目录frameworkwebappdtd site-conf.xsd3 开发顺序开发顺序3.1：理解流程控制器：理解流程控制器 controller.xml开发之前，设计人员设计好控制流程，即编写好板块的 controller.xml 文件。controller.xml 里所有的请求 uri（request-map uri=xxx）都是与 freemaker 页面上的请求/xxx 一一对应。对于用户从页面上提交的请求，流

36、程控制器就能接受到这个请求，并按预定义的事件进行处理，处理完成之后，根据处理结果，会转到不同的页面标识（）这样一次请求响应就完成了。3.2：理解页面组合器：理解页面组合器 widget 定制定制 XML 页面文件。页面文件。在流程控制器里以下代码：意思是页面标识是 showforum 的页面在 ecommerce 版块下 widget 文件夹下的ForumScreens.xml 文件描述的 screen name=”forum”部分。此外开发人员必须熟悉 2.1 节内容，即 widget 标签使用。3.3：页面人员开发：页面人员开发按照流程控制器的内容规范前台页面的请求名（必需与 reques

37、t-map 中的 uri 对应上）；按照流程控制器中页面定义建立页面文件结构。根据业务页面文档或者 PowerPoint 文档编写页面。根据显示需要编写 beanshell 脚本。4 数据库表结构数据库表结构需要熟悉的数据库表结构，具体的标字段定义在各自板块的 entitymodel.xml 文件中。Party 板块板块当事人表当事人类型表当事人角色表组织表人员表角色类型表联系机制表联系机制类型表当事人联系机制表邮政地址表Accounting 板块板块金融帐号表金融帐号交易表礼品卡表支付表支付类型表支付方法表支付方法类型表Order 板块板块订单头订单属性订单备注订单条订单条属性订单条联系机制

38、订单角色订单状态订单类型Product 板块板块产品编目编目目录产品分类产品和分类视图分类内容分类成员分类和分类中的产品关联产品表产品属性表产品内容表产品内容类型表产品特征表产品特征应用商品价格表产品配置表商店商店调查表商店送货方式运送运送类型商店支付设置表仓库Content 板块板块内容表内容属性表内容类型表数据资源表数据资源类型表电文表，此处配置了产品，目录的多语言调查表调查应用类型表调查问题表调查问题类型表调查问题分类Security 板块板块用户登录表权限权限组权限组的权限用户与权限组Common 板块板块枚举表枚举类型备注数据状态表度量衡地理Webapp 板块板块服务器连接日志表二二 开发规范开发规范待续海藻肥http:/TWfZZvj8Y33n