使用ServiceStack构建Web服务

时间 2019-11-11

原文原文链接

提到构建WebService服务，你们确定第一个想到的是使用WCF，由于简单快捷嘛。首先要说明的是，本人对WCF不太了解，可是想快速创建一个WebService，因而看到了MSDN上的这一篇文章 Building Cross-Platform Web Services with ServiceStack，因此这里简要介绍一下如何使用ServiceStack快速创建一个WebService服务。html

固然，在开始以前，首先要说明一下ServiceStack是个什么东西。在国内用ServiceStack的彷佛不多，大部分都是WCF或者ASP.NET WebAPI，惟一接触ServiceStack的多是在C# 中调用Redis的时候，有个ServiceStack.Redis，以前还写过一篇.NET中使用Redis 的拙文。这个ServiceStack.Redis其实就是ServiceStack的一个组件，专门用来跟Redis进行交互的。git

一关于WebService

在谈论ServiceStack以前，先看看构成一个WebService的基本框架：github

服务层就是定义WebService接口的地方，这一层也是客户端使用WebService惟一须要与之交互的一层。web

业务层一般包含有大量的业务逻辑。他也是实现接口层定义的接口的地方，也是保持服务层的轻量以及关注服务端客户端的契约以及通信的地方。浏览器

数据层一般就是封装数据访问方法并给业务层提供抽象数据模型。架构

如今咱们来看Service这一层。一些WebService使用远程过程调用的方法来实现(RPC)，好比会定义以下函数调用：app

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对象中添加字段，不会破坏旧的客户端。ide

在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有所帮助。