aury-boot 0.0.24__py3-none-any.whl → 0.0.26__py3-none-any.whl

aury/boot/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.24'
-__version_tuple__ = version_tuple = (0, 0, 24)
+__version__ = version = '0.0.26'
+__version_tuple__ = version_tuple = (0, 0, 26)
 
 __commit_id__ = commit_id = None

aury/boot/application/app/components.py

@@ -15,6 +15,7 @@ from aury.boot.application.constants import ComponentName, ServiceType
 from aury.boot.application.migrations import MigrationManager
 from aury.boot.common.logging import logger
 from aury.boot.infrastructure.cache import CacheManager
+from aury.boot.infrastructure.channel import ChannelManager
 from aury.boot.infrastructure.database import DatabaseManager
 from aury.boot.infrastructure.events import EventBusManager
 from aury.boot.infrastructure.mq import MQManager
@@ -505,6 +506,49 @@ class MessageQueueComponent(Component):
                 logger.warning(f"消息队列 [{name}] 关闭失败: {e}")
 
 
+class ChannelComponent(Component):
+    """流式通道组件。
+    
+    用于 SSE（Server-Sent Events）和实时通信场景，支持 memory 和 redis 后端。
+    """
+
+    name = ComponentName.CHANNEL
+    enabled = True
+    depends_on: ClassVar[list[str]] = []
+
+    def can_enable(self, config: BaseConfig) -> bool:
+        """当配置了 Channel 实例时启用。"""
+        return self.enabled and bool(config.get_channels())
+
+    async def setup(self, app: FoundationApp, config: BaseConfig) -> None:
+        """初始化流式通道。"""
+        channel_configs = config.get_channels()
+        if not channel_configs:
+            logger.debug("未配置 Channel 实例，跳过通道初始化")
+            return
+        
+        for name, ch_config in channel_configs.items():
+            try:
+                channel_manager = ChannelManager.get_instance(name)
+                if not channel_manager.is_initialized:
+                    await channel_manager.initialize(
+                        backend=ch_config.backend,
+                        url=ch_config.url,
+                    )
+            except Exception as e:
+                logger.warning(f"通道 [{name}] 初始化失败（非关键）: {e}")
+
+    async def teardown(self, app: FoundationApp) -> None:
+        """关闭所有通道实例。"""
+        for name in list(ChannelManager._instances.keys()):
+            try:
+                channel_manager = ChannelManager.get_instance(name)
+                if channel_manager.is_initialized:
+                    await channel_manager.cleanup()
+            except Exception as e:
+                logger.warning(f"通道 [{name}] 关闭失败: {e}")
+
+
 class EventBusComponent(Component):
     """事件总线组件。
     
@@ -555,6 +599,7 @@ FoundationApp.components = [
     StorageComponent,
     TaskComponent,
     MessageQueueComponent,
+    ChannelComponent,
     EventBusComponent,
     SchedulerComponent,
 ]
@@ -563,6 +608,7 @@ FoundationApp.components = [
 __all__ = [
     "AdminConsoleComponent",
     "CacheComponent",
+    "ChannelComponent",
     "DatabaseComponent",
     "EventBusComponent",
     "MessageQueueComponent",

aury/boot/application/constants/components.py

@@ -41,6 +41,9 @@ class ComponentName(str, Enum):
     # 事件总线组件
     EVENT_BUS = "event_bus"
 
+    # 流式通道组件
+    CHANNEL = "channel"
+
     # 迁移组件
     MIGRATIONS = "migrations"
 

aury/boot/commands/templates/project/aury_docs/13-channel.md.tpl

@@ -9,10 +9,34 @@
 
 ## 13.1 基本用法
 
+### 通过环境变量自动初始化（推荐）
+
+配置环境变量后，`ChannelComponent` 会在应用启动时自动初始化：
+
+```bash
+# .env
+CHANNEL__SSE__BACKEND=memory
+CHANNEL__NOTIFICATION__BACKEND=redis
+CHANNEL__NOTIFICATION__URL=redis://localhost:6379/3
+```
+
+```python
+from aury.boot.infrastructure.channel import ChannelManager
+
+# 直接获取已初始化的实例
+sse_channel = ChannelManager.get_instance("sse")
+notification_channel = ChannelManager.get_instance("notification")
+
+# 直接使用
+await sse_channel.publish("user:123", {{"event": "hello"}})
+```
+
+### 手动初始化
+
 ```python
 from aury.boot.infrastructure.channel import ChannelManager
 
-# 命名多实例（推荐）- 不同业务场景使用不同实例
+# 命名多实例 - 不同业务场景使用不同实例
 sse_channel = ChannelManager.get_instance("sse")
 notification_channel = ChannelManager.get_instance("notification")
 
@@ -82,7 +106,7 @@ async def send_notification(user_id: str, message: str):
 async def space_events(space_id: str):
     \"\"\"订阅空间下所有事件。\"\"\"
     async def event_generator():
-        # 使用 psubscribe 订阅 space:{id}:* 下所有事件
+        # 使用 psubscribe 订阅 space:{{id}}:* 下所有事件
         async for msg in sse_channel.psubscribe(f"space:{{space_id}}:*"):
             yield msg.to_sse()  # 自动转换为 SSE 格式
     
@@ -112,21 +136,7 @@ await sse_channel.publish(f"space:{{space_id}}:comment_added", {{
 
 Redis 后端使用 Redis 原生 `PSUBSCRIBE`，内存后端使用 `fnmatch` 实现。
 
-## 13.5 应用场景示例
-
-```python
-# 不同业务场景使用不同的命名实例
-sse_channel = ChannelManager.get_instance("sse")           # 前端 SSE 推送
-chat_channel = ChannelManager.get_instance("chat")         # 聊天消息
-notify_channel = ChannelManager.get_instance("notify")     # 系统通知
-
-# 分别初始化（可使用不同后端）
-await sse_channel.initialize(backend="memory")  # 单进程即可
-await chat_channel.initialize(backend="redis", url="redis://localhost:6379/3")  # 需要跨进程
-await notify_channel.initialize(backend="redis", url="redis://localhost:6379/4")
-```
-
-## 13.6 环境变量
+## 13.5 环境变量
 
 ```bash
 # 默认实例

{aury_boot-0.0.24.dist-info → aury_boot-0.0.26.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aury-boot
-Version: 0.0.24
+Version: 0.0.26
 Summary: Aury Boot - 基于 FastAPI 生态的企业级 API 开发框架
 Requires-Python: >=3.13
 Requires-Dist: alembic>=1.17.2

{aury_boot-0.0.24.dist-info → aury_boot-0.0.26.dist-info}/RECORD

@@ -1,5 +1,5 @@
 aury/boot/__init__.py,sha256=pCno-EInnpIBa1OtxNYF-JWf9j95Cd2h6vmu0xqa_-4,1791
-aury/boot/_version.py,sha256=XrY1zhka91SvYFuoqczo63946VCS-B_2e6wTaL8sPYQ,706
+aury/boot/_version.py,sha256=Fnf259POysYSI-aH6DhnxuHUxCVOFWsQLs4I5Ur_KMA,706
 aury/boot/application/__init__.py,sha256=0o_XmiwFCeAu06VHggS8I1e7_nSMoRq0Hcm0fYfCywU,3071
 aury/boot/application/adapter/__init__.py,sha256=e1bcSb1bxUMfofTwiCuHBZJk5-STkMCWPF2EJXHQ7UU,3976
 aury/boot/application/adapter/base.py,sha256=Ar_66fiHPDEmV-1DKnqXKwc53p3pozG31bgTJTEUriY,15763
@@ -9,14 +9,14 @@ aury/boot/application/adapter/exceptions.py,sha256=Kzm-ytRxdUnSMIcWCSOHPxo4Jh_A6
 aury/boot/application/adapter/http.py,sha256=4TADsSzdSRU63307dmmo-2U_JpVP12mwTFy66B5Ps-w,10759
 aury/boot/application/app/__init__.py,sha256=I8FfCKDuDQsGzAK6BevyfdtAwieMUVYu6qgVQzBazpE,830
 aury/boot/application/app/base.py,sha256=MYfkrb2zZgumLrGWhtT71neGncUfVHyUeAHRnetoSXk,17668
-aury/boot/application/app/components.py,sha256=-blDjMF87GYFmFyk4DHm2KJDcm27HpMxGpNaEFluwEE,22403
+aury/boot/application/app/components.py,sha256=qBAd8hJ4Ap3cfCYJUJu9v_IvC16U9Q8O5dEZDtjDveY,24188
 aury/boot/application/app/middlewares.py,sha256=BXe2H14FHzJUVpQM6DZUm-zfZRXSXIi1QIZ4_3izfHw,3306
 aury/boot/application/app/startup.py,sha256=DHKt3C2G7V5XfFr1SQMl14tNzcuDd9MqUVAxi274HDQ,7873
 aury/boot/application/config/__init__.py,sha256=Dd-myRSBCM18DXXsi863h0cJG5VFrI10xMRtjnvelGo,1894
 aury/boot/application/config/multi_instance.py,sha256=RXSp-xP8-bKMDEhq3SeL7T3lS8-vpRlvBEVBuZVjVK4,6475
 aury/boot/application/config/settings.py,sha256=o0SAwEpFqoHE7zB3lYyaSCm0cX2NZnTVqUWiSJ-Qdtk,30576
 aury/boot/application/constants/__init__.py,sha256=DCXs13_VVaQWHqO-qpJoZwRd7HIexiirtw_nu8msTXE,340
-aury/boot/application/constants/components.py,sha256=hDRs3YxpnfIFcGaUa1DYqBRwmV2_dceOlcCXabHE3fk,1006
+aury/boot/application/constants/components.py,sha256=VBCgxJ_iZXjEZyUkC13ZCdqPmdKq-lQmU7jQpXnTa2Y,1056
 aury/boot/application/constants/scheduler.py,sha256=S77FBIvHlyruvlabRWZJ2J1YAs2xWXPQI2yuGdGUDNA,471
 aury/boot/application/constants/service.py,sha256=_BjSNP83m1KuLcGs1oqciDU9Nk1mO45COucRYubuFkM,513
 aury/boot/application/errors/__init__.py,sha256=aYhGqjHayYr7sv9kM22y0sOo9R-8RK0r3Jf5_tgm7TQ,1217
@@ -81,7 +81,7 @@ aury/boot/commands/templates/project/aury_docs/09-tasks.md.tpl,sha256=swHOQ_pWPt
 aury/boot/commands/templates/project/aury_docs/10-storage.md.tpl,sha256=mhe0j0S51ndPJLjaQ6yD8OPYBEO02NHumJVbBvz2qkw,4320
 aury/boot/commands/templates/project/aury_docs/11-logging.md.tpl,sha256=bwxFCGQsO9cTEbwqJF1xcjsZKP82HRWhIMRUS0c9_ZI,2435
 aury/boot/commands/templates/project/aury_docs/12-admin.md.tpl,sha256=6z3mN54qP2jtpTFOJBLVexvEv0ZHXYKjncvpZG4yOdw,1883
-aury/boot/commands/templates/project/aury_docs/13-channel.md.tpl,sha256=jz10V8v-ygVweio7Ri6A2pPGOZzKZOoWMOyYW7QH77w,4426
+aury/boot/commands/templates/project/aury_docs/13-channel.md.tpl,sha256=Zw01FNabA2kP2G8jDcjZg-CLndyiMpVYxQzTq8ruLmU,4406
 aury/boot/commands/templates/project/aury_docs/14-mq.md.tpl,sha256=4bxLQBbCi0Fue0VQWOPt6acZ5P00BoLkCoLPQe_8k4U,2396
 aury/boot/commands/templates/project/aury_docs/15-events.md.tpl,sha256=a4wQRgVPuYUGTGmw_lX1HJH_yFTbD30mBz7Arc4zgfs,3361
 aury/boot/commands/templates/project/aury_docs/16-adapter.md.tpl,sha256=pkmJkZw2Ca6_uYk2jZvAb8DozjBa2tWq_t3gtq1lFSk,11456
@@ -192,7 +192,7 @@ aury/boot/testing/client.py,sha256=KOg1EemuIVsBG68G5y0DjSxZGcIQVdWQ4ASaHE3o1R0,4
 aury/boot/testing/factory.py,sha256=8GvwX9qIDu0L65gzJMlrWB0xbmJ-7zPHuwk3eECULcg,5185
 aury/boot/toolkit/__init__.py,sha256=AcyVb9fDf3CaEmJPNkWC4iGv32qCPyk4BuFKSuNiJRQ,334
 aury/boot/toolkit/http/__init__.py,sha256=zIPmpIZ9Qbqe25VmEr7jixoY2fkRbLm7NkCB9vKpg6I,11039
-aury_boot-0.0.24.dist-info/METADATA,sha256=BeSds7eWMGtPxD_RNx0CXwIz_FdwWXxr6QRqR1nitzI,7695
-aury_boot-0.0.24.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-aury_boot-0.0.24.dist-info/entry_points.txt,sha256=f9KXEkDIGc0BGkgBvsNx_HMz9VhDjNxu26q00jUpDwQ,49
-aury_boot-0.0.24.dist-info/RECORD,,
+aury_boot-0.0.26.dist-info/METADATA,sha256=2M3n6KMCpEnC-1qSDg-b2nvlGwh86HGw15XfljGC2mo,7695
+aury_boot-0.0.26.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+aury_boot-0.0.26.dist-info/entry_points.txt,sha256=f9KXEkDIGc0BGkgBvsNx_HMz9VhDjNxu26q00jUpDwQ,49
+aury_boot-0.0.26.dist-info/RECORD,,