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 简单验证代码(用户名,密码,邮箱)
Sep 28 Javascript
js实现iframe自动自适应高度的方法
Feb 17 Javascript
解读Bootstrap v4 sass设计
May 29 Javascript
浅谈JavaScript 执行环境、作用域及垃圾回收
May 31 Javascript
Angular Module声明和获取重载实例代码
Sep 14 Javascript
图文详解Javascript中的上下文和作用域
Feb 15 Javascript
JS奇技之利用scroll来监听resize详解
Jun 15 Javascript
jQuery实现节点的追加、替换、删除、复制功能示例
Jul 11 jQuery
angularJS实现动态添加,删除div方法
Feb 27 Javascript
vue+axios实现post文件下载
Sep 25 Javascript
Vue 401配合Vuex防止多次弹框的案例
Nov 11 Javascript
vue实现拖拽交换位置
Apr 07 Vue.js
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关联数组实现根据元素值删除元素的方法
2015/06/26 PHP
Zend Framework实现多文件上传功能实例
2016/03/21 PHP
Joomla使用Apache重写模式的方法
2016/05/04 PHP
同一个表单 根据要求递交到不同页面的实现方法小结
2009/08/05 Javascript
html 锁定页面(js遮罩层弹出div效果)
2009/10/27 Javascript
Javascript 中的类和闭包
2010/01/08 Javascript
input输入框的自动匹配(原生代码)
2013/03/19 Javascript
通过length属性判断jquery对象是否存在
2013/10/18 Javascript
node.js从数据库获取数据
2016/05/08 Javascript
基于Jquery插件Uploadify实现实时显示进度条上传图片
2020/03/26 Javascript
javascript淘宝主图放大镜功能
2016/10/20 Javascript
jquery ui sortable拖拽后保存位置
2017/04/27 jQuery
js+css实现红包雨效果
2018/07/12 Javascript
JavaScript实现随机五位数验证码
2019/09/27 Javascript
Jquery高级应用Deferred对象原理及使用实例
2020/05/28 jQuery
Vue使用Three.js加载glTF模型的方法详解
2020/06/14 Javascript
Python实现可获取网易页面所有文本信息的网易网络爬虫功能示例
2018/01/15 Python
Python之列表实现栈的工作功能
2019/01/28 Python
Python代码需要缩进吗
2020/07/01 Python
python db类用法说明
2020/07/07 Python
python字典通过值反查键的实现(简洁写法)
2020/09/30 Python
Python3.9新特性详解
2020/10/10 Python
python 实现非极大值抑制算法(Non-maximum suppression, NMS)
2020/10/15 Python
CSS3实现的渐变幻灯片效果
2020/12/07 HTML / CSS
使用HTML5技术开发一个属于自己的超酷颜色选择器
2013/09/22 HTML / CSS
Html5导航栏吸顶方案原理与对比实现
2020/06/10 HTML / CSS
南京软件公司的.net程序员笔试题
2014/08/31 面试题
Java文件和目录(IO)操作
2014/08/26 面试题
自考毕业自我鉴定
2014/03/18 职场文书
骨干教师考核方案
2014/05/09 职场文书
物业保安岗位职责
2014/07/02 职场文书
运输企业安全生产责任书
2014/07/28 职场文书
2014年教师节国旗下讲话稿
2014/09/10 职场文书
酒店工程部主管岗位职责
2015/04/16 职场文书
幼儿园教学反思范文
2016/03/02 职场文书
暑假开始了,你的暑假学习计划写好了吗?
2019/07/04 职场文书