✨ feat: 重构启动逻辑，将在线API检查和音频文件夹检查移至新hook模块，删除冗余代码

Author: Cvandia

nonebot_plugin_fishspeech_tts/__init__.py

@@ -7,7 +7,7 @@
 require("nonebot_plugin_alconna")
 
 from . import matcher as _match  # noqa:F401,I001
-from . import on_start_up  # noqa:F401
+from . import hook  # noqa:F401
 
 
 usage: str = """

nonebot_plugin_fishspeech_tts/fish_audio_api.py

@@ -36,26 +36,17 @@ class FishAudioAPI:
     FishAudioAPI类, 用于调用FishAudio的API接口
     """
 
-    def __init__(self):
-        self.api_url: str = API_URL
-        self.path_audio: Path = Path(config.tts_audio_path)
-        self.proxy = API_PROXY
+    api_url: str = API_URL
+    path_audio: Path = Path(config.tts_audio_path)
+    proxy = API_PROXY
+    from typing import ClassVar
 
-        # 如果在线授权码为空, 且使用在线api, 则抛出异常
-        if not config.online_authorization and config.tts_is_online:
-            raise AuthorizationException("请先在配置文件中填写在线授权码或使用离线api")
-        self.headers = {
-            "Authorization": f"Bearer {config.online_authorization}",
-        }
-
-        # 如果音频文件夹不存在, 则创建音频文件夹
-        if not self.path_audio.exists():
-            self.path_audio.mkdir(parents=True)
-            logger.warning(f"音频文件夹{self.path_audio.name}不存在, 已创建")
-        elif not self.path_audio.is_dir():
-            raise FileHandleException(f"{self.path_audio.name}不是一个文件夹")
-
-    async def _get_reference_id_by_speaker(self, speaker: str) -> str:
+    _headers: ClassVar[dict] = {
+        "Authorization": f"Bearer {config.online_authorization}",
+    }
+
+    @classmethod
+    async def _get_reference_id_by_speaker(cls, speaker: str) -> str:
         """
         通过说话人姓名获取说话人的reference_id
 
@@ -68,13 +59,13 @@ async def _get_reference_id_by_speaker(self, speaker: str) -> str:
         exception:
             APIException: 获取语音角色列表为空
         """
-        request_api = self.api_url + "/model"
+        request_api = cls.api_url + "/model"
         sort_options = ["score", "task_count", "created_at"]
-        async with AsyncClient(proxy=self.proxy) as client:
+        async with AsyncClient(proxy=cls.proxy) as client:
             for sort_by in sort_options:
                 params = {"title": speaker, "sort_by": sort_by}
                 response = await client.get(
-                    request_api, params=params, headers=self.headers
+                    request_api, params=params, headers=cls._headers
                 )
                 resp_data = response.json()
                 if resp_data["total"] == 0:
@@ -84,8 +75,9 @@ async def _get_reference_id_by_speaker(self, speaker: str) -> str:
                         return item["_id"]
         raise APIException("未找到对应的角色")
 
+    @classmethod
     async def generate_servettsrequest(
-        self,
+        cls,
         text: str,
         speaker_name: str,
         chunk_length: ChunkLength = ChunkLength.NORMAL,
@@ -103,15 +95,18 @@ async def generate_servettsrequest(
         Returns:
             ServeTTSRequest: TTS请求
         """
+        if not config.online_authorization and config.tts_is_online:
+            raise AuthorizationException("请先在配置文件中填写在线授权码或使用离线api")
+
         reference_id = None
         references = []
         try:
             if is_reference_id_first:
-                reference_id = await self._get_reference_id_by_speaker(speaker_name)
+                reference_id = await cls._get_reference_id_by_speaker(speaker_name)
             else:
                 try:
                     speaker_audio_path = get_speaker_audio_path(
-                        self.path_audio, speaker_name
+                        cls.path_audio, speaker_name
                     )
                     for audio in speaker_audio_path:
                         audio_bytes = audio.read_bytes()
@@ -121,7 +116,7 @@ async def generate_servettsrequest(
                         )
                 except FileHandleException:
                     logger.warning("音频文件夹不存在, 已转为在线模型优先模式")
-                    reference_id = await self._get_reference_id_by_speaker(speaker_name)
+                    reference_id = await cls._get_reference_id_by_speaker(speaker_name)
         except APIException as e:
             raise e from e
         return ServeTTSRequest(
@@ -138,7 +133,8 @@ async def generate_servettsrequest(
             references=references,
         )
 
-    async def generate_tts(self, request: ServeTTSRequest) -> bytes:
+    @classmethod
+    async def generate_tts(cls, request: ServeTTSRequest) -> bytes:
         """
         获取TTS音频
 
@@ -149,14 +145,14 @@ async def generate_tts(self, request: ServeTTSRequest) -> bytes:
             bytes: TTS音频二进制数据
         """
         if request.references:
-            self.headers["content-type"] = "application/msgpack"
+            cls._headers["content-type"] = "application/msgpack"
             try:
                 async with (
-                    AsyncClient(proxy=self.proxy) as client,
+                    AsyncClient(proxy=cls.proxy) as client,
                     client.stream(
                         "POST",
-                        self.api_url + "/v1/tts",
-                        headers=self.headers,
+                        cls.api_url + "/v1/tts",
+                        headers=cls._headers,
                         content=ormsgpack.packb(
                             request, option=ormsgpack.OPT_SERIALIZE_PYDANTIC
                         ),
@@ -169,17 +165,19 @@ async def generate_tts(self, request: ServeTTSRequest) -> bytes:
                 HTTPStatusError,
             ) as e:
                 logger.error(f"获取TTS音频失败: {e}")
-                if self.proxy:
+                if cls.proxy:
                     raise HTTPException("代理地址错误, 请检查代理地址是否正确") from e
                 raise HTTPException("网络错误, 请检查网络连接") from e
         else:
-            self.headers["content-type"] = "application/json"
+            cls._headers["content-type"] = "application/json"
             try:
-                async with AsyncClient(proxy=self.proxy) as client:
+                async with AsyncClient(proxy=cls.proxy) as client:
                     response = await client.post(
-                        self.api_url + "/v1/tts",
-                        headers=self.headers,
-                        json=request.dict(),
+                        cls.api_url + "/v1/tts",
+                        headers=cls._headers,
+                        json=ormsgpack.packb(
+                            request, option=ormsgpack.OPT_SERIALIZE_PYDANTIC
+                        ),
                         timeout=60,
                     )
                     return response.content
@@ -190,30 +188,32 @@ async def generate_tts(self, request: ServeTTSRequest) -> bytes:
                 HTTPStatusError,
             ) as e:
                 logger.error(f"获取TTS音频失败: {e}")
-                if self.proxy:
+                if cls.proxy:
                     raise HTTPException("代理地址错误, 请检查代理地址是否正确") from e
                 raise HTTPException("网络错误, 请检查网络连接") from e
 
-    async def get_balance(self) -> float:
+    @classmethod
+    async def get_balance(cls) -> float:
         """
         获取账户余额
         """
-        balance_url = self.api_url + "/wallet/self/api-credit"
-        async with AsyncClient(proxy=self.proxy) as client:
-            response = await client.get(balance_url, headers=self.headers)
+        balance_url = cls.api_url + "/wallet/self/api-credit"
+        async with AsyncClient(proxy=cls.proxy) as client:
+            response = await client.get(balance_url, headers=cls._headers)
             try:
                 return response.json()["credit"]
             except KeyError:
                 raise AuthorizationException("授权码错误或已失效") from KeyError
 
-    def get_speaker_list(self) -> list[str]:
+    @classmethod
+    def get_speaker_list(cls) -> list[str]:
         """
         获取语音角色列表
         """
         return_list = ["请查看官网了解更多: https://fish.audio/zh-CN/"]
         if not is_reference_id_first:
             try:
-                return_list.extend(get_path_speaker_list(self.path_audio))
+                return_list.extend(get_path_speaker_list(cls.path_audio))
             except FileHandleException:
                 logger.warning("音频文件夹不存在或无法读取")
         return return_list

nonebot_plugin_fishspeech_tts/fish_speech_api.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+from typing import ClassVar
 
 import ormsgpack
 from httpx import (
@@ -24,22 +25,15 @@
 
 
 class FishSpeechAPI:
-    def __init__(self):
-        self.api_url: str = API_URL
-        self.path_audio: Path = PATH_AUDIO
-        self.headers = {
-            "content-type": "application/msgpack",
-        }
-
-        # 如果音频文件夹不存在, 则创建音频文件夹
-        if not self.path_audio.exists():
-            self.path_audio.mkdir(parents=True)
-            logger.warning(f"音频文件夹{self.path_audio.name}不存在, 已创建")
-        elif not self.path_audio.is_dir():
-            raise NotADirectoryError(f"{self.path_audio.name}不是一个文件夹")
+    api_url: str = API_URL
+    path_audio: Path = PATH_AUDIO
+    _headers: ClassVar[dict] = {
+        "content-type": "application/msgpack",
+    }
 
+    @classmethod
     async def generate_servettsrequest(
-        self,
+        cls,
         text: str,
         speaker_name: str,
         chunk_length: ChunkLength = ChunkLength.NORMAL,
@@ -59,7 +53,7 @@ async def generate_servettsrequest(
 
         references = []
         try:
-            speaker_audio_path = get_speaker_audio_path(self.path_audio, speaker_name)
+            speaker_audio_path = get_speaker_audio_path(cls.path_audio, speaker_name)
         except FileHandleException as e:
             raise APIException(str(e)) from e
         for audio in speaker_audio_path:
@@ -82,7 +76,8 @@ async def generate_servettsrequest(
             mp3_bitrate=64,
         )
 
-    async def generate_tts(self, request: ServeTTSRequest) -> bytes:
+    @classmethod
+    async def generate_tts(cls, request: ServeTTSRequest) -> bytes:
         """
         获取TTS音频
 
@@ -94,12 +89,12 @@ async def generate_tts(self, request: ServeTTSRequest) -> bytes:
         try:
             async with AsyncClient() as client:
                 response = await client.post(
-                    self.api_url,
-                    headers=self.headers,
+                    cls.api_url,
+                    headers=cls._headers,
                     content=ormsgpack.packb(
                         request, option=ormsgpack.OPT_SERIALIZE_PYDANTIC
                     ),
-                    timeout=120,
+                    timeout=60,
                 )
                 return response.content
         except (
@@ -113,14 +108,15 @@ async def generate_tts(self, request: ServeTTSRequest) -> bytes:
         except Exception as e:
             raise APIException(f"{e}\n获取TTS音频失败, 检查API后端") from e
 
-    def get_speaker_list(self) -> list[str]:
+    @classmethod
+    def get_speaker_list(cls) -> list[str]:
         """
         获取说话人列表
 
         Returns:
             list[str]: 说话人列表
         """
         try:
-            return get_path_speaker_list(self.path_audio)
+            return get_path_speaker_list(cls.path_audio)
         except FileHandleException as e:
             raise APIException(str(e)) from e

nonebot_plugin_fishspeech_tts/on_start_up.py renamed to nonebot_plugin_fishspeech_tts/hook.py

@@ -3,6 +3,7 @@
 from nonebot.log import logger
 
 from .config import config
+from .fish_audio_api import FishAudioAPI
 
 IS_ONLINE = config.tts_is_online
 API = config.online_api_url
@@ -18,6 +19,16 @@ async def check_online_api():
                 response = await client.get(API)
                 rsp_text = response.text
                 if "Nothing" in rsp_text:
-                    logger.warning("在线API可用")
+                    logger.success("在线API可用")
             except TimeoutException as e:
                 logger.warning(f"在线API不可用: {e}\n请尝试更换API地址或配置代理")
+
+    @driver.on_startup
+    async def check_files():
+        """检查音频文件夹是否存在"""
+        path_audio = FishAudioAPI.path_audio
+        if not path_audio.exists():
+            path_audio.mkdir(parents=True)
+            logger.warning(f"音频文件夹{path_audio.name}不存在, 已创建")
+        elif not path_audio.is_dir():
+            logger.error(f"音频文件夹{path_audio.name}存在, 但不是文件夹")

nonebot_plugin_fishspeech_tts/matcher.py

@@ -56,22 +56,20 @@ async def tts_handle(message: UniMsg, regex_group: dict = RegexDict()):  # noqa:
         # TODO: speed = regex_group["speed"]
 
     try:
-        fish_audio_api = FishAudioAPI()
-        fish_speech_api = FishSpeechAPI()
         if is_online:
             await tts_handler.send("正在通过在线api合成语音, 请稍等")
-            request = await fish_audio_api.generate_servettsrequest(
+            request = await FishAudioAPI.generate_servettsrequest(
                 text, speaker, chunk_length
             )
             # TODO: request = await fish_audio_api.generate_ttsrequest(text, speaker, speed)
-            audio = await fish_audio_api.generate_tts(request)
+            audio = await FishAudioAPI.generate_tts(request)
         else:
             await tts_handler.send("正在通过本地api合成语音, 请稍等")
-            request = await fish_speech_api.generate_servettsrequest(
+            request = await FishSpeechAPI.generate_servettsrequest(
                 text, speaker, chunk_length
             )
             # TODO: request = await fish_speech_api.generate_ttsrequest(text, speaker, speed)
-            audio = await fish_speech_api.generate_tts(request)
+            audio = await FishSpeechAPI.generate_tts(request)
         await UniMessage.voice(raw=audio).finish()
 
     except APIException as e:
@@ -81,13 +79,11 @@ async def tts_handle(message: UniMsg, regex_group: dict = RegexDict()):  # noqa:
 @speaker_list.handle()
 async def speaker_list_handle():
     try:
-        fish_audio_api = FishAudioAPI()
-        fish_speech_api = FishSpeechAPI()
         if is_online:
-            _list = fish_audio_api.get_speaker_list()
+            _list = FishAudioAPI.get_speaker_list()
             await speaker_list.finish("语音角色列表: " + ", ".join(_list))
         else:
-            _list = fish_speech_api.get_speaker_list()
+            _list = FishSpeechAPI.get_speaker_list()
             await speaker_list.finish("语音角色列表: " + ", ".join(_list))
     except APIException as e:
         await speaker_list.finish(str(e))
@@ -96,12 +92,11 @@ async def speaker_list_handle():
 @balance.handle()
 async def balance_handle():
     try:
-        fish_audio_api = FishAudioAPI()
         if is_online:
             await balance.send("正在查询在线语音余额, 请稍等")
-            balance_float = await fish_audio_api.get_balance()
+            balance_float = await FishAudioAPI.get_balance()
             await balance.finish(f"语音余额为: {balance_float}")
         else:
-            await balance.finish("本地api无法查询余额")
+            await balance.finish("本地api无需查询余额")
     except APIException as e:
         await balance.finish(str(e))