在Ruby on Rails中使用Rails Active Resource的教程

在Ruby on Rails中使用Rails Active Resource的教程

簡介

當今的應用程式不僅需要和基於瀏覽器的客戶端互操作,還需要和其他應用程式互操作。為實現互操作性,web 應用程式通常提供一個 web 服務 API。web 服務 API 通過一個網路(比如 Internet)提供對應用程式 的遠端訪問。直到最近,web 服務 API 還使用重型、複雜的基於 SOAP 的 web 服務整合,這種 web 服務,不僅沒有什麼優點,而且還需要很長時間才能實現。帶有基於 Representational State Transfer (REST) 服務的 Rails 框架有一種更簡單、更快捷的方法通過 Active Resource 來實現和使用 web 服務。

在 Rails 實現了 RESTful 以後,現在只需通過一個 Rails 動作就能提供一個特定資源的不同內容型別(或者表示)。這種方法有以下好處:

    一個資源的各種表示狀態。
    對不基於瀏覽器的 HTML 客戶端的附加支援在 Controller 檢視中得到了簡化。
    應用程式之間以及與新客戶端之間的互操作性。

在本文中,您將瞭解 REST、SOAP、Rails Active Resource,以及如何提高多個應用程式之間的互操作性。

Ruby on Rails

Ruby on Rails(也稱為 Rails 或 RoR)是一個用 Ruby 語言編寫的開源 web 應用程式框架。Ruby on Rails 旨在幫助開發人員更輕鬆快捷地開發和部署 web 應用程式,與其他語言和框架相比,Rails 框架進行了幾個假設。其目的是使用敏捷開發的方法,實現快速開發。

Rails 框架合併了以下幾個包:

    Active Record:一個物件關係對映層,用於資料庫相關訪問和功能;
    Action Pack:一個控制器和檢視功能管理器;
    Action Mailer:一個電子郵件處理器;
    Active Support
    Active Resource:提供 web 服務(即 Action Web 服務)。

Web 服務

Web 服務是使用開放協議通訊的應用程式元件,它們可以被其他應用程式使用。web 服務是簡單 APIs ,可以使用 HTML 進行訪問,並在承載請求服務的遠端系統上執行。web 服務是不同平臺上、以不同語言編寫、不同系統上的各種應用程式的關鍵整合點。

REST 不是一個協議;它是利用 World Wide Web 的技術和協議的大型聯網軟體的一種架構風格。REST 描述如何定義和處理分散式資料物件(或資源),強調簡單的資訊交換和可伸縮性。REST 架構描述該該架構上應用的 6 個約束。

另一方面,SOAP 是一個協議規範,用於在計算機網路中交換 web 服務的實現中的結構化資訊。它依賴 XML 作為其訊息格式,通常依賴其他應用程式層協議(RPC 和 HTTP)進行訊息協商和傳輸。SOAP 可以形成 web 服務協議堆疊的基礎層,提供用於在其上構建 web 服務的基礎訊息傳遞框架。
REST 與 SOAP

下表展示了 REST 和 SOAP 之間的一些區別。

https://codertw.com/wp-content/uploads/2018/07/20180709180842-5b43a4aa18661.jpg (831×514)

REST 依賴一個單一的應用程式協議(HTTP)、幾個 URI、以及幾種通過 XML 標準化的資料格式。它採用成熟的 HTTP 方法(比如 GET 和 POST)來指揮應用程式。REST 開發人員使用 URI 來建立一個公共基礎,以便應用程式使用 HTTP 和 XML 來共享資料,而不是為應用程式建立一種機器可讀的標準方法來發現和使用遠端系統上的應用程式元件(這是 SOAP 用於 web 服務的方法)。REST 開發人員使用 XML 文件而不是應用程式方法呼叫來告訴分散式程式如何相互使用資料。

REST 支持者指出,使用 SOAP 協議直接訪問遠端程式的功能必定會遇到 DCOM 和 Common Object Request Broker Architecture 等之前分散式計算架構所遇到的互操作性問題。

Active Resource

在對 web 應用程式在伺服器和客戶機應用程式之間的通訊採用 RESTful 方法之前,SOAP 和其他 XML-RPC 形式被用於通過一個 API 進行通訊。Rails 2 引入的 Active Resource 替代了 Action Web Service。Active Resource 完全理解 RESTful 路由和 XML 表示。它是一個類,用於將 RESTful 資源對映為 Rails 應用程式中的模型。Active Resource 提供一些工具來快速、輕鬆地使用遵守 Rails RESTful URI 結構和協議約定的基於 REST 的 web 服務。Active Resource 將來自任何合格服務的響應對映到富 Ruby 物件。Active Resource 還提供輕鬆執行基本的 CRUD 功能需要的全部生命週期方法。

CRUD 操作分別對應 HTTP 方法 POST、GET、PUT 和 DELETE。而且,Active Resource 對這些 HTTP 方法中的每個方法都有一個方法。它們接收與 CRUD 相同的引數,但返回收到的 XML 的一個雜湊表。Active Resource 物件本質上是 REST web 伺服器的前端。它通過向伺服器回撥 HTTP 呼叫並將 XML 結果解析回一個 Ruby 物件中來獲取並修改它的資料。

清單 1 展示了一個最小 Active Resource 示例。假設有一個圖書館應用程式,每個類別作為一個不同的客戶端,且 Indian History 是其中一個類別。
清單 1. Active Resource 示例


class IndianHistory < ActiveResource::Base
self.site = “http://indian-history.com”
end

ActiveResource 擁有與 Active Record 相同的方法。在上面的程式碼樣例中,類 IndianHistory 正繼承自 ActiveResource Base。在第二行中,self.site 持有包含 IndianHistory 圖書的 URI 的站點值。在本例中,這個 URI 是 http://indian-history.com(假設這個 URI 是帶有必要模型和控制器動作的另一個 Rails 應用程式)。

現在,這個類被對映到站點值定位的 RESTful 資源,您現在可以操作 IndianHistory 類的資源。要獲取 Indian History 下的所有圖書列表,您將呼叫它的 find 方法,它類似於 Active Record find 方法。


>> books = IndianHistory.find (:all)

這個 Active Resource 模組類似於 Active Record 模組;它們擁有相同的風格。

假設您正在尋找標題為 “Akbar” 的圖書,可以使用以下程式碼:


>> books = IndianHistory.find(:all, :params => { :title => “Akbar”}}

與 Active Record find 方法中的常規 :conditions 子句不同,本示例使用了 :params,且 URL 是 GET http://indian-history.com/indian_histories.xml?title=Akbar。

Active Resource 不僅限於檢索資料。您可以使用所有 CRUD 操作。在指令碼/控制檯中,您可以使用:


>> IndianHistory.create (:title => “Jhansi Stories”, :amount => 233.00, :available => 0)

上述程式碼行將使用提供的資料向 create 動作中存在清單 2 中的程式碼的控制器建立一個 HTTP POST。
清單 2. Create


class IndianHistoryController < ActiveResource::Base
def create
@book = IndianHistory.new (params [:indian_history])
respond_to do |format|
if @book.save
flash[:notice] = “New title added successfully” 
format.html { redirect_to(@book) }
format.xml { render :xml => @book, :status => :created}
else
format.html { render :action => “new” }
format.xml { render :xml => @book.errors, :status => :unprocessable_entity}
end
end
end
end

如果圖書記錄成功儲存,將返回新建立的、狀態碼為 HTTP 201 的記錄,並將使用新建立的記錄重定向檢視。

同樣,您也可以更新和刪除記錄,主要您擁有執行管理的許可權和訪問權。

對於 Update 操作,在指令碼/控制檯中使用:
清單 3. Update


>> book= IndianHistory.find (2)
>> book.available = 1
>> book.save 
>> book = IndianHistory.find (2)
>> book.available # => 1

您更新了圖書的可用性並儲存記錄。ActiveResource 和 ActiveRecord 之間有一個細微差別:ActiveResource 中沒有方法 save 和 update。

最後,下面的語句將從資料庫移除記錄。


>> IndianHistory.delete(2)

除了上面介紹的基本操作外,Active Resource 還允許通過設定一個 HTTP 頭部來 支援 HTTP 基本身份驗證。假如使用者名稱和密碼被設定且在身份驗證失敗時丟擲錯誤,則客戶機和伺服器連線的安全檢查就能通過每個連線上的 Active Resource 身份驗證來完成。基本的身份驗證也可以輕鬆實現。

結束語

在本文中,您瞭解了 web 服務、REST、SOAP 和 Rails Active Resource。一個簡單的示例向您展示了 CRUD 操作。

Ruby on Rails Active Resource 包以一種 RESTful 方式提供多個 web 應用程式之間的輕鬆通訊。除了 CRUD 操作外,它還允許您建立自定義動作。

您可能感興趣的文章:

舉例理解Ruby on Rails的頁面快取機制在Ruby on Rails中優化ActiveRecord的方法舉例講解Ruby中迭代器Iterator的用法