VSCode 插件开发实战（十一）： 如何持久化数据存储

前言

VSCode 通过自定义插件，可以极大地提升工作效率。然而，在开发插件时，经常会遇到需要持久化存储数据的需求，有时候我们需要让插件的某些数据在 VSCode 关闭后仍然能够保存下来，以便下次启动时继续使用，例如保存用户设置、任务列表或者其他重要信息。

本文将深入探讨如何在 VSCode 自定义插件中实现数据的持久化存储，并介绍一些高级技巧和最佳实践，以确保数据的安全和可靠性。

为什么需要持久化存储？

试想一下，我们开发了一个任务管理插件，可以帮助我们跟踪每天的开发任务。如果每次关闭 VSCode 后，所有的任务信息都消失了，那无疑会让这个插件变得毫无用处。因此，持久化存储的需求自然就产生了。

VSCode 提供的存储接口

幸运的是，VSCode 为我们提供了一些内置的存储接口，主要有两种：workspaceState 和 globalState。

• workspaceState：只在当前工作区有效，当我们切换到另一个工作区时，数据将不再可用。
• globalState：在所有工作区之间共享，不管你在哪个工作区打开 VSCode，都能访问这些数据。

如何使用这些存储接口？

让我们通过一个简单的例子来看一下如何在插件中使用这些接口。假设我们要开发一个插件，记录用户上次关闭 VSCode 的时间。

使用 workspaceState 存储数据

接下来，我们在插件的 src/extension.ts 文件中添加存储功能。先来看一下 activate 方法：

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    const previousCloseTime = context.workspaceState.get<string>('lastCloseTime');
    if (previousCloseTime) {
        vscode.window.showInformationMessage(`Last close time: ${previousCloseTime}`);
    } else {
        vscode.window.showInformationMessage('No previous close time recorded.');
    }

    context.subscriptions.push(
        vscode.commands.registerCommand('extension.saveCloseTime', () => {
            const currentTime = new Date().toISOString();
            context.workspaceState.update('lastCloseTime', currentTime);
            vscode.window.showInformationMessage(`Current time saved: ${currentTime}`);
        })
    );
}

export function deactivate() {}

在这个示例中，我们做了以下几件事：

1. 使用 context.workspaceState.get 方法读取存储的数据。
2. 如果有数据，就显示上次关闭时间；否则提示没有记录。
3. 注册一个命令，当命令执行时，保存当前时间到 workspaceState。

使用 globalState 存储数据

如果我们需要在不同工作区之间共享数据，可以使用 globalState。只需将上述代码中的 workspaceState 替换为 globalState 即可：

const previousCloseTime = context.globalState.get<string>('lastCloseTime');
context.globalState.update('lastCloseTime', currentTime);

高级技巧

数据结构和序列化

在实际开发中，我们通常需要存储更复杂的数据结构。VSCode 的存储接口能处理字符串、数字和布尔值这些简单类型，但如果我们要存储对象或者数组，就需要进行序列化和反序列化。

假设我们要存储一个任务列表，每个任务包含描述、优先级和完成状态。我们可以使用 JSON 来序列化和反序列化数据。

interface Task {
    description: string;
    priority: number;
    completed: boolean;
}

export function activate(context: vscode.ExtensionContext) {
    const tasksJson = context.globalState.get<string>('tasks');
    let tasks: Task[] = tasksJson ? JSON.parse(tasksJson) : [];

    vscode.commands.registerCommand('extension.addTask', () => {
        vscode.window.showInputBox({prompt: 'Enter task description'}).then(description => {
            if (description) {
                const task: Task = { description, priority: 1, completed: false };
                tasks.push(task);
                context.globalState.update('tasks', JSON.stringify(tasks));
                vscode.window.showInformationMessage(`Task added: ${description}`);
            }
        });
    });

    vscode.commands.registerCommand('extension.listTasks', () => {
        if (tasks.length > 0) {
            tasks.forEach(task => {
                vscode.window.showInformationMessage(`Task: ${task.description}, Priority: ${task.priority}, Completed: ${task.completed}`);
            });
        } else {
            vscode.window.showInformationMessage('No tasks found.');
        }
    });
}

在这个例子中，我们定义了一个 Task 接口，并将任务列表存储为一个 JSON 字符串。每次添加任务后，都会更新全局状态并将任务列表序列化为 JSON 存储。

数据加密

在某些情况下，我们可能需要保护存储的数据，比如存储用户的敏感信息。这时候可以考虑对数据进行加密。虽然 VSCode 没有内置的加密支持，但我们可以借助一些外部库，比如 crypto-js。

首先，安装 crypto-js：

npm install crypto-js

接下来，使用加密和解密来保护数据：

import * as CryptoJS from 'crypto-js';

const secretKey = 'mySecretKey';

function encryptData(data: string): string {
    return CryptoJS.AES.encrypt(data, secretKey).toString();
}

function decryptData(ciphertext: string): string {
    const bytes = CryptoJS.AES.decrypt(ciphertext, secretKey);
    return bytes.toString(CryptoJS.enc.Utf8);
}

export function activate(context: vscode.ExtensionContext) {
    const encryptedTasks = context.globalState.get<string>('encryptedTasks');
    const tasksJson = encryptedTasks ? decryptData(encryptedTasks) : '[]';
    let tasks: Task[] = JSON.parse(tasksJson);

    vscode.commands.registerCommand('extension.addTask', () => {
        // ... (与前例相同)
        const encryptedTasks = encryptData(JSON.stringify(tasks));
        context.globalState.update('encryptedTasks', encryptedTasks);
    });

    vscode.commands.registerCommand('extension.listTasks', () => {
        // ... (与前例相同)
    });
}

在这个示例中，我们使用 AES 加密算法对任务列表进行加密和解密。这样，即使数据被不正当地访问，也不会直接暴露敏感信息。

处理插件更新和数据迁移

插件更新时，数据库结构可能会发生变化。例如，我们可能会为任务添加新的字段。这时候需要考虑数据迁移策略，以确保旧数据能够正确升级。

一种简单的做法是在插件激活时检查数据版本，并根据需要进行迁移：

export function activate(context: vscode.ExtensionContext) {
    const version = context.globalState.get<string>('version');
    if (version !== '1.1') {
        migrateData(context);
        context.globalState.update('version', '1.1');
    }
    // ... 其他初始化代码
}

function migrateData(context: vscode.ExtensionContext) {
    const tasksJson = context.globalState.get<string>('tasks');
    if (tasksJson) {
        let tasks: Task[] = JSON.parse(tasksJson);
        tasks = tasks.map(task => ({
            ...task,
            newField: 'defaultValue' // 添加新的字段
        }));
        context.globalState.update('tasks', JSON.stringify(tasks));
    }
}

通过这种方式，我们可以确保每次插件更新时，数据都能够正确迁移，保持插件的正常工作。

总结

本文详细介绍了在 VSCode 自定义插件中实现持久化数据存储的方法，从基本的 workspaceState 和 globalState 接口，到复杂数据结构的序列化和加密，以及插件更新时的数据迁移。通过掌握这些技术，开发者可以创建更加智能和强大的插件，显著提高用户体验。