Ext.ux.data.writer.FormParam,针对Ext.data.writer.Json这个类进行的修改,不同之处看红色标记除:
/**
* @class Ext.data.writer.Json
This class is used to write {@link Ext.data.Model} data to the server in a JSON format.
The {@link #allowSingle} configuration can be set to false to force the records to always be
encoded in an array, even if there is only a single record being sent.
* @markdown
*/
Ext.define('Ext.ux.data.writer.FormParam', {
extend: 'Ext.data.writer.Writer',
alias: 'writer.formParam',
/**
* @cfg {String} root The HTTP parameter name by which JSON encoded records will be passed to the server if the
* {@link #encode} option is `true`.
*/
root: undefined,
/**
* @cfg {Boolean} [encode=false] Configure `true` to send record data (all record fields if {@link #writeAllFields} is `true`)
* as a JSON encoded HTTP parameter named by the {@link #root} configuration.
*
* The encode option should only be set to true when a {@link #root} is defined, because the values will be
* sent as part of the request parameters as opposed to a raw post. The root will be the name of the parameter
* sent to the server.
*/
encode: false,
/**
* @cfg {Boolean} [allowSingle=true] Configure with `false` to ensure that records are always wrapped in an array, even if there is only
* one record being sent. When there is more than one record, they will always be encoded into an array.
*/
allowSingle: true,
/**
* @cfg {Boolean} [expandData=false] By default, when dot-delimited field {@link #nameProperty mappings} are
* used (e.g. `name: 'myProperty', mapping: 'my.nested.property'`) the writer will simply output a flat data
* object containing the mapping string literal as the property name (e.g. `{ 'my.nested.property': 'foo' }`).
*
* Mappings are used to map incoming nested JSON to flat Ext models. In many case, the data output by the
* writer should preferrably match the original nested data format. Setting this config to `true` will ensure
* that the output will instead look like `{ my: { nested: { property: 'foo' }}}`. The output is generated
* by {@link #getExpandedData}, which can optionally be overridden to apply more customized logic.
*/
expandData: false,
/**
* @protected
* The Reader classes support dot-delimited data mappings for extracting nested raw data into fields, so the
* writer must support converting the flat {@link Ext.data.Model} structure back into the original nested data
* format. Using the same mappings when available, the Writer will simply split each delimiter into a nested
* object in the output, which should exactly match the input format. For example, record data like this:
*
* my.nested.property: 'foo',
* my.nested.another: 'bar',
* my.somethingElse: 123
*
* should write out as...
*
* my: {
* nested: {
* property: 'foo',
* another: 'bar
* },
* somethingElse: 123
* }
*
* This behavior is governed by the {@link #expandData} config. By default, this option is `false` for
* compatibility reasons, and will output a flat structure matching the flat record format. Setting this config
* to `true` will enable the expanded mapping behavior as shown here. This method could also be overridden
* to provide an even more customized output data structure.
*/
getExpandedData: function(data) {
var dataLength = data.length,
i = 0,
item,
prop,
nameParts,
j,
tempObj,
toObject = function(name, value) {
var o = {};
o[name] = value;
return o;
};
for (; i < dataLength; i++) {
item = data[i];
for (prop in item) {
if (item.hasOwnProperty(prop)) {
// e.g. my.nested.property: 'foo'
nameParts = prop.split('.');
j = nameParts.length - 1;
if (j > 0) {
// Initially this will be the value 'foo'.
// Equivalent to rec['my.nested.property']
tempObj = item[prop];
for (; j > 0; j--) {
// Starting with the value above, we loop inside out, assigning the
// current object as the value for the parent name. Work all
// the way up until only the root name is left to assign.
tempObj = toObject(nameParts[j], tempObj);
}
// At this point we'll have all child properties rolled up into a single
// object like `{ nested: { property: 'foo' }}`. Now add the root name
// (e.g. 'my') to the record data if needed (do not overwrite existing):
item[nameParts[0]] = item[nameParts[0]] || {};
// Since there could be duplicate names at any level of the nesting be sure
// to merge rather than assign when setting the object as the value:
Ext.Object.merge(item[nameParts[0]], tempObj);
// Finally delete the original mapped property from the record
delete item[prop];
}
}
}
}
return data;
},
//inherit docs
writeRecords: function(request, data) {
var root = this.root;
if (this.expandData) {
data = this.getExpandedData(data);
}
if (this.allowSingle && data.length === 1) {
// convert to single object format
data = data[0];
}
if (this.encode) {
if (root) {
// sending as a param, need to encode
request.params[root] = Ext.encode(data);
} else {
for(var p in data){
request.params[p] = data[p];
}
}
} else {
// send as jsonData
request.jsonData = request.jsonData || {};
if (root) {
request.jsonData[root] = data;
} else {
request.jsonData = data;
}
}
return request;
}
});
Ext.data.writer.Json当设置了encode=true,但是没有设置root值的时候会:
//<debug> Ext.Error.raise('Must specify a root when using encode'); //</debug>
我将其所有的属性以表单参数形式进行传递。
for(var p in data){ request.params[p] = data[p]; }
当然用jsonData的形式传递给后台已经足够使用。这是只是另一种传递方式而已。切勿纠结!