Angular异步本地存储库升级至v16指南

前言

本文将详细介绍如何将angular-async-local-storage库从旧版本升级到v16，并解析其中的重大变更和弃用内容。作为Angular生态中处理本地存储的优秀解决方案，该库在v16版本中引入了一些重要变化，开发者需要特别注意。

升级准备

首先，确保你已经安装了最新版本的Angular CLI工具，然后执行以下命令进行升级：

ng update @ngx-pwa/local-storage

重要提示：如果你的项目当前版本低于v15，请先按照其他迁移指南逐步升级。特别是v9版本的迁移至关重要，错误的迁移操作可能导致已存储数据的丢失。

环境要求变更

v16版本对运行环境提出了新的要求：

• 必须使用Angular 16或更高版本
• 需要RxJS 7.4或更高版本
• 推荐使用TypeScript 5.0

注意事项：

• 不再支持RxJS 6
• TypeScript 4.9理论上可以工作，但未经充分测试

重大变更解析

LocalStorage服务弃用

LocalStorage服务已被标记为弃用，并将在v17版本中移除。实际上，其替代品StorageMap自v8版本就已存在，现在是时候进行迁移了。

迁移示例：

// 旧版用法
import { LocalStorage } from '@ngx-pwa/local-storage';

@Injectable()
export class YourService {
  constructor(private storage: LocalStorage) {
    this.storage.getItem('key').subscribe();
    this.storage.setItem('key', 'value').subscribe();
    this.storage.removeItem('key').subscribe();
    this.storage.clear().subscribe();
    this.storage.length;
  }
}

// 新版用法
import { StorageMap } from '@ngx-pwa/local-storage';

@Injectable()
export class YourService {
  constructor(private storage: StorageMap) {
    this.storage.get('key').subscribe();
    this.storage.set('key', 'value').subscribe();
    this.storage.delete('key').subscribe();
    this.storage.clear().subscribe();
    this.storage.size;
  }
}

类型差异说明：

1. 当键不存在时，StorageMap的get方法返回undefined（而LocalStorage返回null），需要相应调整条件判断：

// 旧版判断
this.storage.getItem('key').subscribe((data) => {
  if (data !== null) {}
});

// 新版判断
this.storage.get('key').subscribe((data) => {
  if (data !== undefined) {}
});

2. StorageMap的写入方法返回undefined（LocalStorage返回true），不过这对大多数应用场景没有影响，因为这些方法的返回值通常不会被使用

其他弃用内容

JSONSchema特定接口

特定的JSONSchemaXXX接口已被弃用，将在v17中移除。这些接口是该库早期版本中为解决某些TypeScript问题而引入的临时方案，这些问题早已不复存在。自v8版本起，开发者应该使用通用的JSONSchema接口。

特别提醒：如果你使用JSONSchemaArray来处理元组模式，由于v16.2.0中的修复，现在需要切换到JSONSchema。

示例：

// 旧版
const schema: JSONSchemaString = { type: 'string' };

// 新版
const schema = { type: 'string' } satisfies JSONSchema;

技术提示：使用satisfies JSONSchema而非schema: JSONSchema的原因在于更好的类型推断和灵活性。

JSONValidator工具类

JSONValidator已被弃用，v17后将不再提供。这是一个内部工具类，功能有限且可能随时变更，不属于该库的核心范畴。

替代方案：如果需要JSON验证功能，建议使用专门的验证库如ajv等。

LocalDatabase内部类

LocalDatabase已被标记为弃用，v17后将移除。这是一个内部工具类，重写它属于未文档化的行为。如果你确实需要自定义存储实现，建议直接创建自己的存储服务。

升级建议

1. 首先确保测试覆盖率足够，升级后进行充分测试
2. 分阶段进行迁移，特别是大型项目
3. 重点关注LocalStorage到StorageMap的迁移
4. 检查所有JSON Schema相关的类型定义
5. 移除对内部类(JSONValidator、LocalDatabase)的依赖

结语

本次升级主要涉及API的简化和现代化，移除了历史遗留的临时解决方案。虽然需要一定的迁移工作，但将使代码更加规范且面向未来。建议开发者尽早完成升级，以便获得更好的类型支持和更简洁的API体验。