Guzzle 使用教程

介绍

Guzzle是一个PHP的HTTP客户端,用来轻而易举地发送请求,并集成到我们的WEB服务上。

接口简单:构建查询语句、POST请求、分流上传下载大文件、使用HTTP cookies、上传JSON数据等等。
发送同步或异步的请求均使用相同的接口。
使用PSR- 7 接口来请求、响应、分流,允许你使用其他兼容的PSR- 7 类库与Guzzle共同开发。
抽象了底层的HTTP传输,允许你改变环境以及其他的代码,如:对cURL与PHP的流或socket并非重度依赖,非阻塞事件循环。
中间件系统允许你创建构成客户端行为。

了解http协议

HTTP是一个基于TCP/IP通信协议来传递数据,包括html文件、图像、结果等,即是一个客户端和服务器端请求和应答的标准。

HTTP协议特点
1.http无连接:限制每次连接只处理一个请求,服务端完成客户端的请求后,即断开连接。(传输速度快,减少不必要的连接,但也意味着每一次访问都要建立一次连接,效率降低)

2.http无状态:对于事务处理没有记忆能力。每一次请求都是独立的,不记录客户端任何行为。(优点解放服务器,但可能每次请求会传输大量重复的内容信息)

3.客户端/服务端模型:客户端支持web浏览器或其他任何客户端,服务器通常是apache或者iis等

4.简单快速

5.灵活:可以传输任何类型的数据

客户端请求消息

  • 请求行
  • 请求头部
  • 空行
  • 请求数据

黑白课堂

常见请求头

描述 (红色掌握,其他了解)

Referer

浏览器通知服务器,当前请求来自何处。如果是直接访问,则不会有这个头。常用于:防盗链

If-Modified-Since

浏览器通知服务器,本地缓存的最后变更时间。与另一个响应头组合控制浏览器页面的缓存。

Cookie

与会话有关技术,用于存放浏览器缓存的cookie信息。

User-Agent

浏览器通知服务器,客户端浏览器与操作系统相关信息

Connection

保持连接状态。Keep-Alive 连接中,close 已关闭

Host

请求的服务器主机名

Content-Length

请求体的长度

Content-Type

如果是POST请求,会有这个头,默认值为application/x-www-form-urlencoded,表示请求体内容使用url编码

Accept:

浏览器可支持的MIME类型。文件类型的一种描述方式。

MIME格式:大类型/小类型[;参数]

例如:

   text/html ,html文件

   text/css,css文件

   text/javascript,js文件

   image/*,所有图片文件

Accept-Encoding

浏览器通知服务器,浏览器支持的数据压缩格式。如:GZIP压缩

Accept-Language

浏览器通知服务器,浏览器支持的语言。各国语言(国际化i18n)

服务器响应消息

  • 状态行
  • 消息报头
  • 空行
  • 响应正文

黑白课堂
常用的状态码如下:

200 :请求成功。

302 :请求重定向。

304 :请求资源没有改变,访问本地缓存。

404 :请求资源不存在。通常是用户路径编写错误,也可能是服务器资源已删除。

500 :服务器内部错误。通常程序抛异常。

状态信息:状态信息是根据状态码变化而变化的

常见请求头

描述

Location

指定响应的路径,需要与状态码302配合使用,完成跳转。

Content-Type

响应正文的类型(MIME类型)

取值:text/html;charset=UTF-8

Content-Disposition

通过浏览器以下载方式解析正文

取值:attachment;filename=xx.zip

Set-Cookie

与会话相关技术。服务器向浏览器写入cookie

Content-Encoding

服务器使用的压缩格式

取值:gzip

Content-length

响应正文的长度

Refresh

定时刷新,格式:秒数;url=路径。url可省略,默认值为当前页。

取值:3;url=www.itcast.cn    //三秒刷新页面到www.itcast.cn

Server

指的是服务器名称,默认值:Apache-Coyote/1.1。可以通过conf/server.xml配置进行修改。<Connector port="8080" ... server="itcast"/>

Last-Modified

服务器通知浏览器,文件的最后修改时间。与If-Modified-Since一起使用。

版本要求

  • PHP 5.5.0
  • 使用PHP的流, allow_url_fopen 必须在php.ini中启用。
  • 要使用cURL,你必须已经有版本cURL >= 7.19.4,并且编译了OpenSSL 与 zlib。

安装

composer require guzzlehttp/guzzle:~6.0

快速入门

创建客户端

use GuzzleHttp\Client;

$client = new Client([
    // Base URI is used with relative requests
    'base_uri' => 'http://httpbin.org',
    // You can set any number of default request options.
    'timeout'  => 2.0,
]);

base_uri

$client = new GuzzleHttp\Client(['base_uri' => 'https://foo.com/api/']);
// Send a request to https://foo.com/api/test
$response = $client->request('GET', 'test');
// Send a request to https://foo.com/root
$response = $client->request('GET', '/root');

黑白课堂

发送请求

$response = $client->get('http://httpbin.org/get');
$response = $client->delete('http://httpbin.org/delete');
$response = $client->head('http://httpbin.org/get');
$response = $client->options('http://httpbin.org/get');
$response = $client->patch('http://httpbin.org/patch');
$response = $client->post('http://httpbin.org/post');
$response = $client->put('http://httpbin.org/put');

创建一个请求,一切就绪后将请求传送给client:

$request = new Request('PUT', 'http://httpbin.org/put');
$response = $client->send($request, ['timeout' => 2]);

异步请求

$promise = $client->getAsync('http://httpbin.org/get');
$promise = $client->deleteAsync('http://httpbin.org/delete');
$promise = $client->headAsync('http://httpbin.org/get');
$promise = $client->optionsAsync('http://httpbin.org/get');
$promise = $client->patchAsync('http://httpbin.org/patch');
$promise = $client->postAsync('http://httpbin.org/post');
$promise = $client->putAsync('http://httpbin.org/put');

获得响应数据

我们取到了 $response 变量,使用 getBody 方法可以获取响应的主体部分(body),主体可以当成一个字符串或流对象使用

$r=$response->getBody();

查询字符串参数

多种方式来提供请求的查询字符串 你可以在请求的URI中设置查询字符串

$response = $client->request('GET', 'http://httpbin.org?foo=bar');
或
$client->request('GET', 'http://httpbin.org', [
    'query' => ['foo' => 'bar']
]);

或
$client->request('GET', 'http://httpbin.org', ['query' => 'foo=bar']);

上传数据

Guzzle为上传数据提供了一些方法。 你可以发送一个包含数据流的请求,将 body 请求参数设置成一个字符串、 fopen 返回的资源、或者一个 Psr\Http\Message\StreamInterface 的实例

$r = $client->request('POST', 'http://httpbin.org/post', [
    'body' => 'raw data'
]);

// Provide an fopen resource.
$body = fopen('/path/to/file', 'r');
$r = $client->request('POST', 'http://httpbin.org/post', ['body' => $body]);

// Use the stream_for() function to create a PSR-7 stream.
$body = \GuzzleHttp\Psr7\stream_for('hello!');
$r = $client->request('POST', 'http://httpbin.org/post', ['body' => $body]);

上传JSON数据

 $r = $client->request('PUT', 'http://httpbin.org/put', [
    'json' => ['foo' => 'bar']
]);

POST/表单请求

发送 application/x-www-form-urlencoded POST请求需要你传入 form_params 数组参数

$response = $client->request('POST', 'http://httpbin.org/post', [
    'form_params' => [
        'field_name' => 'abc',
        'other_field' => '123',
        'nested_field' => [
            'nested' => 'hello'
        ]
    ]
]);

发送表单文件

你可以通过使用 multipart 请求参数来发送表单 (表单enctype属性需要设置 multipart/form-data ) 文件, 该参数接收一个包含多个关联数组的数组,每个关联数组包含一下键名:

  • name: (必须,字符串) 映射到表单字段的名称。
  • contents: (必须,混合) 提供一个字符串,可以是 fopen 返回的资源、或者一个Psr\Http\Message\StreamInterface 的实例。
    $response = $client->request('POST', 'http://httpbin.org/post', [
    'multipart' => [
        [
            'name'     => 'field_name',
            'contents' => 'abc'
        ],
        [
            'name'     => 'file_name',
            'contents' => fopen('/path/to/file', 'r')
        ],
        [
            'name'     => 'other_file',
            'contents' => 'hello',
            'filename' => 'filename.txt',
            'headers'  => [
                'X-Foo' => 'this is an extra header to include'
            ]
        ]
    ]
    ]);

    Cookies

    Guzzle可以使用 cookies 请求参数为你维护一个cookie会话,当发送一个请求时, cookies 选项必须设置成 GuzzleHttp\Cookie\CookieJarInterface 的实例

    $jar = new \GuzzleHttp\Cookie\CookieJar;
    $r = $client->request('GET', 'http://httpbin.org/cookies', [
    'cookies' => $jar
    ]);

    重定向

    如果你没有告诉Guzzle不要重定向,Guzzle会自动的进行重定向,你可以使用 allow_redirects 请求参数来自定义重定向行为

  • 设置成 true 时将启用最大数量为5的重定向,这是默认设置。
  • 设置成 false 来禁用重定向。
    -传入一个包含 max 键名的关联数组来声明最大重定向次数,提供可选的 strict 键名来声明是否使用严格的RFC标准重定向 (表示使用POST请求重定向POST请求 vs 大部分浏览器使用GET请求重定向POST请求)。
$response = $client->request('GET', 'http://github.com', [
    'allow_redirects' => false
]);
echo $response->getStatusCode();

这里以我黑白课堂网站作为实例讲解

1.第一步创建一个http客户端

前面要引入命名空间

use GuzzleHttp\Client;
use GuzzleHttp\Cookie\CookieJar;
$client = new Client([
            'verify'=>false,
            'base_uri' => 'https://www.heibaiketang.com', //设置这个网站的基本url地址,后续的只需要写相对路径即可
 ]);

2.设置cookies

这里获取很简单,直接在http请求头里面。
黑白课堂

$cookieJar = CookieJar::fromArray([
            'remember_forum_59ba36addc2b2f9401580f014XXXXXXXXX' => 'eyJpdiI6IlArUnJrdFMyQ3h6RlR3d2liQXVFU2c9PSIsInZhbHVlIjoiNUN5RmJMZ1wvaElSeTJ5MnVKUFdvM2lWSTBkMnh0ZG11Rm83VTFYTExON3hnN2JFS3MxV2ZxY01aSnQzZCtyeVR1aDQxZ0pQK1ZvS2FVN2V5Q1FoQzRUYldhbXRua21QTzFJS0VXOXk2SHRJdVdoTjdYZGhRUzJsU0MrdnRUUHJZY3J2cnpGQTBVXC9WOThKTkJuWHgxK3BZcVNkeW9CVDhoeUJUUXVybDVaSDQ9IiwibWFjIjoiODU5MzFlMjNhYWUwYWRlNDk5ZTgzOGMzYjM2MDMyOTQyYzhkNzZhMDFhOGE0ZWMzXXXXXXXXX',
            'laravel_session'=>'eyJpdiI6InZ5T3lyU2FXMEEwN2NNRFVhNVwvT0NnPT0iLCJ2YWx1ZSI6ImkrbUNvQUxGMUVqVTdYOTVHNFwvWHlWeXA4dFlTNHp4ZEk5eVRMSVFuM3V2Mjg2TTB0eXArVzcxdThVQnNoVHpvIiwibWFjIjoiZWNmMmJmMWEwODMwZTBhMDA4ODBlZWUwYzVkMWNjY2ViNmVlMTRlMTQzMmI0MzBjZWNiNzcwZWFmOWFhMTkXXXXXX'
        ], 'www.heibaiketang.com');  // 此处记得请求域名需要保持跟请求的url host一致,否则不会携带此cookie。

登录cookies,打印看看

 print_r($cookieJar->toArray());

Array
(
    [0] => Array
        (
            [Name] => remember_forum_59ba36addc2b2f9401580f014c7f58ea4e30989d
            [Value] => eyJpdiI6IlArUnJrdFMyQ3h6RlR3d2liQXVFU2c9PSIsInZhbHVlIjoiNUN5RmJMZ1wvaElSeTJ5MnVKUFdvM2lWSTBkMnh0ZG11Rm83VTFYTExON3hnN2JFS3MxV2ZxY01aSnQzZCtyeVR1aDQxZ0pQK1ZvS2FVN2V5Q1FoQzRUYldhbXRua21QTzFJS0VXOXk2SHRJdVdoTjdYZGhRUzJsU0MrdnRUUHJZY3J2cnpGQTBVXC9WOThKTkJuWHgxK3BZcVNkeW9CVDhoeUJUUXVybDVaSDQ9IiwibWFjIjoiODU5MzFlMjNhYWUwYWRlNDk5ZTgzOGMzYjM2MDMyOTQyYzhkNzZhMDFhOGE0ZWMzYzFjZTIzYjZjNGFlMTk4YiJ9
            [Domain] => www.heibaiketang.com
            [Path] => /
            [Max-Age] => 
            [Expires] => 
            [Secure] => 
            [Discard] => 1
            [HttpOnly] => 
        )

    [1] => Array
        (
            [Name] => laravel_session
            [Value] => eyJpdiI6InZ5T3lyU2FXMEEwN2NNRFVhNVwvT0NnPT0iLCJ2YWx1ZSI6ImkrbUNvQUxGMUVqVTdYOTVHNFwvWHlWeXA4dFlTNHp4ZEk5eVRMSVFuM3V2Mjg2TTB0eXArVzcxdThVQnNoVHpvIiwibWFjIjoiZWNmMmJmMWEwODMwZTBhMDA4ODBlZWUwYzVkMWNjY2ViNmVlMTRlMTQzMmI0MzBjZWNiNzcwZWFmOWFhMTk2OSJ9
            [Domain] => www.heibaiketang.com
            [Path] => /
            [Max-Age] => 
            [Expires] => 
            [Secure] => 
            [Discard] => 1
            [HttpOnly] => 
        )

)

自动转化我们得参数请求数据。

3.发起获取数据

  $result = $client->get('/user', [
            'cookies' => $cookieJar,
        ]);

        print_r($result->getBody()->getContents());

黑白课堂
这样就获取了我登录这个账号得得信息。

评论区 (0)

没有记录
支持 markdown,图片截图粘贴拖拽都可以自动上传。

相关帖子

黑白课堂

如果你在.env文件下配置了变量参数,在路由缓存下会无效

| 最后更新 2020-12-11 03:05:43
1596 0
黑白课堂

laravel之Artisan命令操作,以及自己编写Artisan Console命令

| 最后更新 2021-01-13 14:24:58
1397 0
黑白课堂

JWT(JSON Web Token)是一个非常轻巧的规范。这个规范允许我们使用JWT在用户和服务器之间传递安全可靠的信息。 一个JWT实际上就是一个字符串,它由三部分组成,头部、载荷与签名

| 最后更新 2021-01-13 14:25:29
1530 0
黑白课堂

扩展一个指令在blade模板中使用。

| 最后更新 2020-12-11 03:04:51
1144 0
黑白课堂

所有Laravel应用启动的中心,所有Laravel的核心服务都是通过服务提供者启动,服务提供者是应用配置的中心. >这里需要了解下IOC(控制反转)也叫依赖注入

| 最后更新 2021-01-11 03:14:14
1047 0
黑白课堂

控制对资源的访问权限,这个权限不同于RBAC(角色的权限访问控制),比如,只能操作自己的信息,可以说是拟补RBAC的更加细腻的权限。

| 最后更新 2021-01-13 14:24:00
1068 0
黑白课堂

黑白课堂 · 技术专家

专业PHP开发

年度VIP 站长创业者玉树凌风每天醒来0收入
查看更多

最新视频课程

钻级赞助商