php基于curl扩展制作跨平台的restfule 接口


Posted in PHP onMay 11, 2015

restfule 接口
适用的平台:跨平台
所依赖:curl扩展
git:https://git.oschina.net/anziguoer/restAPI

ApiServer.php

<?php
/**
 * @Author: yangyulong
 * @Email : anziguoer@sina.com
 * @Date:  2015-04-30 05:38:34
 * @Last Modified by:  yangyulong
 * @Last Modified time: 2015-04-30 17:14:11
 */
 
class apiServer
{
  /**
   * 客户端请求的方式
   * @var string
   */
  private $method = '';
 
  /**
   * 客户端发送的数据
   * @var [type]
   */
  protected $param;
 
  /**
   * 要操作的资源
   * @var [type]
   */
  protected $resourse;
 
  /**
   * 要操作的资源id
   * @var [type]
   */
  protected $resourseId;
 
 
  /**
   * 构造函数, 获取client 请求的方式,以及传输的数据
   * @param object 可以自定义传入的对象
   */
  public function __construct()
  {
    //首先对客户端的请求进行验证
    $this->authorization();
 
    $this->method = strtolower($_SERVER['REQUEST_METHOD']);
 
    //所有的请求都是pathinfo模式
    $pathinfo = $_SERVER['PATH_INFO'];
 
    //将pathinfo数据信息映射为实际请求方法
    $this->getResourse($pathinfo);
 
    //获取传输的具体参数
    $this->getData();
 
    //执行响应
    $this->doResponse();
  }
 
  /**
   * 根据不同的请求方式,获取数据
   * @return [type]
   */
  private function doResponse(){
    switch ($this->method) {
      case 'get':
        $this->_get();
        break;
      case 'post':
        $this->_post();
        break;
      case 'delete':
        $this->_delete();
        break;
      case 'put':
        $this->_put();
        break;
      default:
        $this->_get();
        break;
    }
  }
 
  // 将pathinfo数据信息映射为实际请求方法
  private function getResourse($pathinfo){
 
    /**
     * 将pathinfo数据信息映射为实际请求方法
     * GET /users: 逐页列出所有用户;
     * POST /users: 创建一个新用户;
     * GET /users/123: 返回用户为123的详细信息;
     * PUT /users/123: 更新用户123;
     * DELETE /users/123: 删除用户123;
     *
     * 根据以上规则,将pathinfo第一个参数映射为需要操作的数据表,
     * 第二个参数映射为操作的id
     */
     
    $info = explode('/', ltrim($pathinfo, '/'));
    list($this->resourse, $this->resourseId) = $info;
  }
 
  /**
   * 验证请求
   */
  private function authorization(){
    $token = $_SERVER['HTTP_CLIENT_TOKEN'];
    $authorization = md5(substr(md5($token), 8, 24).$token);
    if($authorization != $_SERVER['HTTP_CLIENT_CODE']){
      //验证失败,输出错误信息给客户端
      $this->outPut($status = 1);
    }
  }
 
  /**
   * [getData 获取传送的参数信息]
   * @param [type] $pad [description]
   * @return [type]   [description]
   */
  private function getData(){
    //所有的参数都是get传参
    $this->param = $_GET;
  }
 
  /**
   * 获取资源操作
   * @return [type] [description]
   */
  protected function _get(){
    //逻辑代码根据自己实际项目需要实现
  }  
 
  /**
   * 新增资源操作
   * @return [type] [description]
   */
  protected function _post(){
    //逻辑代码根据自己实际项目需要实现
  }
 
  /**
   * 删除资源操作
   * @return [type] [description]
   */
  protected function _delete(){
    //逻辑代码根据自己实际项目需要实现
  }
 
  /**
   * 更新资源操作
   * @return [type] [description]
   */
  protected function _put(){
    //逻辑代码根据自己实际项目需要实现
  }
 
  /**
   * 出入服务端返回的数据信息 json格式
   */
  public function outPut($stat, $data=array()){
    $status = array(
      //0 状态表示请求成功
      0 => array(
        'code' => 1,
        'info' => '请求成功',
        'data' =>$data
      ),
      //验证失败
      1 => array(
        'code' => 0,
        'info' => '请求不合法'
      )
    );
 
    try{
      if(!in_array($stat, array_keys($status))){
        throw new Exception('输入的状态码不合法');
      }else{
        echo json_encode($status[$stat]);
      }
    }catch (Exception $e){
      die($e->getMessage());
    }
  }
}

ApiClient.php

<?php
 
/**
 * Created by PhpStorm.
 * User: anziguoer@sina.com
 * Date: 2015/4/29
 * Time: 12:36
 * link: http://www.ruanyifeng.com/blog/2014/05/restful_api.html [restful设计指南]
 */
/*** * * * * * * * * * * * * * * * * * * * * * * * * * ***\
 * 定义路由的请求方式                  *
 *                            *
 * $url_model=0                     *
 * 采用传统的URL参数模式                 *
 * http://serverName/appName/?m=module&a=action&id=1   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * PATHINFO模式(默认模式)               *
 * 设置url_model 为1                   *
 * http://serverName/appName/module/action/id/1/     *
 ** * * * * * * * * * * * * * * * * * * * * * * * * * * **
*/
class restClient
{
  //请求的token
  const token='yangyulong';
 
  //请求url
  private $url;
   
  //请求的类型
  private $requestType;
   
  //请求的数据
  private $data;
   
  //curl实例
  private $curl;
 
  public $status;
 
  private $headers = array();
  /**
   * [__construct 构造方法, 初始化数据]
   * @param [type] $url     请求的服务器地址
   * @param [type] $requestType 发送请求的方法
   * @param [type] $data    发送的数据
   * @param integer $url_model  路由请求方式
   */
  public function __construct($url, $data = array(), $requestType = 'get') {
     
    //url是必须要传的,并且是符合PATHINFO模式的路径
    if (!$url) {
      return false;
    }
    $this->requestType = strtolower($requestType);
    $paramUrl = '';
    // PATHINFO模式
    if (!empty($data)) {
      foreach ($data as $key => $value) {
        $paramUrl.= $key . '=' . $value.'&';
      }
      $url = $url .'?'. $paramUrl;
    }
     
    //初始化类中的数据
    $this->url = $url;
     
    $this->data = $data;
    try{
      if(!$this->curl = curl_init()){
        throw new Exception('curl初始化错误:');
      };
    }catch (Exception $e){
      echo '<pre>';
      print_r($e->getMessage());
      echo '</pre>';
    }
 
    curl_setopt($this->curl, CURLOPT_URL, $this->url);
    curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, 1);
 
  }
   
  /**
   * [_post 设置get请求的参数]
   * @return [type] [description]
   */
  public function _get() {
 
  }
   
  /**
   * [_post 设置post请求的参数]
   * post 新增资源
   * @return [type] [description]
   */
  public function _post() {
 
    curl_setopt($this->curl, CURLOPT_POST, 1);
 
    curl_setopt($this->curl, CURLOPT_POSTFIELDS, $this->data);
     
  }
   
  /**
   * [_put 设置put请求]
   * put 更新资源
   * @return [type] [description]
   */
  public function _put() {
     
    curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'PUT');
  }
   
  /**
   * [_delete 删除资源]
   * delete 删除资源
   * @return [type] [description]
   */
  public function _delete() {
    curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
 
  }
   
  /**
   * [doRequest 执行发送请求]
   * @return [type] [description]
   */
  public function doRequest() {
    //发送给服务端验证信息
    if((null !== self::token) && self::token){
      $this->headers = array(
        'Client_Token: '.self::token,
        'Client_Code: '.$this->setAuthorization()
      );
    }
 
    //发送头部信息
    $this->setHeader();
 
    //发送请求方式
    switch ($this->requestType) {
      case 'post':
        $this->_post();
        break;
 
      case 'put':
        $this->_put();
        break;
 
      case 'delete':
        $this->_delete();
        break;
 
      default:
        curl_setopt($this->curl, CURLOPT_HTTPGET, TRUE);
        break;
    }
    //执行curl请求
    $info = curl_exec($this->curl);
 
    //获取curl执行状态信息
    $this->status = $this->getInfo();
    return $info;
  }
 
  /**
   * 设置发送的头部信息
   */
  private function setHeader(){
    curl_setopt($this->curl, CURLOPT_HTTPHEADER, $this->headers);
  }
 
  /**
   * 生成授权码
   * @return string 授权码
   */
  private function setAuthorization(){
    $authorization = md5(substr(md5(self::token), 8, 24).self::token);
    return $authorization;
  }
  /**
   * 获取curl中的状态信息
   */
  public function getInfo(){
    return curl_getinfo($this->curl);
  }
 
  /**
   * 关闭curl连接
   */
  public function __destruct(){
    curl_close($this->curl);
  }
}

testClient.php

<?php
/**
 * Created by PhpStorm.
 * User: anziguoer@sina.com
 * Date: 2015/4/29
 * Time: 12:35
 */
 
include './ApiClient.php';
 
$arr = array(
  'user' => 'anziguoer',
  'passwd' => 'yangyulong'
);
// $url = 'http://localhost/restAPI/restServer.php';
$url = 'http://localhost/restAPI/testServer.php/user/123';
 
$rest = new restClient($url, $arr, 'get');
$info = $rest->doRequest();
 
//获取curl中的状态信息
$status = $rest->status;
echo '<pre>';
print_r($info);
echo '</pre>';

testServer.php

<?php
/**
 * @Author: anziguoer@sina.com
 * @Email: anziguoer@sina.com
 * @link: https://git.oschina.net/anziguoer
 * @Date:  2015-04-30 16:52:53
 * @Last Modified by:  yangyulong
 * @Last Modified time: 2015-04-30 17:26:37
 */
 
include './ApiServer.php';
 
class testServer extends apiServer
{
  /**
   * 先执行apiServer中的方法,初始化数据
   * @param object $obj 可以传入的全局对象[数据库对象,框架全局对象等]
   */
   
  private $obj;
 
  function __construct()//object $obj
  {
    parent::__construct();
    //$this->obj = $obj;
    //$this->resourse; 父类中已经实现,此类中可以直接使用
    //$tihs->resourseId; 父类中已经实现,此类中可以直接使用
  }
   
  /**
   * 获取资源操作
   * @return [type] [description]
   */
  protected function _get(){
    echo "get";
    //逻辑代码根据自己实际项目需要实现
  }  
 
  /**
   * 新增资源操作
   * @return [type] [description]
   */
  protected function _post(){
    echo "post";
    //逻辑代码根据自己实际项目需要实现
  }
 
  /**
   * 删除资源操作
   * @return [type] [description]
   */
  protected function _delete(){
    //逻辑代码根据自己实际项目需要实现
  }
 
  /**
   * 更新资源操作
   * @return [type] [description]
   */
  protected function _put(){
    echo "put";
    //逻辑代码根据自己实际项目需要实现
  }
}
 
$server = new testServer();

以上所述就是本文的全部内容了,希望大家能够喜欢。

PHP 相关文章推荐
PHP时间戳与日期之间转换的实例介绍
Apr 19 PHP
解析zend Framework如何自动加载类
Jun 28 PHP
教你如何用php实现LOL数据远程获取
Jun 10 PHP
Yii核心组件AssetManager原理分析
Dec 02 PHP
PHP中使用CURL获取页面title例子
Jan 07 PHP
PHP文件缓存类示例分享
Jan 30 PHP
使用 PHPStorm 开发 Laravel
Mar 24 PHP
php获取微信共享收货地址的方法
Dec 21 PHP
php实现的AES加密类定义与用法示例
Jan 29 PHP
PHP explode()函数用法讲解
Feb 15 PHP
PHP基于session.upload_progress 实现文件上传进度显示功能详解
Aug 09 PHP
gearman中任务的优先级和返回状态实例分析
Feb 27 PHP
PHP SPL标准库中的常用函数介绍
May 11 #PHP
PHP中的类型约束介绍
May 11 #PHP
PHP SPL标准库之接口(Interface)详解
May 11 #PHP
PHP SPL标准库之文件操作(SplFileInfo和SplFileObject)实例
May 11 #PHP
PHP设计模式之适配器模式代码实例
May 11 #PHP
Mac环境下php操作mysql数据库的方法分享
May 11 #PHP
PHP设计模式之装饰者模式代码实例
May 11 #PHP
You might like
全国FM电台频率大全 - 23 四川省
2020/03/11 无线电
php生成SessionID和图片校验码的思路和实现代码
2009/03/10 PHP
php基础设计模式大全(注册树模式、工厂模式、单列模式)
2015/08/31 PHP
PHP filesize函数用法浅析
2019/02/15 PHP
简短几句 通俗解释javascript的闭包
2011/01/17 Javascript
重构Javascript代码示例(重构前后对比)
2013/01/23 Javascript
Extjs中RowExpander控件的默认展开问题示例探讨
2014/01/24 Javascript
Javascript数组操作函数总结
2015/02/05 Javascript
Vue 仿百度搜索功能实现代码
2017/02/16 Javascript
如何在AngularJs中调用第三方插件库
2017/05/21 Javascript
从零开始搭建一个react项目开发
2018/02/09 Javascript
对VUE中的对象添加属性
2018/09/18 Javascript
vue element 生成无线级左侧菜单的实现代码
2019/08/21 Javascript
详解vue3.0 diff算法的使用(超详细)
2020/07/01 Javascript
js实现拖拽与碰撞检测
2020/09/18 Javascript
pandas数据框,统计某列数据对应的个数方法
2018/04/11 Python
python print 按逗号或空格分隔的方法
2018/05/02 Python
元组列表字典(莫烦python基础)
2019/04/03 Python
django云端留言板实例详解
2019/07/22 Python
Python使用python-docx读写word文档
2019/08/26 Python
python给list排序的简单方法
2020/12/10 Python
html5实现的便签特效(实战分享)
2013/11/29 HTML / CSS
HealthElement海外旗舰店:新西兰大卖场
2018/02/23 全球购物
美国折衷生活方式品牌:Robert Graham
2018/07/13 全球购物
Linux管理员面试题 Linux admin interview questions
2014/11/01 面试题
行政助理岗位职责范文
2013/12/03 职场文书
大学生职业生涯规划方案
2014/01/03 职场文书
大学生职业生涯规划书参考模板
2014/03/05 职场文书
毕业晚会主持词
2014/03/24 职场文书
捐书活动总结
2014/05/04 职场文书
技术负责人任命书
2014/06/05 职场文书
2014年小学生教师节演讲稿范文
2014/09/10 职场文书
小学六一儿童节活动总结
2015/05/05 职场文书
工作表现证明
2015/06/15 职场文书
大学生暑假实习总结
2015/07/13 职场文书
中国式结婚:司仪主持词(范文)
2019/07/25 职场文书