From 79ff981776ae96832287b59e5e067c57ae0d1e78 Mon Sep 17 00:00:00 2001 From: minecraft1024a Date: Sat, 15 Nov 2025 16:57:48 +0800 Subject: [PATCH] =?UTF-8?q?refactor(maizone):=20=E8=BF=81=E7=A7=BB?= =?UTF-8?q?=E5=9B=9E=E5=A4=8D=E8=B7=9F=E8=B8=AA=E6=9C=8D=E5=8A=A1=E4=BB=A5?= =?UTF-8?q?=E4=BD=BF=E7=94=A8=E6=8F=92=E4=BB=B6=E5=AD=98=E5=82=A8API?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 该重构将 ReplyTrackerService 从手动管理本地JSON文件的方式迁移到使用新的插件本地存储API。 此举旨在统一数据持久化方式，提高代码的可维护性和健壮性。 主要变更包括： - 引入 `get_local_storage` API，将数据存储逻辑委托给通用的存储服务。 - 新增一次性自动数据迁移功能，可将旧 `replied_comments.json` 文件中的数据无缝迁移至新存储。 - 简化了服务内部的数据加载、保存和错误处理逻辑，代码更清晰。 - 迁移成功后，旧数据文件将被备份，以确保数据安全。 --- .../services/reply_tracker_service.py | 265 ++++++------------ 1 file changed, 92 insertions(+), 173 deletions(-) diff --git a/src/plugins/built_in/maizone_refactored/services/reply_tracker_service.py b/src/plugins/built_in/maizone_refactored/services/reply_tracker_service.py index 0c6e9ef22..bc6663c6f 100644 --- a/src/plugins/built_in/maizone_refactored/services/reply_tracker_service.py +++ b/src/plugins/built_in/maizone_refactored/services/reply_tracker_service.py @@ -3,6 +3,7 @@ 负责记录和管理已回复过的评论ID，避免重复回复 """ +import os import time from pathlib import Path from typing import Any @@ -10,6 +11,7 @@ from typing import Any import orjson from src.common.logger import get_logger +from src.plugin_system.apis.storage_api import get_local_storage logger = get_logger("MaiZone.ReplyTrackerService") @@ -17,14 +19,12 @@ logger = get_logger("MaiZone.ReplyTrackerService") class ReplyTrackerService: """ 评论回复跟踪服务 - 使用本地JSON文件持久化存储已回复的评论ID + 使用插件存储API持久化存储已回复的评论ID """ def __init__(self): - # 数据存储路径 - self.data_dir = Path(__file__).resolve().parent.parent / "data" - self.data_dir.mkdir(exist_ok=True, parents=True) - self.reply_record_file = self.data_dir / "replied_comments.json" + # 使用新的存储API + self.storage = get_local_storage("maizone_reply_tracker") # 内存中的已回复评论记录 # 格式: {feed_id: {comment_id: timestamp, ...}, ...} @@ -33,9 +33,58 @@ class ReplyTrackerService: # 数据清理配置 self.max_record_days = 30 # 保留30天的记录 - # 加载已有数据 - self._load_data() - logger.debug(f"ReplyTrackerService initialized with data file: {self.reply_record_file}") + # --- 一次性数据迁移 --- + self._perform_one_time_migration() + + # 从新存储加载数据 + initial_data = self.storage.get("data", {}) + if self._validate_data(initial_data): + self.replied_comments = initial_data + logger.info( + f"已从存储API加载 {len(self.replied_comments)} 条说说的回复记录，" + f"总计 {sum(len(comments) for comments in self.replied_comments.values())} 条评论" + ) + else: + logger.error("从存储API加载的数据格式无效，将创建新的记录") + self.replied_comments = {} + + logger.debug(f"ReplyTrackerService initialized with data file: {self.storage.file_path}") + + def _perform_one_time_migration(self): + """ + 执行一次性数据迁移，从旧的JSON文件到新的存储API。 + """ + old_data_file = Path(__file__).resolve().parent.parent / "data" / "replied_comments.json" + if old_data_file.exists(): + logger.info(f"检测到旧的数据文件 '{old_data_file}'，开始执行一次性迁移...") + try: + with open(old_data_file, "rb") as f: + file_content = f.read() + if not file_content.strip(): + logger.warning("旧数据文件为空，无需迁移。") + os.remove(old_data_file) + logger.info(f"空的旧数据文件 '{old_data_file}' 已被删除。") + return + + old_data = orjson.loads(file_content) + if self._validate_data(old_data): + # 将数据写入新存储 + self.storage.set("data", old_data) + # 立即强制保存以确保迁移完成 + self.storage._save_data() + logger.info("旧数据已成功迁移到新的存储API。") + # 备份旧文件而不是删除 + backup_file = old_data_file.with_suffix(f".json.bak.migrated.{int(time.time())}") + old_data_file.rename(backup_file) + logger.info(f"旧数据文件已成功迁移并备份为: {backup_file}") + else: + logger.error("旧数据文件格式无效，迁移中止。") + backup_file = old_data_file.with_suffix(f".json.bak.invalid.{int(time.time())}") + old_data_file.rename(backup_file) + logger.warning(f"已将无效的旧数据文件备份为: {backup_file}") + + except Exception as e: + logger.error(f"迁移旧数据文件时发生错误: {e}", exc_info=True) def _validate_data(self, data: Any) -> bool: """验证加载的数据格式是否正确""" @@ -51,7 +100,6 @@ class ReplyTrackerService: logger.error(f"说说 {feed_id} 的评论数据不是字典格式") return False for comment_id, timestamp in comments.items(): - # 确保comment_id是字符串格式，如果是数字则转换为字符串 if not isinstance(comment_id, str | int): logger.error(f"无效的评论ID格式: {comment_id}") return False @@ -60,224 +108,95 @@ class ReplyTrackerService: return False return True - def _load_data(self): - """从文件加载已回复评论数据""" + def _persist_data(self): + """ + 清理、验证并持久化数据到存储API。 + """ try: - if self.reply_record_file.exists(): - try: - with open(self.reply_record_file, "rb") as f: - file_content = f.read() - if not file_content.strip(): # 文件为空 - logger.warning("回复记录文件为空，将创建新的记录") - self.replied_comments = {} - return - - data = orjson.loads(file_content) - if self._validate_data(data): - self.replied_comments = data - logger.info( - f"已加载 {len(self.replied_comments)} 条说说的回复记录，" - f"总计 {sum(len(comments) for comments in self.replied_comments.values())} 条评论" - ) - else: - logger.error("加载的数据格式无效，将创建新的记录") - self.replied_comments = {} - except orjson.JSONDecodeError as e: - logger.error(f"解析回复记录文件失败: {e}") - self._backup_corrupted_file() - self.replied_comments = {} - else: - logger.info("未找到回复记录文件，将创建新的记录") - self.replied_comments = {} - except Exception as e: - logger.error(f"加载回复记录失败: {e}", exc_info=True) - self.replied_comments = {} - - def _backup_corrupted_file(self): - """备份损坏的数据文件""" - try: - if self.reply_record_file.exists(): - backup_file = self.reply_record_file.with_suffix(f".json.bak.{int(time.time())}") - self.reply_record_file.rename(backup_file) - logger.warning(f"已将损坏的数据文件备份为: {backup_file}") - except Exception as e: - logger.error(f"备份损坏的数据文件失败: {e}") - - def _save_data(self): - """保存已回复评论数据到文件""" - try: - # 验证数据格式 - if not self._validate_data(self.replied_comments): - logger.error("当前数据格式无效，取消保存") - return - - # 清理过期数据 self._cleanup_old_records() - # 创建临时文件 - temp_file = self.reply_record_file.with_suffix(".tmp") - - # 先写入临时文件 - with open(temp_file, "wb") as f: - f.write(orjson.dumps(self.replied_comments, option=orjson.OPT_INDENT_2 | orjson.OPT_NON_STR_KEYS)) - - # 如果写入成功，重命名为正式文件 - if temp_file.stat().st_size > 0: # 确保写入成功 - # 在Windows上，如果目标文件已存在，需要先删除它 - if self.reply_record_file.exists(): - self.reply_record_file.unlink() - temp_file.rename(self.reply_record_file) - logger.debug(f"回复记录已保存，包含 {len(self.replied_comments)} 条说说的记录") - else: - logger.error("临时文件写入失败，文件大小为0") - temp_file.unlink() # 删除空的临时文件 + if not self._validate_data(self.replied_comments): + logger.error("当前内存中的数据格式无效，取消保存") + return + self.storage.set("data", self.replied_comments) + logger.debug(f"回复记录已暂存，将由存储API在后台保存") except Exception as e: - logger.error(f"保存回复记录失败: {e}", exc_info=True) - # 尝试删除可能存在的临时文件 - try: - if temp_file.exists(): - temp_file.unlink() - except Exception: - pass + logger.error(f"持久化回复记录失败: {e}", exc_info=True) def _cleanup_old_records(self): """清理超过保留期限的记录""" current_time = time.time() cutoff_time = current_time - (self.max_record_days * 24 * 60 * 60) - - feeds_to_remove = [] total_removed = 0 + feeds_to_remove = [ + feed_id + for feed_id, comments in self.replied_comments.items() + if not any(timestamp >= cutoff_time for timestamp in comments.values()) + ] - # 仅清理超过保留期限的记录，不根据API返回结果清理 + # 先移除整个过期的说说 + for feed_id in feeds_to_remove: + total_removed += len(self.replied_comments[feed_id]) + del self.replied_comments[feed_id] + + # 再清理部分过期的评论 for feed_id, comments in self.replied_comments.items(): - comments_to_remove = [] - - # 仅清理超过指定天数的记录 - for comment_id, timestamp in comments.items(): - if timestamp < cutoff_time: - comments_to_remove.append(comment_id) - - # 移除过期的评论记录 + comments_to_remove = [comment_id for comment_id, timestamp in comments.items() if timestamp < cutoff_time] for comment_id in comments_to_remove: del comments[comment_id] total_removed += 1 - # 如果该说说下没有任何记录了，标记删除整个说说记录 - if not comments: - feeds_to_remove.append(feed_id) - - # 移除空的说说记录 - for feed_id in feeds_to_remove: - del self.replied_comments[feed_id] - if total_removed > 0: logger.info(f"清理了 {total_removed} 条超过{self.max_record_days}天的过期回复记录") def has_replied(self, feed_id: str, comment_id: str | int) -> bool: - """ - 检查是否已经回复过指定的评论 - - Args: - feed_id: 说说ID - comment_id: 评论ID (可以是字符串或数字) - - Returns: - bool: 如果已回复过返回True，否则返回False - """ + """检查是否已经回复过指定的评论""" if not feed_id or comment_id is None: return False - comment_id_str = str(comment_id) return feed_id in self.replied_comments and comment_id_str in self.replied_comments[feed_id] def mark_as_replied(self, feed_id: str, comment_id: str | int): - """ - 标记指定评论为已回复 - - Args: - feed_id: 说说ID - comment_id: 评论ID (可以是字符串或数字) - """ + """标记指定评论为已回复""" if not feed_id or comment_id is None: logger.warning("feed_id 或 comment_id 为空，无法标记为已回复") return - current_time = time.time() - - # 确保将comment_id转换为字符串格式 comment_id_str = str(comment_id) - if feed_id not in self.replied_comments: self.replied_comments[feed_id] = {} - - self.replied_comments[feed_id][comment_id_str] = current_time - - # 验证数据并保存到文件 - if self._validate_data(self.replied_comments): - self._save_data() - logger.info(f"已标记评论为已回复: feed_id={feed_id}, comment_id={comment_id}") - else: - logger.error(f"标记评论时数据验证失败: feed_id={feed_id}, comment_id={comment_id}") + self.replied_comments[feed_id][comment_id_str] = time.time() + self._persist_data() + logger.info(f"已标记评论为已回复: feed_id={feed_id}, comment_id={comment_id}") def get_replied_comments(self, feed_id: str) -> set[str]: - """ - 获取指定说说下所有已回复的评论ID - - Args: - feed_id: 说说ID - - Returns: - Set[str]: 已回复的评论ID集合 - """ - if feed_id in self.replied_comments: - # 确保所有评论ID都是字符串格式 - return {str(comment_id) for comment_id in self.replied_comments[feed_id].keys()} - return set() + """获取指定说说下所有已回复的评论ID""" + return {str(cid) for cid in self.replied_comments.get(feed_id, {}).keys()} def get_stats(self) -> dict[str, Any]: - """ - 获取回复记录统计信息 - - Returns: - Dict: 包含统计信息的字典 - """ + """获取回复记录统计信息""" total_feeds = len(self.replied_comments) total_replies = sum(len(comments) for comments in self.replied_comments.values()) - return { "total_feeds_with_replies": total_feeds, "total_replied_comments": total_replies, - "data_file": str(self.reply_record_file), + "data_file": str(self.storage.file_path), "max_record_days": self.max_record_days, } def remove_reply_record(self, feed_id: str, comment_id: str): - """ - 移除指定评论的回复记录 - - Args: - feed_id: 说说ID - comment_id: 评论ID - """ + """移除指定评论的回复记录""" if feed_id in self.replied_comments and comment_id in self.replied_comments[feed_id]: del self.replied_comments[feed_id][comment_id] - - # 如果该说说下没有任何回复记录了，删除整个说说记录 if not self.replied_comments[feed_id]: del self.replied_comments[feed_id] - - self._save_data() + self._persist_data() logger.debug(f"已移除回复记录: feed_id={feed_id}, comment_id={comment_id}") def remove_feed_records(self, feed_id: str): - """ - 移除指定说说的所有回复记录 - - Args: - feed_id: 说说ID - """ + """移除指定说说的所有回复记录""" if feed_id in self.replied_comments: del self.replied_comments[feed_id] - self._save_data() + self._persist_data() logger.info(f"已移除说说 {feed_id} 的所有回复记录")