aury-boot 0.0.25__tar.gz → 0.0.27__tar.gz

{aury_boot-0.0.25 → aury_boot-0.0.27}/PKG-INFO

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

{aury_boot-0.0.25 → aury_boot-0.0.27}/aury/boot/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.25'
-__version_tuple__ = version_tuple = (0, 0, 25)
+__version__ = version = '0.0.27'
+__version_tuple__ = version_tuple = (0, 0, 27)
 
 __commit_id__ = commit_id = None

{aury_boot-0.0.25 → aury_boot-0.0.27}/aury/boot/application/config/settings.py

@@ -246,6 +246,27 @@ class CacheSettings(BaseModel):
     )
 
 
+class ChannelSettings(BaseModel):
+    """流式通道配置（单实例）。
+    
+    环境变量格式: CHANNEL__{FIELD}
+    示例: CHANNEL__BACKEND, CHANNEL__URL
+    
+    支持的后端类型：
+    - memory: 内存后端（默认，单进程）
+    - redis: Redis Pub/Sub（多进程/分布式）
+    """
+    
+    backend: str = Field(
+        default="",
+        description="通道后端 (memory/redis)，空字符串表示不启用"
+    )
+    url: str | None = Field(
+        default=None,
+        description="Redis URL（当 backend=redis 时需要）"
+    )
+
+
 class StorageSettings(BaseModel):
     """对象存储组件接入配置（Application 层）。
 
@@ -779,6 +800,7 @@ class BaseConfig(BaseSettings):
     # ========== 数据与缓存 ==========
     database: DatabaseSettings = Field(default_factory=DatabaseSettings)
     cache: CacheSettings = Field(default_factory=CacheSettings)
+    channel: ChannelSettings = Field(default_factory=ChannelSettings)
     storage: StorageSettings = Field(default_factory=StorageSettings)
     
     # 迁移配置
@@ -879,10 +901,18 @@ class BaseConfig(BaseSettings):
         """获取所有通道实例配置。
         
         从环境变量解析 CHANNEL__{INSTANCE}__{FIELD} 格式的配置。
+        如果没有配置多实例，返回从单实例配置转换的 default 实例。
         """
         if self._channels is None:
             loader = MultiInstanceConfigLoader("CHANNEL", ChannelInstanceConfig)
             self._channels = loader.load()
+            if not self._channels and self.channel.backend:
+                self._channels = {
+                    "default": ChannelInstanceConfig(
+                        backend=self.channel.backend,
+                        url=self.channel.url,
+                    )
+                }
         return self._channels
     
     def get_mqs(self) -> dict[str, MQInstanceConfig]:
@@ -929,6 +959,7 @@ __all__ = [
     "CacheInstanceConfig",
     "CacheSettings",
     "ChannelInstanceConfig",
+    "ChannelSettings",
     "DatabaseInstanceConfig",
     "DatabaseSettings",
     "EventInstanceConfig",

{aury_boot-0.0.25 → aury_boot-0.0.27}/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")
 
@@ -112,29 +136,17 @@ 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
-# 默认实例
+# 单实例配置
 CHANNEL__BACKEND=memory
-
-# 多实例（格式：CHANNEL__{{INSTANCE}}__{{FIELD}}）
-CHANNEL__DEFAULT__BACKEND=redis
-CHANNEL__DEFAULT__URL=redis://localhost:6379/3
-CHANNEL__NOTIFICATIONS__BACKEND=redis
-CHANNEL__NOTIFICATIONS__URL=redis://localhost:6379/4
+# 或 Redis 后端
+CHANNEL__BACKEND=redis
+CHANNEL__URL=redis://localhost:6379/3
+
+# 多实例配置（格式：CHANNEL__{{INSTANCE}}__{{FIELD}}）
+CHANNEL__SSE__BACKEND=memory
+CHANNEL__NOTIFICATION__BACKEND=redis
+CHANNEL__NOTIFICATION__URL=redis://localhost:6379/4
 ```

{aury_boot-0.0.25 → aury_boot-0.0.27}/aury/boot/commands/templates/project/env_templates/messaging.tpl

@@ -2,12 +2,15 @@
 # =============================================================================
 # 流式通道配置 (CHANNEL__) - SSE/实时通信
 # =============================================================================
+# 单实例配置:
+# CHANNEL__BACKEND=memory
+# CHANNEL__BACKEND=redis
+# CHANNEL__URL=redis://localhost:6379/3
+#
 # 多实例配置 (格式: CHANNEL__{{INSTANCE}}__{{FIELD}}):
-# CHANNEL__DEFAULT__BACKEND=memory
-# CHANNEL__SHARED__BACKEND=redis
-# CHANNEL__SHARED__URL=redis://localhost:6379/3
-# CHANNEL__SHARED__KEY_PREFIX=channel:
-# CHANNEL__SHARED__TTL=86400
+# CHANNEL__SSE__BACKEND=memory
+# CHANNEL__NOTIFICATION__BACKEND=redis
+# CHANNEL__NOTIFICATION__URL=redis://localhost:6379/3
 
 # =============================================================================
 # 消息队列配置 (MQ__)