编程语言
首页 > 编程语言> > 【PHP类库】Requests - A humble HTTP request library

【PHP类库】Requests - A humble HTTP request library

作者:互联网

Requests是一个PHP的HTTP类库。相对于cURL等类库来说,它具有简单易用且友好的API,且不依赖于cURL。它支持HEAD、 GET、 POST、 PUT、 DELETE和PATCH等方法,基本能满足任何形式的HTTP请求。

Requests不依赖于任何PHP标准库外的扩展,唯一的要求就是需要PHP5.2+的版本。但是如果PHP的cURL可用,Requests会优先使用它,否则会使用socket。

安装和使用

通过Composer安装

 
  1. {

  2. "require": {

  3. "rmccue/requests": ">=1.0"

  4. },

  5. "autoload": {

  6. "psr-0": {"Requests": "library/"}

  7. }

  8. }

自动加载

可以使用Composer的加载器:

phpinclude('/path/to/composer/vendor/autoload.php');

也可以使用Requests自带的:

php
  1. include('/path/to/library/Requests.php');

  2.  
  3. Requests::register_autoloader();

各种请求

GET请求

php$response = Requests::get('http://httpbin.org/get');

POST请求

php$response = Requests::post('http://httpbin.org/post');

需要传数据的话,可以使用第三个参数:

php
  1. $data = array('key1' => 'value1', 'key2' => 'value2');

  2. $response = Requests::post('http://httpbin.org/post', array(), $data);

如果需要传原始数据的话,第三个参数请传字符串。

其他请求

其他请求方法都大同小异:

php
  1. $response = Requests::put('http://httpbin.org/put');

  2.  
  3. $response = Requests::delete('http://httpbin.org/delete');

  4.  
  5. $response = Requests::patch('http://httpbin.org/patch', array('If-Match' => 'e0023aa4e'));

  6.  
  7. $response = Requests::head('http://httpbin.org/headers');

需要注意的是equests::patch()方法的第二个参数为必传。

Requests::request()方法

看API文档,你会发现这些方法接受的参数几乎一样:$url$headers$data(只有POST、PUT和PATCH有),$options。事实上它们只是对Requests::request()方法进行了一次封装:

php
  1. /**

  2. * Send a GET request

  3. */

  4. public static function get($url, $headers = array(), $options = array()) {

  5. return self::request($url, $headers, null, self::GET, $options);

  6. }

  7.  
  8. /**

  9. * Send a HEAD request

  10. */

  11. public static function head($url, $headers = array(), $options = array()) {

  12. return self::request($url, $headers, null, self::HEAD, $options);

  13. }

  14.  
  15. /**

  16. * Send a DELETE request

  17. */

  18. public static function delete($url, $headers = array(), $options = array()) {

  19. return self::request($url, $headers, null, self::DELETE, $options);

  20. }

  21.  
  22. /**

  23. * Send a POST request

  24. */

  25. public static function post($url, $headers = array(), $data = array(), $options = array()) {

  26. return self::request($url, $headers, $data, self::POST, $options);

  27. }

  28.  
  29. /**

  30. * Send a PUT request

  31. */

  32. public static function put($url, $headers = array(), $data = array(), $options = array()) {

  33. return self::request($url, $headers, $data, self::PUT, $options);

  34. }

$header允许我们自定义请求头,例如POST方法的话,我们通常需要指定Content-Type,使服务器知道我们正在发送的的数据是什么格式:

php
  1. $url = 'https://api.github.com/some/endpoint';

  2. $headers = array('Content-Type' => 'application/json');

  3. $data = array('some' => 'data');

  4. $response = Requests::post($url, $headers, json_encode($data));

$options允许我们对请求进行配置,例如超时时间:

php
  1. $options = array(

  2. 'timeout' => 5

  3. );

  4. $response = Requests::get('https://httpbin.org/', array(), $options);

更多的选项配置请看:http://requests.ryanmccue.info/api/source-class-Requests.html#_request

Requests里所有的请求方法(HEAD、 GET、 POST、 PUT、 DELETE和PATCH)返回的都是一个Requests_Response对象,这个对象包含了响应的各种信息:

更多Requests_Response的信息请看:http://requests.ryanmccue.info/api/source-class-Requests.html#_request

Session处理

当你需要对同一网站发出多个请求,那么Requests_Session对象可以帮到轻易的设置一些默认参数:

php
  1. $url = 'https://api.github.com/';

  2. $header = array('X-ContactAuthor' => 'rmccue');

  3. $data = array();

  4. $options = array('useragent' => 'My-Awesome-App');

  5. $session = new Requests_Session($url, $header, $data, $options);

  6.  
  7. $response = $session->get('/zen');

Requests_Session的构造函数接受urlheadersdataoptions这4个参数,顺序跟Requests::request()方法一致。同时你也可以通过访问属性的方式去修改options参数:

php
  1. // 设置option属性

  2. $session->useragent = 'My-Awesome-App';

  3.  
  4. // 跟上面的作用一致

  5. $session->options['useragent'] = 'My-Awesome-App';

更多Requests_Session的信息请看:http://requests.ryanmccue.info/api/source-class-Requests_Session.html

HTTPS请求

Requests会默认帮忙处理HTTPS请求,就跟在浏览器访问HTTPS网站一样:

php$response = Requests::get('https://httpbin.org/');

但是如果你想使用其他的证书或者自签证书,你可以指定证书文件(PEM格式):

php
  1. $options = array(

  2. 'verify' => '/path/to/cacert.pem'

  3. );

  4. $response = Requests::get('https://httpbin.org/', array(), $options);

如果你想禁用HTTPS的验证,可以通过设置options'verify' => false

HTTP基本验证

HTTP基本验证功能可以通过optionsauth实现:

php
  1. $options = array(

  2. 'auth' => array('user', 'password')

  3. );

  4. Requests::get('http://httpbin.org/basic-auth/user/password', array(), $options);

进阶使用

使用代理

代理可以通过optionsproxy实现:

php
  1. $options = array(

  2. 'proxy' => '127.0.0.1:3128'

  3. );

  4. Requests::get('http://httpbin.org/ip', array(), $options);

如果代理需要验证:

php
  1. $options = array(

  2. 'proxy' => array( '127.0.0.1:3128', 'my_username', 'my_password' )

  3. );

  4. Requests::get('http://httpbin.org/ip', array(), $options);

钩子

通过Requests的钩子系统,我们可以通过注册自己的钩子去扩展Requests的功能:

php
  1. $hooks = new Requests_Hooks();

  2. $hooks->register('requests.after_request', 'mycallback');

  3.  
  4. $request = Requests::get('http://httpbin.org/get', array(), array('hooks' => $hooks));

Request提供的钩子请看:http://requests.ryanmccue.info/docs/hooks.html

自定义验证

通过实现Requests_Auth接口,我们可以为请求添加自定义的验证。假设服务器会检查HTTP请求里的Hotdog请求头的值是不是为Yummy。我们先实现我们的验证类:

php
  1. class MySoftware_Auth_Hotdog implements Requests_Auth {

  2. protected $password;

  3.  
  4. public function __construct($password) {

  5. $this->password = $password;

  6. }

  7.  
  8. public function register(Requests_Hooks &$hooks) {

  9. $hooks->register('requests.before_request', array(&$this, 'before_request'));

  10. }

  11.  
  12. public function before_request(&$url, &$headers, &$data, &$type, &$options) {

  13. $headers['Hotdog'] = $this->password;

  14. }

  15. }

可以看到,类实现了Requests_Auth接口,同时代码实现也用到了钩子。下面我们通过optionsauth去调用我们的自定义验证:

php
  1. $options = array(

  2. 'auth' => new MySoftware_Auth_Hotdog('yummy')

  3. );

  4. $response = Requests::get('http://hotdogbin.org/admin', array(), $options);

Why Requests?

文章开始提到了Requests的一些优点,这个官网有个专门的页面进行详细的介绍,同时还提到了Requests跟其他类似类库的对比。通过这个对比,大家对Requests会有进一步的认识,同时也科普下还有哪些HTTP请求相关的类库。
请猛击:http://requests.ryanmccue.info/docs/why-requests.html

参考

http://requests.ryanmccue.info/

标签:类库,HTTP,humble,request,options,headers,Requests,php,array
来源: https://blog.csdn.net/wangshifan116/article/details/115250373