项目使用.NET MVC开发,在开发过程中网站权限以及页面ViewModel的验证是比较常见的,本文主要记录在维护以前.NET MVC项目时将权限和Model的验证通过过滤器ActionFilterAttribute的方式来进行优化,达到简化程序代码提高效率。
最近接到维护性项目的反馈说网站有冗余的数据,通过查看和分析代码发现项目以前在创建数据的时候为添加Model验证以及权限验证,通过页面加上验证可以快速的修复该问题。但是通过熟悉项目,发现项目很多地方都有这个问题,于是准备使用ActionFilterAttribute过滤器的方式来修复该问题,已达到代码侵入以及修改尽量最少,来提高效率。
这是以前的旧代码片段:
[HttpPost]
public ActionResult Create(CreateModel model)
{
_userService.Add(model);
return Json(DialogFactory.Create(DialogType.Success, string.Empty, "提交成功!"));
}
开发用户权限以及模型验证的过滤器,权限仅仅简单的验证是否登录,模型验证通过ModelState完成,代码如下:
/// <summary>
/// 名 称:模型验证
/// 描 述:验证模型Model
/// 备 注:返回JSON对象
/// </summary>
public class ModelValidateAttribute : ActionFilterAttribute
{
/// <summary>
/// 是否要求登录验证
/// </summary>
private bool _loginRequired = false;
/// <summary>
/// 无参构造方法
/// </summary>
public ModelValidateAttribute(): this(false) {
}
/// <summary>
/// 参数构造方法
/// </summary>
/// <param name="login"></param>
public ModelValidateAttribute(bool login)
{
this._loginRequired = login;
}
/// <summary>
/// 请求前验证模型
/// </summary>
/// <param name="filterContext">上下文</param>
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
base.OnActionExecuting(filterContext);
if (_loginRequired)
{
var loginUser = ApplicationSignInManager.GetLoginUser();//当前登录用户
if (loginUser == null)
{
if (filterContext.HttpContext.Request.IsAjaxRequest())
{
filterContext.Result = new JsonResult()
{
Data = DialogFactory.Create(DialogType.Error, "登陆过期,请重新登陆"),
JsonRequestBehavior = JsonRequestBehavior.AllowGet
};
return;
}
else
{
var returnUrl = filterContext.HttpContext.Request.RawUrl;
filterContext.Result = new RedirectToRouteResult("EKP.Front", new RouteValueDictionary() {
{ "controller", "User" },
{ "action", "Login" },
{ "returnUrl", returnUrl},
}, true);
return;
}
}
}
var modelState = filterContext.Controller.ViewData.ModelState;
if (!modelState.IsValid)
{
//将验证信息返回
var errors = new Dictionary<string, string>();
var messages = modelState.Values
.SelectMany(item => item.Errors)
.Select(item => item.ErrorMessage)
.ToList();
foreach (KeyValuePair<string, ModelState> keyValue in modelState)
{
errors[keyValue.Key] = string.Join(";", keyValue.Value.Errors.Select(e => e.ErrorMessage));
}
filterContext.Result = new JsonResult()
{
Data = DialogFactory.Create(DialogType.Error, string.Join("<br/>", errors.Values))
};
return;
}
}
}
程序中用到了DialogFactory工厂的Create方法,主要创建不同类型的Json对象。过滤器开发好之后,直接在需要验证的Action上面增加[ModelValidate(true)]属性即可,true表示需要登录验证,如果不需要验证登录不带true参数即可,示例:
[HttpPost]
[ModelValidate(true)]
public ActionResult Create(CreateModel model)
{
_userService.Add(model);
return Json(DialogFactory.Create(DialogType.Success, string.Empty, "提交成功!"));
}
NET MVC中用户登录权限和Model模型验证的过滤器的简单开发就完成了,过滤器的使用场景还是比较多的,希望本文可以帮助到其他网友,如果有地方描述不准确或者错误,欢迎网友的反馈和建议!