实践基于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,如需转载请自行联系原作者



相关文章
|
4月前
|
PHP
PHP中的面向对象编程:基础与实践
【10月更文挑战第42天】在PHP的世界里,面向对象编程(OOP)是构建可维护、可扩展应用程序的关键。本文将深入探讨如何在PHP中运用OOP原则来设计软件,从类和对象的创建到继承、多态性以及封装的应用,我们将一一解析。通过实际代码示例,你将学会如何将理论转化为高效的代码实践。
|
3月前
|
PHP 开发者 UED
PHP中的异常处理:理解与实践
在编程世界中,错误和意外是不可避免的。PHP提供了一套异常处理机制,帮助开发者优雅地管理这些问题。本文将引导你理解PHP中异常处理的基本概念,并通过实际代码示例展示如何捕获和处理异常。我们将从基础开始,逐步深入,确保你能掌握这一技能。
66 21
|
3月前
|
缓存 API C#
C# 一分钟浅谈:GraphQL 与 REST 比较
本文对比了REST和GraphQL两种流行的API设计风格,从概念、优缺点及C#实现角度进行了详细分析,并提供了代码示例。REST以其简单易懂和无状态特性著称,而GraphQL则通过精确获取和单次请求的优势,提高了数据获取效率。文章还讨论了常见问题与解决策略,帮助开发者根据实际需求选择合适的API设计风格。
75 10
|
3月前
|
SQL 安全 PHP
PHP安全性实践:防范常见漏洞与攻击####
本文深入探讨了PHP编程中常见的安全漏洞及其防范措施,包括SQL注入、XSS跨站脚本攻击、CSRF跨站请求伪造等。通过实际案例分析,揭示了这些漏洞的危害性,并提供了具体的代码示例和最佳实践建议,帮助开发者提升PHP应用的安全性。 ####
107 6
|
3月前
|
存储 关系型数据库 MySQL
PHP与MySQL动态网站开发:从基础到实践####
本文将深入探讨PHP与MySQL的结合使用,展示如何构建一个动态网站。通过一系列实例和代码片段,我们将逐步了解数据库连接、数据操作、用户输入处理及安全防护等关键技术点。无论您是初学者还是有经验的开发者,都能从中获益匪浅。 ####
|
3月前
|
PHP 开发者
PHP命名空间的深入理解与实践####
本文作为一篇技术性文章,将引领读者深入探索PHP命名空间的概念、重要性及其在实际开发中的应用。我们将从命名空间的基本定义出发,逐步剖析其在大型项目中解决代码冲突、提升代码组织性和可维护性方面的关键作用。通过实例解析和最佳实践分享,帮助开发者更好地理解和运用PHP命名空间,从而优化项目结构和提高开发效率。 ####
|
4月前
|
PHP 开发者
PHP中的面向对象编程:基础与实践
在PHP的世界里,面向对象编程(OOP)是一块基石,它让代码的复用和维护变得简单。本文将带你一探究竟,从对象的创建到继承、封装和多态的应用,我们将一起构建一个简易的在线图书馆系统。准备好了吗?让我们开始吧!
39 2
|
4月前
|
程序员 PHP 开发者
PHP中的异常处理:理解与实践
【10月更文挑战第36天】在编程的海洋里,异常处理是导航灯塔,指引我们避开错误的暗礁。本文将深入浅出地介绍PHP中如何通过try-catch语句来处理程序运行中的异常情况。我们将从基础语法入手,逐步过渡到高级用法,最后以一个实战案例来巩固知识点。无论你是PHP新手还是有经验的开发者,这篇文章都将帮助你提升代码的健壮性和可维护性。
|
4月前
|
SQL 安全 数据挖掘
PHP表单的多方面应用与实践
通过本文的介绍,我们详细探讨了PHP表单的多方面应用与实践。从表单创建、数据验证、安全性、文件上传到多步表单处理,每个方面都有具体的示例和说明。通过掌握这些技术,开发者可以有效地处理表单数据,确保应用的安全性和可靠性。希望本文能为您在PHP开发中提供有价值的参考和指导。
54 2
|
3月前
|
SQL 关系型数据库 MySQL
PHP与MySQL的高效交互:从基础到实践####
本文深入探讨了PHP与MySQL数据库之间的高效交互技术,涵盖了从基础连接到高级查询优化的全过程。不同于传统的摘要概述,这里我们直接以一段精简代码示例作为引子,展示如何在PHP中实现与MySQL的快速连接与简单查询,随后文章将围绕这一核心,逐步展开详细讲解,旨在为读者提供一个从入门到精通的实战指南。 ```php <?php // 数据库配置信息 $servername = "localhost"; $username = "root"; $password = "password"; $dbname = "test_db"; // 创建连接 $conn = new mysqli($se
106 0