參考pageframe v使用手冊

1、引言1.1概述PageFrame是前端業(yè)務開1、引言1.1概述PageFrame是前端業(yè)務開發(fā)平臺，其后面對接服務接口，前端提供頁面組件，快速開發(fā)PageFrame的作用范PageFrame平臺開發(fā)前端J2EEPageFrame并快速使用它，以及使用過程中的注意事項。PageFrame主要提供以下功能231.2術語定閱讀型報文一個服務有閱讀型和交互型兩種報文。閱讀型報文是顯示給前端開發(fā)者交互型報文交互型報文是在服務調用時使用的。這時的報文就是標準的key:value簡單類交互型報文交互型報文是在服務調用時使用的。這時的報文就是標準的key:value簡單類型：為 語言中的類。本文定義為簡單類型的類有數(shù)據(jù)的格原始類型：為JAVANew1.3適用人PageFrame平臺開發(fā)的所有開發(fā)人員1.4參考命名規(guī)1.4.1服務編碼命名規(guī)范文縮寫命名，盡量避免khrw、ljshf等中文簡拼明明。終端類型為PAD、PC、PHONE。1.5參考資《PageFrame.pdm2、下載與安WEBWEBjs組件目錄，包括各種數(shù)據(jù)交互/頁面展示組件存放PC版業(yè)務頁面目錄存放PAD版業(yè)務頁面目PHONEPageFramePageFramePageFrame數(shù)據(jù)庫初始化《PageFrameV1.0.docPageFrame開發(fā)人員使用手冊pageframe_v1.0.warEclipse/JIDEAWEB注意事項：pageframe 中沒有appframe相關的配置文件，在具體項目中需要合集成appframe的相關配置。3、使用說3.1初始3.1.1數(shù)據(jù)庫初始化在指定的數(shù)據(jù)庫用戶下執(zhí)行PageFrame.sql文件中的內容。PageFrame.sql會創(chuàng)建PageFrame所需要的表，這些表中存放的都是配置數(shù)據(jù)。具體表和字段的說明請參見3.1.2配置文件初始在使用PageFrame前，需要配置一些本地特殊的配置。具體如下AppFrame數(shù)據(jù)庫相關配置AppFrame數(shù)據(jù)庫相關配置PageFrame相關的配置步驟defaults.xmltransaction.mappingdatasource.mapping中增在“name="com.asiainfo.pageframe"value="aiscrmaiscrm”為本地項目存放PageFrame相關表的數(shù)據(jù)源名稱AppFrame緩存配置cache.xml增加以下配置，如果有雷同，請刪除PageFrame中需要增加的記錄<!--需要的緩存begin<!--OSDI服務列表緩存<cacheid="com.asiainfo.pageframe.data.CfgOSDISrvEventCache"<!--頁面配置緩存<!--權限緩存addbypangwb<cacheid="mon.service.impl.BsSecFunctionCacheImpl"<!--國際化編碼<cacheid="com.asiainfo.tools.exception.cache.CfgI18nResourceCacheImpl"init="true"<!--FTP配置<cacheid="mon.cache.BsFtpCacheImpl"<cacheid="mon.cache.BsFtpPathCacheImpl"<!--菜單功能組成配置緩存<!--靜態(tài)數(shù)據(jù)<cache<!--pageframe需要的緩存endperties配置aicperties配置aicrmosdi_bean.xml配置在本地項目工程配置根目錄新建配置文件“osdi_bean.xml”，內容如下<?xmlversion="1.0"encoding="UTF-<beansid="SESSIONdesc="session中信息<beanid="Operator0"class="com.asiainfo.pageframe.data.PhoneInfo"desc="客戶信息<attrname="BILL_ID<attr<attrname="ISLOCALCUST<attrname="COUNTY_CODE<attrname="COUNTY_NAME<attrname="CUST_ID<attr<attrname="CUST_STATUS<attrname="BALANCE<attr""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc="""<attrname="USER_ID<attrname="OS_STATUS<attrname="NET_AGE<attrname="CUST_TYPE<attrname="OS_STATUS_NAME<attrname="CUST_NAME<attr<attrname="OFFER_NAME<attrname="TRADEMARK<attrname="TRADEMARK_NAME<attrname="REGION_CODE<attrname="REGION_NAME<attrname="USER_STATUS<attrname="REAL_NAME_FLAG<attr"desc=""""desc=""""desc="""<attrname="USER_ID<attrname="OS_STATUS<attrname="NET_AGE<attrname="CUST_TYPE<attrname="OS_STATUS_NAME<attrname="CUST_NAME<attr<attrname="OFFER_NAME<attrname="TRADEMARK<attrname="TRADEMARK_NAME<attrname="REGION_CODE<attrname="REGION_NAME<attrname="USER_STATUS<attrname="REAL_NAME_FLAG<attr"desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""""desc=""<!--虛擬網(wǎng)產(chǎn)品信--"""<!--流量產(chǎn)品信息 """<!--短信認證信息<beanid="Operator1"class="com.asiainfo.pageframe.data.PhoneInfo"desc="客戶信息<attr"""""""""<!--用戶認證信息"<beanid="Operator2"<attr"""""""""<!--用戶認證信息"<beanid="Operator2" desc="客戶信息""""""有些后端服務的返回對象的一些信息需要放入Session中，供后續(xù)服務使用。這里對PageFrame中目前用的的一些后端服務返回對象屬性保存到Session的操作做一下說明。打開“工程目錄/WEB-INF/classes/pageframe/res/osdi_bean.xml”文件。該文件配置了PageFrame中存放在SessionBean和后端服務返回對象的屬性之間的映射關系。Session中的。文檔表示，如“BASEINFO.COUNTY_CODE”，表示返回對象中有個屬性名稱“BASEINFO”，但它的類型是個對象，需Session中的。文檔表示，如“BASEINFO.COUNTY_CODE”，表示返回對象中有個屬性名稱“BASEINFO”，但它的類型是個對象，需要繼續(xù)指定到該對象中的屬性“COUNTY_CODE”。下面就對配置Sessionosdi_bean.xml中配置新建的屬性和返回對象中的屬性的映射關系。在服務中可以通過ServiceManager.getUser().get(“CUST_INFO”)獲取在osdi_bean.xml中“<attrname=”配置屬性name=”#XXX”時，值為“#”開頭。以開頭的“name”會放入 的Map中。在服務中可以通日志配置<?xmlversion="1.0"encoding="utf-pattern="'.'yyyyMMddHH"remaintime="240"ReturnEventPageFrame中用于存放在Session中的客戶信remaintime屬性和splittime屬性的單位。表示his目錄中只保留10小時內的歷史文件。splittime：分割文件時長。如“1”表示每一個小時分割文件一次。把歷史flushtaskclazz"mon.remote.LogRemoteFlush"類把日志發(fā)往日志心的服務器，使用remote發(fā)送的，地址配置在/remote/perties<?xmlversion="1.0"encoding="UTF-<!DOCTYPEweb-appPUBLIC"-//SunMicrosystems,Inc.//DTDWebApplication2.3//EN"<web-<filter-name>ControlFilter</filter-<filter-class>com.asiainfo.pageframe.ControlFilter</filter-<filter-<filter-name>ControlFilter</filter-<url-pattern>/*</url-</filter-<listener-class>com.asiainfo.tools.fixmemcache.impl.SessionLifeCycle</listener-<session-<session-timeout>5</session-</session-<welcome-file-<welcome-file>index.html</welcome-</welcome-file-</web-<session-<session-timeout>5</session-</session-<welcome-file-<welcome-file>index.html</welcome-</welcome-file-</web-FilterControlFilterinit方法中初publicvoidinit(FilterConfigfilterConfig)throwsServletException{super.init(filterConfig);}項目中通用DAO的使用說明通用DAO是基于Appframe的數(shù)據(jù)庫操作實現(xiàn)的。其主要是舍去了appframe中的bo，enginesql“sql_mysqlxml”。內容如下：<?xmlversion="1.0"encoding="utf-<sqlgroupname="aiscrm"<sqlid="query_i18n_resource"dbid="">select*fromcfg_i18n_resourcewherestate<sqlid="query_intf_code_mapping"dbid="">select*fromcfg_intf_code_mappingwherestate='U'</sql><sqlid="query_mkt_tpl_rel"dbid="">select*fromcfg_mkt_tpl_relwherestate*<sqlid="query_page_element_rule"dbid="">select*fromcfg_page_element_rulewherestate='U'</sql>“dbiddefaults.xml方式“:where條件，請增加“where11DAOSVIDAOSVdao(IDAOSV)ServiceFactory.getService(IDAOSV.class);獲取到通用的DAO，其中的方法簡要說明一下：publicObject[]querySql(Stringsqlid,HashMapparMap,intstart,intend)throws中沒有配置條件變量，這里照樣可以把條件放入parMap中。publicvoidexeSql(String中沒有配置條件變量，這里照樣可以把條件放入parMap中。publicvoidexeSql(Stringdbid,Stringsql,HashMapmap)throwspertiessqlpublicintqueryCountSql(Stringsqlid,HashMapparMap)throwsOSDI總體配置“<datepattern>yyyy-MM-ddAppframe開發(fā)的，該配置可以去除。<objclazz="mon.SessionManager"get="getUser"Code“<rulecheckclazz="com.asiainfo.pageframe.srv.event.OSDIDefaultRuleCheckEvent">OSDI服務調用器配置打開“工程目錄/lib/pageframeV1.0.jar/pageframe/res/osdi_invokercfg.xml”文件。“<invokerclazz="mon.requestchannel.srv.OSDIInvoker"><srvgroupAppframe的調用方式。如果后臺非Appframe開發(fā)的服務，需要自己實現(xiàn)com.asiainfo.tools.osdi.IInvoker接口實現(xiàn)本地化的服務調用。如果項目中有多種服務調用，可以按srvgroup(服務配置頁面中的group屬性)分OSDI抽象/接口類對應的實現(xiàn)類配打開“工程目錄/lib/pageframeV1.0.jar/pageframe/res/osdi_mapping.xml”文件?！?lt;propertyinterclazz="java.util.List"implclazz="java.util.ArrayList"/><propertyOSDI抽象/接口類對應的實現(xiàn)類配打開“工程目錄/lib/pageframeV1.0.jar/pageframe/res/osdi_mapping.xml”文件?！?lt;propertyinterclazz="java.util.List"implclazz="java.util.ArrayList"/><propertyinterclazz="java.util.Map"請求管道配置打開“工程目錄/WEB-INF/classes/pageframe/res/request.xml”文件的方式訪問。在項目開發(fā)階段便于調試可以為“Y”，上線時為“N“N”為不能訪問服務配置頁面。開發(fā)階段為“Y”，上線時為“NAIConfig.xml配置打開“工程目錄/WEB-INF/classes/AIConfig.xml”文件“<ConfigItemname="IS_URL_CHECK_FLAGremarks="URL合法性線需為“Y“<ConfigItemname="IS_SRV_CHECK_FLAGremarks="是否做服務的合法性線需為“Y<ConfigKindname="UNCHECK_URL"remarks不進行驗證的url包括“<ConfigKind3.2服務配置操作說WEB3.2服務配置操作說WEBhttp://ip:port/osdi/configServiceNew、ServiceDisaccord、ServiceUpdate、ServicePackage四個Tab頁。我們一個一個的詳細說明。3.2.1Service這些服務類名稱需要滿足3.1.22中服務名稱配置。輸入連續(xù)的字符后回車，會顯示ClassLoader中轉載的類路徑或名稱含有輸入字符的類列表。出現(xiàn)如下圖：+“#”++“#”+“方法名稱”組成的classmethodJSON數(shù)據(jù)，inputparametersclassmethodJSON數(shù)據(jù)，inputparameters屬性表示輸入入?yún)?shù)的個數(shù)，顯示的順序表示參數(shù)的順序。Outputparameters對象表示一個返回對象，不是否可操是否可操是否可操是告訴前端頁面開發(fā)者該字段是否是告訴前端頁面開發(fā)者該字段允許是告訴前端頁面開發(fā)者該字段的數(shù)據(jù)是否可以緩存在客戶端。為“true”時action屬性必須配置是是在也只實現(xiàn)了“電話號碼格式檢是是是否可操是否可操是告訴前端頁面開發(fā)者該字段是否是告訴前端頁面開發(fā)者該字段允許是告訴前端頁面開發(fā)者該字段的數(shù)據(jù)是否可以緩存在客戶端。為“true”時action屬性必須配置是是在也只實現(xiàn)了“電話號碼格式檢是是是屬性后面有個“choose”按鈕，可以選擇上下文變量中的某個變量是否顯示給前端開是value否否否否否否服務返回對象處配置為一個實現(xiàn)了IEvent接口的果作為該事件的參數(shù)將繼續(xù)處Bean對象服務返回報文處IEvent接口的returnEvent之后執(zhí)行。該事件的參數(shù)是返回Bean被報文化后報文，目前是服務返回對象處配置為一個實現(xiàn)了IEvent接口的果作為該事件的參數(shù)將繼續(xù)處Bean對象服務返回報文處IEvent接口的returnEvent之后執(zhí)行。該事件的參數(shù)是返回Bean被報文化后報文，目前是文對象做二次處理?？梢耘渲枚郔Event接口的事件的參數(shù)將繼續(xù)處理。這里可Beans對象做二次服務調用超時時務調用超時后，如果配置了invokeTimeoutEvent則服務參數(shù)服務調用超時事配置為一個實現(xiàn)了IEvent接口的數(shù)作為該事件的參數(shù)將繼續(xù)處服務調用前規(guī)則配置該服務參數(shù)應該滿足的規(guī)則，只有這些規(guī)則校驗通過才會真正調用服務。規(guī)則配置在服務修改頁面中才能配置。屬性后面有“configIEvent類路徑?？梢詾槊總€服務配置單屬性默認值配置屬性默認值配置QRY（RUL規(guī)則SMT(提交、RPT(報表RequestChannelParameter類中的屬性對象和屬性。默認值只Bean時默認值被設置，值來源于上下文變量RequestChannelParameter。下面對以上屬性做一下說明：屬性名請求流水每次請求都重新會話流水號每次操作員登陸客戶端的客戶端的客戶端類型客戶端MACRequestChannelParameter類中的屬性對象和屬性。默認值只Bean時默認值被設置，值來源于上下文變量RequestChannelParameter。下面對以上屬性做一下說明：屬性名請求流水每次請求都重新會話流水號每次操作員登陸客戶端的客戶端的客戶端類型客戶端MAC地客戶端屏客戶端屏客戶端屏幕像素寬客戶端屏幕像素高操作員名操作員對應的員工配置的操作員操作機器IP操作員工歸屬組織會話流水是否允許同時多次客戶手機是否家庭親情網(wǎng)用戶標示是本地用戶還是外省用戶1=外省0=幕像素寬客戶端屏幕像素高操作員名操作員對應的員工配置的操作員操作機器IP操作員工歸屬組織會話流水是否允許同時多次客戶手機是否家庭親情網(wǎng)用戶標示是本地用戶還是外省用戶1=外省0=停狀態(tài)描基礎套餐基礎套餐地區(qū)代碼10:非實名,11:實客戶實名客戶手機需要驗證的業(yè)務編ID或者檔次ID密碼,證件認證時才有證件類型信時顯示短信認證1:通過0:停狀態(tài)描基礎套餐基礎套餐地區(qū)代碼10:非實名,11:實客戶實名客戶手機需要驗證的業(yè)務編ID或者檔次ID密碼,證件認證時才有證件類型信時顯示短信認證1:通過0:虛擬網(wǎng)標示虛擬網(wǎng)產(chǎn)品流量事件配置事件是在OSDI處理流程中可以本地實現(xiàn)的處理行為。事件必須實com.asiainfo.tools.osdi.IEvent事件配置事件是在OSDI處理流程中可以本地實現(xiàn)的處理行為。事件必須實com.asiainfo.tools.osdi.IEvent類Session服務調用返Session存儲映射戶短信身份校驗信息Session服務調用SessionSession服務調用返回Session默認規(guī)則校驗事件是配置在OSDI.xml中的，這里不需要選擇Session服操作員登陸對接的是SecFrame的操作員登事件類型編類型名服務調用返回結果報文化并實現(xiàn)了“com.asiainfo.tools.osdi.IEvent并實現(xiàn)了“com.asiainfo.tools.osdi.IEvent”接口的類都枚舉出來供選擇。如圖3.2.2Service點擊“ServiceDisaccordClassLoader中類的參數(shù)發(fā)員組織切換時重新設Session中的操作員SecFrame的點擊右側的“update”按鈕。出現(xiàn)和“ServiceNew直接點點擊右側的“update”按鈕。出現(xiàn)和“ServiceNew直接點擊“submit”按鈕就可以3.2.3Servicecode搜索的輸入框，輸入服務名稱，支持模糊查找，回車就能查找匹配Classloader中沒有找到對應的類或方法。只有“delete”另外在“rules”屬性后面多了“config”按鈕，另外在“rules”屬性后面多了“config”按鈕，該按鈕只在服務修改頁面中有其他的屬性修改后點擊右上角的“submit”按鈕就保存了。保存的邏輯是刪除原有的.1規(guī)則配置點擊“config操作“Delete”：刪除該規(guī)點擊“AddProp”按鈕，右側屬性映射關系會增加一條記錄choose1-5最后點擊“1-5最后點擊“Submit”按鈕保存頁面上所有的規(guī)則信息sql，到生成環(huán)境執(zhí)行。一個服務導出一個sql文件，文件中有一下表的sql語句：下數(shù)據(jù)庫表中的該服務記錄CFG_OSDI_SRV_BASE、CFG_OSDI_SRV_PARAMETERSCFG_OSDI_SRV_EVENT、CFG_OSDI_RULE3.2.4Service“ServicePackage”服務包3.2.4Service“ServicePackage”服務包，是服務組合成一個業(yè)務的集合。點擊“ServicePackage”dtil點擊“new”按鈕。打開服務包配置頁面QRY(查詢關聯(lián)的數(shù)據(jù)，包括以下表中的數(shù)據(jù)：CFG_OSDI_SRV_PACKAGE、CFG_OSDI_SRV_BASE_PACKAGE_REL3.3服務查詢操作說包的名稱，服務包的描述等信息。點擊“detail”按鈕，頁面和服務包detail的頁面一樣3.4頁面配置說包的名稱，服務包的描述等信息。點擊“detail”按鈕，頁面和服務包detail的頁面一樣3.4頁面配置說js，css，htmlWEBhttp://localhost:port/osdi/page頁面配置記錄?？梢酝ㄟ^/page/PageCoderequest.xml中“<ischecksubpage>Y</ischecksubpage>”項配置為“Y”時，除配置入口頁面還需要配置入入上面入口頁面編碼對應的絕對地址，頁面編碼對應的絕對地址可能有多個。如上面的test.html頁面，在不同終端的情況下絕對地址有：/pc/test/test.html、/pad/test/test.html。輸入3.5請求方式說PageCodecfg_pagepagecode值。用/page/的路有參數(shù)：PageCodecfg_pagepagecode值。用/page/的路有參數(shù)：-PostURLPostData：JsonArrayPostData：JsonArray[{}]同服務提交的參數(shù)結構JSON,回調函數(shù)/upload?ftpcode=ftppathcode&busiid=下載3.6使用約定說PageFrame的數(shù)據(jù)庫訪問是基于appframe的。所以數(shù)據(jù)源配置和appframe配置相同。后端的服務約定一個服務為后端Java該方法的入?yún)?、出參必須是JAVA的簡單類型或者是POJO如果使用List/Map類型，必須指定泛型，如List<String>List<POJO>，ListListMapList<Map>，Map<String,List>如果使用List/Map類型，必須指定泛型，如List<String>List<POJO>，ListListMapList<Map>，Map<String,List>詢、RUL(規(guī)則、SMT(提交、RPT(報表20khrw、ljshf等中文簡拼，終端類型為PAD、PC、PHONE打開一個入口頁面后，后續(xù)頁面關閉時需要調用service?action=@PageClose&pagecode=來關閉后臺的信息UTF-8編碼的文件。<metahttp-equiv="Content-Type"content="text/html;3.7內部服務使用說PageFrameSession或內存中存放了一些信息，目前有頁面流水號、服務規(guī)則校驗參建立時退出時頁面流水入口頁面入口頁面Session失服務規(guī)則校驗參數(shù)標記服務參數(shù)往復規(guī)規(guī)則在參數(shù)不變的情第一次該服務規(guī)則1Session失操作員信操作員登1．操作員退3.7.1頁面關閉服務3.7.1頁面關閉服務Session中。頁面流水號作用是標記該入口頁面的子頁面請求或頁面中提交的數(shù)據(jù)請異常。PageFrame目前配置一個WEB實例中最多可以存放100000個頁面流水號，如果超過ajax用PostURLservice?action=@PageClose&pageseq=頁面流水號jQuery.ajax({type:'POST',async:true,contentType:"application/json;charset=utf-8"}).success(function(data){息陸2Session失 用戶手機用戶退出Session失用戶認證認證清除Session失3.7.2操作員退出服除Session3.7.2操作員退出服除Session中的操作員信息。調用方式如下：3.7.3用戶退出服務PageFrameSession中的3.7.4認證清除服務Session3.8頁面代理使用說3.8.1配置說明request.xml<proxy<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost<proxyhost“proxyhosts“proxyhostsWEB應用的訪問地址，code為地WEB應用。所以代理的開頭路徑不能重復，如果重復只會取“httpproxy”配置中靠前的一“encodingWEB3.8.2主機配置如果“proxyhostWEBhosts3.9安全說PageFrame中的權限分為頁面權限和服務權限請求類頁面請數(shù)據(jù)請不存在非入口入口頁請求不是入口不存在未配置歸屬該判斷是請求類頁面請數(shù)據(jù)請不存在非入口入口頁請求不是入口不存在未配置歸屬該判斷是未授權歸屬該置不歸屬3.9.1頁面安全需要操作員登陸才能訪問的校驗URL都會要求操作員先登陸。Session中有操作員的信息才URL中帶有這些關鍵字的請求將忽略“需要操作操作員有該入口頁面訪問的權限AIConfig.xml“<ConfigItemname="IS_URL_CHECK_FLAG"remarks="是否做URL所有Http請求返回調返回請返回請返回非返回非調用后創(chuàng)建入返回無在返回404不存在請求路當“Y”時，入口頁面的請求路徑“page/PageCode”需要配置到權限模塊sec_function的viewname只能先訪問入口頁面，才能訪問子頁面的校驗request.xml中的“<ischecksubpage>Y</ischecksubpage>”為“Y”時，點擊入口頁面中3.9.2服務安全需要操作員登陸才能訪問的校驗URL都會要求操作員先登陸。Session中有操作員的信息才能訪問。也有些特殊情況在操作員未登陸的情況下可以訪問系統(tǒng)，如登陸的服務等等。在AIConfig.xml的“ConfigKindname="UNCHECK_SV"”項中，可以配置不需要操作員登陸只能先訪問入口頁面，才能訪問子頁面的校驗 本地化實現(xiàn)說明3.10.1對接本地權限4、頁面組件使用說明[王大元4.1jssearch組件使用說明 本地化實現(xiàn)說明3.10.1對接本地權限4、頁面組件使用說明[王大元4.1jssearch組件使用說明頁面上有個輸入框，要提供搜索功能。如：<inputtype="text"數(shù)組。JSONzhArray=[{name:"酬金配置與管理",文件名多音)UNCODEjs文件，并提供搜索方法。根據(jù)給定的搜索中文詞庫(JSON格式或字符串js{name:"網(wǎng)廳酬金限價配置",{name:"現(xiàn)金充值",{name:"充值記錄查