Question

如何将请求的返回JSON结果记录到服务器？

实施例

/**
 * Gets a user's data
 * @returns {jQuery}
 */
function getUserData(userId){
   return $.get('/usr/' + userId);
}

在上面的示例中，返回的数据将是JSON的对象，例如

{
   "name" : "Bob",
   "status" : 2
}

Answer 1

/**
 * Gets a user's data request
 * @return {jQuery.jqXHR}
 */
function getUserData(userId){
   return $.getJSON('/usr/' + userId);
}

/*
 * Handles the result of a user data request.
 * @param {Object} data The JSON object, already converted to an Object.
 */
function doSomethingWithUserData(data) {
  console.log('do something with user data:', data);
}

getUserData(userId).done(handleUserData);

正如Felix指出的那样，返回值不是JSON，它甚至不是Object。

引用JQuery's types documentation：

从jQuery 1.5开始，$ .ajax（）方法返回jqXHR对象，该对象是XMLHTTPRequest对象的超集。有关更多信息，请参阅$ .ajax条目的jqXHR部分

由于$.get和$.getJSON都是$.ajax的缩写，因此同样适用。

在示例中，我使用了promise和一个处理程序。我已经从处理程序中创建了一个函数，因此可以更清楚地记录它，但这通常是通过匿名函数完成的。

我还将$.get转换为$.getJSON，它将为您执行JSON.parse调用（将回复从字符串转换为对象）。 $.get的处理程序会改为@param {string}。

<强>更新

在评论中，OP询问如何使用自定义数据处理此问题，以便将来的开发人员知道在通话中会发生什么。

现在我们已经获得了数据，让我们来看看它的记录。

有三种很好的文档解决方案，具体取决于复杂程度以及是否需要进行初始化。

最简单的方法是使用@property创建一个@typedef来描述属性，这不需要额外的代码，而且纯粹是文档。

goog.provide('UserData');
/* 
 * UserData (in the style of Closure's JSDocs)
 * @typedef {{
 *   name: {string},
 *   title: {string}
 * }}
 */
UserData;

或

/* 
 * UserData (in the style of useJSDocs)
 * @typedef {Object}
 * @property {string} name
 * @property {string} title
 */
var UserData;

正在使用中：

/*
 * Handles the result of a user data request.
 * @param {UserData} data The JSON object, already converted to an Object,
 * cast to UserData
 */
function doSomethingWithUserData(data) {
  console.log('do something with user data:', data);
}

和@interface @record相似，可能对您更有用。

最后有一个直接上课，你let user = new UserData(jsonUser)，如果你可以收集超过几行的默认设置/初始化并把它放在课堂上，这就是我建议的去法

如何在JsDoc中记录返回的数据

1 个答案: