哮天犬通知组件

适配Hyperf框架的通知组件，支持短信、电话、邮件、钉钉工作通知、钉钉机器人、知音楼工作通知、知音楼机器人等通知渠道。
该SDK可以用于项目中直接往以上七种通知渠道发送通知，不是告警通知SDK，请注意区分，告警通知SDK请移步：PHP告警SDK。 该SDK只适配过 Hyperf1.1、Hyperf2.0 框架，未适配其他框架，其他框架请测试是否可用之后再用于生产环境

代码仓库

https://github.com/tal-tech/alarm-dog-noticer
最新文档请参考代码仓库的 README.md 文件说明

安装

  1. # composer安装依赖
  2. composer require alarm-dog/noticer

配置

使用Hyperf框架工具生成默认配置：

  1. php bin/hyperf.php vendor:publish alarm-dog/noticer

默认配置文件将会被拷贝到框架根目录 config/autoload/noticer.php 注意修改配置文件中的 env 环境变量配置

使用

邮件通知

  1. use Dog\Noticer\Channel\Email;
  2. use Dog\Noticer\Exception\NoticeException;
  4. /**
  5.  * @var Email
  6.  */
  7. $mail = make(Email::class);
  8. // $mail = $this->container->make(Email::class); // 效果一样
  10. try {
  11.     // 发送纯文本
  12.     $mail->to('yourname@foo.bar', '你的名字')
  13.         ->subject('test')
  14.         ->text('<h1>title1</h1>')
  15.         ->send();
  16. } catch (NoticeException $e) {
  17.     // do something for exception
  18. }
  20. // 发送html
  21. $mail->init()
  22.     // ->to('yourname@foo.bar', '你的名字')
  23.     ->to('yourname@foo.bar') // 第二个参数可以省略
  24.     ->subject('test')
  25.     ->html('<h1>title1</h1>')
  26.     ->send();
  28. // 一行一行文本发送
  29. $mail->init()
  30.     // ->to('yourname@foo.bar', '你的名字')
  31.     ->to(['yourname@foo.bar' => '你的名字']) // 可以通过数组格式给多个人发
  32.     ->subject('test')
  33.     ->line('<h1>title1</h1>')
  34.     ->line('<h1>title2</h1>')
  35.     ->line('<h1>title3</h1>')
  36.     ->send();
  38. // 发送视图
  39. $mail->init()
  40.     ->to('yourname@foo.bar', '你的名字')
  41.     ->subject('test')
  42.     ->view('mail', ['name' => '参数值'])
  43.     ->send();
  44. // 视图配置
  45. /*
  46. <!DOCTYPE html>
  47. <html lang="en">
  48. <head>
  49.     <meta charset="UTF-8">
  50.     <title>Hyperf</title>
  51. </head>
  52. <body>
  53. Hello, {{ $name }}. You are using blade template now.
  54. </body>
  55. </html>
  56. */
  58. // 指定blade模板引擎发送视图
  59. $mail->init()
  60.     ->to('yourname@foo.bar', '你的名字')
  61.     ->subject('test')
  62.     ->blade('mail', ['name' => '参数值'])
  63.     ->send();
  65. // 给多个人发送
  66. // 指定blade模板引擎发送视图
  67. $mail->init()
  68.     ->to([
  69.         'yourname@foo.bar' => '你的名字1',
  70.         'yourname2@foo.bar' => '你的名字2',
  71.     ])
  72.     ->subject('test')
  73.     ->view('mail', ['name' => '参数值'])
  74.     ->send();
  76. // 每次发送之后如果仍使用同一个实例，务必重置，否则可能出现问题
  77. $mail->init()
  78.     ->to('yourname@foo.bar', '你的名字')
  79.     ->subject('test')
  80.     ->html('<h1>重置完成</h1>')
  81.     ->send();
  83. // 更多功能请扒源码

短信通知

  1. use Dog\Noticer\Channel\Sms;
  3. /**
  4.  * @var Sms
  5.  */
  6. $sms = make(Sms::class);
  7. // $sms = $this->container->make(Sms::class); // 效果一样
  9. try {
  10.     $tplId = '111111111';
  11.     $param = ['name' => '张三'];
  12.     $receivers = ['131xxxxxxxx', '132xxxxxxxx'];
  13.     $sms->send($tplId, $param, $receivers);
  14. } catch (NoticeException $e) {
  15.     // do something for exception
  16. }

电话通知

  1. use Dog\Noticer\Channel\Phone;
  3. /**
  4.  * @var Phone
  5.  */
  6. $phone = make(Phone::class);
  7. // $phone = $this->container->make(Phone::class); // 效果一样
  9. try {
  10.     $content = '您的验证码为：123456';
  11.     $receiver = '131xxxxxxxx'; // 只能单个发送
  12.     $phone->send($content, $receiver);
  13. } catch (NoticeException $e) {
  14.     // do something for exception
  15. }

钉钉工作通知

  1. use Dog\Noticer\Channel\DingWorker;
  2. use Dog\Noticer\Channel\DingWorker\MsgType\Text;
  3. use Dog\Noticer\Channel\DingWorker\MsgType\Markdown;
  4. use Dog\Noticer\Channel\DingWorker\MsgType\ActionCard;
  6. /**
  7.  * @var DingWorker
  8.  */
  9. $dingworker = make(DingWorker::class);
  10. // $dingworker = $this->container->make(DingWorker::class); // 效果一样
  12. // 发送文本
  13. try {
  14.     // 注意：工作通知相同内容只能一天给一个人发一次，每个人最多一天收到50条消息，为了让通知内容不会因为相同被拦截，可以加上当前发送的时间
  15.     // 其他所有格式都一样，相同会被拦截，建议都加上时间，包括markdown、actionCard
  16.     // $text = new Text('通知内容' . "\n" . date('Y-m-d H:i:s'));
  17.     $text = new Text('通知内容');
  18.     $options = [
  19.         'emails' => 'yourname@foo.bar', // 多一个以|分隔，例如 'emails' => 'yourname@foo.bar|yourname2@foo.bar',
  20.         // 'workcodes' => '01', // 多一个以|分隔，必须带前面0，与邮箱填一个即可
  21.     ];
  22.     $dingworker->send($text, $options);
  23. } catch (NoticeException $e) {
  24.     // do something for exception
  25. }
  27. // 发送markdown，仅支持markdown子集，具体请参考：https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/9e91d73c
  28. $markdown = new Markdown('标题', "
  29. # title1
  30. # title2
  31. ---
  33. **加粗** 不加粗
  34. ");
  35. $options = [
  36.     'emails' => 'yourname@foo.bar', // 多一个以|分隔，例如 'emails' => 'yourname@foo.bar|yourname2@foo.bar',
  37.     // 'workcodes' => '01', // 多一个以|分隔，必须带前面0，与邮箱填一个即可
  38. ];
  39. $dingworker->send($markdown, $options);
  41. // 发送ActionCard
  42. $actionCard = new ActionCard('标题', "
  43. # markdown文本，主体内容
  44. # ---
  45. ");
  46. // 单个button
  47. $actionCard->single('button标题', 'button跳转url');
  48. // 或者多个button
  49. $actionCard->btn('button标题1', 'button跳转url1')
  50.     >btn('button标题2', 'button跳转url2')
  51.     >btn('button标题3', 'button跳转url3');
  52. // 或者通过数组设置多个button
  53. $actionCard->btns([
  54.     ['title' => 'button标题1', 'action_url' => 'button跳转url1'],
  55.     ['title' => 'button标题2', 'action_url' => 'button跳转url2'],
  56. ]);
  57. // 默认button为横向排列，如果需要竖向，可设置：
  58. $actionCard->setVertical(true);
  59. $dingworker->send($actionCard, $options);
  61. // 更多消息类型请扒源码

钉钉机器人（钉钉群）通知

  1. use Dog\Noticer\Channel\DingGroup;
  2. use Dog\Noticer\Channel\DingGroup\MsgType\Text;
  3. use Dog\Noticer\Channel\DingGroup\MsgType\Markdown;
  4. use Dog\Noticer\Channel\DingGroup\MsgType\ActionCard;
  6. /**
  7.  * @var DingGroup
  8.  */
  9. $dinggroup = make(DingGroup::class);
  10. // $dinggroup = $this->container->make(DingGroup::class); // 效果一样
  12. $robots = [
  13.     ['webhook' => '钉钉机器人webhook中的access_token的值', 'secret' => '此参数非必填'],
  14.     ['webhook' => '另外一个机器人'],
  15. ];
  16. $options = [
  18. ]
  19. // 发送文本
  20. try {
  21.     $text = new Text('通知内容');
  22.     $dinggroup->send($text, $robots, $options);
  23. } catch (NoticeException $e) {
  24.     // do something for exception
  25. }
  27. // 发送markdown，仅支持markdown子集，具体请参考：https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/9e91d73c
  28. $markdown = new Markdown('标题', "
  29. # title1
  30. # title2
  31. ---
  33. **加粗** 不加粗
  34. ");
  35. $dinggroup->send($markdown, $robots, $options);
  37. // 发送ActionCard
  38. $actionCard = new ActionCard('标题', "
  39. # markdown文本，主体内容
  40. # ---
  41. ");
  42. // 单个button
  43. $actionCard->single('button标题', 'button跳转url');
  44. // 或者多个button
  45. $actionCard->btn('button标题1', 'button跳转url1')
  46.     >btn('button标题2', 'button跳转url2')
  47.     >btn('button标题3', 'button跳转url3');
  48. // 或者通过数组设置多个button
  49. $actionCard->btns([
  50.     ['title' => 'button标题1', 'action_url' => 'button跳转url1'],
  51.     ['title' => 'button标题2', 'action_url' => 'button跳转url2'],
  52. ]);
  53. // 默认button为横向排列，如果需要竖向，可设置：
  54. $actionCard->setVertical(true);
  55. $dinggroup->send($actionCard, $robots, $options);
  57. // 更多消息类型请扒源码

知音楼机器人（知音楼群）通知

  1. use Dog\Noticer\Channel\YachGroup;
  2. use Dog\Noticer\Channel\YachGroup\MsgType\Text;
  3. use Dog\Noticer\Channel\YachGroup\MsgType\Markdown;
  4. use Dog\Noticer\Channel\YachGroup\MsgType\ActionCard;
  6. /**
  7.  * @var YachGroup
  8.  */
  9. $yachgroup = make(YachGroup::class);
  10. // $yachgroup = $this->container->make(YachGroup::class); // 效果一样
  12. $robots = [
  13.     ['webhook' => 'yach机器人webhook中的access_token的值', 'secret' => '此参数必填'],
  14. ];
  15. // 发送文本
  16. try {
  17.     $text = new Text('通知内容');
  18.     $yachgroup->send($text, $robots);
  19. } catch (NoticeException $e) {
  20.     // do something for exception
  21. }
  23. // 发送markdown，仅支持markdown子集，具体请参考（Yach和钉钉差不多）：https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/9e91d73c
  24. $markdown = new Markdown('标题', "
  25. # title1
  26. # title2
  27. ---
  29. **加粗** 不加粗
  30. ");
  31. $yachgroup->send($markdown, $robots);
  33. // 发送markdown，并带图片地址
  34. $markdown = new Markdown('标题', "
  35. # title1
  36. # title2
  37. ---
  39. **加粗** 不加粗
  40. ", 'http://bpit-public.oss-cn-beijing.aliyuncs.com/note_1_1572593268.jpg');
  41. $yachgroup->send($markdown, $robots);
  43. // 发送ActionCard
  44. $actionCard = new ActionCard('标题', "
  45. # markdown文本，主体内容
  46. # ---
  47. ", $image = '', $contentTitle = ''); // 此处可以填下image和contentTitle的参数
  48. // 单个button
  49. $actionCard->single('button标题', 'button跳转url');
  50. // 或者多个button
  51. $actionCard->btn('button标题1', 'button跳转url1')
  52.     >btn('button标题2', 'button跳转url2')
  53.     >btn('button标题3', 'button跳转url3');
  54. // 或者通过数组设置多个button
  55. $actionCard->btns([
  56.     ['title' => 'button标题1', 'action_url' => 'button跳转url1'],
  57.     ['title' => 'button标题2', 'action_url' => 'button跳转url2'],
  58. ]);
  59. // 默认button为横向排列，如果需要竖向，可设置：
  60. $actionCard->setVertical(true);
  61. $yachgroup->send($actionCard, $robots);
  63. // 更多消息类型请扒源码

知音楼工作通知

  1. use Dog\Noticer\Channel\YachWorker;
  2. use Dog\Noticer\Channel\YachWorker\MsgType\Text;
  3. use Dog\Noticer\Channel\YachWorker\MsgType\Markdown;
  4. use Dog\Noticer\Channel\YachWorker\MsgType\ActionCard;
  6. /**
  7.  * @var YachWorker
  8.  */
  9. $yachworker = make(YachWorker::class);
  10. // $yachworker = $this->container->make(YachWorker::class); // 效果一样
  12. $options = [
  13.     // 通过邮箱发送（推荐）
  14.     'user_type' => 'email',
  15.     // 多个以|分隔
  16.     'userid_list' => 'ethananony@aliyun.com|xxxxxxxxxx@foo.bar',
  17.     // // 通过工号发送
  18.     // 'user_type' => 'workcode',
  19.     // // 多个以|分隔
  20.     // 'userid_list' => '01|999999',
  21. ];
  22. // 发送文本
  23. try {
  24.     $text = new Text('通知内容');
  25.     $yachworker->send($text, $options);
  26. } catch (NoticeException $e) {
  27.     // do something for exception
  28. }
  30. // 发送markdown，仅支持markdown子集，具体请参考（Yach和钉钉差不多）：https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq/9e91d73c
  31. $markdown = new Markdown('标题', "
  32. # title1
  33. # title2
  34. ---
  36. **加粗** 不加粗
  37. ");
  38. $yachworker->send($markdown, $options);
  40. // 发送markdown，并带图片地址
  41. $markdown = new Markdown('标题', "
  42. # title1
  43. # title2
  44. ---
  46. **加粗** 不加粗
  47. ", 'http://bpit-public.oss-cn-beijing.aliyuncs.com/note_1_1572593268.jpg');
  48. $yachworker->send($markdown, $options);
  50. // 发送ActionCard
  51. $actionCard = new ActionCard('标题', "
  52. # markdown文本，主体内容
  53. # ---
  54. ", $image = '', $contentTitle = ''); // 此处可以填下image和contentTitle的参数
  55. // 单个button
  56. $actionCard->single('button标题', 'button跳转url');
  57. // 或者多个button
  58. $actionCard->btn('button标题1', 'button跳转url1')
  59.     >btn('button标题2', 'button跳转url2')
  60.     >btn('button标题3', 'button跳转url3');
  61. // 或者通过数组设置多个button
  62. $actionCard->btns([
  63.     ['title' => 'button标题1', 'action_url' => 'button跳转url1'],
  64.     ['title' => 'button标题2', 'action_url' => 'button跳转url2'],
  65. ]);
  66. // 默认button为横向排列，如果需要竖向，可设置：
  67. $actionCard->setVertical(true);
  68. $yachworker->send($actionCard, $options);
  70. // 更多消息类型请扒源码