1、客戶端項目Android 客戶端第說明書管理部廣州開發(fā)中心項目組2011 年 7 月修改本文檔中所包含的信息屬于信息，如無中國建設的，任何人都無權或利用。Copy Right 2010 by China Construction B日期描述版本作者審核發(fā)布日期120110707文檔建立V1.0目錄1引言4編寫目的4項目背景4適用范圍42實現(xiàn)說明43整合應用相關要求53.13.23.33.43.53.6系統(tǒng)結構要求5代碼合并要求5應用啟動要求6應用退出要求6UI要求7通訊要求74支付接口相關要求84.14.24.34.4啟動支付8參數(shù)9啟動返回接口10返回接口參數(shù)115第注意要點121 引言編寫

2、目的本說明書為 Android 客戶端集成第應用程序代碼提供接口規(guī)范說明，以的接口規(guī)范要求，進行擴展客戶端的第應用程序集成，方便后續(xù)的擴展開發(fā)以及等工作。項目背景客戶端在已實現(xiàn)“”功能的基礎上，需要集成第應用，如“票”、第金融工具等，以擴展客戶端程序的功能，提高相應的使用性和應用范圍。適用范圍團隊 Android 客戶端項目。項目開發(fā)。包括程序員、高級程序員、架構設計師。第應用程序相關。2 實現(xiàn)說明客戶端整合第應用程序是將第應用程序代碼整合到客戶端程序，用戶在客戶端使用第應用程序功能時，客戶端進行啟動第應用程序的界面，具體流程如下描述。1、第提供相應符合規(guī)范的程序代碼。2、客戶端把第提供的程序

3、代碼合并到客戶端代碼中，作為客戶端程序的一部分。3、用戶使用客戶端過程中，調用第應用程序功能，啟動第應用程序界面。3 整合應用相關要求3.1 系統(tǒng)結構要求1、第應用必須是基于 Android 系統(tǒng)的應用程序代碼，采用的系統(tǒng)架構、UI 架構都是基于 android 系統(tǒng) Framework 實現(xiàn)的。2、第應用的 SDK 版本必須是在 2.0 到 2.3 之間（因為這些版本 SDK 變化不大，出于程序穩(wěn)定考慮采用這些版本）。3.2 代碼合并要求1、 第應用程序代碼存放的包名必須唯一，不能和客戶端現(xiàn)有程序或者其他第應用程序的包重名（ 建議第 應用的包命名，即AndroidManifest 中指定的包

4、命名）。2、 第應用程序使用的所有資源（素材，相應布局文件，顏色定義，字符串定義等）名稱應該添加自己的前綴標識，或者使用子目錄存放資源方式，用于和客戶端或其他第應用的系統(tǒng)資源文件相區(qū)分。例如 logo素材可以如下定義：功能資源前綴資源子目錄應用 1ccb_應用 1_logo.pngccb/應用 1/logo.png3、 標明 AndroidManifest.xml 整合時需要注意的要點，如第自定義了哪些權限，控制了特殊的界面布局屬性等。3.3 應用啟動要求為保證用戶使用 home 鍵或者接聽等情況切換出整個客戶端程序后，重新返回使用客戶端時，能夠即可返回到用戶離開前的應用，建行客戶端啟動第三方

5、應用程序時是以任務模式啟動，采用的是建行客戶端自定義的任務管理對象TaskManager，調用方法如下：TaskManager tsm = new TaskManager(mContext); tsm.changeTask(任務名);所以第應用程序需向客戶端提供啟動Activity 名稱和任務名稱（任務名稱建議使用第程序包名），第Activity 名稱在 tsm.changeTask方法中使用，代碼如下：另外客戶端啟動第應用是以新起任務方式啟動，要求第明確指定Activity 所屬的任務名，即在 AndroidManifest.xml 配置 Activity 時指定 taskAffinity屬

6、性，并且需要保證該屬性值具有唯一性，以區(qū)別其他第應用程序。3.4 應用退出要求第應用程序整合到客戶端后，屬于客戶端部分應用程序，所以需要在客戶端退出的時候，第應用程序也需要完全退出?？蛻舳顺绦蛟谟脩舸_認退 出 的 時 候 ， 會 發(fā) 送 一 個 關 閉 廣 播 ， 廣 播 的action屬 性 值 為“com.chinamworld.main.CLOSE_CLENT”，廣播不帶任何相關數(shù)據(jù)；要求第三ent tent = newent();tent.setFlags(ent.FLAG_ACTIVITY_NEW_TASK); t ent.setClass(mContext,x.class); mC

7、ontext.startActivity(tent);應用 2ccb_應用 2_logo.pngccb/應用 2/logo.png方應用程序實現(xiàn)相應廣播器，在接收到廣播后直接關閉第應用程序。另外，由于啟動的使用時用任務管理 TaskManager 啟動的，所以第應用程序退出時（無論是正常退出還是異常【無通信等】退出）都必須調用關閉建行客戶端任務管理中相應的任務，防止建行客戶端自動切換回該任務，代碼如下： TaskManager tsm = new TaskManager(mContext); tsm.finishRunningTask(任務名);這里的任務名必須與啟動時定義的一致。注意：該廣播

8、是建行客戶端退出時發(fā)送的廣播，第應用程序負責接收該廣播執(zhí)行退出。但第應用程序本身退出返回建行客戶端時，不能發(fā)送該同名的廣播，造成整個客戶端退出。3.5 UI 要求1、第應用程序的UI部分由程序提供方進行設計實現(xiàn)，但風格等因盡可能參照客戶端程序，如標題欄可參考如下，水平/垂直居中。2、所有 UI 要求支持 480*800，320*480，240*320，640*960,720*1280 等幾種分辨率，以適應不同分辨率的 android。3、使用客戶端提供的背景，作為第應用程序的背景。3.6 通訊要求根據(jù)客戶端當前的通訊情況，第應用程序應支持 WIFI、2G、3G 通訊，并且除了 WAP 接入點還

9、應當支持 NET 接入點。4 支付接口相關要求4.1 啟動支付第應用程序需要支付時調用建行客戶端相關的支付功能接口，接口分B2C、C2C 兩種方式。B2C 方式，B2C 方式是指用戶確認支付的界面時以 Webview 加載網(wǎng)頁方式實現(xiàn)的，并且支付成功后的成功界面也是以 Webview 重載連接的方式。該方式啟動支付模塊時生成的接口對象調用方法如下：public CCBPay_erface_Tool(Context context, String ord WebView result) context：表示上下文對象aram,ordaram：表示支付參數(shù)以“key1=value1,key2=va

10、lue2,key3=value3”方式拼接的字符串對象result：支付成功后需要重載網(wǎng)頁的 Webveiw 對象然后生成的接口對象調用啟動支付接口方法：public void startCCBPayM() C2C 方式，是指用戶確認支付的界面時用 Activity 方式展現(xiàn)，并且支付成功時采用 Activity 顯示的。該方式啟動支付模塊時生成的接口對象調用方法如下：public CCBPay_erface_Tool(Context context, String ordaram,Class result) ordaram：表示支付參數(shù)以“key1=value1,key2=value2,ke

11、y3=value3”方式拼接的字符串對象result：支付成功后需要顯示結果處理的 Activity 界面對象然后生成的接口對象調用啟動支付接口方法：public void startCCBPayM()4.2參數(shù)下表為商戶或第應用在使用支付時的接口參數(shù)規(guī)范。注：商戶要保證訂單號的唯一性,非參數(shù)值可不填。: 通過以下的數(shù)值字符串拼接后計算出來：TXCODE+MERCHANTID+ ORDERID+ PAYMENTMD5ONCE mac = new MD5ONCE(TXCODE+MERCHANTID+ ORDERID+PAYMENT);mac.calc();=mac.toString();提交的參

12、數(shù)名稱參數(shù)說明最大長度（char）是 否 必輸備注TXCODE交易碼6Y由建行分配為SP7010。WAPVERWAP 版本6N默認為 1.2。MERCHANTID商戶代碼20Y由建行指定ORDERID訂單號30Y商戶需要保證訂單號的唯一性PAYMENT付款金額16Y：元如：11.88Md5 摘要串32YBRANCHID分行代碼9N由建行指定ID商戶柜臺代碼9N由建行分配，缺省為000000000CURCODE幣種2N缺省為 01（只支持支付）REMARK1備注 132N漢字為 UTF-8 編碼REMARK2備注 232N漢字為 UTF-8 編碼字段的生成請參照附件4.3 啟動返回接口用戶在支付

13、完成后，進行“通知商戶”操作，建行客戶端獲取相應數(shù)據(jù)，關閉客戶端支付模塊功能，把參數(shù)傳遞給第應用，即調用啟動時生成CCBPay_erface_Tool 對象的返回方法：B2C 方式啟動時返回調用接口為：public void setBackResult(Context context, String backParams) context：表示上下文對象backParams：為支付結果返回的接口參數(shù)，“key1=value1,key2=value2,key3=value3”方式拼接的字符串對象，并且使用調用B2C 支付接口時指定的Webview 對象result直接 loadUrl 重新加載。

14、C2C 方式啟動時返回調用接口為：public void setBackResult(Context context, HashMap backParams) context：表示上下文對象backParams：為支付結果返回的接口參數(shù)，并且使用以下ent 方式傳送給相應啟動 C2C 方式時指定的 result 接收處理的 Activity。entent = newent();ent.putExtra(key,value);具體傳遞參數(shù)如下節(jié)（4.4 返回接口參數(shù)）所示。4.4 返回接口參數(shù)下表為支付模塊完成支付訂單處理，返回給商戶或第應用的參數(shù)規(guī)范。支付簽名由以下字段順序連接起來成一字符串，

15、然后通過約定的提交的參數(shù)名稱參數(shù)說明最大長度（char）是 否 必輸備注CHANNEL支付標識1N支付標識：1-客戶端支付，其它-wap 支付MERCHANTID商戶代碼20Y商戶在支付的代碼ID商戶柜臺代碼20YBRANCHID商戶在的分行代碼30YORDERID訂單號30YPAYMENT交易金額16Y：元 可以帶小數(shù)點REMARK1備注 132YREMARK2備注 232YBJOURNAL流水號30YDN號碼11NSUCS支付成功標志1YY ： 成功， N ： 失敗，U ： 交易不確定SIGNB系統(tǒng)出具的電子簽名256YUSERNAME客戶50N此字段默認不返回；如需返回，需要聯(lián)系分行在商

16、戶管理 配置返回開關。O支付賬號30N此字段默認不返回；如需返回，需要聯(lián)系分行在商戶管理 配置返回開關。算法對該串進行計算得出：MERCHANTID + ORDERID + PAYMENT + BJOURNAL + SUCS注：字符串中變量名必須是大寫字母。5 第注意要點1、 向客戶端提供：應用程序源碼、素材、布局文件資源等。2、 程序/資源命名：第應用程序的包命名、資源命名、類名等應有相應的含義和唯一性，即需要標明所屬的第應用程序和對應的功能等。3、 Activity 要求：指定所屬任務屬性 android:taskAffinity；為風 格 ， 指 定 界 面 樣 式 為 不 包 含 標 題 欄android:theme=android:style/Theme.NoTiar；關閉橫豎屏切換功能，只支持豎屏 android:screenOrienion=nosensor；不顯示在home 或程序列表中，即具有啟動界面不能帶有不顯示在最近啟動程序中（長按 home