php RESTful 客户端

当PHP作为客户端去对接resuful api的时候,手动封装一个专门请求api的类,代码如下

<?php
namespace app\api\service;


/**
 * CURL数据请求管理器
 * Class Http
 */
class HttpService
{
    //注意如果请求内容为json,则要把post请求中的form-data  进行json_encode已经修改对应的header
    public static $headers = ['Content-Type:application/x-www-form-urlencoded;charset=UTF-8;'];


    /**
     * 设置头信息
     * @param array $headers 头信息
     */
    public static function setHeader($headers){
        self::$headers = array_merge(self::$headers,$headers);
    }

    /**
     * 以get模拟网络请求
     * @param string $url HTTP请求URL地址
     * @param array $query GET请求参数
     * @param array $options CURL参数
     * @return boolean|string
     */
    public static function get($url, $query = [], $options = []){
        $options['query'] = $query;
        return self::request('get', $url, $options);
    }

    /**
     * 以POST模拟网络请求
     * @param string $url HTTP请求URL地址
     * @param array $data POST请求数据
     * @param array $options CURL参数
     * @return boolean|string
     */
    public static function post($url, $data = [], $options = []){
        $options['data'] = $data;
        return self::request('post', $url, $options);
    }

    /**
     * 以DELETE模拟网络请求
     * @param string $url HTTP请求URL地址
     * @param array $data DELETE请求数据
     * @param array $options CURL参数
     * @return boolean|string
     */
    public static function delete($url,$query = [],$options = []){
        $options['query'] = $query;
        return self::request('delete', $url, $options);
    }

    /**
     * 以PUT模拟网络请求
     * @param string $url HTTP请求URL地址
     * @param array $data DELETE请求数据
     * @param array $options CURL参数
     * @return boolean|string
     */
    public static function put($url,$data = [],$options = []){
        $options['data'] = $data;
        return self::request('put', $url, $options);
    }

    /**
     * CURL模拟网络请求
     * @param string $method 请求方法
     * @param string $url 请求方法
     * @param array $options 请求参数[headers,data]
     * @return boolean|string
     */
    public static function request($method, $url, $options = []){
        $curl = curl_init();
        // GET 参数设置
        if (!empty($options['query'])) {
            $url .= (stripos($url, '?') !== false ? '&' : '?') . http_build_query($options['query']);
        }
        // 浏览器代理设置
        curl_setopt($curl, CURLOPT_USERAGENT, self::getUserAgent());
        // CURL 头信息设置
        if (!empty($options['headers'])) {
            self::$headers = array_merge(self::$headers,$options['headers']);
        }
        curl_setopt($curl, CURLOPT_HTTPHEADER, self::$headers);

        // Cookie 信息设置
        if (!empty($options['cookie'])) {
            curl_setopt($curl, CURLOPT_COOKIE, $options['cookie']);
        }

        if (!empty($options['cookie_file'])) {
            curl_setopt($curl, CURLOPT_COOKIEJAR, $options['cookie_file']);
            curl_setopt($curl, CURLOPT_COOKIEFILE, $options['cookie_file']);
        }

        // POST 数据设置
        if (strtolower($method) === 'post') {
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, self::buildQueryData($options['data']));
        }

        //PUT 数据设置
        if (strtolower($method) === 'put') {
            curl_setopt($curl, CURLOPT_POSTFIELDS,self::buildQueryData($options['data']));
        }

        // 请求超时设置
        if (isset($options['timeout']) && is_numeric($options['timeout'])) {
            curl_setopt($curl, CURLOPT_TIMEOUT, $options['timeout']);
        } else {
            curl_setopt($curl, CURLOPT_TIMEOUT, 60);
        }
        curl_setopt($curl, CURLOPT_URL, $url);
        curl_setopt($curl, CURLOPT_HEADER, false);
        curl_setopt($curl, CURLOPT_AUTOREFERER, true);
        curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($curl,CURLINFO_HEADER_OUT,true);
        curl_setopt($curl, CURLOPT_CUSTOMREQUEST, strtoupper($method));
        $content = json_decode(curl_exec($curl),true);
        $content['status'] = curl_getinfo ( $curl, CURLINFO_HTTP_CODE );
        if($content['code'] != 200) {
              //在这里处理异常信息
        }
        curl_close($curl);
        return $content;
    }

    /**
     * POST数据过滤处理
     * @param array $data 需要处理的数据
     * @param boolean $build 是否编译数据
     * @return array|string
     */
    private static function buildQueryData($data, $build = true)
    {
        if (!is_array($data)) return $data;
        foreach ($data as $key => $value) if (is_object($value) && $value instanceof \CURLFile) {
            $build = false;
        } elseif (is_string($value) && class_exists('CURLFile', false) && stripos($value, '@') === 0) {
            if (($filename = realpath(trim($value, '@'))) && file_exists($filename)) {
                list($build, $data[$key]) = [false, new \CURLFile($filename)];
            }
        }
        return $build ? http_build_query($data) : $data;
    }

    /**
     * 获取浏览器代理信息
     * @return string
     */
    private static function getUserAgent(){
        if (!empty($_SERVER['HTTP_USER_AGENT'])) return $_SERVER['HTTP_USER_AGENT'];
        $userAgents = [
            "Mozilla/5.0 (Windows NT 6.1; rv:2.0.1) Gecko/20100101 Firefox/4.0.1",
            "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.57 Safari/536.11",
            "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:38.0) Gecko/20100101 Firefox/38.0",
            "Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; .NET4.0C; .NET4.0E; .NET CLR 2.0.50727; .NET CLR 3.0.30729; .NET CLR 3.5.30729; InfoPath.3; rv:11.0) like Gecko",
            "Mozilla/5.0 (Windows; U; Windows NT 6.1; en-us) AppleWebKit/534.50 (KHTML, like Gecko) Version/5.1 Safari/534.50",
            "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; Trident/4.0)",
            "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)",
            "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.6; rv:2.0.1) Gecko/20100101 Firefox/4.0.1",
            "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_0) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
        ];
        return $userAgents[array_rand($userAgents, 1)];
    }

}

调用(本文对接环信为例) base

<?php


namespace app\api\service\sdk\huanxin;



use app\api\service\HttpService;

/**
 * @author jinanav 
 * @desc 环信基础务器类
 */
class BaseService {

    //配置参数
    protected $config = [];
    //令牌
    protected $token = '';

    /**
     * BaseService constructor.初始化
     */
    public function __construct(array $config = []){
        $this->config = config('huanxin.');
        !empty($config) && $this->config = array_merge($this->config,$config);
        empty($this->config) && ajaxReturn(500,'配置参数异常');
        $this->token = $this->getToken();
        HttpService::setHeader(['Authorization:Bearer '.$this->token]);
    }

    /**
     * 获取管理员权限
     * @author jinanav
     * @return array | string
     */
    public function getToken(){
        //获取环信token
        $token = cache('huanxin_token');
        if(!empty($token) && time() < $token['expires_in']) return $token['access_token'];
        //如果已过期
        $token = HttpService::post($this->config['url_fix'].'token', [
            'grant_type'    => 'client_credentials',
            'client_id'     => $this->config['client_id'],
            'client_secret' => $this->config['client_secret']
        ]);
        //缓存token
        $token['expires_in'] = time() + intval($token['expires_in']) - 600;
        cache('huanxin_token',$token);
        return $token['access_token'];
    }
}

调用用户类

<?php


namespace app\api\service\sdk\huanxin\user;



use app\api\service\HttpService;
use app\api\service\sdk\huanxin\BaseService;
/**
 * @author jinanav  
 * @desc 环信用户管理服务类
 */
class UserService extends BaseService {


    /**
     * 注册单个用户
     * @author jinanav 
     * @return mixed
     */
    public function registerUser($username,$password,$nickname){
        $url = $this->config['url_fix'].'users';
        $param = [
            'username' => $username,
            'password' => $password,
            'nickname' => $nickname
        ];
        return HttpService::post($url,$param);
    }

    /**
     * 批量注册用户
     * @author jinanav  
     * @param array $regArray 批量用户列表
     * @return mixed
     */
    public function registerMoreUser(array $regArray){
        $url = $this->config['url_fix'].'users';
        return HttpService::post($url,$regArray);
    }

    /**
     * 获取单个用户
     * @author jinanav 
     * @param string $username 用户名 (实际上是手机号)
     * @return mixed
     */
    public function getUser(string  $username){
        $url = $this->config['url_fix'].'users/'.$username;
        return HttpService::get($url);
    }

    /**
     * 获取批量用户
     * @author jinanav 
     * @return mixed
     */
    public function getMoreUser($limit = 15,$cursor = ''){
        $url = $this->config['url_fix'].'users';
        $param = empty($cursor) ? ['limit' => $limit,'cursor' => $limit] : [];
        return HttpService::get($url,$param);
    }

    /**
     * 删除单个用户
     * @author jinanav 
     * @return mixed
     */
    public function delUser($username){
        $url = $this->config['url_fix'].'users/'.$username;
        return HttpService::delete($url);
    }

    /**
     * 删除多个用户
     * @author jinanav  
     * @param int $limit 用户数目
     * @return mixed
     */
    public function delMoreUser($limit = 0){
        $url = $this->config['url_fix'].'users/';
        return HttpService::delete($url,['limit' => $limit]);
    }

    /**
     * 更改密码
     * @author jinanav  
     * @param string $username 用户名
     * @param string $password 密码
     * @return mixed
     */
    public function changePassword($username,$password){
        $url = $this->config['url_fix'].'users/'.$username.'/password';
        return HttpService::put($url,['newpassword'=>$password]);
    }

    /**
     * 设置推送昵称
     * @author jinanav 
     * @param string $nickname 推送昵称
     * @return mixed
     */
    public function setNickname($nickname){
        $url = $this->config['url_fix'].'users/nickname';
        return HttpService::put($url,['nickname'=>$nickname]);
    }

    /**
     * 设置推送消息展示方式
     * @author jinanav  
     * @param int $notification_display_style 展示方式 “0”仅通知,“1“通知以及消息详情
     * @return mixed
     */
    public function notification($username,$notification_display_style){
        $url = $this->config['url_fix'].'users/'.$username;
        return HttpService::put($url,['notification_display_style'=>$notification_display_style]);
    }

    /**
     * 设置免打扰
     * @author jinanav 
     * @param string $username 用户名
     * @param int $disturbing 是否免打扰,“0”代表免打扰关闭,“1”免打扰开启
     * @param int $start 免打扰起始时间,单位是小时
     * @param int $end 免打扰结束时间,单位是小时
     * @return mixed
     */
    public function disturbing($username,$disturbing,$start,$end){
        $url = $this->config['url_fix'].'users/'.$username;
        return HttpService::put($url,[
            'notification_no_disturbing'        =>  $disturbing,
            'notification_no_disturbing_start'  =>  $start,
            'notification_no_disturbing_end'    =>  $end,
        ]);
    }

    /**
     * 用户账号禁用
     * @author jinanav 
     * @param string $username 用户名
     * @return mixed
     */
    public function deactivate($username){
        $url = $this->config['url_fix'].'users/'.$username.'/deactivate';
        return HttpService::post($url);
    }

    /**
     * 用户账号解禁
     * @author jinanav 
     * @param string $username 用户名
     * @return mixed
     */
    public function activate($username){
        $url = $this->config['url_fix'].'users/'.$username.'/activate';
        return HttpService::post($url);
    }

    /**
     * 强制下线
     * @author jinanav 
     * @param string $username 用户名
     * @return mixed
     */
    public function disconnect($username){
        $url = $this->config['url_fix'].'users/'.$username.'/disconnect';
        return HttpService::post($url);
    }


}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,701评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,649评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,037评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,994评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,018评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,796评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,481评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,370评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,868评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,014评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,153评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,832评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,494评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,039评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,437评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,131评论 2 356