前端在处理含有大量数据提交的表单时,除了使用Form直接提交刷新页面之外,经常碰到的需求是收集表单信息成数据对象,Ajax提交。
而在处理复杂的表单时,需要一个一个区手动判断处理字段值,显得非常麻烦。接下来介绍的插件将解决这个问题。
使用jquery.serializeJSON
,可以在基于jQuery或者Zepto的页面中,调用 .serializeJSON()
方法来序列化form表单的数据成JS对象。
只需要在jQuery或者Zepto时候引入即可
HTML form
(支持input
、textarea
、select
等标签)
Javascript
:
$(‘#my-profile‘).serializeJSON(); // returns => { fullName: "Mario Izquierdo", address: { city: "San Francisco", state: { name: "California", abbr: "CA" } }, jobbies: ["code", "climbing"], projects: { ‘0‘: { name: "serializeJSON", language: "Javascript", popular: "1" }, ‘1‘: { name: "tinytest.js", language: "Javascript", popular: "0" } }, selectOne: "rock", selectMultiple: ["red", "blue"] }
serializeJSON
方法返回一个JS对象,并非JSON字符串。可以使用 JSON.stringify
转换成字符串(注意IE8兼容性)。
Javascript权威指南(第6版)(中文版) http://www.gooln.com/document/452.html
var jsOnString= JSON.stringify(obj);
获取到的属性值一般是字符串,可以通过HTML指定类型 : type 进行强制转换。
$(‘form‘).serializeJSON(); // returns => { "notype": "default type is :string", "string": ":string type overrides parsing options", // :skip type removes the field from the output "number": { "1": 1, "1.1": 1.1, "other stuff": NaN, // <-- Other stuff parses as NaN (Not a Number) }, "boolean": { "true": true, "false": false, "0": false, // <-- "false", "null", "undefined", "", "0" parse as false }, "null": { "null": null, // <-- "false", "null", "undefined", "", "0" parse as null "other stuff": "other stuff" }, "auto": { // works as the parseAll option "string": "text with stuff", "0": 0, // <-- parsed as number "1": 1, // <-- parsed as number "true": true, // <-- parsed as boolean "false": false, // <-- parsed as boolean "null": null, // <-- parsed as null "list": "[1, 2, 3]" // <-- array and object types are not auto-parsed }, "array": { // <-- works using JSON.parse "empty": [], "not empty": [1,2,3] }, "object": { // <-- works using JSON.parse "empty": {}, "not empty": {"my": "stuff"} } }
数据类型也可以指定在 data-value-type
属性中,代替 :type
标记。
input names
使用:types
)Keys
始终为字符串(默认不自动检测是否需要转换为数组)checkboxes
会被忽略disabled
的elements
会被忽略写法 释义 checkboxUncheckedValue: string 针对未勾选的checkboxes,设定值 parseBooleans: true 自动检测转换”true”、”false”为布尔值true、false parseNumbers: true 自动检测转换”1″、”33.33″、”-44″为数字1、33.33、-44 parseNulls: true 自动检测字符串”null”为null parseAll: true 自动检测转换以上类型的字符串 parseWithFunction: function 自定义转换函数 function(value, name){return parsedValue} customTypes: {} 自定义:types覆盖默认types,如{type: function(value){…}} defaultTypes: {defaultTypes} 重新定义所有的:types,如{type: function(value){…}} useIntKeysAsArrayIndex: true 当keys为整数时,将序列化为数组
serializeJSON 支持 checkboxUncheckedValue
配置,或者可以在checkboxes
添加 data-unchecked-value
属性。
默认方法:
$(‘form‘).serializeJSON(); // returns => {‘check1‘: ‘true‘} // Note that check2 and check3 are not included because they are not checked
上面的写法会忽略未勾选的复选框。如果需要包含,则可以使用以下方法:
1. 配置checkboxUncheckedValue
$(‘form‘).serializeJSON({checkboxUncheckedValue: "false"}); // returns => {‘check1‘: ‘true‘, check2: ‘false‘, check3: ‘false‘}
2. 添加data-unchecked-value
属性
$(‘form#checkboxes‘).serializeJSON(); // Note no option is used // returns => { ‘checked‘: { ‘bool‘: ‘true‘, ‘bin‘: ‘1‘, ‘cool‘: ‘YUP‘ }, ‘unchecked‘: { ‘bool‘: ‘false‘, ‘bin‘: ‘0‘ // Note that unchecked cool does not appear, because it doesn‘t use data-unchecked-value } }
默认的类型为字符串 :string
,可以通过配置转换为其它类型
$(‘form‘).serializeJSON({parseNulls: true, parseNumbers: true}); // returns => { "bool": { "true": "true", // booleans are still strings, because parseBooleans was not set "false": "false", } "number": { "0": 0, // numbers are parsed because parseNumbers: true "1": 1, "2.2": 2.2, "-2.25": -2.25, } "null": null, // "null" strings are converted to null becase parseNulls: true "string": "text is always string", "empty": "" }
在极少数情况下,可以使用自定义转换函数
var emptyStringsAndZerosTOnulls= function(val, inputName) { if (val === "") return null; // parse empty strings as nulls if (val === 0) return null; // parse 0 as null return val; } $(‘form‘).serializeJSON({parseWithFunction: emptyStringsAndZerosToNulls, parseNumbers: true}); // returns => { "bool": { "true": "true", "false": "false", } "number": { "0": null, // <-- parsed with custom function "1": 1, "2.2": 2.2, "-2.25": -2.25, } "null": "null", "string": "text is always string", "empty": null // <-- parsed with custom function }
可以使用 customTypes
配置自定义类型或者覆盖默认类型($.serializeJSON.defaultOptions.defaultTypes
)
$(‘form‘).serializeJSON({ customTypes: { alwaysBoo: function(str) { // value is always a string return "boo"; }, string: function(str) { // all strings will now end with " override" return str + " override"; } } }); // returns => { "scary": "boo", // <-- parsed with type :alwaysBoo "str": "str override", // <-- parsed with new type :string (instead of the default) "number": 5, // <-- the default :number still works }
// Select only imputs that have a non-empty value $(‘form :input[value!=""]‘).serializeJSON(); // Or filter them from the form obj = $(‘form‘).find(‘input‘).not(‘[value=""]‘).serializeJSON(); // For more complicated filtering, you can use a function obj = $form.find(‘:input‘).filter(function () { return $.trim(this.value).length > 0 }).serializeJSON();
使用useIntKeyAsArrayIndex
配置
按照默认的方法,结果为:
$(‘form‘).serializeJSON(); // returns => {‘arr‘: {‘0‘: ‘foo‘, ‘1‘: ‘var‘, ‘5‘: ‘inn‘ }}
使用useIntKeyAsArrayIndex
可以将记过转换为数组并制定顺序
$(‘form‘).serializeJSON({useIntKeysAsArrayIndex: true}); // returns => {‘arr‘: [‘foo‘, ‘var‘, undefined, undefined, undefined, ‘inn‘]}
所有的默认配置均定义在 $.serializeJSON.defaultOptions
,可以进行修改。
$.serializeJSON.defaultOptions.parseAll = true; // parse booleans, numbers and nulls by default $(‘form‘).serializeJSON(); // No optiOns=> then use $.serializeJSON.defaultOptions // returns => { "bool": { "true": true, "false": false, } "number": { "0": 0, "1": 1, "2.2": 2.2, "-2.25": -2.25, } "null": null, "string": "text is always string", "empty": "" }
这个插件支持的配置非常丰富,自定义程度很高,带来很大的便捷性。
表单格式化插件jquery.serializeJSON