在项目中使用 Slack 经常需要用到发消息的功能,为了简化这个操作,我们可以使用一个 npm 包叫做 slack-webhook
。这个包可以让我们使用几行 JavaScript 代码快速的发送消息到 Slack。
安装
使用 npm 安装 slack-webhook:
npm install slack-webhook
使用
- 首先,需要为你的工作区创建一个 Incoming Webhooks URL。进入 Slack 界面的 Your Apps 模块,点击 Create New App 来新建一个 app,并为这个 app 添加一个 Incoming Webhooks 功能,最终可以获得一个 Incoming Webhooks URL。
- 然后,在项目中引入
slack-webhook
模块,创建一个Slack
实例:
const Slack = require('slack-webhook') const url = 'https://hooks.slack.com/services/xxxxxxxxx/xxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxx' const slack = new Slack(url)
记得替换 Incoming Webhooks URL。
- 使用
slack.send()
函数发送消息:
-- -------------------- ---- ------- ------------ ----- ------- -------- ------------ -- ------ ----- ----- ------------- ------- -- ------ ----------- ------ ------- ------ ---- -- -- --
在发送消息时,我们可以设置一些附加内容,如 messages、attachments 等。
格式
可以使用 Slack Message Builder 为消息添加样式,例如:
-- -------------------- ---- ------- ------------ ----- --- ------------ -- ------ ---------- -------- ---- --------- ------ ------- -------- ----------- -------------------------- ----- ----- -- -- ------- ---------- ------- -- ------ ----------- ------ ------- ------ ---- --- ------- -------- -- ------- ------------ ----------------------------------- --- ---------- - ---- -- --------- -- --
示例
下面是一个完整的例子:
-- -------------------- ---- ------- ----- ----- - ------------------------ ----- --- - ----------------------------------------------------------------------------- ----- ----- - --- ---------- ------------ ----- --- ------------ -- ------ ---------- -------- ---- --------- ------ ------- -------- ----------- -------------------------- ----- ----- -- -- ------- ---------- ------- -- ------ ----------- ------ ------- ------ ---- --- ------- -------- -- ------- ------------ ----------------------------------- --- ---------- - ---- -- --
这个例子创建了一个名为 Hello, World!
的消息。消息包括标题 New message
,链接到 https://www.example.com
,信息内容为 This is an example message.
,优先级为 High
。其中,footer
提供了一个给 Slack 发送方的链接。在消息的最右下方,可以看到一个 Powered by Slack
的标记,并附带一个自定义的图片链接。
指导意义
通过这个 npm 包,我们可以快速的实现向 Slack 上面发送消息的功能,这对于项目开发过程中的协调和信息沟通有着非常重要的作用。同时,使用 Slack 还可以大大减少邮件沟通和会议时间,将团队的效率提升到一个新的高度。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/125130