Merge pull request #3 from gdsc-ncku/refactor-service

feat: refactor message handling into dedicated handler modules

Author: yenslife

linebot/app/services/handlers/__init__.py

@@ -0,0 +1,13 @@
+# 匯出所有處理函式
+from .text_handler import handle_text_message
+from .image_handler import handle_image_message
+from .audio_handler import handle_audio_message
+from .common import send_message, create_quick_reply
+
+__all__ = [
+    "handle_text_message",
+    "handle_image_message",
+    "handle_audio_message",
+    "send_message",
+    "create_quick_reply",
+]

linebot/app/services/handlers/audio_handler.py

@@ -0,0 +1,12 @@
+"""處理音訊訊息的模組"""
+
+import logging
+from linebot.models import TextSendMessage
+from .common import create_quick_reply
+
+logger = logging.getLogger(__name__)
+
+
+def handle_audio_message(event):
+    """處理音訊訊息"""
+    return [TextSendMessage(text="收到音訊消息", quick_reply=create_quick_reply())]

linebot/app/services/handlers/common.py

@@ -0,0 +1,50 @@
+"""共用函式模組"""
+
+import logging
+from linebot.models import (
+    QuickReply,
+    QuickReplyButton,
+    MessageAction,
+    SendMessage,
+)
+from ...config.line_config import line_bot_api
+
+logger = logging.getLogger(__name__)
+
+# 常用指令
+COMMANDS = {
+    "/help": (
+        "📚 可用的指令列表：\n"
+        "1. /help - 顯示此幫助訊息\n"
+        "2. /setup - 設定相關功能\n\n"
+        "💡 您也可以直接輸入問題，我會盡力協助您！"
+    ),
+    "/setup": "⚙️ 設定功能開發中，敬請期待！",
+}
+
+
+def create_quick_reply() -> QuickReply:
+    """建立快速回覆按鈕"""
+    return QuickReply(
+        items=[
+            QuickReplyButton(action=MessageAction(label="說明", text="/help")),
+            QuickReplyButton(action=MessageAction(label="設定", text="/setup")),
+        ]
+    )
+
+
+def send_message(reply_token: str, messages: list[SendMessage]) -> None:
+    """發送訊息到 LINE"""
+    readable_messages = str(messages).encode("utf-8").decode("unicode_escape")
+    logger.info(f"準備發送訊息 (使用可讀字串): {readable_messages}")
+
+    # 確保 messages 是一個扁平化的訊息列表 (因為可能有巢狀的訊息列表)
+    flat_messages = []
+    for msg in messages:
+        if isinstance(msg, list):
+            flat_messages.extend(msg)  # 如果是列表，則展開
+        else:
+            flat_messages.append(msg)  # 如果是單一訊息，則直接加入
+
+    line_bot_api.reply_message(reply_token, flat_messages)
+    logger.info(f"已發送訊息: {flat_messages}")

linebot/app/services/handlers/image_handler.py

@@ -0,0 +1,40 @@
+"""處理圖片訊息的模組"""
+
+import os
+import logging
+from linebot.models import TextSendMessage
+from .common import create_quick_reply
+from ...api.vision import process_image
+from ...config.line_config import line_bot_api
+
+logger = logging.getLogger(__name__)
+
+
+def handle_image_message(event):
+    """處理圖片訊息"""
+    try:
+        # 取得圖片內容
+        message_id = event.message.id
+        message_content = line_bot_api.get_message_content(message_id)
+
+        # 建立臨時檔案保存圖片
+        temp_file_path = f"{message_id}.jpg"
+        with open(temp_file_path, "wb") as temp_image_file:
+            for chunk in message_content.iter_content():
+                temp_image_file.write(chunk)
+
+        # 使用 vision 函式處理圖片
+        response = process_image(
+            temp_file_path, "圖片內容有什麼?"
+        )  # TODO: 設定圖片處理的 prompt
+        # 刪除臨時檔案
+        os.remove(temp_file_path)
+        return [TextSendMessage(text=response, quick_reply=create_quick_reply())]
+    except Exception as e:
+        logger.error(f"處理圖片訊息時發生錯誤: {str(e)}", exc_info=True)
+        return [
+            TextSendMessage(
+                text="抱歉，處理圖片時發生錯誤，請稍後再試。",
+                quick_reply=create_quick_reply(),
+            )
+        ]

linebot/app/services/handlers/text_handler.py

@@ -0,0 +1,60 @@
+"""處理文字訊息的模組"""
+
+import json
+import logging
+from linebot.models import TextSendMessage, FlexSendMessage
+from .common import create_quick_reply, COMMANDS
+from ...api.dify import inference
+
+logger = logging.getLogger(__name__)
+
+
+def handle_text_message(event):
+    """處理文字訊息"""
+    try:
+        user_input = event.message.text
+        user_id = event.source.user_id
+
+        # 產生回應訊息
+        quick_reply = None
+        if user_input in COMMANDS:
+            response_text = COMMANDS[user_input]
+            quick_reply = create_quick_reply()
+            return [TextSendMessage(text=response_text, quick_reply=quick_reply)]
+
+        # 處理一般查詢
+        response_text = inference(user_input, user_id)
+        quick_reply = create_quick_reply()
+
+        # 處理可能包含 Flex Message 的回應
+        if "===FLEX_MESSAGE===" in response_text:
+            parts = response_text.split("===FLEX_MESSAGE===")
+            text_content = parts[0].strip()
+            text_message = TextSendMessage(text=text_content, quick_reply=quick_reply)
+
+            # 檢查是否有 Flex Message 部分
+            if len(parts) > 1:
+                flex_content = parts[1].strip().replace("```", "").replace("json", "")
+                if flex_content and flex_content != "False":
+                    try:
+                        flex_json = json.loads(flex_content)
+                        return [
+                            text_message,
+                            FlexSendMessage(alt_text="詳細資訊", contents=flex_json),
+                        ]
+                    except Exception as e:
+                        logger.error(f"Flex訊息解析錯誤: {str(e)}", exc_info=True)
+
+            return [text_message]
+
+        # 純文字回應
+        return [TextSendMessage(text=response_text, quick_reply=quick_reply)]
+
+    except Exception as e:
+        logger.error(f"處理訊息時發生錯誤: {str(e)}", exc_info=True)
+        return [
+            TextSendMessage(
+                text="抱歉，系統發生錯誤，請稍後再試。",
+                quick_reply=create_quick_reply(),
+            )
+        ]

linebot/app/services/message_service.py

@@ -1,134 +1,32 @@
-import logging
-import json
+"""訊息服務模組 - 處理 LINE Bot 的各種訊息類型"""
 
-from linebot.models import (
-    TextSendMessage,
-    QuickReply,
-    QuickReplyButton,
-    MessageAction,
-    SendMessage,
-    FlexSendMessage,
+import logging
+from .handlers import (
+    handle_text_message,
+    handle_image_message,
+    handle_audio_message,
+    send_message,
 )
-from ..api.vision import process_image
-from ..config.line_config import line_bot_api
-from ..api.dify import inference
 
 logger = logging.getLogger(__name__)
 
-COMMANDS = {
-    "/help": (
-        "📚 可用的指令列表：\n"
-        "1. /help - 顯示此幫助訊息\n"
-        "2. /setup - 設定相關功能\n\n"
-        "💡 您也可以直接輸入問題，我會盡力協助您！"
-    ),
-    "/setup": "⚙️ 設定功能開發中，敬請期待！",
-}
-
 
+# 為了保持與舊版API相容，我們可以保留這個類別作為包裝器
 class MessageService:
-    """處理 LINE Bot 的訊息服務"""
+    """處理 LINE Bot 的訊息服務 (相容性封裝)"""
 
-    def handle_text_message(self, event) -> TextSendMessage:
+    def handle_text_message(self, event):
         """處理文字訊息"""
-        try:
-            user_input = event.message.text
-            user_id = event.source.user_id
-
-            # 產生回應訊息
-            quick_reply = None
-            if user_input in COMMANDS:
-                response_text = COMMANDS[user_input]
-                quick_reply = self._create_quick_reply()
-                return [TextSendMessage(text=response_text, quick_reply=quick_reply)]
-
-            # 處理一般查詢
-            response_text = inference(user_input, user_id)
-            quick_reply = self._create_quick_reply()
-
-            # 處理可能包含 Flex Message 的回應
-            if "===FLEX_MESSAGE===" in response_text:
-                parts = response_text.split("===FLEX_MESSAGE===")
-                text_content = parts[0].strip()
-                text_message = TextSendMessage(
-                    text=text_content, quick_reply=quick_reply
-                )
-
-                # 檢查是否有 Flex Message 部分
-                if len(parts) > 1:
-                    flex_content = (
-                        parts[1].strip().replace("```", "").replace("json", "")
-                    )
-                    if flex_content and flex_content != "False":
-                        try:
-                            flex_json = json.loads(flex_content)
-                            return [
-                                text_message,
-                                FlexSendMessage(
-                                    alt_text="詳細資訊", contents=flex_json
-                                ),
-                            ]
-                        except Exception as e:
-                            logger.error(f"Flex訊息解析錯誤: {str(e)}", exc_info=True)
-
-                return [text_message]
+        return handle_text_message(event)
 
-            # 純文字回應
-            return [TextSendMessage(text=response_text, quick_reply=quick_reply)]
-
-        except Exception as e:
-            logger.error(f"處理訊息時發生錯誤: {str(e)}", exc_info=True)
-            return TextSendMessage(
-                text="抱歉，系統發生錯誤，請稍後再試。",
-                quick_reply=self._create_quick_reply(),
-            )
-
-    def handle_image_message(self, event) -> TextSendMessage:
+    def handle_image_message(self, event):
         """處理圖片訊息"""
-        try:
-            # 取得圖片內容
-            message_id = event.message.id
-            message_content = line_bot_api.get_message_content(message_id)
-
-            # 建立臨時檔案保存圖片
-            temp_file_path = f"{message_id}.jpg"
-            with open(temp_file_path, "wb") as temp_image_file:
-                for chunk in message_content.iter_content():
-                    temp_image_file.write(chunk)
-
-            # 使用 vision 函式處理圖片
-            response = process_image(
-                temp_file_path, "圖片內容有什麼?"
-            )  # TODO: 設定圖片處理的 prompt
+        return handle_image_message(event)
 
-            # 刪除臨時檔案
-            os.remove(temp_file_path)
-
-            return TextSendMessage(
-                text=response, quick_reply=self._create_quick_reply()
-            )
-        except Exception as e:
-            logger.error(f"處理圖片訊息時發生錯誤: {str(e)}", exc_info=True)
-            return TextSendMessage(
-                text="抱歉，處理圖片時發生錯誤，請稍後再試。",
-                quick_reply=self._create_quick_reply(),
-            )
-
-    def handle_audio_message(self, event) -> TextSendMessage:
+    def handle_audio_message(self, event):
         """處理音訊訊息"""
-        return TextSendMessage(
-            text="收到音訊消息", quick_reply=self._create_quick_reply()
-        )
+        return handle_audio_message(event)
 
-    def send_message(self, reply_token: str, messages: list[SendMessage]) -> None:
+    def send_message(self, reply_token, messages):
         """發送訊息到 LINE"""
-        line_bot_api.reply_message(reply_token, messages)
-
-    def _create_quick_reply(self) -> QuickReply:
-        """建立快速回覆按鈕"""
-        return QuickReply(
-            items=[
-                QuickReplyButton(action=MessageAction(label="說明", text="/help")),
-                QuickReplyButton(action=MessageAction(label="設定", text="/setup")),
-            ]
-        )
+        send_message(reply_token, messages)

linebot/app/webhooks/handlers.py

@@ -9,19 +9,19 @@
 # text message
 @handler.add(MessageEvent, message=TextMessage)
 def handle_message(event):
-    reply_message = message_service.handle_text_message(event)
-    message_service.send_message(event.reply_token, [reply_message])
+    reply_messages = message_service.handle_text_message(event)
+    message_service.send_message(event.reply_token, reply_messages)
 
 
 # image message
 @handler.add(MessageEvent, message=ImageMessage)
 def handle_image_message(event):
-    reply_message = message_service.handle_image_message(event)
-    message_service.send_message(event.reply_token, [reply_message])
+    reply_messages = message_service.handle_image_message(event)
+    message_service.send_message(event.reply_token, reply_messages)
 
 
 # audio message
 @handler.add(MessageEvent, message=AudioMessage)
 def handle_audio_message(event):
-    reply_message = message_service.handle_audio_message(event)
-    message_service.send_message(event.reply_token, [reply_message])
+    reply_messages = message_service.handle_audio_message(event)
+    message_service.send_message(event.reply_token, reply_messages)