網際網路無所不在,加上它天生跨平台的特性,讓越來越多團隊開始把龐大的 C/C++ 業務與科學運算程式往 Web 環境遷移。SOAP、REST 與 XML-RPC 這三套 Web 服務協定都能擔這份工作,但它們的成本與複雜度差別不小。本文會說明什麼情況下該選 XML-RPC 而不是 SOAP 或 REST,並以一個可運行的 C++ 範例,示範如何把既有的 C++ 方法掛成遠端服務。
C/C++ 程式碼的整合,傳統上有幾條路可走:CORBA、DCOM、RMI/IIOP,以及 JNI。圖 1 描繪了一個常見的困境:三個分別用 Java、VC++ 與 PL/1 開發的應用程式,各自要接上同一份 C++ 程式碼,就必須為每一種用戶端技術各開一組介面。
圖 1. 沒有 XML-RPC 的現況
也就是說,同一份 C++ 程式碼得為 RMI/IIOP/JNI、CORBA、DCOM 各做一遍對外介面。三倍的開發量,再加上三套部署與管理流程,維護成本會迅速失控。
XML-RPC 在這種情境下是更划算的選擇:它用 HTTP 當傳輸、用 XML 當編碼,讓 C++ 程式只需對外暴露一組介面,就能同時服務所有用戶端。
圖 2. 導入 XML-RPC 之後
圖 2 呈現的就是「XML over HTTP 的遠端程序呼叫」模型。SOAP 與 REST 也能達到同樣目的,但差異不小,接著就來比一比。
三者都能跑在 HTTP 上,但對 C++ 開發者而言,它們的定位與成熟度相當不同。
表 1. 三種協定的詳細比較
| 項目 | SOAP | XML-RPC | REST |
|---|---|---|---|
| 定義 | 用於分散式環境中交換資訊的輕量級協定,以 XML 為基礎,包含信封、一組編碼規則,以及表示遠端程序呼叫與回應的約定。 | 以 HTTP 為傳輸、XML 為編碼的遠端程序呼叫。設計目標是簡單,同時仍允許傳遞與回傳複雜資料結構。 | 一種描述「設計良好的 Web 應用該長什麼樣子」的樣式:由網頁組成的網路,使用者透過選擇連結前進,每次選擇換來下一頁的傳輸與呈現。 |
| 目標 | 在 XML-RPC 基礎上擴充:支援使用者自訂資料型別、指定收件者、訊息層級的處理控制等。 | 格式簡單且條理清楚。看得懂 HTML 的人應該能讀懂含 XML-RPC 呼叫的文件、理解它在做什麼,一兩次嘗試就能改對。協定極易實作,也易於移植到其他環境或作業系統。 | 提供一套關於 Web 該如何運作的設計模式,作為 Web 標準與 Web 服務設計的指引框架。 |
| 支援型別 | 整數、Boolean、ASCII 字串、雙精度帶正負號浮點數、日期時間、結構、陣列、位元組陣列、列舉、使用者自訂型別、多型存取器。 | 整數、Boolean、ASCII 字串、雙精度帶正負號浮點數、日期時間、結構、陣列。 | 依實作而異。常見的有整數、Boolean、ASCII 字串、雙精度浮點數、日期時間、集合、清單、屬性。 |
| 簡單性 | 略為複雜 | 易於理解與開發 | 依實作而異 |
| 穩定性 | W3C 接受的標準 | 並非標準 | 屬於體系結構參考,不需要標準化 |
| 互通性 | 無法與 REST/XML-RPC 互通 | 無法與 REST/SOAP 互通 | 無法與 SOAP/XML-RPC 互通 |
| 工具 | IBM、Microsoft 等大公司已在自家工具中支援 SOAP。 | 工具仍在發展中。 | 支援工具不多。 |
| 自訂能力 | 高度可自訂,不受資料型別與協定限制 | 輕量,僅能在 HTTP 上運作,型別支援有限 | 僅能在 HTTP 上運作 |
| 函式庫 | 有大量開源實作 | 有大量開源實作(見下文) | 可用的實作函式庫不多 |
如果換成 C++ 的角度來看,可用的 XML-RPC 實作大致有以下幾種。
表 2. C++ 可用的 XML-RPC 實作
| 函式庫/套件 | 說明 |
|---|---|
| PDEL(Packet Design Embedded Library) | 一個 C 函式庫,透過 http_xml_send_xmlrpc 與 http_servlet_xmlrpc 同時提供用戶端與伺服器端的 XML-RPC 實作,可透過 HTTP 傳送自訂 XML 資料。套件本身還附帶許多 XML-RPC 以外的功能。 |
| XMLRPC++ | XML-RPC 的 C++ 實作,內含簡易的伺服器與用戶端類別。因為是物件導向設計,可以直接繼承這些類別、實作出自己的 XML-RPC 伺服器,把業務功能當成服務對外公開。本文的範例即採用這個函式庫。 |
| XMLRPC-C | 一個 C 實作,C 與 C++ 程式都能用來把方法掛成服務,並內附名為 abyss 的 Web 伺服器。若要公開 C++ 方法,需先為該方法寫一層 C 風格的包裝,再用此庫對外發布。 |
要讓 C++ 程式具備 XML-RPC 能力,第一步是取得並安裝對應的函式庫。XMLRPC++ 在 Linux、AIX、32 位元 Windows 等平台的安裝方式,可參考官方文件與相關資源的連結。本文的範例環境是 Red Hat 9,搭配 XML-RPC++ 0.7。
範例再簡單不過——把兩個整數相加,封裝在一個名為 Operations 的使用者自訂類別裡。
清單 1. Operations 類別宣告
class Operations {
public:
int add();
Operations(int i, int j);
private:
int op1; //Operand 1
int op2; //Operand 2
};
建構子接收兩個整數,分別存進私有成員 op1 與 op2;而 add 方法就是我們準備對外公開的那個服務。
清單 2. Operations.cpp
int Operations::add()
{
std::cout << "Sum of " << op1 << " + " << op2 << " = " << op1 + op2 << std::endl;
return(op1 + op2);
}
接著用一張類別關聯圖說明函式庫各元件如何與我們的 Operations 類別串接起來。
圖 3. XML-RPC 函式庫與範例程式的類別關聯圖
表 3. 各類別職責
| 類別名稱 | 用途 |
|---|---|
| Operations | 要對外公開的 add 方法實作所在。 |
| Add | 包裝類別,負責呼叫 Operations 的 add 方法;同時繼承 myXMLRpcServerMethod。 |
| myXMLRpcServerMethod | 繼承自函式庫的 XMLRpcServerMethod。它的 execute 會在 Add 類別中被覆寫。 |
| XMLRpcServerMethod | 所有要註冊到伺服器的方法,都必須經由 myXMLRpcServerMethod 繼承自這個類別並實作自己的 execute。execute 就是對外服務的包裝:伺服器收到 XML-RPC 呼叫時,會直接觸發它。本例中當用戶端呼叫「Add」服務,被喚起的就是 Add 的 execute。 |
| myXMLRpcServer | 有兩個關鍵私有成員:pm_serverMethods 是已註冊方法的指標清單;pm_XMLRpcServer 則用來設定伺服器 IP、連接埠等屬性。三個關鍵方法分別是:建構子(以 IP/連接埠初始化並綁定伺服器物件)、pm_registerMethods(建立指向 Add 的物件並加入 pm_serverMethods)、run(包裝 XMLRpcServer 的 work 方法)。 |
| XMLRpcServer | 函式庫提供的伺服器類別,兩個關鍵方法:bindAndListen(port) 綁定並監聽指定連接埠;work(...) 啟動伺服器。 |
由於 XMLRpcServer 與 XMLRpcServerMethod 已由函式庫實作,我們把注意力放在自己需要寫的四個類別上。
清單 3. myXMLRpcServer.cpp
#include "myXMLRpcServer.h"
using namespace XMLRpc;
using namespace std;
myXMLRpcServer::myXMLRpcServer()
{
//call register methods
pm_registerMethods();
//set port bind and listen
int port = 8085;
pm_XMLRpcServer.bindAndListen(port);
std::cout << "XMLRpcSever running in port " << port << std::endl;
}
void
myXMLRpcServer::pm_registerMethods()
{
Add* a = new Add(&pm_XMLRpcServer);
myXMLRpcServerMethod *p = a;
pm_serverMethods.push_back(p);
}
void
myXMLRpcServer::run()
{
pm_XMLRpcServer.work(-1);
}
清單 4. myXMLRpcServer.h
#include <iostream>
#include "myXMLRpcServerMethods.h"
#include "XMLRpc.h"
class myXMLRpcServer {
public:
myXMLRpcServer();
void run();
private:
void pm_registerMethods();
XmlRpc::XmlRpcServer pm_XMLRpcServer;
std::list< myXMLRpcServerMethod* > pm_serverMethods;
};
清單 5 與清單 6 負責把方法註冊進 XML-RPC 伺服器。
清單 5. myXMLRpcServerMethods.cpp
#include <iostream>
#include "myXMLRpcServer.h"
#include "Operations.h"
using namespace std;
Add::Add(XmlRpcServer* s) : myXMLRpcServerMethod("Add", s) {};
void Add::execute(XmlRpcValue & params, XmlRpcValue& result)
{
Operations a(10,12);
try
{
cout << "Inside Add::execute method\n";
result = a.add();
}
catch(std::exception & stde)
{
throw XmlRpcException(stde.what());
}
}
清單 6. myXMLRpcServerMethods.h
class myXmlRpcServerMethod : public XmlRpcServerMethod
{
public:
myXMLRpcServerMethod
(const char *name, XmlRpcServer * server) : XmlRpcServerMethod(name, server) {}
virtual void execute(XmlRpcValue & params, XmlRpcValue& result) {assert(0);}
};
class Add : public myXMLRpcServerMethod
{
public:
Add(XmlRpcServer* s);
virtual void execute(XmlRpcValue & params, XmlRpcValue& result);
};
伺服器端的起點是驅動程式:在此建立 myXMLRpcServer 物件並呼叫 run(),後者最終會把伺服器拉起來。
清單 7. myServerDriver.cpp
#include <iostream>
#include "myXMLRpcServer.h"
int main(int argc, char* argv[])
{
myXMLRpcServer GeeBoomBaa;
std::cout << "About to run the server\n";
GeeBoomBaa.run();
return 0;
}
編譯時別忘了把 (XML_RPC_INSTALL_DIR)/src 與 (XML_RPC_INSTALL_DIR)/include 兩個目錄加進 include 路徑;連結階段則要帶上 libXmlRpc.a。成功編譯連結後會得到一個可執行檔,那就是你的 XML-RPC 伺服器。範例中伺服器跑在 localhost、監聽 8085 連接埠,這個設定寫死在 myXMLRpcServer.cpp 裡;實務上更合理的做法是改成讀取設定檔,或從命令列參數傳入。執行產生的 a.out 即可啟動服務。
用戶端要從函式庫的 XmlRpcClient 類別建立物件,它的 execute(...) 接受三個參數:
const char*)const int)清單 8 的用戶端會呼叫 add 方法,並在用戶端印出結果。
清單 8. sampleClient.cpp
#include <iostream>
#include "XMLRpc.h"
using namespace XMLRpc;
int main(int argc, char* argv[])
{
const char *server = "localhost";
const int port = 8085;
const char *uri = NULL;
XmlRpcValue args, res;
XmlRpcClient c(server, port, uri);
c.execute("Add", args, res);
std::cout << "result is " << res << std::endl;
}
XML-RPC 是個簡單卻有力的輕量級訊息協定,靠著 XML 讓異質平台之間得以互通。正是這份「簡單」,讓它在把既有程式往企業體系裡整合時顯得格外實用;而各語言的實作多半開源,又進一步推升了它在企業應用整合領域的接受度。隨著成熟的 XML-RPC 工具持續增加,這套技術很有機會成為企業內部整合的事實標準。