jQuery form插件的使用--ajaxForm() 和 ajaxSubmit()

一、通过Form插件的两个核心方法ajaxForm() 和 ajaxSubmit()，都可以在不修改表单的HTML代码结构的情况下，轻易地将表单的提交方式升级为Ajax提交方式。

$(function(){
	//ajaxForm() 和 ajaxSubmit()可选参数项对象options
	var options = {
		url: url,			//默认是form的action，如果在此行定义并初始化，则会覆盖action
		type: type,			//默认是form的method="get"或"post"，如果在此行定义并初始化，则会覆盖method
		beforeSerialize:function(){}	//序列化提交数据之前的回调函数   
		beforeSubmit: showRequest,	//提交前执行的回调函数
		dataType: null,			//服务器return返回数据类型：html(默认), xml, script, json...
		target: '#jspElementId',	//把服务器return返回的内容,放入id为jspElementId的元素中
		success: showResponse,      	//提交成功后执行的回调函数
		error:function(){},		//提交失败后执行的回调函数	
		clearForm: true,		//提交成功后是否清空表单中的字段值
		resetForm: true,		//提交成功后是否重置表单中的字段值，即恢复到页面加载时的状态
		timeout: 3000			//设置请求时间，超过该时间后，自动退出请求，单位(毫秒)
	}
 
	/*--    ajaxForm()和ajaxSubmit()都可以接收0或1个参数，该参数可以是一个变量、一个对象或回调函数。
		这两种方法主要的区别是：
		ajaxForm()不能主动提交form，函数只是为提交表单做准备。增加所有需要的事件监听器，为AJAX提交表单做好准备，最后以submit来触发提交。
		而ajaxSubmit()会主动提交表单，同时可以在点击其他按钮时也可以触发提交，不一定是submit按钮。--*/
	//----ajaxForm()演示
	$("#myFormId").ajaxForm(options);
	
	$('#myFormId').ajaxForm(function() {   
		$('#jspElementId').html("提交成功！欢迎下次再来！").show();    
	});  
	
	//----ajaxSubmit()演示
	$("#myFormId2").submit(funtion(){
		$(this).ajaxSubmit(options);
		return false;   //阻止表单默认提交
	});       
	$('#myFormId2').submit(function() {
		$(this).ajaxSubmit(function() {   
			$('#jspElementId').html("提交成功！欢迎下次再来！").show();    
		});
		return false;   //阻止表单默认提交
	});
});
 
//提交前执行：在这里对表单进行验证，如果不符合规则，将返回false来阻止表单提交，直到符合规则为止
function showRequest(formData, jqForm, options){
	//方式一：利用formData参数。formData: 数组对象，提交表单时，Form插件会以Ajax方式自动提交这些数据，格式如：[{name:user,value:val },{name:pwd,value:pwd}]
	for (var i=0; i < formData.length; i++) {
		if (!formData[i].value) {
			alert('用户名,地址和自我介绍都不能为空!');
			return false;
		}
	} 
	var queryString = $.param(formData); //$.param()数组转字符串，组装数据，插件会自动提交数据
	alert(queryString); //类似 ： name=1&add=2  
 
	//方式二：利用jqForm对象。jqForm:   jQuery对象，封装了表单的元素   
	var form = jqForm[0]; //把表单转化为dom对象
	if (!form.name.value || !form.address.value) {
		alert('用户名和地址不能为空，自我介绍可以为空！');
		return false;
	}
 
	//方式三：options:  options对象
 
	//方式四：利用fieldValue()方法，fieldValue 是表单插件的一个方法，它能找出表单中的元素的值，返回一个集合。
	var usernameValue = $('input[name=name]').fieldValue();
	var addressValue = $('input[name=address]').fieldValue();
	if (!usernameValue[0] || !addressValue[0]) {
		alert('用户名和地址不能为空，自我介绍可以为空！');
		return false;
	}
 	   
	return true;  //只要不返回false，表单都会提交,在这里可以对表单元素进行验证
};
 
//提交后执行
function showResponse(responseText, statusText){
	alert('状态: ' + statusText + '\n 返回的内容是: \n' + responseText); 
	//dataType=xml
	var name = $('name', responseXML).text();
	var address = $('address', responseXML).text();
	$("#xmlout").html(name + "  " + address);
	//dataType=json
	$("#jsonout").html(data.name + "  " + data.address);
};

二、详细介绍参数

ajaxForm 和 ajaxSubmit 都支持大量的可选参数，它们通过可选参数项对象options传入。可选参数项对象只是一个简单的 JavaScript对象，里边包含了一些属性和一些值：

url
表单提交的地址。
缺省值：表单的action的值

type
表单提交的方式，'GET' 或 'POST'.
缺省值：表单的 method 的值 (如果没有指明则认为是 'GET')

semantic
一个布尔值，用来指示表单里提交的数据的顺序是否需要严格按照语义的顺序。一般表单的数据都是按语义顺序来进行串行化（或序列化）的，除非表单里有一个type="image"元素. 所以只有当表单里必须要求有严格顺序并且表单里有type="image"时才需要指定这个。
缺省值： false

formSerialize
将表单串行化（或序列化）成一个查询字符串。这个方法将return返回以下格式的字符串：name1=value1&name2=value2。

iframe
布尔值，用来指示表单是否需要提交到一个iframe里。这个用在表单里有file域要上传文件时。更多信息请参考代码示例页面里的File Uploads 文档。
缺省值： false

beforeSubmit
表单提交前执行的方法。这个可以用在表单提交前的预处理，或表单校验。如果'beforeSubmit'指定的函数返回false，则表单不会被提交。 'beforeSubmit'函数调用时需要3个参数：数组形式的表单数据，jQuery 对象形式的表单对象，可选的用来传递给ajaxForm/ajaxSubmit 的对象。

数组形式的表单数据是下面这样的格式：[ { name: 'username', value: 'jresig' }, { name: 'password', value: 'secret' } ]

缺省值： null

dataType
指定服务器响应返回的数据类型。其中之一: null, 'xml', 'script', 或者 'json'. 这个 dataType 选项用来指示你如何去处理server端返回的数据。这个和 jQuery.httpData 方法直接相对应。

下面就是可以用的选项：

'xml': 如果 dataType == 'xml' 则 server 端返回的数据被当作是 XML 来处理，这种情况下'success'指定的回调函数会被传进去 responseXML 数据

'json': 如果 dataType == 'json' 则server端返回的数据将会被执行，并传进'success'回调函数

'script': 如果 dataType == 'script' 则server端返回的数据将会在上下文的环境中被执行

缺省值： null

target
用server端返回的内容更换指定的页面元素的内容。这个值可以用jQuery 选择器来表示, 或者是一个jQuery 对象，一个 DOM 元素。
缺省值： null

success
当表单提交后执行的函数。如果'success' 回调函数被指定，当server端返回对表单提交的响应后，这个方法就会被执行。 responseText 和 responseXML 的值会被传进这个参数 (这个要依赖于dataType的类型).
缺省值： null

clearForm
布尔值，指示表单提交成功后是否需要清空。清除表单元素：该方法将所有的文本（text）输入字段、密码（password）输入字段和文本区域（textarea）字段置空，清除任何select元素中的选定，以及将所有的单选（radio）按钮和多选（checkbox）按钮重置为非选定状态。

缺省值： null

resetForm
布尔值，指示表单提交成功后是否需要重置。重置：通过调用表单元素原有的DOM方法，将表单恢复到初始状态。
缺省值： null

三、使用方法实例

formSerialize()

var queryString = $('#myFormId').formSerialize();  
      
// 现在可以使用$.get、$.post、$.ajax等来提交数据 
$.post('myscript.php', queryString);

fieldSerialize()
将表单的字段元素串行化（或序列化）成一个查询字符串。当只有部分表单字段需要进行串行化（或序列化）时，这个就方便了。这个方法将return返回以下格式的字符串：name1=value1&name2=value2。

var queryString = $('#myFormId .specialFields').fieldSerialize();

fieldValue()
返回匹配插入数组中的表单元素值。该方法return返回数组。如果元素值被判定可能无效，则数组为空，否则它将包含一个或多于一个的元素值。

var value = $('#myFormId :password').fieldValue(); // 取得密码输入值   
alert('The password is: ' + value[0]);

clearFields()

$('#myFormId .specialFields').clearFields();

clearForm()

$('#myFormId').clearForm();

resetForm()

 $('#myFormId').resetForm();

jQuery form插件的使用--ajaxForm() 和 ajaxSubmit()

猜你喜欢