Rest API 开发学习笔记(转)

Rest API 开发学习笔记

概述

REST 从资源的角度来观察整个网络，分布在各处的资源由URI确定，而客户端的应用通过URI来获取资源的表示方式。获得这些表徵致使这些应用程序转变了其状态。随着不断获取资源的表示方式，客户端应用不断地在转变着其状态，所谓表述性状态转移（Representational State Transfer）。

这一观点不是凭空臆造的，而是通过观察当前Web互联网的运作方式而抽象出来的。Roy Fielding 认为，

“设计良好的网络应用表现为一系列的网页，这些网页可以看作的虚拟的状态机，用户选择这些链接导致下一网页传输到用户端展现给使用的人，而这正代表了状态的转变。”

REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML以及HTML这些现有的广泛流行的协议和标准。资源是由URI来指定。对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE方法。通过操作资源的表现形式来操作资源。资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式。 REST的要求客户端和服务器结构连接协议具有无状态性能够利用Cache机制增进性能层次化的系统隨需代碼 - Javascript （可選）

RESTful Web 服务

RESTful Web 服务（也称为 RESTful Web API）是一个使用HTTP并遵循REST原则的Web服务。它从以下三个方面资源进行定义：URI，比如：http://example.com/resources/。

§ Web服务接受与返回的互联网媒体类型，比如：JSON，XML ，YAML 等。

§ Web服务在该资源上所支持的一系列请求方法（比如：POST，GET，PUT或DELETE）。

该表列出了在实现RESTful Web 服务时HTTP请求方法的典型用途。

HTTP 请求方法在RESTful Web 服务中的典型应用

资源

GET

PUT

POST

DELETE

一组资源的URI，比如http://example.com/resources/

列出 URI，以及该资源组中每个资源的详细信息（后者可选）。

使用给定的一组资源替换当前整组资源。

在本组资源中创建/追加一个新的资源。该操作往往返回新资源的URL。

删除整组资源。

单个资源的URI，比如http://example.com/resources/142

获取指定的资源的详细信息，格式可以自选一个合适的网络媒体类型（比如：XML、JSON等）

替换/创建指定的资源。并将其追加到相应的资源组中。

把指定的资源当做一个资源组，并在其下创建/追加一个新的元素，使其隶属于当前资源。

删除指定的元素。

PUT 和 DELETE 方法是幂等方法。GET方法是安全方法（不会对服务器端有修改，因此也是幂等的）。

不像基于SOAP的Web服务，RESTful Web服务并没有的“正式”标准。这是因为REST是一种架构，而SOAP只是一个协议。虽然REST不是一个标准，但在实现RESTful Web服务时可以使用其他各种标准（比如HTTP，URL，XML，PNG等）。

REST的优点可以利用缓存Cache来提高响应速度通讯本身的无状态性可以让不同的服务器的处理一系列请求中的不同请求，提高服务器的扩展性浏览器即可作为客户端，简化软件需求相对于其他叠加在HTTP协议之上的机制，REST的软件依赖性更小不需要额外的资源发现机制在软件技术演进中的长期的兼容性更好

Rest 开发

首先先定义接口IRestHandler:

/// <summary>

/// The IRestHandler is an interface which provides Delete,Get,Post and Put methods.

/// </summary>

public interface IRestHandler : ICloneable

{

/// <summary>

/// Delete method for RestHandler

/// </summary>

/// <param name="processor">The rest processor.</param>

/// <param name="authenticated">if set to <c>true</c> [authenticated].</param>

/// <returns>The http response</returns>

RestHandlerResponse Delete(IRestProcessor processor, bool authenticated);

/// <summary>

/// Get method for RestHandler

/// </summary>

/// <param name="processor">The rest processor.</param>

/// <param name="authenticated">if set to <c>true</c> [authenticated].</param>

/// <returns>The http response</returns>

RestHandlerResponse Get(IRestProcessor processor, bool authenticated);

/// <summary>

/// Post method for RestHandler

/// </summary>

/// <param name="processor">The rest processor.</param>

/// <param name="authenticated">if set to <c>true</c> [authenticated].</param>

/// <returns>The http response</returns>

RestHandlerResponse Post(IRestProcessor processor, bool authenticated);

/// <summary>

/// Put method for RestHandler

/// </summary>

/// <param name="processor">The rest processor.</param>

/// <param name="authenticated">if set to <c>true</c> [authenticated].</param>

/// <returns>The http response</returns>

RestHandlerResponse Put(IRestProcessor processor, bool authenticated);

}

我们要定义一个HttpListener,先定义一个接口IRestListener:

/// <summary>

/// Listen an ip point and accept connection.

/// </summary>

public interface IRestListener : IDisposable

{

/// <summary>

/// Gets or sets the max allowed connections to this listener.

/// </summary>

int MaxConnections { get; set; }

/// <summary>

/// Gets or sets desktop rest manager.

/// </summary>

DesktopRestManager DesktopRestManager { get; set; }

/// <summary>

/// Gets a value that indicate if it is listening.

/// </summary>

bool IsRunning { get; }

/// <summary>

/// Gets or sets the server address information.

/// </summary>

IPEndPoint ServerAddress { get; set; }

string Protocol { get; set; }

/// <summary>

/// Start a listener.

/// </summary>

/// <returns>The ip end point to listen.</returns>

bool Start(TcpListener listener, IPEndPoint address);

/// <summary>

/// Stop the listener.

/// </summary>

/// <returns>True if successfully, else false.</returns>

bool Stop();

}

接下来实现

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

public class HttpListener : IRestListener

{

public HttpListener(DesktopRestManager drm)

{

this.desktopRestManager = drm;

this.isRunning = false;

MaxConnections = 50;

this.serverAddress = new IPEndPoint(new IPAddress(new byte[] { 127, 0, 0, 1 }), 10000);

this.Protocol = "Http";

}

#region IRestServer Members

//public event ServerStatusChangedHandler ServerStatusChanged;

public DesktopRestManager DesktopRestManager

{

get { return this.desktopRestManager; }

set { this.desktopRestManager = value; }

}

public bool IsRunning

{

get { return this.isRunning; }

}

public IPEndPoint ServerAddress

{

get { return this.serverAddress; }

set { this.serverAddress = value; }

}

public int MaxConnections

{

get;

set;

}

public string Protocol

{

get;

set;

}

public bool Start(TcpListener tcpListener, IPEndPoint address)

{

this.ServerAddress = address;

this.listener = tcpListener;

this.isRunning = true;

Thread th = new Thread(new ThreadStart(this.Listening));

th.Start();

return true;

}

public bool Stop()

{

bool success = true; ;

if (this.isRunning == true)

{

try

{

this.isRunning = false;

if (listener != null)

{

listener.Stop();

}

catch (SocketException socketEx)

{

_traceLog.InfoFormat("Stop http rest server: {0}", socketEx.Message);

success = false;

}

return success;

}

#endregion

#region IDisposable Members

public void Dispose()

{

this.Stop();

}

#endregion

#region Private Methods

private void Listening()

{

while (this.isRunning)

{

TcpClient tcpClient = null;

try

{

tcpClient = listener.AcceptTcpClient();

HttpConnection connection = new HttpConnection(tcpClient);

RestProcessor rh = new RestProcessor(this.desktopRestManager);

Thread processThread = new Thread(new ParameterizedThreadStart(req => connection.SendResponse(rh.HandleRequest(req as RestHandlerRequest))));

processThread.Name = "RestManager_Http_ProcessRequest";

processThread.Start(connection.GetRequest());

}

catch (SocketException socketEx)

{

if (this.isRunning)

{

_traceLog.InfoFormat("Socket exception: {0}", socketEx.Message);

}

else

{

_traceLog.Info("The use stop the http listener.");

}

if (tcpClient != null && tcpClient.Connected)

{

tcpClient.Close();

}

catch (System.ArgumentNullException ex)

{