使用ServiceStack構建Web服務
提到構建WebService服務，大家肯定第一個想到的是使用WCF，因為簡單快捷嘛。首先要說明的是，本人對WCF不太瞭解，但是想快速建立一個WebService，於是看到了MSDN上的這一篇文章 Building Cross-Platform Web Services with ServiceStack，所以這裡簡要介紹一下如何使用ServiceStack快速建立一個WebService服務。
當然，在開始之前，首先要說明一下ServiceStack是個什麼東西。 在國內用ServiceStack的似乎很少，大部分都是WCF或者ASP.NET WebAPI，唯一接觸ServiceStack的可能是在C# 中呼叫Redis的時候，有個
一 關於WebService
在談論ServiceStack之前，先看看構成一個WebService的基本框架：
服務層就是定義WebService介面的地方，這一層也是客戶端使用WebService唯一需要與之互動的一層。
業務層通常包含有大量的業務邏輯。他也是實現介面層定義的介面的地方，也是保持服務層的輕量以及關注服務端客戶端的契約以及通訊的地方。
資料層通常就是封裝資料訪問方法並給業務層提供抽象資料模型。
現在我們來看Service這一層。一些WebService使用遠端過程呼叫的方法來實現(RPC)，比如會定義如下函式呼叫：
public interface IService
{
string DoSomething(int input);
}這種RPC的方式使得服務不能很好的應對變化。比如，在上面的程式碼中，如果後續版本的介面需要接受兩個引數來執行DoSomething方法，或者說除了返回一個string外還需要返回其他資訊。如果在原介面上修改的話，就會使得老版本的客戶端無法使用。當然，我們可以建立一個平行的DoSomething_v2來接受兩個引數。但是隨著時間的遷移，我們的介面中會充斥著越來越多這樣的定義，不管是新使用者還是老使用者都會感到困惑。
面對這種情況，可以使用資料傳輸物件(DTO) 來定義前面的介面中的相關引數。上面的RPC方式轉換為對應的DTO模型如下：
public class DoSomethingRequest
{
public int Input { get; set; }
}
public class DoSomethingResponse
{
public string Result { get; set; }
}
public interface IService
{
DoSomethingResponse DoSomething(DoSomethingRequest request);
}每個服務接受一個DTO請求引數，返回一個DTO響應。在請求和相應的DTO物件中新增欄位，不會破壞舊的客戶端。
在WCF中RPC和DTO風格的WebService均支援，但是在ServiceStack中僅支援DTO風格。ServiceStack為了減少繁瑣和注重介面設計從而僅擁抱的DTO風格的遠端 WebService介面。 這是瞭解 ServiceStack的關鍵，也是ServiceStack框架的設計原則。
瞭解了ServiceStack的設計理念後，來看看ServiceStack是什麼。
二 ServiceStack是什麼
ServiceStack是一個開源的十分流行的WebService框架，引用其官網的介紹：
“Service Stack is a high-performance .NET web services platform that simplifies the development of high-performance REST (JSON, XML, JSV, HTML, MsgPack, ProtoBuf, CSV) and WCF SOAP Web Services.”
“ServiceStack是一個高效能的.NET Web Service 平臺，他能夠簡化開發高效能的REST (支援JSON,XML,JSV,HTML,MsgPack,ProtoBuf,CSV等訊息格式)以及WCF SOAP風格的WebService”。
在其主頁上也有一篇名為What is the ServiceStack的介紹。建議您直接看，這裡從裡面截取了幾張圖：
可以看到ServiceStack除了在其底層是一個精簡的WebService框架之外，在其上還有與之相關的一些元件，比如號稱.NET 上最快的JSON序列化工具，.NET中流行的Redis訪問模組，輕量級快速Orm框架OrmLite等諸多功能。
可以看到這些元件基本提供了一個WebService框架必需的一些功能。
在內部實現上ServiceStack建立在原生的ASP.NET IHttpHandler之上，他能夠允許在.NET Framework和Mono之上。
下面來看如何使用ServiceStack建立一個WebService：
三 使用ServiceStack
要建立服務，首先要定義介面。這裡以一個售票系統為例來說明如何使用ServiceStack來建立服務:
建立服務介面層
首先新建一個TicketSystem.ServiceContract的類庫，我們定義DTO物件。必需要有一個Ticket實體類：
public class Ticket
{
public int TicketId { get; set; }
public int TableNumber { get; set; }
public int ServerId { get; set; }
public List<Order> Orders { get; set; }
public DateTime Timestamp { get; set; }
}在WCF中需要在實體類和欄位上面新增DataContract和DataMember來表示序列化時需要的欄位，如果沒有新增這些標籤，在序列化的時候就會忽略。
而在ServiceStack中，這些標記都不需要，ServiceStack會序列化所有的Plain Old CLR Objects（POCOs）,並且這些物件對客戶端都可見。
然後開始定義Service中需要用到的對外提供服務的介面：
public interface ITicketService
{
List<Ticket> Any(GetAllTicketsInQueueRequest request);
void Any(QueueTicketRequest request);
Ticket Any(PullTicketRequest request);
}在ITickertService中，我們定義了三個操作，第一次看到這樣的操作可能有些奇怪，因為方法名稱都一樣。這是ServiceStack和WCF不一樣的地方。在WCF中以上介面可能是這樣的：
[ServiceContract]
public interface ITicketService
{
[OperationContract]
List<Ticket> GetAllTicketsInQueue(GetAllTicketsInQueueRequest request);
[OperationContract]
void QueueTicket(QueueTicketRequest request);
[OperationContract]
Ticket PullTicket(PullTicketRequest request);
}WCF中介面需要使用ServiceContract來表明，其中的方法需要使用OperationContract來標記。方法的名稱就是服務的名稱。
ServiceStack中的服務方法名為Any，Get以及Post，這也是ServiceStack支援的請求型別，Any表示服務可以通過HTTP Get和HTTP Post兩種方式呼叫。這強化和簡化了RESTFull風格的WebService的實現。只需要在這些方法上新增愛[Route(…)]屬性即可。在ServiceStack中，方法和方法之間的區別是通過服務的引數及請求物件Request DTO來區分的，而不是像WCF中通過方法名稱來區分。這就表示一個請求DTO物件不能在ServiceStack的多個Service中複用。
建立服務端
有了服務介面層之後，需要編寫服務端以實現這些邏輯，也就是前面定義的ITicketService介面。首先建立名為ServiceStackServer的空的ASP.NET 應用程式，然後新建TicketService類，是該類實現ITicketService介面並繼承自Service類。Service類是ServiceStack中的，可以通過NuGet來安裝和引用ServiceStack相關類庫：
實現後TicketService類如下：
public class TicketService : Service, ITicketService
{
private static readonly TicketSystem.TicketProcessor.TicketProcessor
_ticketProcessor = new TicketSystem.TicketProcessor.TicketProcessor();
public List<Ticket> Any(GetAllTicketsInQueueRequest request)
{
return _ticketProcessor.GetTicketsInQueue()
.Select(TicketTranslator.TranslateTicket).ToList();
}
public void Any(QueueTicketRequest request)
{
_ticketProcessor.QueueTicket(
TicketTranslator.TranslateTicket(request.Ticket));
}
public Ticket Any(PullTicketRequest request)
{
TicketSystem.TicketProcessor.Ticket nextTicket =
_ticketProcessor.PullTicket();
if (nextTicket != null)
{
return TicketTranslator.TranslateTicket(nextTicket);
}
return null;
}
}這裡面我們定義了一個私有了TicketProcessor 變數，介面中的所有方法都通過該類實現，在介面物件到該方法的呼叫中，我們對實體進行了轉換。該物件在其他程式集中定義，這樣能保證服務端程式碼簡潔。
有了服務端之後，需要把服務端Host起來對外提供服務，ServiceStack提供了通過IIS，Self-Host等多種形式。因為我們之前建立的ASP.NET程式，所以，只需要再新增一個Global.asax檔案，然後在啟動的事件Application_Start中初始化即可。
protected void Application_Start(object sender, EventArgs e)
{
//Initialize your web service on startup.
new TicketServiceHost().Init();
}public class TicketServiceHost : AppHostBase
{
//Register your web service with ServiceStack.
public TicketServiceHost()
: base("Ticket Service", typeof(TicketService).Assembly)
{ }
public override void Configure(Funq.Container container)
{
//Register any dependencies your services use here.
}
}只需要實現ApphostBase基類，提供服務顯示名稱，以及實現了Service介面的服務所在的程式集即可。
當然也可以通過控制檯應用程式來Host我們的WebService，這時TicketServiceHost需要實現AppSelfHostBase，實現如下：
public class TicketServiceHost : AppSelfHostBase
{
/// <summary>
/// Default constructor.
/// Base constructor requires a name and assembly to locate web service classes.
/// </summary>
public TicketServiceHost()
: base("WebApplication1", typeof(TicketService).Assembly)
{
}
/// <summary>
/// Application specific configuration
/// This method should initialize any IoC resources utilized by your web service classes.
/// </summary>
/// <param name="container"></param>
public override void Configure(Container container)
{
//Config examples
//this.AddPlugin(new PostmanFeature());
//this.AddPlugin(new CorsFeature());
}
}然後在Main函式中，啟動即可：
static void Main(string[] args)
{
var listeningOn = args.Length == 0 ? "http://*:1337/" : args[0];
var appHost = new TicketServiceHost()
.Init()
.Start(listeningOn);
Console.WriteLine("AppHost Created at {0}, listening on {1}",
DateTime.Now, listeningOn);
Console.ReadKey();
}現在，我們執行前面建立的ASP.NET或者執行Console託管的TicketServiceHost， 在瀏覽器中訪問http://localhost:1337/即可看到我們定義好的服務：
服務客戶端
服務端建立和託管好之後， 服務使用者就可以直接編寫HttpWebRequest物件對這些服務通過Get或者Post方式進行直接訪問了。
除此之外，ServiceStack也內建了一些便捷訪問的客戶端，這些物件位於ServiceStack.ServiceClient.Web名稱空間中。所有的內建的客戶端都實現了ServiceStack.Service.IServiceClient 放，這些支援REST的客戶端都實現了ServiceStack.Service.IRestClient.這些客戶端物件包括：
- JsonServiceClient
- JsvServiceClient
- XmlServiceClient
- MsgPackServiceClient
- ProtoBufServiceClient
- Soap11ServiceClient
- Soap12ServiceClient
從名稱可以看出，這幾種不同之處在於支援的序列化和反序列化格式不同。因為他們實現的是一系列相同的介面，所以他們的用法相同，也可以相互替換。
這裡我們不演示如何通過HttpWebRequest像請求普通的網頁那樣請求我們之前託管好的WebService，現在假設我們有一個Console程式需要使用WebService程式。只需要新建一個ServiceStack的Service，然後將Host的地址傳入即可。這些方法在內部會為我們將程式碼轉化為傳統的使用HttpWebRequest的方式請求，目前這些方法還都是同步的。
比如，如果我們想使用WCF中使用的Soap11來請求，只需如下程式碼：
static void Main(string[] args)
{
Console.Title = "ServiceStack Console Client";
using (var client = new Soap11ServiceClient("http://localhost:1337"))
{
List<Ticket> queuedTickets = client.Send<List<Ticket>>(
new GetAllTicketsInQueueRequest()) ;
if (queuedTickets != null)
{
foreach (Ticket ticket in queuedTickets)
{
PrintTicket(ticket);
}
}
}
Console.ReadKey();
}這裡的Soap11ServiceClient 物件可以換成ServiceStack支援的其他資料序列化格式。
四 結語
本文介紹了開源的比較流行的WebService框架ServiceStack，並通過一個簡單的例子展現瞭如何使用ServiceStack創建出一個WebService。
它能夠比較方便快捷的搭建高效的具有RESTFull風格的WebService應用程式。其框架的設計思路也非常值得學習，通過類似“約定大於配置”的方式，減少了WCF中建立WebService需要的各種標記，強制使用者使用DTO的方式來建立服務介面。ServiceStack也提供了名為ServiceStackVS的VisualStudio外掛能夠幫助您方便的建立ServiceStack模板。
WCF可以實現ServiceStack所有的功能。但是ServiceStack為您快速建立一個高效WebService提供了另外一種選擇，他可以運行於不同的平臺。ServiceStack也是開源社群比較活躍的一個WebService框架，通過研究其程式碼也可以借鑑其思路，提高自己的編碼和架構水平。比如可以修改Client以支援非同步方法呼叫等等，可以自己動手新增自己想要的功能。
希望本文對您瞭解ServiceStack有所幫助。