在我们日常开发过程中,前端的表单验证很重要,如果这块处理不当,会出现很多bug 。但是如果处理的好,不仅bug会很少,用户体验也会得到很大的提升。在开发过程中我们可以不借助 JS 库,自己去手写 JS 验证,但是如果是团队项目,为了达到代码的统一还是调用统一的 表单验证方式 比较合适。下面介绍在 ASP.NET MVC中结合Jquery Validate 进行表单验证的方式。首先推荐一篇关于Jquery Validate 如何使用的博文,写的很详细。http://www.cnblogs.com/hejunrex/archive/2011/11/17/2252193.html。而我将要介绍的是如何结合Jquery Validate 进行表单验证。
一、Jquery.Validate 中的用法概述以及重要的用法
1.普通的表单结合 Jquery.Validate 的验证方式
以验证用户名、年龄、邮编为例。html表单如下
<form id="addForm" method="post" action="/JQValidate/AddForm">
<div>
姓名:
<input type="text" name="txtName" id="txtName" />
<span class="errorMsg">错误信息放置的位置</span>
<br />
年龄:
<input type="text" name="txtAge" />
<span class="errorMsg"></span>
<br />
邮政编码:
<input type="text" name="txtZipCode" />
<span class="errorMsg"></span>
</div>
<div>
<input type="submit" value="提交" />
</div>
</form>
Jquery.Validate JS 验证
<script src="~/Scripts/jquery-1.7.1.js"></script>
<script src="~/Scripts/jquery.validate.js"></script>
<script type="text/javascript">
$(function () {
// 表单验证
formValidate();
}); var formValidate = function () {
// 添加自定义校验(邮政编码验证)
jQuery.validator.addMethod("isZipCode", function (value, element) {
var zipCode = /^[0-9]{6}$/;
return this.optional(element) || (zipCode.test(value));
}, "请正确填写您的邮政编码"); $("#addForm").validate({ // #JQForm是form表单的ID
rules: {
txtName: { // 要验证的表单的id
required: true, // 是否是必填项
minlength: 2, // 最小长度
remote: "/JQValidate/ValidateName",// 返回 true 就会出现错误信息
},
txtAge: {
required: true,
range: [18, 30]
},
txtZipCode: {
required: true,
isZipCode: true,
},
},
messages: {// 如果没有给属性错误提示,就会用默认提示
txtName: {
required: "请输入会员名称", // 如果提交的时候没有填写提示的文字
minlength: "会员名称的长度不能小于2位", // 如果输入的长度小于2提示的文字
remote: "用户名重复"
},
txtAge: {
required: "年龄不能为空",
range: "年龄范围是18~30"
},
txtZipCode: {
required: "邮政编码不能为空",
},
},
errorPlacement: function (error, element) { // 自定义错误信息放置的位置
error.appendTo(element.next("span"));
},
})
};
</script>
2.添加自定义校验
以添加一个自定义的邮编为例
// 添加自定义校验(邮政编码验证)
jQuery.validator.addMethod("isZipCode", function (value, element) {
var zipCode= /^[0-9]{6}$/;
return this.optional(element) || (zipCode.test(value));
}, "请正确填写您的邮政编码");
3.把错误消息放到自定义的区域
有时候美工设计的静态页面我们开发人员为了保持其html结构不被改变,就要自定义错误信息的位置。如美工的html表单结构:
姓名:
<input type="text" name="txtName" id="txtName" />
<span class="errorMsg">错误信息放置的位置</span>
$("#addForm").validate({ // #JQForm是form表单的ID
rules: {},
messages: {},
errorPlacement: function (error, element) { // 自定义错误信息放置的位置
error.appendTo(element.next("span"));
},
})
4.远程校验
返回值为true 就提示错误信息,否则不提示
remote: "/JQValidate/ValidateName",// 返回 true 就会出现错误信息
注意如果不传参数,默认是把当前校验的值传到后台校验,如果还要传入其他参数通过这种形式(dataType必须是json类型)
remote: { // 默认会把当前验证的值传到后台验证,如果还需要传输其他的参数在data中添加
url: "/JQValidate/ValidateName",
type: "post",
data: { "testData": "testName" },
dataType: "json", // 此处返回类型必须是JSON
}
二、Jquery.Validate 结合Ajax.BeginForm 验证方式,实现验证成功后的异步提交表单
1.引入 JS
<script src="~/Scripts/jquery-1.7.1.js"></script>
@*Ajax.BeginForm 需要的js 文件*@
<script src="~/Scripts/jquery.unobtrusive-ajax.js"></script>
<script src="~/Scripts/jquery.validate.js"></script>
2.
普通的表单结合Jquery.Validate提交方式是非异步的,用Jquery.Validate 结合Ajax.BeginForn 验证方式,实现验证成功后的异步提交表单。如果让Jquery.Validate去验证表单就必须用<form></form>包裹,也就必须获取到<form></form>的id。如果没有设置要提交的表单id运行后查看网页源代码我们会发现ASP.NET MVC 默认会给我们分配一个form id,查看源文件如图
如果我们通过id=“form0”去验证也可以,但是如果一个页面不止一个表单就很难分清要验证哪个form表单了。我们看下Ajax.BeginForm的参数重载是可以设置form表单的属性的。如图
所以表单改成如下方式就行了(最后一个参数加上 new { @id = "AddForm" })
@using (Ajax.BeginForm("AddForm", "JQValidate", new { }, new AjaxOptions() { HttpMethod = "post", OnBegin = "ajaxFormOnBegin", OnSuccess = "afterOnSuccess", OnFailure = "afterOnFailure", UpdateTargetId = "UpdateTargetHiddenID" }, new { @id = "AddForm" }))
{
<div>
姓名:
<input type="text" name="txtName" id="txtName" />
<span class="errorMsg">错误信息放置的位置</span>
<br />
年龄:
<input type="text" name="txtAge" />
<span class="errorMsg"></span>
<br />
邮政编码:
<input type="text" name="txtZipCode" />
<span class="errorMsg"></span>
</div>
<div>
<input type="submit" value="提交" />
</div>
}
三、Jquery.Validate 结合 非 form 表单提交的验证方式
有时候页面上不仅是表单数据,也有表格等其他数据,而不想通过form表单都提交到后台,但是又想通过Jquery.Validate方式验证。那么我们可以这样做。
表单:
<form>
<div>
姓名:
<input type="text" name="txtName" id="txtName" />
<span class="errorMsg">错误信息放置的位置</span>
<br />
年龄:
<input type="text" name="txtAge" />
<span class="errorMsg"></span>
<br />
邮政编码:
<input type="text" name="txtZipCode" />
<span class="errorMsg"></span>
</div>
<div>
<input type="button" value="提交" onclick="javascript: btnSubmit();" />
</div>
</form>
Jquery.Validate 中有一个方法是valid(),是用来判断表单是否验证通过的,同时会进行校验是否合法。
Jquery.Validate验证:
<script type="text/javascript">
$(function () {
// 表单验证
formValidate();
}); var formValidate = function () {
// 添加自定义校验(邮政编码验证)
jQuery.validator.addMethod("isZipCode", function (value, element) {
var zipCode = /^[0-9]{6}$/;
return this.optional(element) || (zipCode.test(value));
}, "请正确填写您的邮政编码"); $("#addForm").validate({ // #JQForm是form表单的ID
rules: {
txtName: { // 要验证的表单的id
required: true, // 是否是必填项
minlength: 2, // 最小长度
remote: "/JQValidate/ValidateName",// 返回 true 就会出现错误信息
},
txtAge: {
required: true,
range: [18, 30]
},
txtZipCode: {
required: true,
isZipCode: true,
},
},
messages: {// 如果没有给属性错误提示,就会用默认提示
txtName: {
required: "请输入会员名称", // 如果提交的时候没有填写提示的文字
minlength: "会员名称的长度不能小于2位", // 如果输入的长度小于2提示的文字
remote: "用户名重复"
},
txtAge: {
required: "年龄不能为空",
range: "年龄范围是18~30"
},
txtZipCode: {
required: "邮政编码不能为空",
},
},
errorPlacement: function (error, element) { // 自定义错误信息放置的位置
error.appendTo(element.next("span"));
},
})
};
</script>
Jquery.Validate验证是否通过,通过就往后台提交数据,没有通过会出现错误提示:
// 非submit按钮提交方式
var btnSubmit = function () {
// 检测表单是否验证通过 并进行表单验证
var validateState = $("#addForm").valid();
if (!validateState) {
return false;
} // 往后台提交数据,当然还可以传入其他你想提交的数据
$.ajax({
url: "/JQValidate/AddForm",
type: "post",
dataType: "text",
data:{txtName:$("#txtName").val()},
success: function (data) {
alert(data);
}
}); };
总结
通过以上这几种结合Jquery.Validate表单验证提交方式,应该可以覆盖到我们日常开发过程中的表单验证方式,如果你还有更好的方式不妨大家一起交流分享。
下一篇博客将是介绍ASP.NET MVC 通过 模型注解方式进行表单验证。