[PR #866] [CLOSED] refactor: 提升代码质量 - 类型安全、消除重复、修复数据转换 #694

New issue

Closed

opened 2026-02-27 07:12:46 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 07:12:46 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/imsyy/SPlayer/pull/866
Author: @Copilot
Created: 2/11/2026
Status: ❌ Closed

Base: dev-dl-rust ← Head: copilot/sub-pr-864

📝 Commits (4)

0c9f031 Initial plan
985950a 🐛 fix: 修复数据转换逻辑，恢复 size 和 duration 的正确格式
f669747 ✨ refactor: 提升代码质量，增强类型安全和可维护性
797a9cc ♻️ refactor: 提取共享路径工具函数，消除代码重复

📊 Changes

7 files changed (+110 additions, -42 deletions)

View changed files

📝 electron/main/database/LocalMusicDB.ts (+13 -6)
📝 electron/main/ipc/ipc-file.ts (+4 -15)
📝 electron/main/services/LocalMusicService.ts (+27 -11)
📝 electron/main/utils/format.ts (+30 -6)
➕ electron/main/utils/paths.ts (+29 -0)
📝 src/utils/color.ts (+5 -3)
📝 src/views/Local/layout.vue (+2 -1)

📄 Description

代码审查发现类型安全问题、数据转换错误和代码重复。本次重构修复这些问题并提升整体代码质量。

修复数据转换错误

processMusicList: 恢复 duration 秒转毫秒和 size 字节保留（前端需要原始字节数供 formatFileSize 处理）
Local/layout.vue: 修复 allMusicSize 计算（字节 → GB）

// 之前：删除了关键转换，破坏前端显示
return { ...track, name: track.title, cover, quality: track.bitrate ?? 0 };

// 之后：保持正确的数据格式
return {
  ...track,
  name: track.title,
  cover,
  size: track.size,           // 字节数，供 formatFileSize 处理
  duration: track.duration * 1000,  // 转为毫秒
  quality: track.bitrate ?? 0,
};

消除 `any` 类型，增强类型安全

定义明确类型: Artist、ProcessedMusicTrack、ScanEvent（含 Progress/Batch/End 子类型）
移除 getArtistNames 的 any 参数: 使用 Artist | Artist[]
扫描回调事件类型化: (err, event: ScanEvent | null) => void

// 之前：类型不安全
export const getArtistNames = (artists: any): string[] => {
  // ...
}

// 之后：明确类型定义
type Artist = string | { name?: string };
export const getArtistNames = (artists: Artist | Artist[]): string[] => {
  // ...
}

消除代码重复

创建 utils/paths.ts 统一路径管理，消除 ipc-file.ts 和 LocalMusicService 中的重复 getCoverDir 实现（-15 行）：

// utils/paths.ts - 单一来源
export const getCoverDir = (): string => {
  return getLocalDataPaths().coverDir;
};

// ipc-file.ts & LocalMusicService.ts - 复用
import { getCoverDir } from "../utils/paths";

其他优化

提取 LocalMusicDB.escapeLike 为私有方法
移除不必要的空回调 () => {}
完善函数返回类型标注

质量验证: ✅ Code Review (0 issues) | ✅ CodeQL (0 alerts)

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/imsyy/SPlayer/pull/866 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 2/11/2026 **Status:** ❌ Closed **Base:** `dev-dl-rust` ← **Head:** `copilot/sub-pr-864` --- ### 📝 Commits (4) - [`0c9f031`](https://github.com/imsyy/SPlayer/commit/0c9f0318e9944d3ca0b58c027d3affc43e337ead) Initial plan - [`985950a`](https://github.com/imsyy/SPlayer/commit/985950abcf58e35504b3c734b012918d0707fd35) 🐛 fix: 修复数据转换逻辑，恢复 size 和 duration 的正确格式 - [`f669747`](https://github.com/imsyy/SPlayer/commit/f669747a2bb5864f986eff8a6a0f3a69645097ad) ✨ refactor: 提升代码质量，增强类型安全和可维护性 - [`797a9cc`](https://github.com/imsyy/SPlayer/commit/797a9cc25927be0378ab0770bee5e4aa7a8703d4) ♻️ refactor: 提取共享路径工具函数，消除代码重复 ### 📊 Changes **7 files changed** (+110 additions, -42 deletions) <details> <summary>View changed files</summary> 📝 `electron/main/database/LocalMusicDB.ts` (+13 -6) 📝 `electron/main/ipc/ipc-file.ts` (+4 -15) 📝 `electron/main/services/LocalMusicService.ts` (+27 -11) 📝 `electron/main/utils/format.ts` (+30 -6) ➕ `electron/main/utils/paths.ts` (+29 -0) 📝 `src/utils/color.ts` (+5 -3) 📝 `src/views/Local/layout.vue` (+2 -1) </details> ### 📄 Description 代码审查发现类型安全问题、数据转换错误和代码重复。本次重构修复这些问题并提升整体代码质量。 ## 修复数据转换错误 - **`processMusicList`**: 恢复 `duration` 秒转毫秒和 `size` 字节保留（前端需要原始字节数供 `formatFileSize` 处理） - **`Local/layout.vue`**: 修复 `allMusicSize` 计算（字节 → GB） ```typescript // 之前：删除了关键转换，破坏前端显示 return { ...track, name: track.title, cover, quality: track.bitrate ?? 0 }; // 之后：保持正确的数据格式 return { ...track, name: track.title, cover, size: track.size, // 字节数，供 formatFileSize 处理 duration: track.duration * 1000, // 转为毫秒 quality: track.bitrate ?? 0, }; ``` ## 消除 `any` 类型，增强类型安全 - **定义明确类型**: `Artist`、`ProcessedMusicTrack`、`ScanEvent`（含 `Progress`/`Batch`/`End` 子类型） - **移除 `getArtistNames` 的 `any` 参数**: 使用 `Artist | Artist[]` - **扫描回调事件类型化**: `(err, event: ScanEvent | null) => void` ```typescript // 之前：类型不安全 export const getArtistNames = (artists: any): string[] => { // ... } // 之后：明确类型定义 type Artist = string | { name?: string }; export const getArtistNames = (artists: Artist | Artist[]): string[] => { // ... } ``` ## 消除代码重复创建 `utils/paths.ts` 统一路径管理，消除 `ipc-file.ts` 和 `LocalMusicService` 中的重复 `getCoverDir` 实现（-15 行）： ```typescript // utils/paths.ts - 单一来源 export const getCoverDir = (): string => { return getLocalDataPaths().coverDir; }; // ipc-file.ts & LocalMusicService.ts - 复用 import { getCoverDir } from "../utils/paths"; ``` ## 其他优化 - 提取 `LocalMusicDB.escapeLike` 为私有方法 - 移除不必要的空回调 `() => {}` - 完善函数返回类型标注 **质量验证**: ✅ Code Review (0 issues) | ✅ CodeQL (0 alerts)  --- ✨ Let Copilot coding agent [set things up for you](https://github.com/imsyy/SPlayer/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>