Laravel 5.8 Slackに通知を送信する(laravel/slack-notification-channel)
Laravel 5.8laravel/slack-notification-channelを利用してSlackへの通知を試してみました。
本家のドキュメントはこちら
https://laravel.com/docs/5.8/notifications#slack-notifications
Slack Webhook URL
プログラムの前に通知先のURLを取得しておきます。
こちらにアクセスしWebhook URLを作成します。
https://slack.com/apps/A0F7XDUAZ
https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
という形式のURLが取得できると思います。
.envファイルに追記しておきます。
・.env
SLACK_URL=https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
laravel/slack-notification-channel
つづいて、slack通知用のライブラリ「laravel/slack-notification-channel」をインストールします。
$ composer require laravel/slack-notification-channel
Notifiable
Slackへの通知はNotifiableトレイトを使用しているクラスに対して実行可能となります。
サンプルして、デフォルトで存在するApp\Userを変更しSlackへの通知を可能にしています。
・app/User.php
- <?php
- namespace App;
- use Illuminate\Notifications\Notifiable;
- use Illuminate\Contracts\Auth\MustVerifyEmail;
- use Illuminate\Foundation\Auth\User as Authenticatable;
- class User extends Authenticatable
- {
- use Notifiable;
- /**
- * The attributes that are mass assignable.
- *
- * @var array
- */
- protected $fillable = [
- 'name', 'email', 'password',
- ];
- /**
- * The attributes that should be hidden for arrays.
- *
- * @var array
- */
- protected $hidden = [
- 'password', 'remember_token',
- ];
- /**
- * The attributes that should be cast to native types.
- *
- * @var array
- */
- protected $casts = [
- 'email_verified_at' => 'datetime',
- ];
- // 以下を追加
- public function routeNotificationForSlack($notification)
- {
- return env('SLACK_URL');
- }
- }
Notification
通知する内容はNotificationクラスで指定します。
以下のコマンドでクラスの雛形を作成。
$ php artisan make:notification SampleNotification
app/Notifications/SampleNotification.phpが出力されます。
内容を以下のように編集。
・app/Notifications/SampleNotification.php
- <?php
- namespace App\Notifications;
- use Illuminate\Bus\Queueable;
- use Illuminate\Notifications\Notification;
- use Illuminate\Contracts\Queue\ShouldQueue;
- use Illuminate\Notifications\Messages\MailMessage;
- use Illuminate\Notifications\Messages\SlackMessage;
- class SampleNotification extends Notification
- {
- use Queueable;
- public function __construct()
- {
- }
- public function via($notifiable)
- {
- return ['slack'];
- }
- public function toArray($notifiable)
- {
- return [
- ];
- }
- public function toSlack($notifiable) {
- return (new SlackMessage)
- ->from('Bomb', ':bomb:') // 送信元
- ->to('#general ') // 送信先
- ->content('Slackへの通知テスト'); // メッセージ
- }
- }
送信テスト用のコマンドを作成します。
・app/Console/Commands/SampleCommand.php
- <?php
- namespace App\Console\Commands;
- use Illuminate\Console\Command;
- use Illuminate\Support\Facades\DB;
- use App\User;
- use App\Notifications\SampleNotification;
- class SampleCommand extends Command
- {
- protected $signature = 'my:command';
- protected $description = 'コマンドサンプル';
- public function __construct()
- {
- parent::__construct();
- }
- public function handle()
- {
- // Notifiableなオブジェクトを作成
- $user = new User();
- // 対象にSlackメッセージ配信
- $user->notify(new SampleNotification());
- }
- }
実行
$ php artisan my:command
お手軽にSlackへ通知できました。
複数人への一括配信
複数人に一括で配信したい場合は、Notification::sendが便利です。
- <?php
- namespace App\Console\Commands;
- use Illuminate\Console\Command;
- use Illuminate\Support\Facades\DB;
- use App\User;
- use App\Notifications\SampleNotification;
- use Illuminate\Notifications\Notification;
- class SampleCommand extends Command
- {
- protected $signature = 'my:command';
- protected $description = 'コマンドサンプル';
- public function __construct()
- {
- parent::__construct();
- }
- public function handle()
- {
- // Notifiableなオブジェクトを作成
- //$user = new User();
- // 対象にSlackメッセージ配信
- //$user->notify(new SampleNotification());
- $users = [];
- $users[] = new User();
- \Notification::send($users, new SampleNotification());
- }
- }
ユーザーごとにメッセージ内容を変更
SampleNotificationのtoSlackは、Notifiableトレイトをuseしているオブジェクトが渡されます。
今回の例だとUserオブジェクトが$notifiableとして渡されます。
ユーザーごとにメッセージを変更したい場合は、$notifiableの内容により処理を変更すればOKです。
・SampleNotification.php
- <?php
- namespace App\Notifications;
- use Illuminate\Bus\Queueable;
- use Illuminate\Notifications\Notification;
- use Illuminate\Contracts\Queue\ShouldQueue;
- use Illuminate\Notifications\Messages\MailMessage;
- use Illuminate\Notifications\Messages\SlackMessage;
- class SampleNotification extends Notification
- {
- use Queueable;
- public function __construct()
- {
- }
- public function via($notifiable)
- {
- return ['slack'];
- }
- public function toArray($notifiable)
- {
- return [
- ];
- }
- public function toSlack($notifiable) {
- return (new SlackMessage)
- ->from('Bomb', ':bomb:') // 送信元
- ->to('#general ') // 送信先
- ->content('Slackへの通知テスト:'.$notifiable->name); // メッセージ
- }
- }
・SampleCommand.php
- <?php
- namespace App\Console\Commands;
- use Illuminate\Console\Command;
- use Illuminate\Support\Facades\DB;
- use App\User;
- use App\Notifications\SampleNotification;
- use Illuminate\Notifications\Notification;
- class SampleCommand extends Command
- {
- protected $signature = 'my:command';
- protected $description = 'コマンドサンプル';
- public function __construct()
- {
- parent::__construct();
- }
- public function handle()
- {
- $users = [];
- $userA = new User();
- $userA->name = 'Aさんへのコメント';
- $users[] = $userA;
- $userB = new User();
- $userB->name = 'Bさんへのコメント';
- $users[] = $userB;
- $userC = new User();
- $userC->name = 'Cさんへのコメント';
- $users[] = $userC;
- \Notification::send($users, new SampleNotification());
- }
- }
実行結果
その他の使い方は、本家のドキュメントが詳しいです。
https://laravel.com/docs/5.8/notifications#slack-notifications
【参考URL】
https://laravel.com/docs/5.8/notifications#slack-notifications
Slack 通知を送信する
LaravelでFacadeを作ってSlackに通知してみた
