UAPWEB开发规范-精品文档资料.docx

《UAPWEB开发规范-精品文档资料.docx》由会员分享，可在线阅读，更多相关《UAPWEB开发规范-精品文档资料.docx（9页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、UAPLFW开发规范文件编号： UAP-LFW- SPEC-001 版本号： V1.0 修改状态： 0 编写人：李绍文审核人：批准人：批准时间： 2013.7 版本记录版本修改与参与人修改时间修改原因修改概述审批人 1.0李绍文 2013.7 原始规范建立 建立UAPLFW开发规范1.0版 邓君涛目录UAPLFW开发规范1版本记录2目录31.目的41.1 面向用户41.2 规范目标42. LFW源码规范52.1代码目录52.2命名规范52.3多语63. LFW产品管理73.1 UAP目录结构73.2 LFW目录结构73.3 Portal目录结构74. 皮肤规范91.目的1.1 面向用户UAPL

2、FW平台的开发人员以及基于该平台进行业务开发的相关人员1.2 规范目标在UAP编码规范的基础上，给出基于轻量级(LFW)开发平台的开发规范。本规范遵从于UAP编码规范,是其在LFW领域的补充。2. LFW源码规范2.1代码目录LFW编码规范101： 遵从统一的UAP编码规范；LFW编码规范102：门户源文件目录 srcportalspec；含portalspec源代码的组件名称需要保证全局唯一；LFW编码规范103：对外公共接口源文件目录srcpublic；包含对外的公共接口以及vo对象；LFW编码规范104：组件内共用源文件目录srcprotected；组件内公共public与protect

3、ed可互相引用，构造时合并编译，分拆jar包LFW编码规范105：WEB源文件目录 web，对应hotwebs ；注: webcontext指代码对应web站点名称，比如: portal；在.module_prj文件中描述LFW编码规范106：lfw框架源文件目录 webframe，对应hotwebs lfw；注：portal源码可不遵从改规范LFW编码规范107：UI模型源文件目录 webhtml，对应hotwebs synchtmlLFW编码规范108：业务公共资源文件,比如js、jsp等，源代码路径web sync比如: websyncoacoaddresslistoacopubdown

4、load.jsp对应产品目录 hotwebsportalsyncoacoaddresslistoacopubdownload.jspLFW编码规范109：uaphome资源文件目录 uaphome ,对应产品的LFW编码规范110：组件源码依赖关系描述文件，文件名component.xml,内容编码 utf-8,不带bom。开发工具根据依赖关系进行编译，工具可对组件间代码依赖错误做出检查2.2命名规范LFW编码规范201: 代码模块名称、业务组件名称遵从UAP统一规范LFW编码规范202: app命名规则：_appid,比如: webam_usermgr , 即web权限管理组件下的用户管理节

5、点LFW编码规范203: UI组件名称 .，比如： uap.lfw.webad.usermgrLFW编码规范204：一个UI组件下可分为listwin,cardwin两个节点，分别是列表和卡片window，其他形式winid不受此约束，可自行定义LFW编码规范205: window的主viewid是 mainLFW编码规范206: 控制类命名遵从下面的规范App控制类：.AppController，比如：uap.lfw.webad.usermgr.UserMgrAppControllerListWindow控制类: .ListWinController，比如：uap.lfw.webad.use

6、rmgr. ListWinControllerListWindow主view控制类: . ListWinMainViewController，比如： uap.lfw.webad.usermgr.ListWinMainViewControllerCardWindow控制类: .CardWinController，比如：uap.lfw.webad.usermgr.CardWinControllerCardWindow主view控制类: . CardWinMainViewController，比如： uap.lfw.webad.usermgr.CardWinMainViewControllerLFW

7、编码规范207: 后台包名规范接口包：.itf对外接口包：.pubitfvo对象包: .vo实现类包: .impl对外接口实现类包: .pubimplLFW编码规范208: UI模型文件采用utf-8编码，不带BOM2.3多语LFW编码规范301: 遵从UAP统一多语规范LFW编码规范302: 需要用户编辑的字段全部使用数据多语注：数据多语是持久化时按语种信息分6个字段存储LFW编码规范303: UI模型文件对应的多语数据存储在 *.properties资源文件中，模型的element中通过langDir, i18nName两个字段定位到具体资源文件LFW编码规范304: 个性化UI模型文件中

8、多语信息在element的属性中增加6个属性字段存储LFW编码规范305: 控件js多语需要实现接口LfwJSMutiLangSupport, 该接口占据的是全局流量，仅全局控件可使用该接口LFW编码规范306：扩展js多语，与include.js平级定义langres.properties文件,utf-8格式；内容格式如下：资源号=默认值;资源路径,比如：js_res-res00025=源文件;imp_js_resLFW编码规范307：其他未指明形态文件，比如： jsp，模板文件等，在生成输出流前代码翻译成多语3. LFW产品管理3.1 UAP目录结构LFW产品规范101：遵从UAP统一目录

9、规范LFW产品规范102： hotwebslfw目录是轻量框架目录，对应产品入口 :/:/lfw, 路径小写LFW产品规范103： hotwebsportal目录是产品门户目录 ，对应产品入口 :/:/portal, 路径小写LFW产品规范104： 基于轻量框架开发的站点，产品放在hotwebs目录下，与portal目录平级，路径小写LFW产品规范105: portalhome 目录是门户运行时目录，子目录为业务组件名称3.2 LFW目录结构LFW产品规范201： hotwebslfw各级子目录小写，WEB-INF等中间件规范目录除外LFW产品规范202： hotwebslfw各级文件名称小写

10、，LFW控件js文件首字母大写LFW产品规范203：hotwebslfwframe 框架代码，子目录按设备分开，比如：device_padLFW产品规范204：基于lfw的扩展控件遵从以上规则LFW产品规范204：基于lfw的扩展站点，比如portal，遵从以上规则LFW产品规范205：hotwebslfwsync，lfw站点不支持sync目录，无需加载3.3 Portal目录结构LFW产品规范301： hotwebsportal各级子目录小写，WEB-INF等中间件规范目录除外LFW产品规范302：hotwebsportal 根目录文件只能是portal运行时的文件LFW产品规范303：ho

11、twebsportalframe 门户框架目录, 除portal、lfw两个站点外，不允许再出现该目录LFW产品规范304：hotwebsportal images门户图片目录LFW产品规范305：hotwebsportal imagesfloatTreeIcon 门户一级菜单图标目录，文件名称: menuiten.icopath_.pngLFW产品规范306：hotwebsportalsync UI模型存放目录，子目录结构如下：synchtmlapplications : app模型存放目录synchtml nodes: window模型存放目录synchtml views: public

12、view模型存放目录LFW产品规范307：hotwebsportal tpl 门户模板存放目录LFW产品规范308：hotwebsportal webtemp 门户临时目录LFW产品规范350：基于lfw开发的其他站点遵从以上规则4. 皮肤规范LFW皮肤规范401：皮肤源文件存储遵从LFW编码规范LFW皮肤规范402：皮肤存储路径如下： device_themeswebclassic_；如果明确皮肤不需要区分设备，可以省略device目录；默认支持皮肤为蓝色,路径为webclassicLFW皮肤规范403：lfw框架皮肤路径为hotwebslfwframedevice_pc themeswebclassicLFW皮肤规范404：业务产品皮肤路径为 hotwebsportalsynchtmlnodesthemes