分类 PHP 下的文章

我的个人博客:逐步前行STEP

服务提供者是一个有效的将工具与业务解耦的方案,下面结合一个实用案例来解释服务提供者在实现提供基础服务的工具中的应用。

服务提供者

服务提供者是 Laravel 应用启动的中心,所有 Laravel 的核心服务都是通过服务提供者启动,通过使用服务提供者来管理类的依赖和执行依赖注入,可以很好地将一些底层服务与应用层代码解耦。

短信服务

短信服务对于一个系统来说,是基础的、通用的服务,不依赖于业务细节,所以应该将其与业务解耦。

系统设计

将不同服务商的sdk称为驱动,短信服务应该满足以下需求:

  1. 可替换驱动
  2. 驱动实例化对使用者透明

1、可替换驱动

要满足第1点,首先应该使用接口约束对外暴露的方法,只有驱动满足接口约束,才能不影响业务直接替换驱动,于是设计接口:

<?php

namespace App\Interfaces;

Interface SmsDriverInterface
{

    public function sendMessage($phones, $template_id, $parameters);
}

如果接入的厂商是七牛云,则创建七牛云短信驱动,并在驱动中调用SDK实现功能:

<?php
namespace App;

use Qiniu\Auth;
use Qiniu\Http\Client;
use Qiniu\Http\Error;
use Qiniu\Sms\Sms;
class QiniuDriver implements SmsDriverInterface
{
    const HOST = 'https://sms.qiniuapi.com';

    const VERSION = 'v1';
    public function __construct()
    {
        $this->auth  = new Auth(config('access_key'), config('secret_key'));

        $this->sms = new Sms($this->auth);
    }
 
    public function sendMessage($phones, $template_id, $parameters = [])
    {
        $phones = array_map(function($item)
        {
            if(!is_string($item))
            {
                $item = strval($item);
            }

            return $item;
        }, $phones);

        $ret = $this->sms->sendMessage($template_id, $phones, $parameters);

        $result = $this->getResultApiRet($ret);

        return $result;
    }
}

别的厂商的驱动也这样实现接口SmsDriverInterface,在更换厂商的时候,换一个驱动实例化就可以了。

2、驱动实例化对使用者透明

此处的使用者就是使用短信服务实现业务需求的工程师啦,因为短信服务的基础、通用的特性,会被在业务中很多地方使用,如果更换驱动的话,会涉及很多具体业务代码的修改,所以需要创建一个服务类,用来统筹驱动的使用,具体业务中再调用这个服务类,驱动的实例化就对业务透明了:

<?php
namespace App;
class SmsService
{
    public $driver;
    
    public function driver($driver_name)
    {
        switch($driver_name)
        {
            case 'qiniu':
                $this->driver = new QiniuDriver();
            break;
            case 'aliyun':
                $this->driver = new AliyunDriver();
            break;
        }
    }
    
    public function senndMessage($phone, $template_id)
    {
        return $this->driver->sendMessage($phone, $template_id);
    }
} 

再做改进,将传参选择驱动类型改为从配置中获取驱动类型:

<?php
namespace App;
class SmsService
{
    public $driver;
    
    public function driver()
    {
        switch(config('driver'))
        {
            case 'qiniu':
                $this->driver = new QiniuDriver();
            break;
            case 'aliyun':
                $this->driver = new AliyunDriver();
            break;
        }
    }
    ......
}

至此,基本满足了刚才所说的2点基本需求,但是,在增加驱动的时候要去改动driver()中的代码,增加其它驱动项,在服务类中枚举出所有的驱动似乎不够简洁,这里可以使用服务提供者再做优化:

<?php

namespace App\Providers;

use App\Interfaces\SmsDriverInterface;
use App\NullSms;
use App\QiniuSms;
use App\SmsService;
use Illuminate\Support\ServiceProvider;

class SmsServiceProvider extends ServiceProvider
{

    protected $defer = true;

    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {

    }

    /**
     * Register the application services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton(SmsDriverInterface::class, function ($app) {

            switch(config('driver'))
            {
                case 'qiniu':
                    return new QiniuDriver();
            }

            return new NullSms();
        });
    }

    public function provides()
    {
        return [SmsDriverInterface::class];
    }
}

这里将驱动接口与配置中指定的具体驱动绑定,在服务类中的实例化方式可以改成依赖注入,因为短信驱动应该使用单例并且为了调用短信服务方便,将服务类中方法改为静态方法:

namespace App;
class SmsService
{
    public $driver;
    
    public function __construct(SmsDriverInterface $driver)
    {
        $this->driver = $driver;
    }
    
    public static function driver()
    {
        return app(self::class)->driver;
    }
    public static function sendMessage($phone, $template_id)
    {
        return SmsSend::driver()->sendMessage($phone, $template_id);
    }
}

最后将短信服务提供者添加到config/app.php文件的providers列表中,短信服务者的开发就完成了。

在这个案例中,短信服务提供者通过服务容器的依赖注入,实现了驱动在服务类中的自动实例化,在逻辑上将底层驱动与上层服务解耦。

这个案例比较简单,还有很多可以完善的地方,比如,不在服务提供者中能够使用switch去匹配驱动类型,而是增加一个驱动管理器,根据命名规则去实例化对应的驱动,这样的话就达到了增加并更换驱动的时候,只增加驱动类,以及更换config配置,就能“平滑”替换驱动的目的。

我的个人博客:逐步前行STEP

使用Goutte + GuzzleHttp 爬取网页时,如下代码中的请求头设置无效:

$jar = CookieJar::fromArray([
            "HMACCOUNT" => 'C0CDC28BD0110387',
        ], self::$host);

        $client = new GoutteClient();

        $guzzle_client = new GuzzleClient([
            'timeout'=>20,
            'headers'=>[
                'Referer'=>$prefix_url,
                'User-Agent'=>'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/76.0.3809.100 Safari/537.36',
            ],
            'cookies' => $jar,
            'debug'=>true,
        ]);

        $client->setClient($guzzle_client);

经过研究源码发现,User-Agent 请求字段使用了默认值,没有应用传入的参数,而cookies配置则因为语法问题被覆盖丢失。

以下是具体探究过程:
vendor/symfony/browser-kit/Client.php中:


......
    /**
     * @param array     $server    The server parameters (equivalent of $_SERVER)
     * @param History   $history   A History instance to store the browser history
     * @param CookieJar $cookieJar A CookieJar instance to store the cookies
     */
    public function __construct(array $server = [], History $history = null, CookieJar $cookieJar = null)
    {
        $this->setServerParameters($server);
        $this->history = $history ?: new History();
        $this->cookieJar = $cookieJar ?: new CookieJar();
    }
......
    /**
     * Sets server parameters.
     *
     * @param array $server An array of server parameters
     */
    public function setServerParameters(array $server)
    {
        $this->server = array_merge([
            'HTTP_USER_AGENT' => 'Symfony BrowserKit',
        ], $server);
    }
......

设置了$this->sever的初始值,然后在该文件的:

public function request(string $method, string $uri, array $parameters = [], array $files = [], array $server = [], string $content = null, bool $changeHistory = true)
    {
......

        $server = array_merge($this->server, $server);
......
        $this->internalRequest = new Request($uri, $method, $parameters, $files, $this->cookieJar->allValues($uri), $server, $content);
......
        if ($this->insulated) {
            $this->response = $this->doRequestInProcess($this->request);
        } else {
            $this->response = $this->doRequest($this->request);
        }
......

如果Goutte 的 request 中没有设置相同键的sever ,生成的请求对象的sever属性就初始化包含HTTP_USER_AGENT(因为当前需求是在实例化的时候传参作为全局配置,不考虑在request之前设置header来使配置生效的方案),而在vendor/fabpot/goutte/Goutte/Client.php中:

protected function doRequest($request)
    {
        $headers = array();
        foreach ($request->getServer() as $key => $val) {
            $key = strtolower(str_replace('_', '-', $key));
            $contentHeaders = array('content-length' => true, 'content-md5' => true, 'content-type' => true);
            if (0 === strpos($key, 'http-')) {
                $headers[substr($key, 5)] = $val;
            }
            // CONTENT_* are not prefixed with HTTP_
            elseif (isset($contentHeaders[$key])) {
                $headers[$key] = $val;
            }
        }
......
        if (!empty($headers)) {
            $requestOptions['headers'] = $headers;
        }
......
        // Let BrowserKit handle redirects
        try {
            $response = $this->getClient()->request($method, $uri, $requestOptions);
            }
......

可见,Request的sever属性被用于作为GuzzleHttp实例的请求头,不过在上面的代码中,键 HTTP_USER_AGENT 已经被更改为user-agent,而从vendor/guzzlehttp/guzzle/src/Client.php文件可以看出 GuzzleHttp 实例的request方法调用了requestAsync方法,requestAsync中将上面代码传入的$requestOptions 作为请求头字段,在该文件中,从构造器可知,本文第一段代码中传入构造器的参数都会作为配置使用,在方法configureDefaults和prepareDefaults都有做处理,并将传入的请求头从以header为键换成了以_conditional为键:

private function prepareDefaults($options)
    {
        $defaults = $this->config;

        if (!empty($defaults['headers'])) {
            // Default headers are only added if they are not present.
            $defaults['_conditional'] = $defaults['headers'];
            unset($defaults['headers']);
        }
......
}

vendor/guzzlehttp/guzzle/src/Client.php的:

private function applyOptions(RequestInterface $request, array &$options)
{
......

        // Merge in conditional headers if they are not present.
        if (isset($options['_conditional'])) {
            // Build up the changes so it's in a single clone of the message.
            $modify = [];
            foreach ($options['_conditional'] as $k => $v) {
                if (!$request->hasHeader($k)) {
                    $modify['set_headers'][$k] = $v;
                }
            }
......

查找了_conditional数据是否在Request对象的请求头中存在,不存在就新增,至此,User-Agent配置失效的原因出来了,就是在此处被丢弃了,作如下修改,将传入的参数覆盖默认参数:

private function applyOptions(RequestInterface $request, array &$options)
{
......

        // Merge in conditional headers if they are not present.
        if (isset($options['_conditional'])) {
            // Build up the changes so it's in a single clone of the message.
            $modify = [];
            foreach ($options['_conditional'] as $k => $v) {
                if (!$request->hasHeader($k)) {
                //改动此处
                    $modify['set_headers'][$k] = $v;
                }
            }
......

这样,User-Agent配置就可以被正确使用了。

然而,设置的cookie还是无效,
继续调试源码,可以发现,在vendor/guzzlehttp/guzzle/src/Client.php的prepareDefaults 函数:

private function prepareDefaults($options)
    {
......
        // Shallow merge defaults underneath options.
        $result = $options + $defaults;
......        return $result;
    }

有一个合并数组的语句 $result = $options + $defaults;,但是,经过测试,该语句没有进行数组合并,我的php版本是7.1.3,这个应该跟版本有关,暂时没有查资料看具体适用于什么版本,我这儿直接改了就好了,类似还有该文件的另一处地方:

private function configureDefaults(array $config)
    {
......
        $this->config = $config + $defaults;
......

将其改成:

private function configureDefaults(array $config)
    {
......
        $this->config = array_merge($defaults, $config);
......

即可(array_merge中注意两个数组的顺序)。

我的个人博客:逐步前行STEP

使用以下代码将packagist源更换为中国镜像:

composer config -g repo.packagist composer https://packagist.phpcomposer.com

或者

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

我的个人博客:逐步前行STEP

1、$exist

查询 是否存在这个字段

//查询所有存在标签你字段的博客
App\Blog::where('tags','$exist',true)->get()

2、$in

查询 是否存在 【数组字段中的元素在列表中出现】

//查询所有包含标签tag_a或者tag_b的博客
App\Blog::whereRaw(['tags'=>['$in'=>["tag_a","tag_b"]]])->get()

3、$all

查询 是否存在 【数组字段中的元素全部在列表中】

//查询所有包含标签tag_a和tag_b的博客
App\Blog::whereRaw(['tags'=>['$all'=>["tag_a","tag_b"]]])->get()

4、$size

查询数组字段 tags 满足指定元素个数的文档

App\Blog::where('tags', 'size', 3)->get();

5、$where

条件过滤语句

App\Blog::whereRaw(['$where'=>'this.image_cnt = this.verify_image_cnt'])->get()

我的个人博客:逐步前行STEP

1、执行单例测试

./vendor/bin/phpunit

2、执行指定单例测试文件

./vendor/bin/phpunit   tests/BlogTest.php

3、执行指定测试函数

./vendor/bin/phpunit  --filter testPostArticle

4、执行指定文件的指定测试函数

./vendor/bin/phpunit  --filter testPostArticle  tests/BlogTest.php