update.2025.08.09

Author: lzy98276

README.md

@@ -37,13 +37,15 @@ app/plugin/
   "description": "插件功能描述",
   "author": "插件作者",
   "entry_point": "main.py",
-  "min_app_version": "1.0.0",
+  "background_service": "service.py",
+  "min_app_version": "1.0.0.0",
   "dependencies": [],
-  "enabled": true
+  "enabled": true,
+  "autostart": false
 }
 ```
 
-### 3. 插件主程序结构
+### 3. 插件主程序 (main.py)
 
 ```python
 # 导入必要的库
@@ -96,6 +98,25 @@ def get_plugin_info() -> Dict:
     return plugin.get_info()
 ```
 
+### 4. 插件服务
+
+如果插件需要在后台运行服务，应在 `service.py` 文件中实现：
+
+```python
+class MyPluginService:
+    def __init__(self):
+        # 初始化服务
+        pass
+        
+    def start(self):
+        # 启动服务
+        pass
+        
+    def stop(self):
+        # 停止服务
+        pass
+```
+
 ## 插件系统特性
 
 ### 核心优势
@@ -128,9 +149,11 @@ def get_plugin_info() -> Dict:
 1. **创建插件目录**: 在 `app/plugin/` 下创建插件目录
 2. **编写配置文件**: 创建 `plugin.json` 定义插件信息
 3. **实现主程序**: 编写 `main.py` 实现插件功能
-4. **添加界面**: 创建图形界面（如需要）
-5. **编写文档**: 创建 `README.md` 说明插件用法
-6. **测试调试**: 测试插件功能并调试问题
+4. **实现服务**: 如果需要后台服务，编写 `service.py`
+5. **添加界面**: 创建图形界面（如需要）
+6. **编写文档**: 创建 `README.md` 说明插件用法
+7. **测试调试**: 测试插件功能并调试问题
+8. **打包发布**: 打包插件为 zip 文件，发布到插件广场
 
 ### 3. 最佳实践
 

example_plugin/README.md renamed to SecRandom-plugins/README.md

@@ -53,21 +53,25 @@ app/plugin/example_plugin/
   "description": "插件描述",
   "author": "作者",
   "entry_point": "入口文件",
+  "background_service": "后台服务文件",
   "min_app_version": "最低应用版本",
   "dependencies": [],
-  "enabled": true
+  "enabled": true,
+  "autostart": false
 }
 ```
 
 **配置项说明：**
 - `name`: 插件显示名称
-- `version`: 插件版本号（语义化版本）
+- `version`: 插件版本号（语义化版本）(格式：v1.0.0(就建议这种格式的)  或者是跟你的GitHub tag一致)
 - `description`: 插件功能描述
 - `author`: 插件作者
 - `entry_point`: 插件入口文件（通常是 main.py）
-- `min_app_version`: 兼容的最低应用版本
+- `background_service`: 插件后台服务文件（可选）
+- `min_app_version`: 兼容的最低应用版本(格式：v0.0.0.0(必须是这个!))
 - `dependencies`: 依赖列表（可选）
 - `enabled`: 是否默认启用
+- `autostart`: 是否自动启动(一般来说默认最好是false)
 
 ### 2. 插件主程序 (main.py)
 
@@ -168,9 +172,28 @@ except Exception as e:
     # 返回错误信息或显示错误提示
 ```
 
+### 6. 插件服务
+
+如果插件需要在后台运行服务，应在 `service.py` 文件中实现：
+
+```python
+class ExampleService:
+    def __init__(self):
+        # 初始化服务
+        pass
+        
+    def start(self):
+        # 启动服务
+        pass
+        
+    def stop(self):
+        # 停止服务
+        pass
+```
+
 ## 插件集成要点
 
-### 1. 与主系统通信
+### 1. 与主系统通信(暂时不支持)
 
 插件可以通过以下方式与主系统集成：
 

example_plugin/main.py renamed to SecRandom-plugins/main.py

@@ -1,10 +1,12 @@
 {
   "name": "示例插件",
-  "version": "v1.0.2",
+  "version": "v1.0.3",
   "description": "这是一个简单的示例插件，展示插件系统的基本功能",
   "author": "SecRandom",
   "entry_point": "main.py",
+  "background_service": "service.py",
   "min_app_version": "v0.0.0.0",
   "dependencies": [],
-  "enabled": true
+  "enabled": true,
+  "autostart": false
 }

example_plugin/plugin.json renamed to SecRandom-plugins/plugin.json

@@ -0,0 +1,89 @@
+import os
+import sys
+import time
+import threading
+import subprocess
+from loguru import logger
+
+class BackgroundService:
+    def __init__(self, plugin_path):
+        self.plugin_path = plugin_path
+        self.running = False
+        self.thread = None
+        
+    def start(self):
+        """启动后台服务"""
+        if self.running:
+            return
+            
+        self.running = True
+        self.thread = threading.Thread(target=self._run_service, daemon=True)
+        self.thread.start()
+        logger.info(f"插件 {os.path.basename(self.plugin_path)} 后台服务已启动")
+    
+    def stop(self):
+        """停止后台服务"""
+        self.running = False
+        if self.thread and self.thread.is_alive():
+            self.thread.join(timeout=5)
+        logger.info(f"插件 {os.path.basename(self.plugin_path)} 后台服务已停止")
+    
+    def _run_service(self):
+        """运行后台服务主循环"""
+        logger.info(f"插件 {os.path.basename(self.plugin_path)} 后台服务开始运行")
+        
+        try:
+            # 这里可以添加插件特定的后台逻辑
+            # 例如：定时任务、监听事件、数据处理等
+            while self.running:
+                # 示例：每60秒执行一次任务
+                time.sleep(60)
+                
+                # 在这里添加插件的后台逻辑
+                self._execute_background_task()
+                
+        except Exception as e:
+            logger.error(f"插件 {os.path.basename(self.plugin_path)} 后台服务运行错误: {e}")
+    
+    def _execute_background_task(self):
+        """执行后台任务（可由插件开发者重写此方法）"""
+        # 默认实现：记录日志
+        logger.info(f"插件 {os.path.basename(self.plugin_path)} 后台任务执行中...")
+        
+        # 插件开发者可以在这里添加自己的后台逻辑
+        # 例如：
+        # - 数据同步
+        # - 定时检查
+        # - 消息推送
+        # - 系统监控
+        # 等等
+
+# 全局服务实例
+service_instance = None
+
+def start_background_service(plugin_path):
+    """启动后台服务"""
+    global service_instance
+    if service_instance is None:
+        service_instance = BackgroundService(plugin_path)
+        service_instance.start()
+    return service_instance
+
+def stop_background_service():
+    """停止后台服务"""
+    global service_instance
+    if service_instance:
+        service_instance.stop()
+        service_instance = None
+
+if __name__ == "__main__":
+    # 当作为独立脚本运行时的测试代码
+    plugin_path = os.path.dirname(os.path.abspath(__file__))
+    service = start_background_service(plugin_path)
+    
+    try:
+        # 保持运行
+        while True:
+            time.sleep(1)
+    except KeyboardInterrupt:
+        stop_background_service()