jquery.validate表单验证框架详解

jQuery验证框架

http://koalaxyq.javaeye.com/blog/556633 Html代码

此文谨以以上js片段开始介绍jQuery Validation。 验证从这个方法开始：validate( [options] )

（一）、可选项( options )

[1] debug 类型：Boolean 默认：false

说明：开启调试模式。如果为true，表单不会提交，而且会在控制台显示一些错误消息（需要Firebug或者Firebug lite）。当要阻止表单默认提交事件，尝试去开启它。 $(\ debug: true })

[2] submitHandler 类型：Callback 默认：default (native) form submit

说明：当表单通过验证，提交表单。回调函数有个默认参数form $(\

submitHandler: function(form) { // do other stuff for a valid form form.submit(); } })

[3] invalidHandler 类型：Callback

说明：当未通过验证的表单提交时，可以在该回调函数中处理一些事情。该回调函数有两个参数：第一个为一个事件对象，第二个为验证器（validator） $(\

invalidHandler: function(form, validator) { var errors = validator.numberOfInvalids(); if (errors) {

var message = errors == 1

? 'You missed 1 field. It has been highlighted'

: 'You missed ' + errors + ' fields. They have been highlighted'; $(\ $(\ } else {

$(\ } } })

[4] ignore 类型：Seletor

说明：当进行表单验证时，过滤掉选择器所选择的表单。用了jQuery not方法（ not() ）。类型为submit和reset的表单总是被忽略的。 $(\ ignore: \})

[5] rules 类型：Options 默认：rules are read from markup (classes, attributes, metadata)

说明：用户定义的键/值对规则。键为一个表单元素的name属性（或是一组单选/复选按钮）、值为一个简单的字符串或者由规则/参数对（rule/parameter）组成的一个对象。可以和 class/attribute/metadata 规则一起使用。每个规则可以指定一个依存的验证前提条件。 $(\ rules: {

// simple rule, converted to {required:true} name: \ // compound rule

email: {

required: true, email: true }/* email: {

depends: function(element) {

return $(\ } }*/ } })

[6] messages 类型：Options 默认：验证方法默认使用的消息

说明：用户自定义的 键/值 对消息。键为一个表单元素的name属性，值为该表单元素将要显示的消息。该消息覆盖元素的title属性或者默认消息。消息可以是一个字符串或者一个回调函数。回调函数必须在验证器的作用域中调用，将规则参数作为回调函数的第一个参数，将该表单元素作为回调函数的第二个参数，且必须返回一个字符串类型的消息。

$(\ rules: {

name: \ email: {

required: true, email: true } },

messages: {

name: \ email: {

required: \

email: \ } } })

[7] groups 类型：Options

说明：指定错误消息分组。一个组由一个任意的组名作为键，一个由空白符分割的表单元素name属性列表作为值。用errorPlacement定义组消息的存放位置。 Js代码

1. $(\2. groups: {

3. username: \4. },

5. errorPlacement: function(error, element) { 6. if (element.attr(\

7. || element.attr(\8. error.insertAfter(\9. else

10. error.insertAfter(element); 11. }, 12. debug:true 13. })

[8] onsubmit 类型：Boolean 默认：true

说明：提交时验证表单。当设置为false时，只能用其它的事件验证。 Js代码

1. $(\2. onsubmit: false 3. })

[9] onfocusout 类型：Boolean 默认：true

说明：焦点离开时验证（单选/复选按钮除外）。如果表单中没有输入任何内容，所有的规则将被跳过，除非该表单已经被标记为无效的。 Js代码

$(\ onfocusout: false })

[10] onkeyup 类型：Boolean 默认：true

说明：当键盘按键弹起时验证。只要表单元素没有被标记成无效的，不会有反应。另外，所有的规则将在每次按键弹起时验证。

$(\ onkeyup: false })

[11] onclick 类型：Boolean 默认：true

说明：鼠标点击验证针对单选和复选按钮。 $(\ onclick: false })

[12] focusInvalid 类型：Boolean 默认：true

说明：当验证无效时，焦点跳到第一个无效的表单元素。当为false时，验证无效时，没有焦点响应。 $(\ focusInvalid: false })

[12] focusCleanup 类型：Boolean 默认：false

说明：如果为true，当表单得到焦点时，移除在该表单上的errorClass并隐藏所有错误消息。避免与focusInvalid一起使用。 $(\ focusCleanup: true })

[13] meta 类型：String

说明：如果想使用其它插件来使用元数据验证规则，得指定相应的元数据对象。 $(\ meta: \})

[14] errorClass 类型：String 默认：\

说明：用此设定的样式来定义错误消息的样式。 $(\ errorClass: \})

[15] validClass 类型：String 默认：\

说明：设定当验证通过时，消息显示的样式。 $(\ validClass: \})

[16] errorElement 类型：String 默认：\

说明：用html元素类型创建错误消息的容器。默认的\有个优点就是能在错误消息与无效表单之间用for属性建立有意义的联系（一个常常使用的，而不管表单元素是什么的）。 $(\ errorElement: \})

[17] wrapper 类型：Boolean

说明：用一个指定的元素将错误消息包围。与errorLabelContainer一起创建一个错误消息列表非常有用。 $(\ wrapper: \})

[18] errorLabelContainer 类型：Selector

说明：错误消息标签的容器。 $(\

errorLabelContainer: \ wrapper: \})

[19] errorContainer 类型：Selector

说明：错误消息的容器。 $(\

errorContainer: \ errorLabelContainer: \ wrapper: \

submitHandler: function() { alert(\})

[20] showErrors 类型：Callback 默认：None,内置的显示消息

说明：自定义消息显示的句柄。该回调函数有两个参数，第一个为errorMap,第二个参数为errorList，在validator对象的上下文中调用。参数只包含那些经过onblur/onkeyup验证的表单元素，也有可能是单个元素。除此之外，你还可以用this.defaultShowErrors()触发默认的行为。 $(\

showErrors: function(errorMap, errorList) { $(\

+ this.numberOfInvalids() + \ this.defaultShowErrors(); } })

[21] errorPlacement 类型：Callback 默认：紧跟在无效表单后的标签中

说明：用户自定义错误标签的显示位置。第一个参数：一个作为jQuery对象的错误标签，第二个参数为：一个作为jQuery对象的未通过验证的表单元素。 $(\

errorPlacement: function(error, element) {

error.appendTo( element.parent(\ }, debug:true })

[22] success 类型：String,Callback

说明：如果指定它，当验证通过时显示一个消息。如果是String类型的，则添加该样式到标签中，如果是一个回调函数，则将标签作为其唯一的参数。 $(\ //success: \

success: function(label) {

label.addClass(\ } })

[23] highlight 类型：Callback 默认：添加errorClass到表单元素

说明：将未通过验证的表单元素设置高亮。 $(\

highlight: function(element, errorClass) { $(element).fadeOut(function() { $(element).fadeIn() }) } })

[24] unhighlight 类型：Callback 默认：移除errorClass

说明：与highlight操作相反 $(\

highlight: function(element, errorClass) { $(element).addClass(errorClass);

$(element.form).find(\ .addClass(errorClass); },

unhighlight: function(element, errorClass) { $(element).removeClass(errorClass);

$(element.form).find(\ .removeClass(errorClass); } });

[25] ignoreTitle 类型：Boolean 默认：false

说明：设置它用来跳过错误消息对title属性的引用，避免Google工具栏引起的冲突。 $(\ ignoreTitle: true })

原文地址：http://docs.jquery.com/Plugins/Validation/validate#toptions

（二）插件方法 (jQuery validation)

文章分类:Web前端

[1] validate( [options] ) 返回：Validator

说明：见第一部分 [2] valid() 返回：Boolean 说明：检查表单是否已通过验证。

$(\$(\

alert(\ return false; });

[3] rules() 返回：Options

说明：返回一个表单元素的验证规则。有几个方法定义验证规则：

? ? ? ?

在表单元素的class属性中定义验证规则（推荐的方法）。 通过指定验证方法的属性（推荐的方法）。

可以通过元数据(metadata)插件来定义元数据验证规则。 可以通过指定validate()方法的rules选项。

alert($(\

[4] rules( \ 返回：Options

参数\类型：String

参数 rules 类型：Options 要添加的规则，与validate方法中的验证规则一致。

说明：添加规则到匹配的表单元素，返回该元素的所有验证规则，需要先执行$(\。在rules中也可以添加用户自定义的消息对象。 $(\ required: true, minlength: 2, messages: {

required: \

minlength: jQuery.format(\ } });

[5] rules( \ 返回：Options

参数\类型：String

参数 rules (Options) 类型：Options 用空白符分割的验证规则。只操作通过rules选项或rules(\指定的验证规则。

说明：从第一个匹配的表单元素中移除指定的验证规则，并返回该元素所有的验证规则。 $(\

$(\

[6] removeAttrs( attributes ) 返回：Options

参数 attributes 类型：String 用空白符分割的属性列表 说明：从第一个匹配的表单元素中删除指定的属性并返回它们。 $(\

var rules = $(\ $(\ $(\});

原文请见：http://docs.jquery.com/Plugins/Validation#Fields_with_complex_names_.28brackets.2C_dots.29

（三、四）选择器及实用工具 (jQuery validation)

文章分类:Web前端

[1] :blank 返回：Array

说明：匹配所有空值的表单元素。没有任何值或都空白符(whitespace)都被认为是空值。 它是由 jQuery.trim(value).length == 0 来判断的。 $(\

[2] :filled 返回：Array

说明：匹配所有不为空的表单元素。任何值都可以认为是已输入的，但只有空白符的值除外。 它是由 jQuery.trim(value).length > 0 来判断的。 $(\

[3] :unchecked 返回：Array

说明：匹配所有未选择的表单元素。反向操作为 :checked function countUnchecked() {

var n = $(\

$(\}

countUnchecked();

$(\

四、实用工具(Utilities)

jQuery.validator.format( template, [argument], [argumentN...] ) 返回：String

参数 template 类型：String 要格式化的字符串

参数 argument (Optional) 类型：String, Array 用字符串或字符串数组(对应索引的元素)填充第一个占位符

参数 argumentN... (Optional) 类型：String 填充第二个或之后的占位符。

说明：用参数来填充{n}占位符。除template外的一个或多个参数都可以用来填充相应的占位符。 $(document).ready(function(){ $(\ var str = \ alert(\

str = jQuery.validator.format(str, \ //str = $.validator.format(str, [\ alert(\ }); });

原文请见：http://docs.jquery.com/Plugins/Validation

（五）验证器 (jQuery validation)

validate方法返回的验证器对象( Validator Object) 有一些公用的方法。你可以用来触发验证程序或改变表单(form)的内容。验证器对象有更多的方法，不过只有文档中给出的这些方法是专为使用而设计的。

(一)验证器方法(Validator methods) [1] form() 返回：Boolean

说明：验证表单是否通过验证，若通过验证则返回true，反之返回false。这个方法在正常的提交事件(submit event)触发，它返回一个结果。 $(\

[2] element( element ) 返回：Boolean

参数 element 类型：Selector 验证表单中的一个需要验证的表单元素。

说明：验证单个表单元素是否通过验证，若通过验证则返回true，反之返回false。这个方法在正常的焦点离开事件(blur)或按键弹起(keyup)时触发，它返回一个结果。

$(\

[3] resetForm( ) 返回：undefined

说明：重置表单。

恢复表单元素到原来的值(需要form插件支持)，移除无效验证的样式并隐藏错误消息。 (...貌似只有在IE下才可以移除样式) var validator = $(\validator.resetForm();

[4] showErrors( errors ) 返回：undefined

参数 errors 类型：Object 一个或多个表单元素的name属性和验证消息组成的键/值对。

说明：显示指定的验证消息。

在指定的errorPlacement中显示验证消息。键为待验证表单元素的name属性，值为相应的验证消息。

var validator = $(\

validator.showErrors({\

[5] numberOfInvalids( ) 返回：Integer

说明：返回未通过验证的表单元素的个数。

这个方法依赖于内部的验证器情况。只有在验证完所有表单元素时才统计所有待验证的表单元素(submit事件或通过$(\。当只验证单个表单元素，则只有统计该表单元素。与invalidHandler选项联合使用的时候非常有用。

var validator = $(\ invalidHandler: function() {

$(\ } });

(二)验证器函数(Validator functions)

[1] setDefaults( defaults ) 返回：undefined

参数 defaults 类型：Options 要设置成默认值的选项。 说明：修改验证框架的默认设置。

接受validate方法中的所有选项。 jQuery.validator.setDefaults({ debug: true });

[2] addMethod( name, method, [message] ) 返回：undefined

参数 name 类型：String 要添加的方法名，用于标识和引用，必须是一个有效的javascript标识符。

参数 method 类型：Callback 方法的实现部分，返回true如果表单元素通过验证。 参数 message(Optional) 类型：String, Function 该方法的默认验证消息。可以用

jQuery.validator.format(value) 方法创建。如果未定义该参数，则使用本地已存在的验证消息，另外，必须为指定的表单元素定义验证消息。

说明：添加一个用户自定义的验证方法。它由方法名（必须是一个合法的javascript标识符）、基于javascript的函数及默认的验证消息组成。

jQuery.validator.addMethod(\ return this.optional(element) || value == params[0] + params[1]; }, jQuery.format(\

[3] addClassRules( name, rules ) 返回：undefined

参数 name 类型：String 要添加的样式规则名。 参数 rules 类型：Options 规则选项。

说明：添加一个复合的样式验证方法。对于将多个联合使用的规则重构进单个样式中非常有用。 jQuery.validator.addClassRules(\ required: true, minlength: 2 });

[4] addClassRules( rules ) 返回：undefined

参数 rules 类型：Options 样式类名-规则表。

说明：添加一个复合的样式验证方法。对于重构通用的联合规则非常有用。 jQuery.validator.addClassRules({ name: {

required: true, minlength: 2 }, zip: {

required: true, digits: true, minlength: 5, maxlength: 5 } });

原文请见：http://docs.jquery.com/Plugins/Validation

（六）内置验证方法 (jQuery validation)

[1] required( ) 返回：Boolean 说明：让表单元素必须填写（选择）。

如果表单元素为空(text input)或未选择(radio/checkbox)或选择了一个空值(select)。 作用于text inputs, selects, checkboxes and radio buttons.

当select提供了一个空值选项

$(\ rules: {

fruit: \ } });

[2] required( dependency-expression ) 返回：Boolean

参数 dependency-expression 类型：String 在form上下文中的一个表达式( String )，表单元素是否需要填写依赖于该表达式返回一个或多个元素。

说明：让表单元素必须填写（选择），依赖于参数的返回值。

表达式中像#foo:checked, #foo:filled, #foo:visible这样的选择过滤器将经常用到。 $(\ rules: { details: {

required: \ }

}, debug:true });

$(\ $(\});

[3] required( dependency-callback ) 返回：Boolean

参数 dependency-callback 类型：Callback 该回函数以待验证表单元素作为其唯一的参数。当该回调函数返回true，则该表单元素是必须的。

说明：让表单元素必须填写（选择），依赖于参数的返回值。

表达式中像#foo:checked, #foo:filled, #foo:visible这样的选择过滤器将经常用到。 $(\ rules: { age: {

required: true, min: 3 }, parent: {

required: function(element) { return $(\ } } } });

$(\ $(\});

[4] remote( options ) 返回：Boolean

参数 options 类型：String, Options 请求服务器端资源的url(String)。或$.ajax()方法中的选项(Options)。

说明：请求服务器端资源验证。

服务器端的资源通过$.ajax (XMLHttpRequest)获取key/value对，响应返回true则表单通过验证。

$(\ rules: { email: {

required: true, email: true,

remote: \ } } });

[5] minlength( length ) 返回：Boolean

参数 length 类型：Integer 至少需要多少个字符数。 说明：确保表单元素满足给定的最小字符数。

在文本框(text input)中输入的字符太少、没有选中足够的复选框(checkbox)、一个选择框(select)中没有选中足够的选项。这以上三种情况中该方法返回false。 $(\ rules: { field: {

required: true, minlength: 3 } } });

[6] maxlength( length ) 返回：Boolean

参数 length 类型：Integer 允许输入的最大字符数。 说明：确保表单元素的文本不超过给定的最大字符数。

在文本框(text input)中输入的字符太多、选择太多的复选框(checkbox)、一个选择框(select)中没有选中太多的选项。这以上三种情况中该方法返回false。 $(\

rules: { field: {

required: true, maxlength: 4 } } });

[7] rangelength( range ) 返回：Boolean

参数 range 类型：Array 允许输入的字符数范围。 说明：确保表单元素的文本字符数在给定的范围当中。

在文本框(text input)中输入的字符数不在给定范围内、选择的复选框(checkbox)不在给在的范围内、一个选择框(select)选中的选项不在给定的范围内。这以上三种情况中该方法返回false。 $(\ rules: { field: {

required: true, rangelength: [2, 6] } } });

[8] min( value ) 返回：Boolean

参数 value 类型：Integer 需要输入的最小整数。 说明：确保表单元素的值大于等于给定的最小整数。 该方法只在文本输入框(text input)下有效。 $(\ rules: { field: {

required: true, min: 13 } }

});

[9] max( value ) 返回：Boolean

参数 value 类型：Integer 给定的最大整数。 说明：确保表单元素的值小于等于给定的最大整数。 该方法只在文本输入框(text input)下有效。 $(\ rules: { field: {

required: true, max: 23 } } });

[10] range( range ) 返回：Boolean

参数 range 类型：Array 给定的整数范围。 说明：确保表单元素的值在给定的范围当中。

该方法只在文本输入框(text input)下有效。 $(\ rules: { field: {

required: true, range: [13, 23] } } });

[11] email( ) 返回：Boolean

说明：确保表单元素的值为一个有效的email地址。

如果值为一个有效的email地址，则返回true。该方法只在文本输入框(text input)下有效。 $(\

rules: { field: {

required: true, email: true } } });

[12] url( ) 返回：Boolean

说明：确保表单元素的值为一个有效的URL地址(http://www.mydomain.com)。

如果值为一个有效的url地址，则返回true。该方法只在文本输入框(text input)下有效。 $(\ rules: { field: {

required: true, url: true } } 1. });

[13] date( ) dateISO( ) dateDE( ) 返回：Boolean

说明：用来验证有效的日期。这三个函数分别验证的日期格式为(mm/dd/yyyy)、(yyyy-mm-dd,yyyy/mm/dd)、(mm.dd.yyyy)。

$(\ rules: { field: {

required: true, date: true /*dateISO: true dateDE: true*/ } } });

[14] number( ) numberDE() 返回：Boolean

说明：用来验证小数。number()的小数点为圆点( . )，numberDE()的小数点为英文逗号( , )。 $(\ rules: { field: {

required: true, number: true //numberDE: true } } });

[15] digits() 返回：Boolean

说明：确保文本框中的值为数字。 $(\ rules: { field: {

required: true, digits: true } } });

[16] digits() 返回：Boolean

说明：确保文本框中的值为数字。 $(\ rules: { field: {

required: true, digits: true }

} });

[17] accept( [extension] ) 返回：Boolean

参数 extension(Optional) 类型：String 允许的文件后缀名，用\或\分割。默认为\

说明：确保表单元素接收给定的文件后缀名的文件。如果没有指定参数，则只有图片是允许的(png,jpeg,gif)。

$(\ rules: { field: {

required: true, accept: \ } } });

[18] equalTo( other ) 返回：Boolean

参数 other 类型：Selector 要与当前值比较的另一个表单元素。 说明：确保两个表单元素的值是一致的。 $(\ rules: {

password: \ password_again: { equalTo: \ } } });

原文请见：http://docs.jquery.com/Plugins/Validation

（七）注意事项 (jQuery validation)

[1]复杂的name属性值

当使用rules选项时，如果表单的name属性值包含有非法的javascript标识符，必须将name值加上引号。 $(\ rules: {

// no quoting necessary name: \ // quoting necessary! \ // dots need quoting, too! \ } });

[2]重构规则

不论什么时候，当你的表单中的多个字段含有相同的验证规则及验证消息，重构规则可以减少很多重复。使用 addMethod 和 addClassRules 将非常有效果。 假使已经重构了如下规则：

// alias required to cRequired with new message

$.validator.addMethod(\ \// alias minlength, too

$.validator.addMethod(\

// leverage parameter replacement for minlength, {0} gets replaced with 2 $.format(\// combine them both, including the parameter for minlength

$.validator.addClassRules(\

那么使用的时候如下：

[3]验证消息

当验证了一个无效的表单元素，验证消息显示在用户面前。这些消息是从哪里来的呢？有三个途径来取得验证消息。

1.通过待验证表单元素的title属性

2.通过默认的验证消息

3.通过插件设置(messages选项) 这三种途径的优先顺序为：3 > 1 > 2

[4]验证消息与Google工具栏的冲突

有时候验证消息会与Goole工具栏的AutoFill插件冲突。AutoFill通过替换表单元素的title属性，以显示提示消息。此时，验证消息如果获取的是title属性值，那么就得不到我们预期想要得到的结果。当文档载入时，可以通过如下方法避免冲突。

1. $(\

[5]表单提交

默认地，表单验证失败时阻止表单的提交，当验证通过，表单提交。当然，也可以通过submitHandler来自定义提交事件。

将提交按钮的class属性设置成cancel，在表单提交时可以跳过验证。

下面这段代码将循环提交表单： $(\

submitHandler: function(form) {

// some other code maybe disabling submit button // then:

$(form).submit(); } });

$(form).submit() 触发了另外一轮的验证，验证后又去调用submitHandler，然后就循环了。可以用 form.submit() 来触发原生的表单提交事件。 $(\

submitHandler: function(form) { form.submit(); } });

原文请见：http://docs.jquery.com/Plugins/Validation

（八）应用实例 (jQuery validation)

[1] 验证页面

<%@ page language=\>