自动化CodeReview系列目录

  1. 自动化CodeReview - ASP.NET Core依赖注入
  2. 自动化CodeReview - ASP.NET Core请求参数验证

参数验证实现

在做服务端开发时经常需要对客户端传入的参数进行合法性验证,在ASP.NET Core中通常会使用如下方式:

public class LoginModel
{
[Required(ErrorMessage = "账号不能为空")]
public string Account { get; set; }
[StringLength(, MinimumLength = , ErrorMessage = "密码长度应介于6-12个字符之间")]
public string Password { get; set; }
}
public IActionResult Login(LoginModel model)
{
if (ModelState.IsValid)
{
//参数校验通过,处理登陆逻辑
}
else
{
//参数校验失败,返回第一个错误
var firstErrorMsg = ModelState.GetFirstErrorMessage();
return Content(firstErrorMsg);
}
}

这么写虽然可以验证参数了,但还是要多写一个if...else...,能不能简化成只用一行代码就实现验证呢?

答案是:可以的,先看简化后的用法:

[ValidateModel]
public IActionResult Login(LoginModel model)
{
//能执行到此处表示参数已验证通过
}

以上代码如果Account传空会返回:

{
"errCode": ,
"errMsg": "账号不能为空"
}

与之前的区别是在Action上加了一个[ValidateModel],参数校验逻辑在ValidateModelAttribute里处理,这是MVC里Action过滤器的用法,篇幅限制我就不展开了,直接上代码:

namespace Mondol.WPDental.Web.Filters
{
/// <summary>
/// 确保当前Action的Model是已验证的,否则返回错误响应结果
/// </summary>
public class ValidateModelAttribute : Attribute, IActionFilter
{
public void OnActionExecuting(ActionExecutingContext context)
{
if (!context.ModelState.IsValid)
{
var result = new Result(ResultErrorCodes.ArgumentBad, context.ModelState.GetFirstErrorMessage());
context.Result = new JsonResult(result);
}
} public void OnActionExecuted(ActionExecutedContext context)
{
}
}
}

使用ValidateModel需要保证:

1. 项目中有统一的返回格式;例如:JSON或XML

2. 所有接口有统一的公共字段;例如:

{
"errCode": , //0成功,其它值失败
"errMsg": "失败时的错误消息",
"data": {
//成功时的返回数据

}
}

其实对于优秀的项目架构设计,以上2点都不是问题,只有“统一”才可以更好的抽象化代码,封装通用框架。

写到这里其实还不完美,如果Login上的[ValidateModel]忘加了呢?

编译也能通过,测试时还不容易发现。但这实实在在是个BUG,没有校验参数合法性啊。

自动化CodeReview之AutoReview

  我始终坚信再牛掰的程序员也有疏忽的时候,有时写着写着就忘加了。

能不能在忘加的时候提醒一下呢?答案是:可以的。

本系列的第1篇我写了关于【ASP.NET Core依赖注入】的自动化CodeReview,在写参数验证自动化CodeView时我发现自动化CodeView其实有很多可写的。

为了将零散的代码整理到一起,也为了以后可以持续维护下去,我重开了一个项目,项目名暂定AutoReview,PS:大家如果有更好的名字欢迎赐教

项目代码我放到了github上,地址为:https://github.com/md-frank/AutoReview

先来看下它的用法:

先在Startup.ConfigureServices方法最后加入如下代码:

public void ConfigureServices(IServiceCollection services)
{
//注册服务代码放到此处 //此段放在最后
if (_env.IsDevelopment())
{
services.AddAutoReview(
new DependencyInjectionAssert(),
new ValidateModelAssert()
{
ValidateModelAttributeType = typeof(ValidateModelAttribute)
}
);
}
}

AddAutoReview方法接受一个IAssert数组,表示要使用的断言,目前支持2个断言DependencyInjectionAssert、ValidateModelAssert

然后在在Startup.Configure方法中加入如下代码:

public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
{
//使用AutoReview,代码位置任意
if (_env.IsDevelopment())
app.UseAutoReview();
}

至此如果任意断言验证失败,UseAutoReview方法都会抛出异常,并提示问题代码的具体位置,终止项目运行。

现在你就可以在开发过程中发现BUG了,解决问题后重新运行即可。

自动化CodeReview - ASP.NET Core请求参数验证的更多相关文章

  1. 自动化CodeReview - ASP.NET Core依赖注入

    自动化CodeReview系列目录 自动化CodeReview - ASP.NET Core依赖注入 自动化CodeReview - ASP.NET Core请求参数验证 我个人比较懒,能自动做的事绝 ...

  2. 配置 ASP.NET Core 请求(Request)处理管道

    配置 ASP.NET Core 请求(Request)处理管道 在本节中,我们将讨论使用中间件组件为 asp.net core 应用程序配置请求处理管道. 作为应用程序启动的一部分,我们要在Confi ...

  3. 使用JWT的ASP.NET CORE令牌身份验证和授权(无Cookie)——第1部分

    原文:使用JWT的ASP.NET CORE令牌身份验证和授权(无Cookie)--第1部分 原文链接:https://www.codeproject.com/Articles/5160941/ASP- ...

  4. 自研后端HTTP请求参数验证器服务ParamertValidateService

    好处:方便了后端对HTTP请求中参数进行核验,只需一次编写效验器,一行代码便可对所有参数的pojo进行参数核验!而且更改效验逻辑时只需要更改效验器类即可,实现了解耦合. 只需要程序员按照规范开发一个P ...

  5. 使用Enablebuffering多次读取Asp Net Core 请求体

    使用Enablebuffering多次读取Asp Net Core 请求体 1 .Net Core 2.X时代 使用EnableRewind倒带 public IActionResult Index( ...

  6. ASP.NET Core 请求/查询/响应参数格式转换(下划线命名)

    业务场景: 在 ASP.NET Core 项目中,所有的代码都是骆驼命名,比如userName, UserName,但对于 WebApi 项目来说,因为业务需要,一些请求.查询和响应参数的格式需要转换 ...

  7. ASP.NET Core 使用Cookie验证身份

    ASP.NET Core 1.x提供了通过Cookie 中间件将用户主体序列化为一个加密的Cookie,然后在后续请求中验证Cookie并重新创建主体,并将其分配给HttpContext.User属性 ...

  8. asp.net core webApi 参数保护

    asp.net core webApi 参数保护 Intro asp.net core data protection 扩展,基于 IDataProtector 扩展的数据保护组件,自动化的实现某些参 ...

  9. 理解ASP.NET Core - 模型绑定&验证(Model Binding and Validation)

    注:本文隶属于<理解ASP.NET Core>系列文章,请查看置顶博客或点击此处查看全文目录 模型绑定 什么是模型绑定?简单说就是将HTTP请求参数绑定到程序方法入参上,该变量可以是简单类 ...

随机推荐

  1. url语法

    URL的主要部分 URL通常被写成如下形式: <方案>:<方案描述部分> 一个URL包含了它使用的方案名称(<方案>), 其后紧跟一个冒号,然后是一个字符串 (&l ...

  2. Spring自学教程-ssh整合(六)

    以下是本人原创,如若转载和使用请注明转载地址.本博客信息切勿用于商业,可以个人使用,若喜欢我的博客,请关注我,谢谢!博客地址 感谢您支持我的博客,我的动力是您的支持和关注!如若转载和使用请注明转载地址 ...

  3. cron 执行php文件

    php执行的命令要写全路径,不然无法执行

  4. MySql5.6设置慢查询

    ---恢复内容开始--- 在my.cnf中 mysqld节点下 #开启慢查询 slow_query_log = ON #设置超时时间 slow_launch_time = 2 #记录日志 slow_q ...

  5. NavigationView学习笔记

    <android.support.v4.widget.DrawerLayout xmlns:android="http://schemas.android.com/apk/res/an ...

  6. 今天学习了下,如何破解wifi

    破解了隔壁的wif,得罪了,哥哥要蹭网一段时间. 主要思路:安装linux环境.这里我选择了虚拟机加cdlinux .运行里面的min抓得握手包,然后淘宝花10元跑下包,因为自己的电脑不行,跑费时间太 ...

  7. PHP读取Excel文件(PHPExcel)

    /*     * 读取Excel文件     * */    require_once (dirname(dirname(dirname(__FILE__))).'/PHPExcel/PHPExcel ...

  8. bzoj1121

    传送门:http://www.lydsy.com/JudgeOnline/problem.php?id=1121 题解: 神题啊,妈的不会写的都去吃屎吧.

  9. php在客户端禁用cookie时让session不失效的解决方法

    cookie固然好,不过有些客户端浏览器会禁用cookie,这就会导致你所依赖cookies的程序会失效或出错,那么若真出现用户关闭cookies的情况,PHP应该如何再次使用session?方法还是 ...

  10. 遗传算法GA

    遗传算法(Genetic Algorithms,GA)是一种全局优化方法,它借用了生物遗传学的观点,通过自然选择.遗传.变异等作用机制,实现种群中个体适应性的提高,体现了自然界中“物竞天择.适者生存” ...