仅供参考， cURL 二次封装的类库 Curl_Manager

Posted on by
cURL是一个可以在命令行下发起http请求的工具，phpl有调用ibcurl的适配器(adapter)，所以在php里可以很方便的使用这个工具。

在使用cURL的过程中是否觉得难以使用，选项太多，没有封装，使用不够方便？

为了方便使用，我对php的cURL进行了二次封装，基于组合模式，使用灵活，能满足多数应用场景，经过我长期的实践。

  • 支持 ssl/proxy
  • 支持 cookie，会记录所有请求的cookie并带上(如需获得cookie的值，需要自己解析)
  • 支持常见请求方法get/post/put/delete 等等RESTFul所需要的方法
  • 支持文件上传
  • 支持返回http报文和报头
  • 支持带cookie的follow location(如果使用curl_setopt($this->_ch, CURLOPT_FOLLOWLOCATION, true);cookie并不会自动带上)
  • 解决cURL请求lighttpd会产生417 Expectation Failed错误的问题

实际上Curl_Manager并没有开发到心目中理想的样子，但并不妨碍使用，仅供各位参考:)

测试例子：

Php代码  收藏代码
  1. <?php
  2. require_once(“Curl_Manager.php”);
  4. $manager = new Curl_Manager();
  6. $manager->set_action(‘gg’, ‘http://www.google.com/’, ‘http://willko.iteye.com/’);//设置动作，(动作名称, 动作对应url，来源referer)
  8. $manager->open()->get(‘gg’); //打开一个请求，进行get操作
  10. echo $manager->body(); // 获得报文
  11. echo $manager->header(); // 获得报头(需要自己解析)
  13. //发起ssl请求
  14. $manager->set_action(‘taobao’, ‘https://login.taobao.com/member/login.jhtml?f=top&redirectURL=http://www.taobao.com/’, ‘http://willko.iteye.com/’);
  16. $manager->ssl()->get(‘taobao’); //使用ssl方法，让当前这个请求支持ssl请求
  18. echo $manager->body();
  19. echo $manager->header();

支持cookie：

Php代码  收藏代码
  1. $manager->cookie();

带参数请求，get/post/put/delete等等使用方式一样

Php代码  收藏代码
  1. $manager->post(‘action’, array(‘k’ => ‘v’, ‘a’ => ‘b’));
  2. $manager->post(‘action’, ‘k=v&a=b’);
  3. $manager->post(‘action’, array(‘k’ => ‘v’, ‘@a’ => ‘/home/www/avatar.gif’)); //上传，需要使用绝对路径，参数名称加”@”。

Curl_Manager代码，也可以从附件下载：

Php代码  收藏代码
  1. <?php
  2. // +———————————————————————-+
  3. // | Copyright (c) 2008-2010 Willko Cheng                                 |
  4. // +———————————————————————-+
  5. // | Authors: Willko Cheng <willko@foxmail.com>                           |
  6. // | Blog: http://willko.iteye.com/                                     |
  7. // +———————————————————————-+
  9. class Curl_Manager {
  10.     private $_is_temp_cookie = false;
  11.     private $_header;
  12.     private $_body;
  13.     private $_ch;
  15.     private $_proxy;
  16.     private $_proxy_port;
  17.     private $_proxy_type = ‘HTTP’; // or SOCKS5
  18.     private $_proxy_auth = ‘BASIC’; // or NTLM
  19.     private $_proxy_user;
  20.     private $_proxy_pass;
  22.     protected $_cookie;
  23.     protected $_options;
  24.     protected $_url = array ();
  25.     protected $_referer = array ();
  27.     public function __construct($options = array()) {
  28.         $defaults = array ();
  30.         $defaults [‘timeout’] = 30;
  31.         $defaults [‘temp_root’] = sys_get_temp_dir ();
  32.         $defaults [‘user_agent’] = ‘Mozilla/5.0 (Windows; U; Windows NT 6.0; zh-CN; rv:1.8.1.20) Gecko/20081217 Firefox/2.0.0.20’;
  34.         $this->_options = array_merge ( $defaults, $options );
  35.     }
  37.     public function open() {
  38.         $this->_ch = curl_init ();
  40.         //curl_setopt($this->_ch, CURLOPT_FOLLOWLOCATION, true);
  41.         curl_setopt ( $this->_ch, CURLOPT_HEADER, true );
  42.         curl_setopt ( $this->_ch, CURLOPT_RETURNTRANSFER, true );
  43.         curl_setopt ( $this->_ch, CURLOPT_USERAGENT, $this->_options [‘user_agent’] );
  44.         curl_setopt ( $this->_ch, CURLOPT_CONNECTTIMEOUT, $this->_options [‘timeout’] );
  45.         curl_setopt ( $this->_ch, CURLOPT_HTTPHEADER, array(‘Expect:’) ); // for lighttpd 417 Expectation Failed
  47.         $this->_header = ”;
  48.         $this->_body = ”;
  50.         return $this;
  51.     }
  53.     public function close() {
  54.         if (is_resource ( $this->_ch )) {
  55.             curl_close ( $this->_ch );
  56.         }
  58.         if (isset ( $this->_cookie ) && $this->_is_temp_cookie && is_file ( $this->_cookie )) {
  59.             unlink ( $this->_cookie );
  60.         }
  61.     }
  63.     public function cookie() {
  64.         if (! isset ( $this->_cookie )) {
  65.             if (! emptyempty ( $this->_cookie ) && $this->_is_temp_cookie && is_file ( $this->_cookie )) {
  66.                 unlink ( $this->_cookie );
  67.             }
  69.             $this->_cookie = tempnam ( $this->_options [‘temp_root’], ‘curl_manager_cookie_’ );
  70.             $this->_is_temp_cookie = true;
  71.         }
  73.         curl_setopt ( $this->_ch, CURLOPT_COOKIEJAR, $this->_cookie );
  74.         curl_setopt ( $this->_ch, CURLOPT_COOKIEFILE, $this->_cookie );
  76.         return $this;
  77.     }
  79.     public function ssl() {
  80.         curl_setopt ( $this->_ch, CURLOPT_SSL_VERIFYPEER, false );
  82.         return $this;
  83.     }
  85.     public function proxy($host = null, $port = null, $type = null, $user = null, $pass = null, $auth = null) {
  86.         $this->_proxy = isset ( $host ) ? $host : $this->_proxy;
  87.         $this->_proxy_port = isset ( $port ) ? $port : $this->_proxy_port;
  88.         $this->_proxy_type = isset ( $type ) ? $type : $this->_proxy_type;
  90.         $this->_proxy_auth = isset ( $auth ) ? $auth : $this->_proxy_auth;
  91.         $this->_proxy_user = isset ( $user ) ? $user : $this->_proxy_user;
  92.         $this->_proxy_pass = isset ( $pass ) ? $pass : $this->_proxy_pass;
  94.         if (! emptyempty ( $this->_proxy )) {
  95.             curl_setopt ( $this->_ch, CURLOPT_PROXYTYPE, $this->_proxy_type == ‘HTTP’ ? CURLPROXY_HTTP : CURLPROXY_SOCKS5 );
  96.             curl_setopt ( $this->_ch, CURLOPT_PROXY, $this->_proxy );
  97.             curl_setopt ( $this->_ch, CURLOPT_PROXYPORT, $this->_proxy_port );
  98.         }
  100.         if (! emptyempty ( $this->_proxy_user )) {
  101.             curl_setopt ( $this->_ch, CURLOPT_PROXYAUTH, $this->_proxy_auth == ‘BASIC’ ? CURLAUTH_BASIC : CURLAUTH_NTLM );
  102.             curl_setopt ( $this->_ch, CURLOPT_PROXYUSERPWD, “[{$this->_proxy_user}]:[{$this->_proxy_pass}]” );
  103.         }
  105.         return $this;
  106.     }
  108.     public function post($action, $query = array()) {
  109.         if (is_array($query)) {
  110.             foreach ($query as $key => $val) {
  111.                 if ($val{0} != ‘@’) {
  112.                     $encode_key = urlencode($key);
  114.                     if ($encode_key != $key) {
  115.                         unset($query[$key]);
  116.                     }
  118.                     $query[$encode_key] = urlencode($val);
  119.                 }
  120.             }
  121.         }
  123.         curl_setopt ( $this->_ch, CURLOPT_POST, true );
  124.         curl_setopt ( $this->_ch, CURLOPT_URL, $this->_url [$action] );
  125.         curl_setopt ( $this->_ch, CURLOPT_REFERER, $this->_referer [$action] );
  126.         curl_setopt ( $this->_ch, CURLOPT_POSTFIELDS, $query );
  128.         $this->_requrest ();
  130.         return $this;
  131.     }
  133.     public function get($action, $query = array()) {
  134.         $url = $this->_url [$action];
  136.         if (! emptyempty ( $query )) {
  137.             $url .= strpos ( $url, ‘?’ ) === false ? ‘?’ : ‘&’;
  138.             $url .= is_array ( $query ) ? http_build_query ( $query ) : $query;
  139.         }
  141.         curl_setopt ( $this->_ch, CURLOPT_URL, $url );
  142.         curl_setopt ( $this->_ch, CURLOPT_REFERER, $this->_referer [$action] );
  144.         $this->_requrest ();
  146.         return $this;
  147.     }
  149.     public function put($action, $query = array()) {
  150.         curl_setopt ( $this->_ch, CURLOPT_CUSTOMREQUEST, ‘PUT’ );
  152.         return $this->post ( $action, $query );
  153.     }
  155.     public function delete($action, $query = array()) {
  156.         curl_setopt ( $this->_ch, CURLOPT_CUSTOMREQUEST, ‘DELETE’ );
  158.         return $this->post ( $action, $query );
  159.     }
  161.     public function head($action, $query = array()) {
  162.         curl_setopt ( $this->_ch, CURLOPT_CUSTOMREQUEST, ‘HEAD’ );
  164.         return $this->post ( $action, $query );
  165.     }
  167.     public function options($action, $query = array()) {
  168.         curl_setopt ( $this->_ch, CURLOPT_CUSTOMREQUEST, ‘OPTIONS’ );
  170.         return $this->post ( $action, $query );
  171.     }
  173.     public function trace($action, $query = array()) {
  174.         curl_setopt ( $this->_ch, CURLOPT_CUSTOMREQUEST, ‘TRACE’ );
  176.         return $this->post ( $action, $query );
  177.     }
  179.     public function connect() {
  181.     }
  183.     public function follow_location() {
  184.         preg_match ( ‘#Location:\s*(.+)#i’, $this->header (), $match );
  186.         if (isset ( $match [1] )) {
  187.             $this->set_action ( ‘auto_location_gateway’, $match [1], $this->effective_url () );
  189.             $this->get ( ‘auto_location_gateway’ )->follow_location ();
  190.         }
  192.         return $this;
  193.     }
  195.     public function set_action($action, $url, $referer = ”) {
  196.         $this->_url [$action] = $url;
  197.         $this->_referer [$action] = $referer;
  199.         return $this;
  200.     }
  202.     public function header() {
  203.         return $this->_header;
  204.     }
  206.     public function body() {
  207.         return $this->_body;
  208.     }
  210.     public function effective_url() {
  211.         return curl_getinfo ( $this->_ch, CURLINFO_EFFECTIVE_URL );
  212.     }
  214.     public function http_code() {
  215.         return curl_getinfo($this->_ch, CURLINFO_HTTP_CODE);
  216.     }
  218.     private function _requrest() {
  219.         $response = curl_exec ( $this->_ch );
  221.         $errno = curl_errno ( $this->_ch );
  223.         if ($errno > 0) {
  224.             throw new Curl_Manager_Exception ( curl_error ( $this->_ch ), $errno );
  225.         }
  227.         $header_size = curl_getinfo ( $this->_ch, CURLINFO_HEADER_SIZE );
  229.         $this->_header = substr ( $response, 0, $header_size );
  230.         $this->_body = substr ( $response, $header_size );
  231.     }
  233.     public function __destruct() {
  234.         $this->close ();
  235.     }
  236. }
  238. class Curl_Manager_Exception extends Exception {
  240. }

Leave a Reply

Your email address will not be published. Required fields are marked *