使用ServiceStack构建Web服务

使用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的时候，有个ServiceStack.Redis，之前还写个一篇 .NET中使用Redis 的拙文。这个ServiceStack.Redis其实就是ServiceStack的一个组件，专门用来跟ServiceStack进行交互的。

一 关于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有所帮助。

作者：  yangecnu（ yangecnu's Blog on 博客园） 
出处： http://www.cnblogs.com/yangecnu/ 
本 作品由yangecnu 创作，采用知识共享署名-非商业性使用-禁止演绎 2.5 中国大陆许可协议进行许可。 欢迎转载，但任何转载必须保留完整文章，在显要地方显示署名以及原文链接。如您有任何疑问或者授权方面的协商，请 给我留言。

 

分类:  DotNet Framework

标签:  ServiceStack,  WebService,  DTO,  POCO