实践基于REST风格的Webservice(PHP,C#)

简介:


概念:

WEB服务的风格,从维基百科上查了一下,有不下十几种,但是比较常用的就是REST和RPC。其中,基于SOAP协议的Webservice就是RPC风格的。

REST全称Representational State Transfer。它是基于无状态的,cs结构的,可以缓存的通信协议。事实上,它是使用 HTTP协议的。某些观点来看,互联网本身就是基于HTTP的,因此也可以认为是一种基于REST风格的Webservice。REST风格的Webservice对于SOAP,CORBA(一种和SOAP互相竞争的协议)来说,属于轻量级。请求较之于也比较简单。比如,用SOAP的Webservice的请求可能是如下这样的一个XML,有用的信息都被包括在冗余的信息中:

<?xml version="1.0"?>

<soap:Envelope

xmlns:soap="http://www.w3.org/2001/12/soap-envelope"

soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

<soap:body pb="http://www.acme.com/phonebook">

 <pb:GetUserDetails>

  <pb:UserID>12345</pb:UserID>

 </pb:GetUserDetails>

</soap:Body>

</soap:Envelope>

 

而使用REST的请求就很简单,只是一个URL地址:http://www.acme.com/phonebook/UserDetails/12345,只需要使用浏览器就能验证这个REST的Webservice是否正常。HTTP的请求方式有多种,GET,POST,PUT,PATCH,DELETE。REST同样可以利用这些请求方式。REST的Webservice的响应通常是一个XML文件,但是和SOAP不同的是,REST并不一定需要响应返回XML文件,它也可以是CSV格式或者Json格式。

很多公司都采用REST风格的Webservice,比如 Google Glass API,Twitter,Yahoo,Flickr,Amazon等。比如Google有一个Webservice,Google Maps API,它提供2种输出格式,JSON和XML。地址分别是http://maps.googleapis.com/maps/api/geocode/json?parameters和http://maps.googleapis.com/maps/api/geocode/xml?parameters

该服务的具体使用方法和参数满可以查阅https://developers.google.com/maps/documentation/geocoding/?hl=zh-CN&csw=1#XML

演示:

下面演示一个基于PHP语言开发的REST风格的webservice。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?php
switch ( $_SERVER [ 'REQUEST_METHOD' ])
{
     case  'GET' :
         $id = $_GET [ "id" ];
         $arrayid  explode ( "," $id );
         search( $arrayid );
         break ;
     case  'POST' :
         $id = $_POST [ "id" ];
         $username = $_POST [ "username" ];
         $sex = $_POST [ "sex" ];
         $age = $_POST [ "age" ];
                                       
         add( $id , $username , $sex , $age );
         break ;
     default :
         exit ();
}
function  search( $arrayid )
{
     $users =getCsvFile( "example.csv" );
     $string = "" ;
     foreach ( $users  as  $a )
     {
         $id = $a [0];
         if (in_array( $id , $arrayid ))
         {
             $string .= <<<EOF
     <user id= "$a[0]" >
         <name> $a [1]</name>
         <sex> $a [2]</sex>
         <age> $a [3]</age>
     </user>
EOF;
         }
     }
     $string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n"
             . "<data>\r\n"
             . $string
             . "</data>" ;
                                   
     header( "Content-type:application/xml" );
     print ( $string );
                                   
}
function  add( $id , $username , $sex , $age )
{
     $users =getCsvFile( "example.csv" );
     $string = "$id,$username,$sex,$age" ;
                                   
     WriteLinetxt( $string , "example.csv" );
                                   
     $string = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n"
             . "<return>\r\n"
             . "  <status>0</status>\r\n"
             . "</return>\r\n" ;
                                   
     header( "Content-type:application/xml" );
     print ( $string );
                                   
}
function  getCsvFile( $filepath )
     {
         $handle =null;
         $returnvalue = array ();
         try
         {
             $handle  fopen ( $filepath , "r" );
             while  ( $data  fgetcsv ( $handle , 1000,  "," ))
             {
                 array_push ( $returnvalue , $data );
             }
             fclose( $handle );
         }
         catch (Exception  $e )
         {
             fclose( $handle );
             $handle =null;
             die ( "Error!: " . $e ->getMessage(). "<br/>" );
         }
                                       
         return  $returnvalue ;
     }
function  WriteLinetxt( $content , $filename )
{
         file_put_contents ( $filename $content . "\r\n" ,FILE_APPEND);
}
?>

代码说明:

上述代码,根据请求的方式是POST还是GET来区分,如果是GET的话,则需带上查询的ID。服务会返回一个Content-type为application/xml的一份xm文档。如果是POST的话,则会把相应的POST进来的值写入到数据库。

本例中,数据库只是简单的采用CSV文件,即用逗号分割数据的文本文件。数据文件如下:

CBD247FF7AF9473193DC06EB24DBCCC8

由于REST风格的web服务可以通过浏览器验证,因此可以输入url地址测试。本例中没有采用url重写,如果使用url重写的话,服务地址会更友好。

D87BE31CF24D416BA901BA11EF15A2A6

服务部署好之后,就可以调用了。在PHP中,可以通过simplexml_load_file方法,get到这个xml文件。

1
2
3
4
5
<?php
$url = "http://localhost:8080/b.php?id=1001,1003,1004" ;
$response =simplexml_load_file( $url );
var_dump( $response );
?>

74A2BDE9531F4A879C284A805D575126

通过var_dump,可以看到获得的直接是一个SimpleXMLElement对象,当然你也可以把它转换成string对象。

下面用php代码实现模拟POST数据。PHP常用的模拟POST动作的方法有3种,分别为Curl、socket、file_get_contents,这里还是采用file_get_contents方法。代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php
$url = "http://localhost:8080/b.php" ;
$data  array
(
     'id'  =>  '1990' ,
     'username'  =>  '小张' ,
     'sex'  =>  '男' ,
'age' => '20'
);
$post_string =http_build_query( $data );
$context  array (
     'http'  =>  array (
         'method'  =>  'POST' ,
'header' => 'content-type: application/x-www-form-urlencoded' ,
         'content'  =>  $post_string )
     );
$stream_context  = stream_context_create( $context );
$response  file_get_contents ( $url , false,  $stream_context );
$xml =simplexml_load_string( $response );
var_dump( $xml );
?>

代码中,模拟了POST提交,并且获得了返回的string,再把string转成了SimpleXMLElement对象。而且数据库中数据也已经写入。

5ABB6024DDF8491FAE0A051F8E524C15

C#版本访问:

C#也可以通过代码调用PHP写的REST风格的Webservice。代码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
class  Program
    {
        static  void  Main( string [] args)
        {
            string [] paramName = {  "id"  };
            string [] paramVal = {  "1001,1004"  };
            var  p = HttpGet( "http://localhost:8080/b.php" , paramName, paramVal);
            Console.WriteLine(p);
            Console.WriteLine( "-------------------------------" );
            string [] paramName1 = {  "id" "username" "sex" "age"  };
            string [] paramVal1 = {  "1030" "tom" "男" "23"  };
            var  p1 = HttpPost( "http://localhost:8080/b.php" , paramName1, paramVal1);
            Console.WriteLine(p1);
        }
        static  string  HttpGet( string  url,  string [] paramName,  string [] paramVal)
        {
            StringBuilder paramz =  new  StringBuilder();
            for  ( int  i = 0; i < paramName.Length; i++)
            {
                paramz.Append(paramName[i]);
                paramz.Append( "=" );
                paramz.Append(HttpUtility.UrlEncode(paramVal[i]));
                paramz.Append( "&" );
            }
            url +=  "?"  + paramz.ToString();
            HttpWebRequest req = WebRequest.Create(url)  as  HttpWebRequest;
            string  result =  null ;
            using  (HttpWebResponse resp = req.GetResponse()  as  HttpWebResponse)
            {
                StreamReader reader =  new  StreamReader(resp.GetResponseStream());
                result = reader.ReadToEnd();
            }
            return  result;
        }
        static  string  HttpPost( string  url,  string [] paramName,  string [] paramVal)
        {
            HttpWebRequest req = WebRequest.Create( new  Uri(url))  as  HttpWebRequest;
            req.Method =  "POST" ;
            req.ContentType =  "application/x-www-form-urlencoded" ;
            // Build a string with all the params, properly encoded.
            // We assume that the arrays paramName and paramVal are
            // of equal length:
            StringBuilder paramz =  new  StringBuilder();
            for  ( int  i = 0; i < paramName.Length; i++)
            {
                paramz.Append(paramName[i]);
                paramz.Append( "=" );
                paramz.Append(HttpUtility.UrlEncode(paramVal[i]));
                paramz.Append( "&" );
            }
            // Encode the parameters as form data:
            byte [] formData = UTF8Encoding.UTF8.GetBytes(paramz.ToString());
            req.ContentLength = formData.Length;
            // Send the request:
            using  (Stream post = req.GetRequestStream())
            {
                post.Write(formData, 0, formData.Length);
            }
            // Pick up the response:
            string  result =  null ;
            using  (HttpWebResponse resp = req.GetResponse()  as  HttpWebResponse)
            {
                StreamReader reader =  new  StreamReader(resp.GetResponseStream());
                result = reader.ReadToEnd();
            }
            return  result;
        }
    }

F8FED7F3BB7C4808801FE1FA3AC1C220

参考文档:

http://geeknizer.com/rest-vs-soap-using-http-choosing-the-right-webservice-protocol/

http://msdn.microsoft.com/zh-cn/magazine/dd942839.aspx

http://www.gen-x-design.com/archives/create-a-rest-api-with-php/

http://rest.elkstein.org/2008/02/what-is-rest.html

















本文转自cnn23711151CTO博客,原文链接: http://blog.51cto.com/cnn237111/1285298,如需转载请自行联系原作者



相关文章
|
2月前
|
存储 安全 数据库连接
C#深度揭秘:常量的魅力和实践,一文让你从新手到专家
C#深度揭秘:常量的魅力和实践,一文让你从新手到专家
18 0
|
2月前
|
程序员 PHP
PHP程序员的成长之路:技术探索与实践
在当今数字化时代,PHP作为一种广泛应用的后端编程语言,对于程序员而言具有重要意义。本文从技术探索和实践的角度出发,探讨了PHP程序员在成长过程中所面临的挑战与机遇,以及如何通过持续学习与实践不断提升自身技能。
|
2天前
|
存储 缓存 自然语言处理
深入PHP内核:理解OPcache的工作原理与优化实践
【5月更文挑战第6天】 在现代Web开发中,提升性能和响应速度是持续追求的目标。PHP作为一种广泛使用的服务端脚本语言,其执行效率至关重要。本文将深入探索PHP的OPcache(优化器缓存)组件,解析其如何改善PHP的性能表现。通过剖析OPcache的工作机制,我们将讨论有效的配置策略以及实践中的最佳优化方法,旨在帮助开发者充分理解并利用OPcache来提升应用性能。
|
8天前
|
PHP 开发者
PHP中的命名空间深入理解与实践
【4月更文挑战第30天】在现代PHP开发中,命名空间是管理代码中类名和函数名冲突的重要工具。本文将探讨PHP命名空间的核心概念、实现机制及其在实际项目中的应用场景,帮助开发者更有效地组织和维护大型项目代码。我们将通过实例分析如何利用命名空间避免常见的名称冲突问题,并提供最佳实践建议。文章旨在为有一定PHP基础的开发人员提供进阶指导,使其能够在复杂的项目结构中灵活运用命名空间。
|
9天前
|
设计模式 算法 搜索推荐
【PHP开发专栏】PHP设计模式解析与实践
【4月更文挑战第29天】本文介绍了设计模式在PHP开发中的应用,包括创建型(如单例、工厂模式)、结构型和行为型模式(如观察者、策略模式)。通过示例展示了如何在PHP中实现这些模式,强调了它们在提升代码可维护性和可扩展性方面的作用。设计模式是解决常见问题的最佳实践,但在使用时需避免过度设计,根据实际需求选择合适的设计模式。
|
9天前
|
编译器 PHP
深入理解PHP 8.0的新特性及实践应用
【4月更文挑战第29天】在这篇文章中,我们将深入探讨PHP 8.0的新特性及其在实际开发中的应用。通过对新特性的详细解析,我们将了解到PHP 8.0如何提高开发效率,优化代码质量,以及提升应用程序的性能。同时,我们还将通过实际案例,展示如何在项目中应用这些新特性,以实现更高效、更稳定的开发环境。
|
14天前
|
缓存 安全 JavaScript
PHP 7.4新特性解析与实践
【4月更文挑战第24天】 在这篇文章中,我们将深入探讨PHP 7.4版本的新特性,并通过实际示例代码展示如何将这些新特性应用于日常开发工作中。我们将重点介绍预加载优化、类型化属性、箭头函数等重要更新,并分析这些新特性对性能和编码习惯的影响。通过本文,读者将获得对PHP 7.4新特性的全面理解,以及如何有效地利用这些新工具来提升代码质量和开发效率。
|
18天前
|
存储 C# 开发者
掌握 C#编程:关键技术与实践
【4月更文挑战第20天】掌握C#编程的关键技术,包括面向对象编程、数据类型、控制流、异常处理、集合泛型、委托事件和异步编程。通过学习基础、实践项目、代码调试、参考优秀代码、社区交流和持续学习来提升技能。注重代码质量,以开发高质量应用程序。
|
1月前
|
PHP
PHP 7.4的新特性及实践应用
【4月更文挑战第2天】本文主要介绍了PHP 7.4的新特性,并通过实例代码展示了如何在实际项目中应用这些新特性。文章首先简要回顾了PHP的发展历史,然后详细分析了PHP 7.4的新特性,包括预加载、数组解构、扩展的返回类型声明等。接下来,通过实际代码示例,演示了如何在项目中使用这些新特性。最后,总结了PHP 7.4新特性的优势和局限性,并展望了PHP未来的发展趋势。