聊天機器人 BOT，Python，教學

【Python】 Line Bot 開發 -3 Flask 與 Line Bot 的異國戀情!

發表於2018-02-182019-11-21 由MissterHao撰寫

前情提要:

在上一篇裡介紹了常用的 Line Bot Events
那在這一篇裡面我將要跟你們一起一步一步地建立最基本的
Flask server 和如何用 Flask server 與 Line Bot api 做結合

在接下來的內容中大致有兩大重點:

Flask server
Flask server 與 Line Bot api 做結合

就讓我們開始動手做吧!!

Getting Your Hands Drity!

Line Bot 系列文章:

因為我發現wordpress好像步行列出同系列的文章
所以這邊幫大家把這系列的都列出來了，這樣大家比較好找~

基本款 Flask Server:

還記得之前有談到 Line Bot接收到指令後會從他的Line server那邊POST一個請求到你設定的Webhook取得之後要做的事，那我們自己設定的Webhook其實就是一個很簡單的網址，一個可以接收他POST過來的資料然後作完處理後再回傳相對應的回應(就是一般所說的API啦XD)

那想要做出這樣的功能就要就要先做出一個簡單且且可以服務的Server

那初學者想要做出一個簡單且且可以服務的Server就要先學會用Flask

那要先學會Flask就要先看Henry Li’s Blog啦XD

廢話不多說了啦開始做啦

安裝:

pip install flask

這樣就安裝好了呀!

CODE:

做一個Server就只有三個步驟:

Import and Setting
Add View
run server

1. Import and Setting

這裡很簡單，需要宣告一個變數負責掌控server，那在此範例中我將命名為app

from flask import Flask

app = Flask(__name__)

接下來如果需要任何的設定都可以在app.config裡面調整，例如:

app.config["host"] = "0.0.0.0"

2. Add View

在 flask 裡面，你可以使用 app.route(routepath) 這個裝飾氣(decorator)來為你的路徑設定服務的function。

在Python裡面Decorator用的好不好對於一個大Project來說是很重要的

就我的經驗來看它可以把很多功能包裝起來要用時再用decotator來包裝就好，設計得好的話真的非常方便呢!!

@app.route("/")
def root():
    return "Root Page"

3. run server

server的設定差不多完成啦

在Flask系列的套件裡面都是差不多的啟動方法啦

app.run(host, port, ....)

總整理一下

from flask import Flask

app = Flask(__name__)

@app.route("/")
def root():
    return "Root Page"

if __name__ == "__main__":
    app.run("0.0.0.0", 5000, debug=True)

現在你只要在網址列打上 localhost:5000 就可以看到

這樣我們就成功完成一個簡單的server了~~

Flask server 與 Line Bot api 做結合:

當然你一定要先安裝 Line Bot 相關的套件啦

pip install line-bot-sdk

接下來就是需要 import 和做 setting 啦!

from linebot import (
    LineBotApi, WebhookHandler
)
from linebot.exceptions import (
    InvalidSignatureError
)
from linebot.models import (
    MessageEvent, TextMessage, TextSendMessage,
)

app = Flask(__name__)
line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
handler = WebhookHandler('YOUR_CHANNEL_SECRET')

前面的import 都跟一般的作用一樣，但 line_bot_api 和 handler 又是做什麼用的呢??

line_bot_api 負責與 Line 本身的API做溝通(就是幫你都做好準備了啦XD)

handler 負責處理送過來的資料

@handler.add(MessageEvent, message=TextMessage)
def handle_message(event):
  
  line_bot_api.reply_message(event.reply_token,TextSendMessage(text=event.message.text))

利用 handler.add 這個 function 來包裝裝飾你自己處理 line 回傳的 json 資料

那你可能會問 json 資料長什麼樣子呢? Key 有什麼呢?

答案在這裡~ reference!

在上面的連結裡面有著所有的官方 line bot api response

至於上面的 MessageEvent 就是當收到的是文字訊息時，就會啟動

那準備好處理 Event 總要有一個自己的api去接收json吧!!

那就是~

@app.route("/callback", methods=['POST'])

def callback():

    # get X-Line-Signature header value
    signature = request.headers['X-Line-Signature']

    # get request body as text
    body = request.get_data(as_text=True)
    app.logger.info("Request body: " + body)
    # handle webhook body

    try:
        handler.handle(body, signature)
    except InvalidSignatureError:
        abort(400)
    return 'OK'

handler.handle(body, signature): 會幫你判斷要用剛剛設定的哪個 event 來作回應

InvalidSignatureError: Line sdk 會檢查你的資料是否正確(用你的CHANNEL_ACCESS_TOKEN)

其實到這邊為止就已經設定好了所有的事件等等的了!

接下來就是做個總整理就可以run啦~

底下範例出處

from flask import Flask, request, abort
from linebot import (
    LineBotApi, WebhookHandler
)
from linebot.exceptions import (
    InvalidSignatureError
)
from linebot.models import (
    MessageEvent, TextMessage, TextSendMessage,
)

app = Flask(__name__)

line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
handler = WebhookHandler('YOUR_CHANNEL_SECRET')

@app.route("/callback", methods=['POST'])
def callback():
    # get X-Line-Signature header value
    signature = request.headers['X-Line-Signature']

    # get request body as text
    body = request.get_data(as_text=True)
    app.logger.info("Request body: " + body)

    # handle webhook body
    try:
        handler.handle(body, signature)
    except InvalidSignatureError:
        abort(400)

    return 'OK'

@handler.add(MessageEvent, message=TextMessage)
def handle_message(event):
    line_bot_api.reply_message(
        event.reply_token,
        TextSendMessage(text=event.message.text))


if __name__ == "__main__":
    app.run()

到這裡大家應該都了解怎麼用自己設計的server與Line Bot API做串接了吧了吧~(?

如果有問題的話也歡迎留言在下方告訴我喔

# ——————————————————————————————————————–

# 距離上一篇好像有點久遠了QAQ，開學後一直很忙都沒什麼上來繼續寫教學

# 最近有些專題部分有點忙到一個段落(??)有空時間就上來繼續發文章吧~~

# 有任何指教或是問題的都可以在下方跟我討論喔!

# ——————————————————————————————————————–

最後一篇沒有意外的話(我沒有加新文章的話)就是要跟大家講解一下幾個常見的Paas伺服器的架設方法了!

到目前為止我們的 Line Bot 都還在本機上面吧!

如果不能放到伺服器上面的話要怎麼跟朋友炫耀你的小機器人呢XD 你說對吧XDDDD

下一篇的重點就是架設伺服器並將你的https webhook設定到line bot中

接著就可以看著他根據你設定的功能對你做回應啦~~~~(灑花~

那我們就下一篇再見吧~掰掰~

# ================================================================

# 2018/03/03 補充
# 看到留言來補充 push 的用法
((還記得在第一篇時我有說到不是每種line bot 都可以用push 的功能嗎?
要照著我說的那樣申請才能使用主動push的功能喔!
其實寫法並不難只要一行就OK了~~

但是 BUT HOWEVER

你一定要指名你要傳給誰喔!!

因為我在這邊採到雷過QAQ

先來show一下寫法吧~

python
line_bot_api.push_message( id, TextSendMessage(text="XD"))

id: 這邊的id 並不是我們line互加好友的那個id喔!

這邊是指line伺服器那邊儲存的喔(room_id, group_id或是一般id都可以)!!

那我們要怎麼拿到呢?

可以用特定的事件來記錄reply的id(會出現在 handle_message 的 event裡面)

這樣就可以主動推波消息出去了~

# ===============================================================

# 2018/04/08 更新
# profile 用法

profile = line_bot_api.get_profile(user_id)

有一個function叫做 get_profile
會回傳一個class，可以用 profile.display_name 來顯示喔!

# ===============================================================

作者： MissterHao

一位熱愛資工領域、喜歡好笑事物、偶爾打打網球的學生 ! For A Better Me! View All Posts