Hipay系统自助终端面开发流程和规范06版

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

2、iipayy内建的的数据库库。Logs: 是系统统日志文文件夹。Hipayy.baat是启启动文件件。图（1）1.2：aappllicaatioons 目录 图（22）所示示Accouuntiing : 帐帐务管理理，支付付信息 ，发票票等。Conteent : 内内容管理理，调查查等。Ecommmercce : 电子子商务应应用。Orderr : 订单管管理。Partyy ：人人员组织织管理Securrityyextt : 安全管管理拓展展Produuct : 产产品管理理。Compoonennt-lloadd.xmml : 板块块加载配配置文件件。图（2）1.3：eecommmerrce

3、目录 图（33）所示示Src : jaava源源文件。Confiig : 配置置文件，主主要是多多语言的的配置文文件Data : 系系统运行行时需要要导入的的数据文文件Scrippt : Hiipayy 系统统 miini-lanng文件件（简单单Javva方法法）Templlatees : 模板板页面Webappp : weeb 服服务需要要用到的的页面和和脚本Widgeet : 用xxml描描述的页页面Buildd.xmml : 用aant工工具编译译srcc文件夹夹的源文文件生成成的cllassses文文件和jjar包包放在bbuilld中。gianttstoone-commponnen

4、tt.xmml : 电子商商务板块块加载配配置文件件。 图（3）1.4：wwebaapp 目录Webappp 下下有一个个应用文文件夹为为 eccommmercce ，其其目录结结构如图图（4）所所示:除了 WEEBINFF 文件夹夹以外，其其他的文文件都是是页面文文件，页页面文件件都是以以ftll为后缀缀的frreemmakeer模板板页面。图（4）1.5：WWEBINF 目录录如图（55）所示示Actioons : 系系统脚本本文件夹夹 ，bbeannsheell脚脚本contrrolller.xmll ：流流程控制制器web.xxml ：网站站参数设设置图（5）1.6：aactiions

5、s 目录录 如图图（6）其文件结构构和图（44）中的的ftll页面结结构是对对应的。比如说显示示购物车车信息的的页面sshowwcarrt.fftl放放在图（44）caart文文件夹中中，则对对应的脚脚本shhowccartt.bssh放在在图（66）的ccartt文件夹夹中，这这样做不不是必需需的，但但是是规规范的，易易于维护护的。图（6）1.7：wwidgget 目录Widgeet是把把ftll页面和和bshh脚本组组合起来来供前端端显示的的工具。它它用xmml语言言和特定定标签描描述页面面和页面面，页面面和脚本本之间如如何组合合和定制制。CommoonSccreeens.xmll 是公公

6、共模板板定制页页面CartSScreeen.xmll 是购购物车相相关页面面定制CatallogSScreeenss.xmml 是是产品，目目录的显显示的页页面定制制CustoomerrScrreenns.xxml 是有关关调查，寻寻价和客客户方面面的页面面定制ConteentSScreeenss.xmml 是是跟内容容管理相相关的页页面定制制OrderrScrreenns.xxml 是跟订订单和支支付相关关的页面面定制EcommmercceSeetupp.bssh是公公共模板板加载的的脚本图（7）其他板块的的目录结结构和eecommmerrce 是相似似的。2 开发内内容2.1：对对widd

7、gett组合页页面要熟熟练掌握握。Web WWidgget是是轻量级级的Weeb应用用程序，为为使用者者提供一一键式的的服务。它它通常被被设计为为具有特特定的功功能，如如提供天天气、股股票、拍拍卖等的的信息。它它与网页页一样，使使用标准准的Weeb技术术开发，如如XHTTML，CCSS，jjavaascrriptt等。从从这方面面看，WWidgget是是脱离浏浏览器UUI运行行的网页页。beansshelll脚本本准备数数据，ffreeemakker页页面显示示数据，而而widdgett 工具具正是组组合脚本本和页面面的，它它规定了了哪个脚脚本为哪哪个页面面组织数数据，即即起到绑绑定脚本本和页

8、面面的作用用，同时时也可以以定义某某些变量量供页面面使用，当当然有些些页面可可以没有有脚本，简简单的来来说，wwidgget就就是用户户请求页页面，它它把变量量，标签签和frreemmakeer模板板语言组组合生成成HTMML页面面，当用用户请求求时就发发送给用用户浏览览器。Widgeet用到到的标签签在frrameeworrk / wiidgeet / dttd 里里的xssd文件件里，如如图（88）图（8）在ecliipsee开发环环境下，有有代码预预示的功功能，如如图（99）图（9）图（10）图（10）的!- 的内容是注释，从图中的注释清楚地介绍的用widget如何定制一个模板。scre

9、een Screeen标签签对应的的是前端端请求的的页面，页页面的名名称naame属属性是必必须的。sectiionScreeen 下下有一个个唯一的的 seectiion ，sectiion下下包含 conndittionn ，acctioons ，widdgetts和faiil-wwidggetss 标签。condiitioon如果 coondiitioon存在在，并且且conndittionn是trrue 则页面面显示wwidggetss内容，否否则显示示faill-wiidgeets。如果 coondiitioon不存存在，则则faiil-wwidggetss标签也也就没有有必要。以下

10、是对 atttrNaame 非空的的判断： 是检查查当前用用户是否否拥有对对ordder的的VIEEW（查查看）的的权限 是把把变量跟跟某个常常量进行行比较，操操作包括括 leess greeateer eequaals lesss-eequaals greeateer-eequaals nott-eqqualls cconttainns ,分别表表示，小小于 大大于 等等于 小小于等于于 大于于等于 不等 包含。是把两两个变量量进行比比较, typpe类型型值可以以为Flloatt Dooublle IInteegerr Loong Boooleaan SStriing PlaainSStr

11、iing Datte TTimee Tiimesstammp 和和Objjectt，如果果没有ttypee默认为为Strringg。and 是是对多个个条件进进行与操操作 or 或操作作 xoor 异异或 nott 非其他的标签签请查看看图（88）所示示的文件件中内容容。actioonsactioons 是加载载页面之之前的动动作。常用的动作作是 ：set : set定义义一个变变量并赋赋值 ffielld 的的值就是是变量名名 vaaluee 是变变量值；scrippt : scrippt加载载一个bbeannsheell脚脚本文件件，loocattionn是脚本本的位置置，位置以” com

12、mponnentt:/xyzz/ ”开头，意意思是在在xyzz这个板板块下，xxyz是是在Hiipayy的安装装目录下下的apppliicattionns和fframmewoork下下的第一一层子目目录文件件夹，如如图（22）得文文件夹都都可以作作为这里里的peertyy-maap : propeertyy-maap加载载一个属属性文件件，reesouurcee的值是是文件的的名称，文文件后缀缀为prropeertiies,可省略略不写，对对于多语语言，比比如要加加载简体体中文配配置文件件TMSSBasseUiiLabbelss_zhh_CNN.prropeertiies和和美国英英语配置置文

13、件TTMSBBaseeUiLLabeels_en_US.prooperrtiees，并并把配置置文件的的键值对对放在一一个Maap即uuiLaabellMapp中，作作为全局局变量是是用，只只需要这这样一行行代码：这行代码会会加载所所有各种种语言的的配置文文件，然然后根据据用户的的loccalee，读取取当时当当地的语语言配置置。还有有一点需需要注意意，如果果uiLLabeelMaap在TTMSBBaseeUiLLabeels_zh_CN.prooperrtiees中找找不到键键值，它它会去TTMSBBaseeUiLLabeels_operrtiees查找找，如果果没找到到，则继继续查找找TM

14、SSBasseUiiLabbelss.prropeertiies，如如果仍然然没有值值则返回回键本身身，如果果有则返返回文件件中定义义的值；widgeetsWidgeets 是对页页面的加加载和布布局。常常用的加加载页面面的方法法包括1：plaatfoorm-speeciffic compoonennt:/TMMSBaase/webbappp/TMMSBaase/inccluddes/heaaderr.fttl 为为要加载载的文件件路径和和名称。即即TMSSBasse这个个板块下下webbappp文件夹夹的子文文件夹TTMSBBasee下的子子文件夹夹inccluddes下下的heeadeer

15、.fftl文文件。2：inccludde-sscreeen这行代码的的意思是是加载一一个页面面，这个个页面是是在TMMSBaase这这个板块块下的wwidgget文文件夹下下的bccd.xxml文文件里定定义的aabc页页面。aabc是是scrreenn的 nnamee的值。3：deccoraatorr另外，模板板常用到到这行代代码 ，意思是页面面的boody部部分是空空的，其其他页面面使用以以下代码码使用这这个模板板， maiin-ddecoorattor是是模板的的名称（sscreeen的的namme的值值）则其他页面面的内容容出现在在boddy部分分。4：conntaiinerrWidg

16、eet中可可以加载载容器 容容器里面面可以加加载其他他页面，这这类似于于HTMML中的的DIVV 层。以下代码是合法的：和效果是是等同的的，其他他类似。5：widdgett中的seectiionwidgeets中中可以放放置多个个secctioon 6：其他加载一个图图片可以以使用页面上显示示一行文文字可用用其他的标签签请查看看图（88）所示示的文件件中内容容。fail-widdgetts等同于wiidgeet标签签，是条条件不满满足时给给用户显显示的页页面。2.2：对对freeemaakerr模板语语言的熟熟练掌握握2.2.11：各页面功功能及存存放位置置页面文件后后缀为fftl，存存放在图

17、图（4）所所示的目目录中，即即webbappp下的应应用文件件夹中图（4）自助终端目目前用到到的页面面中有图图（4）中中的部分分页面：main.ftll 是主主页面，用用户返回回时会到到此页面面，该页页面左边边显示分分类，右右边显示示推广产产品。mainfframme.fftl 框架页页面分三三个部分分 框架架上面部部分占999.998% 是用户户操作的的业务页页面，框框架中间间占0.01%，是用用来加载载终端插插件，框框架下部部是用来来加载加加密插件件和进行行加密验验证的。mainuup.fftl 是语言言选择页页面。loginn.fttl 是是用户刷刷卡登陆陆页面。cart下下的shhow

18、ccartt.fttl页面面 (购物车车页面)catallog下下的siideddeeppcattegoory.ftll (终端屏屏幕的左左边目录录翻页页页面)custoomerr下的ssurvvey.ftll （调调查页面面即用户户的密码码，号码码输入页页面）errorr 下的的errror.ftll （错误误页面）incluudess 下的的：headeer.fftl 模板头头部导航航栏 加加载样式式表 定定制页面面超时脚脚本footeer.fftl 模板板底部留留个按钮钮hidebbotttom.ftll 加载载终端插插件，是是页面底底部框架架固定不不动的部部分，对对于不同同的终端端，申

19、明和条条用插件件的方式式可能不不同，此此时需要要编写多多个厂家家的底部部框架页页面。jiamii.fttl 工工行自助助终端用用到的加加密插件件页面。orderr下的checkkouttopttionns.fftl 该页面面显示正正在支付付中，请请用户等等候，该该页面向向后台传传递了用用户的支支付方式式，货物物的运送送方式，联联系方式式等等重重要信息息，不可可或缺。orderrcommpleete.ftll该页面面是支付付完成页页面，显显示支付付结果，成功则用户可以选择打印凭条。另外还用到到了orrderr板块的的webbappp 下oordeermggr的字字文件夹夹enttry的的catt

20、aloog的部部分文件件，如图图（111）图（11）callddetaailIIE.fftl 是天一一终端的的IE浏浏览器在在进行银银行卡打打电话业业务时显显示的页页面。callddetaailNNE.fftl 是芙蓉蓉终端mmozzzilaa浏览器器银行卡卡打电话话页面categgoryy.fttl 是显示示产品分分类的页页面 其其指向ccateegorrydeetaiilcateggoryydettaill.fttl 是是产品分分类的详详细信息息页面 其指向向prooducctsuummaary.ftllproduuctssummmaryy.fttl 是是某一个个分类下下所有产产品的简简要

21、介绍绍页面 ，在终终端上就就是显示示在屏幕幕右边的的四个按按钮上的的内容。produuct.ftll 是产产品页面面 其指指向 pprodducttdettaill.fttl页面面produuctddetaail.ftll 页面面是根据据对产品品的配置置的详情情页面来来展示产产品。比比如银行行卡打电电话这个个产品就就是配置置成了ccallldettaill.fttl ,如果没没有配置置则默认认显示pprodducttdettaill.fttl页面面2.2.22：常用的的页面标标签以下例子中中可以见见到常用用到了页页面标签签。$uiLLabeelMaap.cchoooseLLangguagge#

22、-$uiLLabeelMaap.ffirsstPaageddownnInfformmatiion- inpuut typpe=butttonn id=$sstylleVaaluee claass=buuttoonImmgCllasss vallue=$uuiLaabellMapplaanguuagee.deescrripttionn?iff_exxistts namme=$iindeex*22oncclicck=winndoww.loocattionn=$llangguagge.rrequuesttUrii?iff_exxistts;/ 注释 注注释的内内容不能能出现 - 字样 #-$uiLL

23、abeelMaap.ffirsstPaageddownnInfformmatiion-要注意区分分HTMML页面面的注释释 赋值值asssignn 设置变量 页面使用变变量时用用 $inddex ,将将会显示示 条件件判断 if elsse使用时以尖尖括号和和#开头头 并以以 结结尾b)A 比BB大A 不比比B大 列表表 liist ssizee iindeexlanguuageesLiist sizze = $lannguaagessLisst?sizze$laanguuagee 位置是是 $laanguuagee_inddex ,则最后显示示的结果果是：Chineese位位置是 0 , E

24、ngglissh位置置是 11 , Freenchh位置是是 2, 异常处处理如果变量值值没有定定义页面面就会报报错，加加上以下下一些判判断，可可以消除除页面上上的错误误：existts iff_exxistts haas_cconttentt ddefaaultt existts 是是对某个个变量进进行判断断，返回回值是布布尔型 truue oor ffalsse ;if_exxistts 返返回是字字符串，对某个变量进行判断 如果值或引用不存在则显示空串，相当于“”；has_cconttentt 对变变量进行行判断，如如果值或或引用存存在并且且不为空空时才为为truue 否否则为ffals

25、se。defauult 如如果变量量无值就就设定默默认值。$soomepparaametter$soomepparaametter$sommepaarammeteer?iif_eexissts$sommepaarammeteer?ddefaaultt(“deffaulltVaaluee”) 其他对于自助终终端页面面目前常常用就是是上面介介绍的这这些标签签 更多请参考考FreeeMaarkeer设计计指南.docc推荐登陆官官方网站站 HYPERLINK http:/wwww.frreemmakeer.oorg g查看详详细手册册。2.3：对对beaanshhelll脚本的的熟悉Beansshe

26、lll 是是宽松的的Javva，使使用变量量前无需需定义，它它完全兼兼容Jaava语语法。详情请登陆陆官方网网站 HYPERLINK http:/wwww.beeansshelll.oorg g Flt页面面负责显显示后台台传来的的数据，对对页面来来说beeansshelll脚本本是重要要的后端端数据源源，在beannsheell里里可以直直接引用用reqquesst变量量和coonteext变变量；通过reqquesst的ggetPParaametter(“namme”) 方法bbsh脚脚本可以以获取前端端页面传传来的参参数通过conntexxt的pput(“namme”,vaaluee)

27、方方法bssh脚本本可以把把经过处处理的数数据送回回前端页页面显示示。页面使用 $ namme 即可显显示。requeest 可以得得到deeleggatoor 和和 diispaatchher deleggatoorbsh脚本本中得到到dellegaatorr：deleggatoor = reequeest.gettAtttribbutee(ddeleegattor);deleggatoor 是是实体引引擎对数数据库增增删查改改的代理理器；数据库查找找根据主键查查找：Bsh脚脚本中最最常做的的事情是是到数据据库中查查找数据据供前台台页面展展示。valuee = deeleggatoor.ff

28、inddByPPrimmaryyKeyy( 数据库库表名, inMMap );inMapp放置主主键键值值对. UtiilMiisc.toMMap(namme,vallue)方法法是把键键值对放放入Maap中比如：orderrHeaaderr=dellegaatorr.fiindBByPrrimaaryKKey(OrrderrHeaaderr,UUtillMissc.ttoMaap(ordderIId, 110000);意思是在表表OrdderHHeadder中中查找主主键（oordeerIdd）等于于 10000的的记录，查查出后赋赋给orrderrHeaaderr。根据某几个个字段交交集查

29、询询：valuueLiist = dellegaatorr.fiindBByAnnd( 数据库库表名, inMMap );orderrHeaaderr=dellegaatorr.fiindBByAnnd(OrdderHHeadder,UtilMMiscc.tooMapp(sstattusIId, AAPPRROVEE，grranddTottal,2000);意思是在表表OrdderHHeadder查查询状态态是APPPROOVE并并且交易易金额是是2000元的记记录列表表。根据某几个个字段并并集查询询：valuueLiist = dellegaatorr.fiindBByOrr( 数据库库表名

30、, inMMap );orderrHeaaderr=dellegaatorr.fiindBByOrr(OOrdeerHeeadeer,UtilMMiscc.tooMapp(sstattusIId, AAPPRROVEE，grranddTottal,2000);意思是在表表OrdderHHeadder查查询状态态是APPPROOVE或或者交易易金额是是2000元的记记录列表表。根据条件查查询：deleggatoor.finndByyConndittionn(数据据库名, 条件件列表, 需要要查询出出来的字字段列表表, 字段段排序列列表)需要查询出出来的字字段列表表如果设设置为 nulll 则则默

31、认查查出所有有字段。创建条件比如产品号号等于1100001：Condditiion11 = neww EnntittyExxpr(prroduuctIId, EnntittyOpperaatorr.EQQUALLS, 1000011);状态是ACCTIVVE：Condiitioon2 = neww EnntittyExxpr(sttatuusIdd , EnntittyOpperaatorr.EQQUALLS, ACCTIVVE);生产日期大大于某个个日期ddatee1：Condiitioon3 = nnew EnttityyExppr(munnaDaate, EEntiityOOperrat

32、oor.GGREAATERR_THHAN, daate11);过期时间小小于或等等于某个个日期 datta2：Condiitioon4 = nnew EnttityyExppr(oveerDaate, EEntiityOOperratoor.LLESSS_THHAN_EQUUAL_TO, daate22);总条件：Condss = neww LiinkeedLiist();添加条件：Condss.addd(CCondditiion11);Condss.addd(CCondditiion22);Condss.addd(CCondditiion33);Condss.addd(CCondditiio

33、n44);设置条件之之间的关关系为与与关系：findCCondditiion= neew EEntiityCCondditiionLListt(Coondss, EEntiityOOperratoor.AAND);设置排序：按产品品号倒序序排列。orderrby = UttilMMiscc.tooLisst(-prroduuctIId ) ；开始查询：findRResuultLListt=dellegaatorr.fiindBByCoondiitioon( Prooducct, fiindCCondditiion, nulll, ordeerbyy );其他查询方方法请参参考coom.ggia

34、nntsttonee.enntitty.GenneriicDeeleggatoor类的的方法。删除数据库库记录在查询方法法中介绍绍的比较较详细，此此处不再再赘述相相关内容容。根据主键删删除：GenerricPPK ppk = (GenneriicVaaluee)itt.neext().gettPriimarryKeey(); deeleggatoor.rremooveBByPrrimaaryKKey(pk);根据某几个个字段交交集删除除deleggatoor.rremooveBByAnnd(TerrmSeerviice,UttilMMiscc.tooMapp(DDEVTTYPEEID,sDDE

35、VTTYPEEID);根据条件删删除deleggatoor.rremooveBByCoondiitioon(“数据库库表”,“条件列列表”);删除列表deleggatoor.rremooveAAll(Lisst);可以先查出出一个列列表，然然后删除除。其他删除方方法请参参考coom.ggianntsttonee.enntitty.GenneriicDeeleggatoor类的的方法。增加数据库库记录deleggatoor.ccreaate( 数据库库表名, inMMap );比如：noowTiimesstammp是当当时时间间deleggatoor.ccreaate( Prroduuct, U

36、UtillMissc.ttoMaap(prooducctIdd, 1000022, sttatuusIdd, CRREATTE, ffrommDatte, noowTiimesstammp);意思是往表表Prooducct中插插入一条条产品号号是1000022 状态态是CRREATTE，开开始日期期是noowTiimesstammp的记记录。更改数据库库中的记记录valuee 是数数据库的的一条记记录。fieldds是实实据库字字段的键键值对MMapvaluee = makkeVaaluee(“数据库库表”, ffiellds)deleggatoor.sstorre(vallue);根据条件更

37、更新：deleggatoor.sstorreByyConndittionn();deleggatoor.sstorreByyConndittionn(数数据库表表名, 要更更新的字字段, 更新条条件);dispaatchherbsh脚本本中得到到disspattcheer：dispaatchher = rrequuestt.geetAtttriibutte(disspattcheer);dispaatchher 是服务务引擎的的调度器器。调用服务方方法：同步调用服服务：outMaap = diispaatchher.runnSynnc (服务务名 , innMapp ) ;inMapp是输入入

38、参数组组成的MMap ；outMaap是输输出参数数组成的的Mapp ；2.4：熟熟悉流程程控制器器conntroolleer.xxmlhandller控制器定义义了对于于各种类类型请求求或响应应采用何何种方法法来处理理。在conttrolllerr.xmml里有有大量的的uri是页页面的请请求。requeest-mapp 上面代码的的意思是是：如果有请求求是maain ，第一一步安全全验证，https=true，表示要走https安全协议，https =false就走htttp协议议，auuth=truue强制制调用cchecckLooginn请求，验验证用户户是否已已登录，aauthh=f

39、aalsee则不检检查此项项，第二二步意思思是如果果成功则则到请求求maiin页面面。maain页页面在vvieww-maap中介介绍。再看看chheckkLoggin： 验证用用户是否否登陆 这个请求中中htttps=truue，走走htttps协协议，aauthh=faalsee,它当当然不能能递归调调用自己己。eventt 是对对该请求求的响应应事件 typpe=”javva” 表示示后台用用javva方法法来处理理这个请请求，ppathh是jaava的的路径，iinvooke的的值是jjavaa类的某某个静态态方法。方法会返回回“succcesss” 或者者errrorr，如如果是前前

40、者，则则页面转转到maain页页面，否否则到llogiin页面面。处理请求的的事件除除了jaava还还有 sservvicee ，用用一个服服务来响响应一个个请求，服服务会返返回“succcesss”或者eerroor。常用的还有有simmplee 是mminii-laang ，即简简单jaava语语言，详详情参看看安装目录fraamewworkkmiinillanggdttdsimmplee-meethoods.xsdd及各板板块中sscriipt文文件夹的的例程。当一个请求求的reespoonsee的tyype是是 “rrequuestt”的时时候 会会根据vvaluue的值值来继续续找

41、rrequuestt -mmap的的对应值值，这样样就形成成了链式式请求，即即多个请请求连续续调用。当当最后一一个请求求的值肯肯定会落落在tyype 是 “vieew”上。应应为HTTTP请请求肯定定会给用用户一个个回应。view-mapp当一个请求求的reespoonsee的tyype 是 “vieew”的时候候 就会会根据vvaluue的值值来找 vieew-mmap的的对应值值。respponsse nnamee=ssucccesss ttypee=vvieww上面代码的的意思是是如果来来了viiew的的页面请请求，就就去acccouuntiing这这个板块块的wiidgeet文件件夹下的的CommmonnScrreenns.xxml文文件中定定义的mmainn