【正文】 U8API 開發(fā)手冊 “ U8API 資源管理器”是一個為 U8 客戶化應用開發(fā)提供統(tǒng)一的 U8API 資源查詢、訪問、調(diào)用規(guī)范等服務的平臺化工具產(chǎn)品。 本產(chǎn)品向外提供 一套完整統(tǒng)一的標準 U8 API 調(diào)用接口，以便基于 U8 標準 API 資源，采用統(tǒng)一編程模型和開發(fā)規(guī)范，為企業(yè)提供應用集成和個性化功能擴展增值服務，打造量體合身的信息系統(tǒng)。 在分類體系上，本產(chǎn)品向外提供的 U8 API資源主要按照功能模塊以及各個單據(jù)進行劃分，如庫存管理下的盤點單，提供“添加新 單據(jù)”、“審核單據(jù)”、“棄審單據(jù)”、“刪除單據(jù)”、“裝載單據(jù)”和“修改單據(jù)”這樣六個標準的 API 接口 ， 以 供客戶 調(diào)用 。 客戶可以在“ U8API 資源管理器”中查看要調(diào)用的 API 接口描述，同時可以獲取調(diào)用 該 API 的代碼示例（目前支持兩種語言 C和 VB）， 客戶 只需要 結合 API 接口描述并 按照代碼注釋中給出的提示 步驟 進行操作就可以方便的使用 U8 API 資源。 下面 主要介紹 如何使用 U8API 進行 個性化 開發(fā)， 如何對 U8API 進行調(diào)用 ， 同時給出 使用過程 中 需要 注意 的 內(nèi)容 。 用 . API總體應用過程 API 查找發(fā)現(xiàn) 在 U8 產(chǎn)品中“ UAP”目錄下找到“ U8API 資源管理器”，單擊，登錄，進入“ U8API 資源管理器”。在左側(cè) “ U8API” 樹形節(jié)點下，找到 某某模塊，如 “庫存管理”模塊（可以看到下面列有很多個單據(jù)，如盤點單、采購入庫單等），展開要操作的單據(jù)，分兩個子節(jié)點：“事件”和“服務接口”，在“服務接口”下可以看到該單據(jù)提供的 API 接口，如“添加新單據(jù)”、“審核單據(jù)”等。雙擊這些節(jié)點出現(xiàn)該 API 的詳細描述，如下圖 所示。在節(jié)點上右鍵單擊彈出“上下文菜單”，在“代碼示例”菜單項上彈出下一級子菜單，單擊它們，如單擊“ C代 碼示例”則可以看到調(diào)用該 API 的 C示例代碼，如下圖 所示。 直接拷貝這些代碼，然后在 集成開發(fā)環(huán)境（ IDE） 中編輯 和編譯 這些代碼 ，即 能 實現(xiàn)調(diào)用 U8 標準 API。 利用這些代碼 示例時，請按照其中每一步驟的提示說明正確操作，如添加必要的引用、按照自動生成的代碼填入正確的參數(shù)等。正確使用則可以 調(diào)用 成功，否則會返回 詳細的 錯誤信息。 以下代碼中均以 C為例， VB 語言請具體查看對應的 VB 代碼示例部分。 圖 接口描述 圖 代碼示例 API 調(diào)用過程 ? 組件 引用 針對兩種語言 ，需要引用不同的組件。 (1) C： %U8SOFT%\Interop\、 %U8SOFT%\Interop\、 %U8SOFT%\UFMOM\U8APIFramework\、 %U8SOFT%\UFMOM\U8APIFramework\、 %U8SOFT%\UFMOM\U8APIFramework\UF 如下圖 、 、 所示。 （ 2） VB： %U8SOFT%\UFMOM\U8APIFramework\. tlb 、 %U8SOFT%\UFMOM\U8APIFramework\. tlb、 %U8SOFT%\UFMOM\U8APIFramework\. tlb、 添加 Microsoft XML 引用 如下圖 、 所示。 其中， %U8SOFT%表示 U8872 的安裝目錄。 圖 添加 對 引用 圖 添加 對 引用 圖 添加 對 U8API 框架類庫引用 （ .dll） 圖 添加 對 U8API 框架類庫引用 (.tlb) 圖 添加 Microsoft XML 引用 ? API 調(diào)用 添加必要的引用后， 可以直接利用自動生成的代碼示例（支持 C和 VB 兩種語言），結合 API 接口詳細 描述，填入必要的參數(shù)值，就可以調(diào)用 U8 API。 總體上，對 U8 API 的調(diào)用分成七個步驟： 1) 構造 u8login 對象并登陸 ； 2) 構造環(huán)境上下文對象，傳入 login，并按需設置其它上下文參數(shù) ； 3) 設置 API 地址標識 (Url)參數(shù) ； 4) 構造 APIBroker； 5) API 參數(shù)賦值； 6) 調(diào)用 API； 7) 獲取返回結果 。 詳細的 API 調(diào)用過程請看下文“ API 內(nèi)容”中各個模塊中介紹的“開發(fā)步驟”。 ? BO 參數(shù)賦值 API 參數(shù)分兩種類型： BO 參數(shù) 和 普通參數(shù) 。 BO 參數(shù) 即單據(jù)表頭或表體類型的參數(shù)， 普通參數(shù) 則是非表頭表頭類型的參數(shù) 。 對 BO 參數(shù) ， 支持兩種方式傳入，一種傳 BO 對象，另一種傳 DOM 對象 。 以下分別介紹： (1) 傳 BO對象 給 BO 表頭參數(shù) 或 表體參數(shù) 賦值，推薦使用 BO 對象（ BussinessObject）。 例如： BusinessObject DomHead = (DomHead)。 = 10。 //設置行數(shù) ，不設置也可 //給 BO對象的字段賦值，值可以是真實類型，也可以是無類型字符串 //以下代碼示例只設置第一行值。各字段定義詳見 API服務接口定義 /****************************** 以下是必輸字段 ****************************/ DomHead[0][poid] = 。 //主關鍵字段， int類型 DomHead[0][dpodate] = 。 //日期， DateTime類型 DomHead[0][cpoid] = 。 //訂單編號， string類型 ?? /***************************** 以下是非必輸字段 ****************************/ DomHead[0][ipresent] = 。 //現(xiàn)存量， string類型 DomHead[0][cmaketime] = 。 //制單時間， DateTime類型 DomHead[0][cmodifytime] = 。 //修改時間， DateTime類型 ?? 在此種情況下 U8 API框架會對 BO對象各字段進行參數(shù)校驗。對字段進行賦值時， 值可以是真實類型，也可以是無類型字符串 。 (2) 傳 DOM 對象 給 BO 表頭參數(shù) 或 表體參數(shù) 賦值，也支持直接傳入 DOM 對象（ DOMDocument）。 例如： domHead = new ()。 ()。 (domHead, domHead)。 但是 ，在此種情況下 U8 API框架不會對 DOM對象進行參數(shù)驗證。請在使用該方法之前，確保 DOM對象的正確性。 API 典型應用場景 ? 執(zhí)行單一操作 單一操作指一項任務只需要一個 API 完成，比如：單據(jù)新增、 審核 /棄審、刪除等單一操作。這是 API 調(diào)用最常見的場景，只需按照 API 的接口規(guī)范構造參數(shù)直接調(diào)用即可。 ? 執(zhí)行復合操作 復合操作， 即一項任務由多個 API 的協(xié)作來完成。比如，自定義的單據(jù)維護界面的主要邏輯，一般由以下四個步驟構成： 1) 加載單據(jù)； 2) 在編輯界面上顯示； 3) 用戶修改單據(jù)字段； 4) 提交保存。 以上步驟需要進行兩次 API 調(diào)用： 1) 加載單據(jù)時候調(diào)用“加載 API”，以獲取單據(jù) BO 對象（或原始 DOM 對象）并在界面上展現(xiàn)； 2) 用戶在修改單據(jù)時其實就是在修改 BO 對象，用戶保存單據(jù)時調(diào)用“保存 API”，此時要將此 BO 對象傳給“ 保存 API”（而不用構造新的 BO 對象）。 代碼示例： 首先，登陸； //構造 u8login 對象并登陸 u8Login = new ()。 String sSubId = AS。 String sAccID = (default)@001。 String sYear = 2020。 String sUserID = demo。 String sPassword = 。 String sDate = 20200930。 String sServer = localhost。 String sSerial = 。 if (!(ref sSubId, ref sAccID, ref sYear, ref sUserID, ref sPassword, ref sDate, ref sServer, ref sSerial)) { (登陸失敗，原因： + )。 (u8Login)。 return。 } 然后，通過 LOAD 接口獲取 BO 對象； //構造環(huán)境上下文對象，傳入 login，并按需設置其它上下文參數(shù) U8EnvContext envContext = new U8EnvContext()。 = u8Login。 //設置上下文參數(shù) ?? //設置 API 地址標識 (Url) U8ApiAddress myApiAddress = new U8ApiAddress(“裝載單據(jù)的地址標識 ”)。 //構造 APIBroker U8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext)。 //API參數(shù)賦值 (參數(shù)名 , 參數(shù)值 )。 ?? //調(diào)用 LOAD接口 API if (!()) { //錯誤處理 Exception apiEx = ()。 if (apiEx != null) { if (apiEx is MomSysException) { MomSysException sysEx = apiEx as MomSysException。 (系統(tǒng)異常： + )。 //todo:異常處理 } else if (apiEx is MomBizException) { MomBizException bizEx = apiEx as MomBizException。 (API異常： + )。 //todo:異常處理 } } //結束本次調(diào)用，釋放 API資源 ()。 return。 } //獲取表頭或表體的 BO對象，如果要取原始的 XMLDOM對象結果，請使用 GetResult(參數(shù)名 ) BusinessObject DomRet = (表頭或表體參數(shù)名 )。 接著， BO 對象經(jīng)用戶修改重新賦值 ,并傳遞給 UPDATE 接口提交保存； //修改獲取的 BO對象，對需要更改的字段重新賦值 DomRet[0][字段名 ] = 新的字段值 。 ?? //重新構造“新增或修改” API的地址標識 myApiAddress = new U8ApiAddress(新增或修改” API的地址標識 )。 //重新構造 APIBroker broker = new U8ApiBroker(myApiAddress, envContext)。 //表頭或表體參數(shù)賦值 (表頭或表體參數(shù)名 , DomRet)。 //API參數(shù)賦值 (參數(shù)名 , 參數(shù)值 )。 ?? //調(diào)用 UPDA