簡單兩步就能將 Laravel Log 資訊發到其他平臺上

coding01發表於2018-05-13

Laravel

我們在寫程式碼時，都想自己的程式碼儘可能的不影響現有的程式碼。

或者說，最大化不改動任何程式碼的情況下，如何嵌入我們的新功能？這是我們常說的「非侵入式」的開發方式。

使用「非侵入式」的開發模式，主要在提供第三方外掛和功能中最為常見。今天藉助「Rollbar」第三方工具來說說如何做到「非侵入式」開發。

本文主要能學到:

Laravel Event / Listener 原理；

Rollbar for Laravel 的使用

建立一個 Log to Dingding 群的功能

Laravel Event / Listener 原理

在 Laravel，主要利用 EventServiceProvider 來載入 Events / Listeners:

<?php

namespace Illuminate\Events;

use Illuminate\Support\ServiceProvider;
use Illuminate\Contracts\Queue\Factory as QueueFactoryContract;

class EventServiceProvider extends ServiceProvider
{
    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton('events', function ($app) {
            return (new Dispatcher($app))->setQueueResolver(function () use ($app) {
                return $app->make(QueueFactoryContract::class);
            });
        });
    }
}
複製程式碼

EventServiceProvider 返回的是 Dispatcher 物件。我們看看 Dispatcher 類：

<?php

namespace Illuminate\Events;

use Exception;
use ReflectionClass;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Illuminate\Container\Container;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
use Illuminate\Contracts\Events\Dispatcher as DispatcherContract;
use Illuminate\Contracts\Broadcasting\Factory as BroadcastFactory;
use Illuminate\Contracts\Container\Container as ContainerContract;

class Dispatcher implements DispatcherContract
{
    /**
     * The IoC container instance.
     *
     * @var \Illuminate\Contracts\Container\Container
     */
    protected $container;

    /**
     * The registered event listeners.
     *
     * @var array
     */
    protected $listeners = [];

    /**
     * The wildcard listeners.
     *
     * @var array
     */
    protected $wildcards = [];

    /**
     * The queue resolver instance.
     *
     * @var callable
     */
    protected $queueResolver;

    /**
     * Create a new event dispatcher instance.
     *
     * @param  \Illuminate\Contracts\Container\Container|null  $container
     * @return void
     */
    public function __construct(ContainerContract $container = null)
    {
        $this->container = $container ?: new Container;
    }

    /**
     * Register an event listener with the dispatcher.
     *
     * @param  string|array  $events
     * @param  mixed  $listener
     * @return void
     */
    public function listen($events, $listener)
    {
        foreach ((array) $events as $event) {
            if (Str::contains($event, '*')) {
                $this->setupWildcardListen($event, $listener);
            } else {
                $this->listeners[$event][] = $this->makeListener($listener);
            }
        }
    }

...

}
複製程式碼

主要作用是繫結 Events 和 Listeners，當 Events觸發時，直接執行 Listeners。

我們希望 log 除了在本地檔案儲存輸出外，也想把 log 資訊實時發到其他平臺和渠道上，這時候我們就需要藉助 LogServiceProvider 的 events / listeners繫結實現了。現在來看看 LogServiceProvider:

<?php

namespace Illuminate\Log;

use Monolog\Logger as Monolog;
use Illuminate\Support\ServiceProvider;

class LogServiceProvider extends ServiceProvider
{
    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton('log', function () {
            return $this->createLogger();
        });
    }

    /**
     * Create the logger.
     *
     * @return \Illuminate\Log\Writer
     */
    public function createLogger()
    {
        $log = new Writer(
            new Monolog($this->channel()), $this->app['events']
        );

        if ($this->app->hasMonologConfigurator()) {
            call_user_func($this->app->getMonologConfigurator(), $log->getMonolog());
        } else {
            $this->configureHandler($log);
        }

        return $log;
    }

   ...
}
複製程式碼

這裡將 $this->app['events'] 也就是 Dispatcher 傳入，使用者事件的註冊：

    /**
     * Register a new callback handler for when a log event is triggered.
     *
     * @param  \Closure  $callback
     * @return void
     *
     * @throws \RuntimeException
     */
    public function listen(Closure $callback)
    {
        if (! isset($this->dispatcher)) {
            throw new RuntimeException('Events dispatcher has not been set.');
        }

        $this->dispatcher->listen(MessageLogged::class, $callback);
    }
複製程式碼

有了 ServiceProvider 和 listen 就可以做到「非入侵」開發了。

Rollbar

Rollbar error monitoring integration for Laravel projects. This library adds a listener to Laravel's logging component. Laravel's session information will be sent in to Rollbar, as well as some other helpful information such as 'environment', 'server', and 'session'.

參考：docs.rollbar.com/docs/larave…

簡單使用

使用該工具，只要在其官網註冊賬號，併產生一個 access token 即可

安裝該工具，也只需要簡單的兩步：

composer require rollbar/rollbar-laravel

// .env
ROLLBAR_TOKEN=[your Rollbar project access token]

// 如果 < Laravel 5.5，則需要在 app.php 中新增
Rollbar\Laravel\RollbarServiceProvider::class,
複製程式碼

測試，只要有 Log 輸出，rollbar 後臺都可以收到資訊，方便檢視，而再也不需要去看 log 檔案了。

剖析實現原理

我們來看看 rollbar 是不是我們所設想的那樣實現的？

我們先看看 RollbarServiceProvider

<?php namespace Rollbar\Laravel;

use Illuminate\Support\ServiceProvider;
use InvalidArgumentException;
use Rollbar\Rollbar;
use Rollbar\Laravel\RollbarLogHandler;

class RollbarServiceProvider extends ServiceProvider
{
    /**
     * Indicates if loading of the provider is deferred.
     *
     * @var bool
     */
    protected $defer = false;

    /**
     * Bootstrap the application events.
     */
    public function boot()
    {
        // Don't boot rollbar if it is not configured.
        if ($this->stop() === true) {
            return;
        }

        $app = $this->app;

        // Listen to log messages.
        $app['log']->listen(function () use ($app) {
            $args = func_get_args();

            // Laravel 5.4 returns a MessageLogged instance only
            if (count($args) == 1) {
                $level = $args[0]->level;
                $message = $args[0]->message;
                $context = $args[0]->context;
            } else {
                $level = $args[0];
                $message = $args[1];
                $context = $args[2];
            }

            $app['Rollbar\Laravel\RollbarLogHandler']->log($level, $message, $context);
        });
    }

    /**
     * Register the service provider.
     */
    public function register()
    {
        // Don't register rollbar if it is not configured.
        if ($this->stop() === true) {
            return;
        }

        $app = $this->app;

        $this->app->singleton('Rollbar\RollbarLogger', function ($app) {

            $defaults = [
                'environment'       => $app->environment(),
                'root'              => base_path(),
                'handle_exception'  => true,
                'handle_error'      => true,
                'handle_fatal'      => true,
            ];
            $config = array_merge($defaults, $app['config']->get('services.rollbar', []));
            $config['access_token'] = getenv('ROLLBAR_TOKEN') ?: $app['config']->get('services.rollbar.access_token');

            if (empty($config['access_token'])) {
                throw new InvalidArgumentException('Rollbar access token not configured');
            }

            $handleException = (bool) array_pull($config, 'handle_exception');
            $handleError = (bool) array_pull($config, 'handle_error');
            $handleFatal = (bool) array_pull($config, 'handle_fatal');

            Rollbar::init($config, $handleException, $handleError, $handleFatal);

            return Rollbar::logger();
        });

        $this->app->singleton('Rollbar\Laravel\RollbarLogHandler', function ($app) {

            $level = getenv('ROLLBAR_LEVEL') ?: $app['config']->get('services.rollbar.level', 'debug');

            return new RollbarLogHandler($app['Rollbar\RollbarLogger'], $app, $level);
        });
    }

    /**
     * Check if we should prevent the service from registering
     *
     * @return boolean
     */
    public function stop()
    {
        $level = getenv('ROLLBAR_LEVEL') ?: $this->app->config->get('services.rollbar.level', null);
        $token = getenv('ROLLBAR_TOKEN') ?: $this->app->config->get('services.rollbar.access_token', null);
        $hasToken = empty($token) === false;

        return $hasToken === false || $level === 'none';
    }
}
複製程式碼

這個比較好理解，先利用 register 註冊兩個 singleton，然後在 boot 方法中，註冊 listener

    $app['log']->listen(function () use ($app){});
複製程式碼

其中 $app['log']，就是我們的上文說的 LogServiceProvider，將 listener 註冊到 EventServiceProvider 中。

$this->dispatcher->listen(MessageLogged::class, $callback);
複製程式碼

最後我們看看 Rollbar facades 返回的是：RollbarLogHandler 物件

<?php namespace Rollbar\Laravel\Facades;

use Illuminate\Support\Facades\Facade;

class Rollbar extends Facade
{
    /**
     * Get a schema builder instance for the default connection.
     *
     * @return \Rollbar\Laravel\RollbarLogHandler
     */
    protected static function getFacadeAccessor()
    {
        return 'Rollbar\Laravel\RollbarLogHandler';
    }
}

複製程式碼

看看 RollbarLogHandler 實現，也主要是將 log 資訊反饋到Rollbar 中，此處不做分析了。

模擬實現

通過對 Rollbar 簡單的分析，就會發現原來通過簡單 Listener，不用改現在的任何功能和程式碼，就能實現將 log 實時發到你想接收的地方。

所以我們可以嘗試也寫一個這樣的功能，將 log 資訊發到釘釘上。

好了，我們開始寫 Log2Dingding 外掛。

根據之前的文章我們可以很方便的組織好外掛結構:

composer.json 設定:

{
    "name": "fanly/log2dingding",
    "description": "Laravel Log to DingDing",
    "license": "MIT",
    "authors": [
        {
            "name": "fanly",
            "email": "yemeishu@126.com"
        }
    ],
    "require": {},
    "extra": {
        "laravel": {
            "providers": [
                "Fanly\\Log2dingding\\FanlyLog2dingdingServiceProvider"
            ]
        }
    },
    "autoload": {
        "psr-4": {
            "Fanly\\Log2dingding\\": "src/"
        }
    }
}

複製程式碼

我們定義 ServiceProvider:

<?php
/**
 * User: yemeishu
 * Date: 2018/5/13
 * Time: 下午2:56
 */
namespace Fanly\Log2dingding;

use Fanly\Log2dingding\Dingtalk\Messager;
use Illuminate\Support\ServiceProvider;
use Fanly\Log2dingding\Support\Client;

class FanlyLog2dingdingServiceProvider extends ServiceProvider {

    protected function registerFacade()
    {
        // Don't register rollbar if it is not configured.
        if ($this->stop() === true) {
            return;
        }

        $this->app->singleton('fanlylog2dd', function ($app) {
            $config['access_token'] = getenv('FANLYLOG_TOKEN') ?: $app['config']->get('services.fanly.log2dd.access_token');

            if (empty($config['access_token'])) {
                throw new InvalidArgumentException('log2dd access token not configured');
            }

            return (new Messager(new Client()))->accessToken($config['access_token']);
        });
    }

    /**
     * Bootstrap the application services.
     */
    public function boot()
    {
        // Don't boot rollbar if it is not configured.
        if ($this->stop() === true) {
            return;
        }

        $app = $this->app;

        // Listen to log messages.
        $app['log']->listen(function () use ($app) {
            $args = func_get_args();

            // Laravel 5.4 returns a MessageLogged instance only
            if (count($args) == 1) {
                $level = $args[0]->level;
                $message = $args[0]->message;
                $context = $args[0]->context;
            } else {
                $level = $args[0];
                $message = $args[1];
                $context = $args[2];
            }

            $app['fanlylog2dd']->message("[ $level ] $message\n".implode($context))->send();
        });

    }

    /**
     * Register the application services.
     */
    public function register()
    {
        $this->registerFacade();
    }

    private function stop()
    {
        $level = getenv('FANLYLOG_LEVEL') ?: $this->app->config->get('services.rollbar.level', null);
        $token = getenv('FANLYLOG_TOKEN') ?: $this->app->config->get('services.rollbar.access_token', null);
        $hasToken = empty($token) === false;

        return $hasToken === false || $level === 'none';
    }
}
複製程式碼

我們主要是建立一個發釘釘訊息的單例，然後再註冊 listener，只要獲取 log 資訊，就傳送資訊到釘釘上。

測試一下：

總結

最後做成外掛，和 Rollbar 一樣，引入：

composer require "fanly/log2dingding"

// .env
FANLYLOG_TOKEN=56331868f7056a3e645e7dba034c5550e7af***
複製程式碼

同樣的，其他資訊都不需要設定，跑一個測試：

Laravel 框架的一大好處在於，可以以友好的方式實現我們「非入侵」開發，只要藉助「ServiceProvider」和「Events/Listner」，就可以擴充套件我們的功能。

參考

「12步」製作 Laravel 外掛 (一)mp.weixin.qq.com/s/AD05BiKjP…
「3步」釋出 Laravel 外掛 (二)mp.weixin.qq.com/s/RSYeHU7aR…
fanly/log2dingding packagist.org/packages/fa…

簡單2步就能將大量檔案歸類儲存
2022-11-28
簡單兩步，給 Laravel-admin 煥新顏
2018-09-17
Laravel
將Hibernate配置到Weblogic JNDI上的詳細步驟
2003-08-25
Web
金融大資料分析還不簡單，有了Smartbi簡單幾步就能搞定
2022-01-20
大資料
將專案管理實施到金融公司的簡單步驟
2022-04-14
專案管理
簡單幾步把LOGO變字型
2013-07-23
Go
將asm上datafile移動到其他的diskgroup或者普通filesystem上
2013-02-04
ASM
兩種語言，一個平臺——《iOS開發指南：從Hello World到App Store上架》
2017-06-19
iOSAPP
DNSLOG平臺搭建從0到1
2020-06-27
DNS
最簡單的SAP雲平臺開發教程 - 如何開發UI5應用並執行在SAP雲平臺上
2018-04-24
UI
簡單兩步--搭建自己的專屬梯子
2018-11-22
簡訊效率高於其他社交媒體平臺
2013-10-04
將Java應用部署到SAP雲平臺neo環境的兩種方式
2018-06-19
Java
把日誌寫到其他伺服器上的操作步驟
2008-05-09
伺服器
Charilaos Kalogirou：分享將iOS遊戲移植到Android平臺的注意要點
2012-08-09
iOS遊戲Android
LEARUN快速開發平臺，讓開發變得更簡單
2019-12-20
微信公眾平臺開發（四）簡單回覆功能開發
2013-07-03
簡單的11步在Laravel中實現測試驅動開發
2019-02-27
Laravel
簡單的 11 步在 Laravel 中實現測試驅動開發
2018-07-17
Laravel
git上傳github簡單操作步驟
2019-04-07
Github
簡單 16步走一遍 Laravel Echo 的使用
2018-07-28
Laravel
JNPF快速開發平臺-簡單快速高效開發java專案
2020-10-10
Java
win7平臺上使用eclipse(luna)將mapred任務上傳到叢集上執行
2016-09-25
Win7Eclipse
上門洗車維修服務預約平臺小程式，洗車店入駐平臺製作開發方案，讓洗車更簡單！
2021-09-07
常用的自媒體工具有哪些？把文章發到30+平臺其實很簡單
2020-05-15
Facebook：跨平臺遊戲盈利比單平臺高33％將成為遊戲發展核心生態
2014-03-19
遊戲
4.PHP微信公眾平臺開發 - 簡單回覆功能開發
2019-05-11
PHP
直播系統平臺搭建，點選連結跳轉到三方平臺或其他頁面
2021-11-05
上海商業車險資訊平臺正式上線
2009-07-26
odps平臺將資料匯入到hdfs
2018-12-24
Appsblogger：融資平臺Kickstarter資訊資料圖
2012-06-13
APP
邁步進入跨平臺開發時代
2015-05-25
進行自媒體一鍵分發的平臺有哪些？分發簡不簡單？
2020-04-14
頭位資訊平臺將可靠性放在首位
2021-06-11
直播平臺軟體開發，簡單易修改的彈框元件
2023-04-06
元件
Cocos2dx 3.0rc 建立工程並移植到其他平臺
2014-03-16
Eclipse平臺中“MessageDialog”訊息對話方塊的簡單實現
2007-05-07
Eclipse
windows下安裝laravel簡單步驟以及碰到的問題
2016-02-24
WindowsLaravel