从TypeScript的类中派生接口[每日前端夜话0xAE]

大多数面向对象编程语言都鼓励编程到接口【https://tuhrig.de/programming-to-an-interface/】的模式。TypeScript 当然支持这一点,你可以创建一个或多个接口,然后再定义生成这个接口实例的类(或工厂)。

但是当程序员预期将来可能会存在多个具体实现时,有时会过度使用对接口的编程,尽管在实现时可能有一个。

在直到真正实际需要这些多个实现之前,这些单实现接口会继续增加维护开销,因为每次我们需要引入新成员时,都需要修改两个位置。当然可以依靠工具来帮忙,但它仍然不是理想的解决方式。

此外,仅依靠具体实现并不是理想的解决方案,因为如果我们将来需要多个实现的话,TypeScript 编译器服务还没有一个很好的机制能够批量替换具体实现的所有用法与相对应的接口。

因此在本文中,我们探索了 typescript 的两个功能,可以帮助我们解决这个问题。

从类派生接口

TypeScript 的一个鲜为人知的特性是接口可以从类派生。

export interface SyncBackend extends FSSyncBackend {}

这对我们的用例来说似乎是一个明智的选择。但是有一个重要的警告:实现的所有私有或受保护成员都将会在派生接口中公开。

如果你对此感到惊讶,你并不孤独。当我第一次遇到它时,发现它非常反直觉,但在官方文档中解释了其背后的基本原理:【https://www.typescriptlang.org/docs/handbook/interfaces.html】

当接口类型扩展类的类型时,它继承类的成员但不继承它们的实现。就好像接口已经声明了类的所有成员而没有提供实现一样。接口甚至会继承基类的私有成员和受保护成员。这意味着当你创建一个继承了具有私有或受保护成员的类的接口时,该接口类型只能由该类或其子类实现。 当你具有大型继承层次结构但希望指定你的代码仅使用具有某些属性的子类时,这非常有用。除了继承基类之外,子类不必相关。

所以,这一切都很好,但如果我们只想要公有成员,应该怎么办?

值得庆幸的是存在一个简单的解决方法

使用映射类型

我们可以使用从类型的公共成员派生的映射类型【https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-1.html】。

由于类定义是隐式的类型定义,因此这也适用于类:

export type SyncBackend = { 
    [K in keyof FSSyncBackend]: FSSyncBackend[K];
}

现在 SyncBackend 类型只有 FSSyncBackend 类的公共成员。

虽然在大多数情况下,这达到了我们的目的,但如果我们严格需要一个接口而不是一个别名(可能是为了改进类型错误消息),可以简单地定义一个从这个别名扩展的接口:

type SyncBackend$1 = { 
    [K in keyof FSSyncBackend]: FSSyncBackend[K];
}

export interface SyncBackend extends SyncBackend$1 {}

如果最终我们确实需要多个实现,可以选择具有明确定义的接口,或者将一个实现保留为规范实现,从中派生接口并使其他实现符合该规范。

如果实际暴露了多个实现,则前一个解决方案(显式定义的接口)有助于将接口的 API 记录与各个实现的记录分开。

https://lorefnon.tech/2019/08/18/deriving-interfaces-from-classes-in-typescript/

原文发布于微信公众号 - 前端先锋(jingchengyideng)

原文发表时间:2019-08-20

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

扫码关注云+社区

领取腾讯云代金券