解决抽象类中的 TypeScript 索引签名问题

改进索引签名的 TypeScript 抽象类设计

解决方案 1：使用映射类型来提高可扩展性并减少 TypeScript 中的重复。

export abstract class BaseAPI {
  static readonly [key: string]: ApiCall<unknown> | Record<string, ApiCall<unknown>> | undefined | (() => string);
  static getChannel(): string {
    return 'Base Channel';
  }
}

export class TransactionAPI extends BaseAPI {
  static readonly CREATE: ApiCall<Transaction> = {
    method: 'POST',
    endpoint: 'transaction',
    response: {} as ApiResponse<Transaction>,
  };
}

export class FileAPI extends BaseAPI {
  static readonly CREATE: ApiCall<File> = {
    method: 'POST',
    endpoint: 'file',
    response: {} as ApiResponse<File>,
  };
}

使用装饰器简化 API 类设计

解决方案2：使用装饰器自动生成索引签名。

function WithIndexSignature<T extends { new (...args: any[]): {} }>(constructor: T) {
  return class extends constructor {
    static readonly [key: string]: ApiCall<unknown> | Record<string, ApiCall<unknown>> | undefined | (() => string);
  };
}

@WithIndexSignature
export class TransactionAPI extends BaseAPI {
  static readonly CREATE: ApiCall<Transaction> = {
    method: 'POST',
    endpoint: 'transaction',
    response: {} as ApiResponse<Transaction>,
  };
}

@WithIndexSignature
export class FileAPI extends BaseAPI {
  static readonly CREATE: ApiCall<File> = {
    method: 'POST',
    endpoint: 'file',
    response: {} as ApiResponse<File>,
  };
}

添加 API 端点提取的单元测试

解决方案 3：包括使用 Jest 的单元测试来验证实现。

import { ApiManager, TransactionAPI, FileAPI } from './api-manager';

describe('ApiManager', () => {
  it('should extract endpoints from TransactionAPI', () => {
    const endpoints = ApiManager['getEndpoints'](TransactionAPI);
    expect(endpoints).toContain('transaction');
  });

  it('should extract endpoints from FileAPI', () => {
    const endpoints = ApiManager['getEndpoints'](FileAPI);
    expect(endpoints).toContain('file');
  });

  it('should validate endpoint safety', () => {
    const isSafe = ApiManager.isEndpointSafe('transaction');
    expect(isSafe).toBe(true);
  });
});

关于 TypeScript 索引签名的常见问题

1. TypeScript 中的索引签名是什么？
2. 索引签名允许您定义对象的键和值的类型。例如， static readonly [key: string]: ApiCall<unknown> 强制所有键都是具有特定类型值的字符串。
3. 为什么抽象类需要索引签名？
4. 抽象类使用索引签名为所有子类提供统一的类型定义，确保一致的行为和类型安全。
5. 装饰器可以帮助减少代码重复吗？
6. 是的，装饰者喜欢 @WithIndexSignature 动态注入索引签名，减少在每个子类中手动定义它们的需要。
7. 使用有什么好处 Record<string, ApiCall<unknown>>？
8. 它提供了一种灵活且强类型的方式来动态定义对象属性，非常适合管理 API 端点等复杂模式。
9. 测试如何验证 API 管理器中的端点提取？
10. 测试如 expect().toContain() 验证注册表中是否存在特定端点，确保 API 管理器按预期运行。

简化 TypeScript API 类设计

通过将逻辑集中在“BaseAPI”类中，可以简化跨子类（例如“TransactionAPI”和“FileAPI”）处理索引签名的过程。使用装饰器和映射类型等先进技术，您可以消除重复代码，同时保持一致性和类型安全。这是扩展复杂系统的有效方法。 🚀

通过集成测试框架和动态类型定义，开发人员可确保其 API 端点保持稳健且无错误。这些策略不仅可以解决眼前的挑战，还可以保证您的代码库能够面向未来进行敏捷开发。采用这些实践使 TypeScript 成为构建可扩展软件解决方案的强大盟友。