JS中两种常见定义API的方式对比

使用类和直接导出函数在定义API时都是常见的,并且它们各自有其优点和适用场景。下面我将解释这两种方式的主要区别和各自的优点。

一、使用类定义API

优点:

1.组织性:类可以提供一个自然的结构来封装相关的API方法。
2.封装性:类可以包含私有方法和状态,这有助于隐藏实现细节。
3.继承性:如果未来需要扩展API集,可以通过继承来扩展功能。
4.实例化和配置:如果需要为每个API实例配置不同的设置或状态,可以使用类的实例方法。
代码示例:

class AuthAPI {  
  login(data: Login.LoginRequestData) {  
    return request<Login.LoginResponseData>({  
      url: "users/login",  
      method: "post",  
      data  
    });  
  }  
}  
  
export default new AuthAPI(); // 导出类的实例

使用方式:

import AuthAPI from "@/api/auth";

AuthAPI.login(loginData).then((data) => {})
        

二、直接导出函数定义API

优点:

1.简单直接:函数可以直接暴露API的调用方式,不需要额外的类包装。
2.无状态:如果API调用是无状态的(即不需要跟踪状态),那么函数可能是更好的选择。
3.树摇:在某些构建系统中(如Webpack的Tree Shaking),未使用的函数可以被排除在最终构建之外,这有助于减少包大小。
代码示例:

import { request } from "@/utils/service";  
import type * as Login from "./types/login";  
  
/** 登录并返回 Token */  
export function loginApi(data: Login.LoginRequestData) {  
  return request<Login.LoginResponseData>({  
    url: "users/login",  
    method: "post",  
    data  
  });  
}

使用方式:

import { loginApi } from "@/api/login"

loginApi({ username, password}).then((data) => {})
区别:

1.结构:类提供了一个结构化的方式来组织代码,而函数则更直接。
2.封装性:类可以封装私有方法和状态,而函数通常是公开的。
3.实例化和配置:类可以实例化,并为每个实例配置不同的设置或状态,而函数则没有这个概念。
4.继承性:类支持继承,而函数不支持。

哪种方式更好?

这取决于自己的具体需求和偏好。如果你的API集是简单的、无状态的,并且你更喜欢简单直接的方式,那么直接导出函数可能更好。如果你的API集更复杂,需要更多的组织和封装,或者你需要为每个API实例配置不同的设置或状态,那么使用类可能更合适。

在许多现代前端应用中,直接导出函数是更常见的做法,因为它更简单、更直接,并且与函数式编程的范式相符。然而,这并不意味着类在定义API时就没有用处,它们仍然在某些场景下非常有用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354

推荐阅读更多精彩内容