iT邦幫忙

2024 iThome 鐵人賽

DAY 10
0
Software Development

做一支專屬自己學校的課程評價 LINE Bot 吧!系列 第 10

[Day 10] 使用 FlexSendMessage 讓回覆訊息變成-金箔陽春麵版

  • 分享至 

  • xImage
  •  

讓回覆訊息變得更美妙吧!

承如上篇所介紹,基本上已經了解回覆訊息的運作,並使用了 TextMessage 進行回覆,接下來將介紹 LINE 另一種回覆訊息的方式 FlexSendMessage,學會了就可以變成這樣啦:
https://ithelp.ithome.com.tw/upload/images/20240924/20151510ZeKLfgShoL.png

上圖為小生物 LINE Bot 所使用的 Flex message 訊息,使用者輸入課名或教師名後,所獲得的評價資訊介面。

定義需求

  • 改良回覆訊息的樣式,並以 FlexSendMessage 方式回覆

JSON 形式的 Flex message

LINE 提供了 Flex message 模擬器讓開發者可以藉由零件拼出客製化的訊息樣式,所以第一步就是要先做出來,可以選擇:

  1. 自行透過介面刻出對應的介面
  2. 使用匯入的方式貼上現成的 JSON 格式 message
    這邊教學方便,使用匯入的方式貼上現成的 JSON 格式 message,我這邊提供上圖中對應的評價回覆模板 JSON ,可以參照以下方式將內容貼上,按下 Apply 之後就會看到左側的簡圖囉~
    https://ithelp.ithome.com.tw/upload/images/20240924/20151510vEZCjgF8dR.png

編寫邏輯

  1. 建立一個 JSON 檔案: Python 跟 JSON 可謂是不同家的東東,需要額外放置,所以先將評價回覆模板 JSON 的內容放到一個新檔案:
    hulolo > chatbot > reply_evaluation.json
    https://ithelp.ithome.com.tw/upload/images/20240924/20151510EYWM1S4roo.png

是不是一切看起來甚好。

  1. 準備引入 JSON 的路徑與相關套件: 會使用路徑 ospathlib 套件以及 FlexSendMessage :

    from linebot.models import MessageEvent, TextMessage, TextSendMessage, \
         FlexSendMessage
    from pathlib import Path
    import os
    
    # 宣告一個路徑代表此資料夾的位置稍後要引入 JSON
    BASE_DIR = Path(__file__).resolve().parent.parent 
    
  2. 函式處理 JSON 引入與修改: flex_message_package 函式中負責將引入的 JSON 加上變數:

    def flex_message_package(course_info):
        # JSON 評價回覆格式位置
        json_path = os.path.join(BASE_DIR, 'chatbot', 'reply_evaluation.json')
        # Python 是看不懂 JSON 的,需要轉為字典形式
        flex = json.load(open(json_path, 'r', encoding='utf-8'))
    
        # 這裡是 JSON 中每個會成為變數的位置,將其換成真正資料表中的變數
        flex['header']['contents'][0]['text'] = course_info['course_name']
        flex['header']['contents'][1]['text'] = course_info['teacher_name']
        flex['body']['contents'][0]['contents'][0]['contents'][0]['text'] =
        course_info['feedback_content']
        flex['body']['contents'][0]['contents'][2]['contents'][1]['text'] =
        course_info['course_type']
        flex['body']['contents'][0]['contents'][3]['contents'][1]['text'] =
        course_info['evaluation_semester']
        flex['body']['contents'][0]['contents'][4]['contents'][1]['text'] =
        course_info['submitter_name']
        flex['footer']['contents'][0]['contents'][0]['text'] = 
        f"{course_info['teacher_name']}-{course_info['course_name']}"
        flex['footer']['contents'][0]['contents'][1]['text'] = 
        f"第{course_info['number']}則"
    
        return flex    
    
  3. 修正 handle_message 函式: 這次要改為回覆 flex message,我們會先使用 enumerate 取得 idx ,目的是為了要得到這是第幾則的評價;再用一個字典將變數裝好準備傳給 flex_message_package 函式幫忙美化:

    # 此檔案位置: hulolo > chatbot > views.py
    # 刪除以下程式碼
    for course in filtered_courses:
        messages.append(TextMessage(
            text=f"""課程: {course.course_name}\
            評價: {course.feedback_content}
            """))
    

    再來加上新的評價字典格式,以下的 course.course_name 等除了第幾則外,都是原資料表中的欄位,如果忘記了可以到 models.py 回去複習:

    # 此檔案位置: hulolo > chatbot > views.py
    # 在原本位置加入程式碼:
    
    for idx, course in enumerate(filtered_courses, start=1):  
        # 準備課程資料以傳入 flex_message_package 函式
        course_info = {
            'course_name': course.course_name,
            'teacher_name': course.teacher_name,
            'course_type': course.course_type,
            'feedback_content': course.feedback_content,
            'evaluation_semester': course.evaluation_semester,
            'submitter_name': course.submitter_name,
            'number': str(idx),  # 這裡的 idx 是第幾則的意思
            }
        # 呼叫 flex_message_package 函式來產生 Flex Message
        flex_message = flex_message_package(course_info)    
    
        # 以 `FlexSendMessage` 類型打包訊息
        messages.append(FlexSendMessage(
                        alt_text=f"課程評價:{course.course_name}",
                        contents=flex_message
                    ))
    #以下程式碼不變動,注意它沒有被包在迴圈哦!
    line_bot_api.reply_message
    

結果

同樣地,當輸入 王小明-海洋生命科學導論 就會得到一筆訊息回覆,輸入 吳小峰-特殊教育學生評量 則會收到兩筆訊息回覆,這樣就對啦~
https://ithelp.ithome.com.tw/upload/images/20240924/20151510dOBmmb8695.png

再往前一點點

  • JSON Editor Online 是我個人很愛的 JSON 線上編輯器,可以很清楚的知道每一個物件的位置與順序,能夠視覺化的了解變數應該塞進去的位置!

覆盤

在這篇文章中,我們學會了:

  • 利用 FlexSendMessage 與模擬器設計回覆訊息
  • 如何引入 JSON 檔案到 Django 中
  • 先塞入假文字,再透過變數對字典的更新,獲得可用的 Flex message
  • enumerate 搭配 for 迴圈可以得到索引也能用 start 設定起始數值
  • Day 10 原始碼

上一篇
[Day 09] 在 views.py 接收使用者訊息、篩選資料表及回覆 TextSendMessage 訊息-陽春麵版
下一篇
[Day 11] 以 PostbackEvent 觸發事件,讓使用者輸入老師名就能跑出課程列表
系列文
做一支專屬自己學校的課程評價 LINE Bot 吧!30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言