使用类和直接导出函数在定义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时就没有用处，它们仍然在某些场景下非常有用。
网友评论