很多人都听说的webhook,也知道他有一个响当当的名字,『钩子』,但是想我一样听过没用过的人也有很多,这次我尝试了下个github上webhook的试水教程走了一遍,在这里跟大家做一下小小的分享,原文链接在这里。
webhook是个什么东西呢,在这里需要说一下啊,通俗的说就是,webhook就是你放在git仓库的一个通知员,一旦你的仓库里发生了什么事情,这个通知员就会用『你给他留得电话号码』给你打电话,说啥啥啥事发生了,然后你看看你该做些啥。
这里只提供一个试水的做法,里面有很多可以探索的东西,了解更多可以去原文了解。这里的用法以github仓库为例
步骤一:创建一个webhook(通知员)
这需要你有一个github仓库,然后进入这个仓库的settings中,选择webhook
然后进入后,再点击 『Add webhook』,这个时候可能会让你输入密码,anyway,输入就好了,然后就如下面
这里说下, 你要给通知员你的电话号码了,仓库里出了事,人家会打这个电话来通知你呀,对应这里呢,就是我们的Payload URL,我们先输入『http://localhost:4567/payload』(这里下面会解释,先这么输入着)。然后你看圆圈里是啥,圆圈里是事件,意思就是你跟人家通知员约定,什么情况下给我打电话,这个约定你可以自己选择,你可以选择只有仓库进货的时候(push事件)的时候给我打电话,也可以选择无论什么屁大的事都给我打电话,也可以选择让我自己来抉择什么情况给我打电话。然后勾选上Active,然后选择Add webhook。这一步就算完成了,你在仓库里就安排好了一个通知员,一个你的眼线。
步骤二: 配置你的服务器(电话)
你给了人家电话号码,让人家通知员有事给你打电话,还不给人家钱,如果你连电话都没有,那不是太坑了吗。所以呢,这里就要配置好你的电话。让你家那可怜的通知员打的电话你能收到。当然这里要求你的电话(服务器)能连接到电话网路(外网)上。
当然你不用太担心外网服务器的事情,咱们有个ngrok这么个神器,下载地址,下载下来就可以让你在本地就有一个外网地址。下载下来后,运行
./ngrok http 4567
就会有下面的提示
意思是你通过http://5ad4c892.ngrok.io 就可以访问到你的本地的4567端口了。所以咱们把咱们的真的电话号码给通知员去。
回到github的webhook页面,之前让你写的Payload URL的值是『http://localhost:4567/payload』,当然了,这个地址不是外网地址,人家通知员肯定不能正确通知你喽,所以现在就要重新设置地址了。把咱们在本地起的5ad4c892.ngrok.io 替换了localhost:4567,也就是Payload URL由之前的『http://localhost:4567/payload』变成了现在的『http://5ad4c892.ngrok.io/payload』,这样,这个电话线路就通了,人家打的电话就能到你这里了。
现在是真正要做电话的时候了,你需要在你的本地的4567上起一个服务了,这次咱们用sinatra。建一个文件,文件名为server.rb(需要你有ruby的环境),键入以下代码。
require 'sinatra'
require 'json'
post '/payload' do
push = JSON.parse(request.body.read)
puts "I got some JSON: #{push.inspect}"
end
然后运行
ruby server.rb
你就会看到
这样你就是建立了一个简版的小电话,可以接受通知员的电话了。
这个时候,在你的仓库里push个东西或者其他你选择的操作,就可以收到这个你操作的信息了。