如何使用JavaScript对象字面量优雅定义RestfulAPI的各种状态响应体-js教程-PHP中文网

javascript对象字面量可定义结构清晰、语义明确、复用性强、易于维护的restful api响应体，通过统一外层字段（code/message/data/timestamp）、预置状态模板、解构默认值及错误码映射实现简洁专业。

如何使用javascript对象字面量优雅定义restfulapi的各种状态响应体

用 JavaScript 对象字面量定义 RESTful API 的响应体，核心是**结构清晰、语义明确、复用性强、易于维护**。不靠类或工厂函数，也能写出既简洁又专业的响应格式。

统一响应结构，固定顶层字段

所有接口返回应保持一致的外层结构，比如包含 code、message、data（可选）、timestamp。用对象字面量直接定义“模板”，避免每次手动拼写：

const ApiResponse = {
  success: (data = null, message = 'OK') => ({
    code: 200,
    message,
    data,
    timestamp: Date.now()
  }),
  created: (data = null, message = 'Created') => ({
    code: 201,
    message,
    data,
    timestamp: Date.now()
  }),
  notFound: (message = 'Resource not found') => ({
    code: 404,
    message,
    data: null,
    timestamp: Date.now()
  }),
  badRequest: (message = 'Invalid request') => ({
    code: 400,
    message,
    data: null,
    timestamp: Date.now()
  })
};

调用时干净利落：ApiResponse.success({ id: 123, name: 'Alice' })。

按业务场景预置常用状态对象

对高频状态（如登录成功、权限拒绝、参数校验失败），可预先定义具名常量对象，再配合浅拷贝动态填充细节：

const AuthResponses = {
  loginSuccess: Object.freeze({
    code: 200,
    message: 'Login successful',
    data: { token: '', user: {} }
  }),
  invalidCredentials: Object.freeze({
    code: 401,
    message: 'Invalid credentials',
    data: null
  }),
  forbidden: Object.freeze({
    code: 403,
    message: 'Access denied',
    data: null
  })
};

// 使用时
return { ...AuthResponses.loginSuccess, data: { token, user } };

好处是类型友好（IDE 可推导）、不易误改、语义一目了然。

Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档，版本为 JDK 25，本条下载地址已指向官方 Windows x64 zip 安装包直链，适合调试旧项目或兼容旧版 Java 运行环境。

下载

用解构 + 默认值简化嵌套响应

当响应需携带分页、元信息等结构时，避免深层硬编码。利用对象字面量结合解构默认值，让调用方只关心关键字段：

const ListResponse = ({ list = [], total = 0, page = 1, pageSize = 20 } = {}) => ({
  code: 200,
  message: 'OK',
  data: {
    list,
    pagination: { total, page, pageSize }
  },
  timestamp: Date.now()
});

// 调用
ListResponse({ list: users, total: 156 });
// → { code: 200, message: 'OK', data: { list: [...], pagination: { total: 156, page: 1, pageSize: 20 } }, ... }

错误响应集中管理，支持自定义码与提示

把错误码和默认提示抽成映射表，再封装为可扩展的工厂函数：

const ERROR_CODES = {
  VALIDATION_ERROR: { code: 400, message: 'Validation failed' },
  NOT_FOUND: { code: 404, message: 'Resource not found' },
  SERVER_ERROR: { code: 500, message: 'Internal server error' }
};

const ApiError = (type, customMessage, details) => {
  const { code, message } = ERROR_CODES[type] || ERROR_CODES.SERVER_ERROR;
  return {
    code,
    message: customMessage || message,
    data: { details },
    timestamp: Date.now()
  };
};

// 使用
ApiError('VALIDATION_ERROR', 'Email format invalid', { email: 'invalid' });

这样既保留灵活性，又杜绝散落各处的 magic number 和重复字符串。

不复杂但容易忽略：保持 timestamp 类型统一（毫秒数）、data 始终存在（哪怕为 null）、code 严格对应 HTTP 状态码语义——这些细节能让前端解析更稳、文档更准、协作更顺。