TypeScript中的方法重载详解


Posted in Javascript onApril 12, 2019

前言

方法重载(overload)在传统的静态类型语言中是很常见的。JavaScript 作为动态语言, 是没有重载这一说的。一是它的参数没有类型的区分,二是对参数个数也没有检查。虽然语言层面无法自动进行重载,但借助其动态的特性,我们可以在代码中手动检查入参的类型,或者通过 arguments 获取到参数个数,从而实现根据不同的入参做不同的操作。

比如有一个获取聊天消息的方法,根据传入的参数从数组中查找数据。如果入参为数字,则认为是 id,然后从数据源中找对应 id 的数据并返回,否则当成类型,返回这一类型的消息。

function getMessage(query) {
 if (typeof query === "nunber") {
 return data.find(message => message.id === query);
 } else {
 return data.filter(message => message.type === query);
 }
}

TypeScript 中,假如我们的消息数据为如下结构:

type MessageType = "string" | "image" | "audio";

type Message = {
 id: number;
 type: MessageType;
 content: string;
};

上面获取数据的方法等价于:

function getMessage(
 query: number | MessageType
): Message[] | Message | undefined {
 if (typeof query === "number") {
 return data.find(message => message.id === query);
 } else {
 return data.filter(message => message.type === query);
 }
}

这样做一是类型书写上比较丑陋,二是没有发挥出 TypeScript 类型检查的优势,这里我们是可以根据入参的类型明确知道返回的类型的,即如果传入的是 id,返回的是单个数据或undefined,如果是根据类型查找,返回的是数组。而现在调用方法后,得到的类型太过宽泛,这和使用 any 做为返回没多大差别。

TypeScript中的方法重载详解

函数返回类型不够紧凑

因为类型的不明朗,返回的结果都不能直接操作,需要进行类型转换后才能继续。

const result1 = getMessage("audio");
/** 不能直接对 result1 调用数组方法 */
console.log((result1 as Message[]).length);

const result2 = getMessage(1);
if (result2) {
 /** 不能对 result2 直接访问消息对象中的属性 */
 console.log((result2 as Message).content);
}

重载的实现

这时候可通过提供多个函数类型的声明来解决上面的问题,最后得到的结果就是间接实现了函数的重载。当然这个重载只是 TypeScript 编译时的。

function getMessage(id: number): Message | undefined;
function getMessage(type: MessageType): Message[];
function getMessage(query: any): any {
 if (typeof query === "number") {
  return data.find(message => message.id === query);
 } else {
  return data.filter(message => message.type === query);
 }
}

这样改造后,我们在调用的时候直接就会有重载的提示。

TypeScript中的方法重载详解

实现 TypeScript 的重载后调用时的自动提示

并且得到的结果类型是重载方法中指定的入参与返回的组合,在对结果进行使用时,无须再进行类型转换。

const result1 = getMessage("audio");
/** ✅ 无须类型转换 */
console.log(result1.length);

const result2 = getMessage(1);
if (result2) {
 /** ✅ 无须类型转换 */
 console.log(result2.content);
}

这里需要理解的是,上面添加的函数类型仅作为 TypeScript 在编译时使用的,它不是真的实现像传统静态类型语言那样的重载,也不会改变编译后代码的输出。实际运行时仍然是不带重载的 JavaScript 版本。

编译后的代码

但这一点也不影响我们在 TypeScript 中使用这种假的重载。

可选参数

另一个 TypeScript 重载的场景。还是上面获取消息数据的方法,因为根据类型查找消息时,会返回同类型消息的一个数组。此时我们想加一个参数实现只返回结果中前几个数据,那么可以很方便地进行如下的改造:

function getMessage(id: number): Message | undefined;
+function getMessage(type: MessageType, count?: number): Message[];
+function getMessage(query: any, count = 10): any {
 if (typeof query === "number") {
  return data.find(message => message.id === query);
 } else {
+  return data.filter(message => message.type === query).splice(0, count);
 }
}

通过重载,这个新增的参数很容易实现只针对入参 MessageType 时,这样如果我们有如下的调用,会得到编译时的报错:

/** ? Argument of type '1' is not assignable to parameter of type 'MessageType' */
getMessage(1,10);

而非重载的版本是享受不到上面提到的类型优势的。

function getMessage(
 query: number | MessageType,
 count = 10
): Message[] | Message | undefined {
 if (typeof query === "number") {
  return data.find(message => message.id === query);
 } else {
  return data.filter(message => message.type === query).splice(0, count);
 }
}

/** ✅ ojbk, 不错报 */
getMessage(1, 10);

重载过程

TypeScript 重载的过程是,拿传入的参数和重载的方法签名列表中由上往下逐个匹配,直到找到一个完全匹配的函数签名,否则报错。所以推荐的做法是将签名更加具体的重载放上面,不那么具体的放后面。

/** ✅*/
function getMessage(type: MessageType, count?: number): Message[];
function getMessage(id: number): Message | undefined;

/** ?*/
function getMessage(id: number): Message | undefined;
function getMessage(type: MessageType, count?: number): Message[];

像上面示例中正确做法这样,如果说入参个数只有一个,那可以直接跳过第一个函数签名,无须做入参类型的判断。

相关资源

  • TypeScript Handbook - Functions - Overloads
  • Typescript method overloading

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对三水点靠木的支持。

Javascript 相关文章推荐
javascript 写类方式之一
Jul 05 Javascript
js文件中调用js的实现方法小结
Oct 23 Javascript
JS网页播放声音实现代码兼容各种浏览器
Sep 22 Javascript
js中reverse函数的用法详解
Dec 26 Javascript
ionic2 tabs使用 Modal底部tab弹出框
Dec 30 Javascript
Angular组件化管理实现方法分析
Mar 17 Javascript
Angular动态添加、删除输入框并计算值实例代码
Mar 29 Javascript
jquery实现图片放大点击切换
Jun 06 jQuery
Vue.js添加组件操作示例
Jun 13 Javascript
小程序实现列表点赞功能
Nov 02 Javascript
vue+webpack 更换主题N种方案优劣分析
Oct 28 Javascript
javascript 易错知识点实例小结
Apr 25 Javascript
vue-cli 3.x配置跨域代理的实现方法
Apr 12 #Javascript
解决微信小程序调用moveToLocation失效问题【超简单】
Apr 12 #Javascript
详解Bootstrap 学习(一)入门
Apr 12 #Javascript
vue组件中iview的modal组件爬坑问题之modal的显示与否应该是使用v-show
Apr 12 #Javascript
vue+echarts实现可拖动节点的折线图(支持拖动方向和上下限的设置)
Apr 12 #Javascript
详解Vue中使用插槽(slot)、聚类插槽
Apr 12 #Javascript
JS实现li标签的删除
Apr 12 #Javascript
You might like
php 动态多文件上传
2009/01/18 PHP
php park、unpark、ord 函数使用方法(二进制流接口应用实例)
2010/10/19 PHP
解析htaccess伪静态的规则
2013/06/18 PHP
ThinkPHP3.1新特性之动态设置自动完成及自动验证示例代码
2014/06/23 PHP
destoon调用discuz论坛中带图片帖子的实现方法
2014/08/21 PHP
PHP设计模式概论【概念、分类、原则等】
2020/05/01 PHP
修改jQuery.Autocomplete插件 支持中文输入法 避免TAB、ENTER键失效、导致表单提交
2009/10/11 Javascript
js 编写规范
2010/03/03 Javascript
js实现快速分享功能(你的文章分享工具)
2013/06/25 Javascript
JavaScript数据类型详解
2015/04/01 Javascript
12个超实用的JQuery代码片段
2015/11/02 Javascript
JS中parseInt()和map()用法分析
2016/12/16 Javascript
微信小程序 九宫格实例代码
2017/01/21 Javascript
bootstrap table 多选框分页保留示例代码
2017/03/08 Javascript
详谈JS中数组的迭代方法和归并方法
2017/08/11 Javascript
通俗解释JavaScript正则表达式快速记忆
2017/08/23 Javascript
详解关于element el-button使用$attrs的一个注意要点
2018/11/09 Javascript
JS实现的小火箭发射动画效果示例
2018/12/08 Javascript
js图片无缝滚动插件使用详解
2020/05/26 Javascript
vue.js循环radio的实例
2019/11/07 Javascript
[07:43]《辉夜杯》公开赛晋级外卡赛战队—TRG训练生活探秘
2015/12/11 DOTA
python实现图片文件批量重命名
2020/03/23 Python
Python hashlib加密模块常用方法解析
2019/12/18 Python
Python爬取阿拉丁统计信息过程图解
2020/05/12 Python
2020版Python学习路线图(附学习资料)
2020/09/15 Python
Python与C/C++的相互调用案例
2021/03/04 Python
html5视频自动横过来自适应页面且点击播放功能的实现
2020/06/03 HTML / CSS
温泉秘密:Onsen Secret
2020/07/06 全球购物
叙述DBMS对数据控制功能有哪些
2016/06/12 面试题
创业计划书如何吸引他人眼球
2014/01/10 职场文书
先进工作者获奖感言
2014/02/08 职场文书
销售主管竞聘书
2014/03/31 职场文书
蛋糕店创业计划书范文
2014/09/21 职场文书
银行求职自荐信范文
2015/03/04 职场文书
JS异步堆栈追踪之为什么await胜过Promise
2021/04/28 Javascript
Java数据开发辅助工具Docker与普通程序使用方法
2021/09/15 Java/Android