【全栈之路】web api权限拦截

最近接手了App服务器重构的工作,已经N久没有写.net程序的我也要试着把以前的东西一点一点捡回来。目前使用的技术是web api2,这是一个类似与aps.net MVC的东西,可以说其实就是一个东西,它相比于MVC,应该可以叫MC,因为它没有视图,是一个纯接口类型的项目,这样用来做后台服务器的接口再好不过了。

想到很久以前,刚刚开始学习编程,做一个权限管理和验证,使用最笨的方法,需要在每个方法里面写上验证的代码,判断用户的权限,这种代码的冗余问题非常严重,到后来了解了<code>AOP面向切面</code>编程,才知道原来还可以有过滤器这个东西,正在被广泛使用在<code>权限控制</code>,<code>身份验证</code>,<code>日志记录</code>等等很多用途上。

ASP.NET Web API 特性

ASP.NET Web API 包含下列特性:

<font style='font-size:24px'>1.先进的 HTTP 编程模型:</font> 使用新的强类型的 HTTP 对象模型直接操作 HTTP 请求和响应, 在 HTTP客户端使用相同的编程模型和 HTTP 管道;
<font style='font-size:24px'>2.支持路由:</font> Web API 完整支持 ASP.NET 路由, 包括路由参数和约束。 此外, 到动作的映射支持约定, 从此将不再需要向类或者方法添加类似于 [HttpPost] 之类的属性;
<font style='font-size:24px'>3.内容协商:</font> 客户端与服务端可以一起决定 API 返回数据的格式。 默认支持 XML, JSON 以及 Form URL-Encoded 格式, 可以扩展添加自定义格式, 甚至可以替换掉默认的内容协商策略;
<font style='font-size:24px'>4.模型绑定与验证:</font> 模型绑定器可以轻易地从 HTTP 请求中提取数据并转换成在动作方法中使用的 .Net 对象;
<code><font style='font-size:24px'>5.过滤:</font> Web API 支持过滤, 包括总所周知的 [Authorize] 过滤标记, 可以为 Action 添加并插入自定义过滤, 实现认证、异常处理等;</code>
<font style='font-size:24px'>6.查询聚合:</font> 只要简单的返回 Iqueryable<T> , Web API 将会支持通过 OData 地址约定进行查询;
<font style='font-size:24px'>7.改进的 Http 细节可测试性:</font> Web API 不是将 HTTP 细节设置到一个静态的 Context 对象上, 而是使用 HttpRequestMessage 和 HttpResponseMessage 实例, 可以使用这些对象的泛型版本为这些 Http 类型添加自定义类型;
<font style='font-size:24px'>8.改进的依赖反转 (IoC) 支持:</font> Web API 使用 MVC Dependency Resolver 实现的服务定位器模式在不同的场景下来获取实例;
<font style='font-size:24px'>9.基于代码的配置:</font> Web API 单独使用代码完成配置, 从而保证了配置文件的整洁;
<font style='font-size:24px'>10.自托管 (Self-Host) :</font> Web API 除了可以托管在 IIS 中, 还可以托管在进程中,依旧可以使用路由以及其它的特性。


从上面的介绍中可以看出wei api可以通过<code>标记/特性</code>,使用过滤器的方式来进行深入到方法的操作,这样做的好处是:便捷,非常的便捷,就让我们来看看吧~

1、新建一个asp.net web的工程


image

2、选择Empty 勾上web api


image

3、一个建好的空的web api项目


image

4、新建一个控制器


image

TestController
<pre><code class='cs hljs'>
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
using System.Web.Http.Results;

namespace Api.Controllers
{
public class TestController : ApiController
{
/// <summary>
/// 接收数据类型
/// </summary>
public class MyData
{
public string myname { get; set; }
public string myvalue { get; set; }
}

    /// <summary>
    /// 测试Action  进行权限验证
    /// </summary>
    /// <param name="data"></param>
    /// <returns></returns>
    [SecurityFilter("test")]
    [HttpPost]
    public JsonResult<string> test([FromBody] MyData data )
    {
       
        return Json("123121=====>"+data.myname);
    }

    /// <summary>
    /// 权限不够执行的Action
    /// </summary>
    /// <returns></returns>
    [HttpGet]
    public JsonResult<string> error()
    {
        return Json("error");
    }

}

}

</code></pre>

SecurityFilter(过滤器),继承ActionFilterAttribute,实现OnActionExecuting方法,这个方法为Action执行前执行的方法,我就在这里来做权限验证的事情
<pre><code class = "cs hljs">
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using System.Web.Http.Filters;
using System.Web.Http.Results;
using System.Web.Routing;

namespace Api.Filter
{
public class SecurityFilter: ActionFilterAttribute
{
private string name;

    public SecurityFilter(){}

    public SecurityFilter(string name) {
        this.name = name;
     }

    /// <summary>
    /// Action执行前
    /// </summary>
    /// <param name="actionContext"></param>
    public override void OnActionExecuting(HttpActionContext actionContext)
    {

           base.OnActionExecuting(actionContext);
            //获取request的参数列表【获取API的参数】
           // Dictionary<string, object> actionargument = actionContext.ActionArguments;
            //找出请求参数
           // RequestBaseEntity requestData = actionargument["requestData"] as RequestBaseEntity;
           //requestData是参数的名字
           //直接从上下文中回去请求参数,这个方法在HttpContext.Current.Request将无法获取到
        //获取请求信息中的token和用户信息
        string myname = HttpContext.Current.Request["myname"].ToString();
        Console.WriteLine(myname);
        //现在用户token信息是否有效和过期
        if (!myname.Equals("tmm"))
        {
            //如果token已经失效,重定向至token过期返回页面
            HttpContext.Current.Response.Redirect("~/api/test/error");

//创建响应对象,初始化为成功,没有指定的话本次请求将不会被拦截
actionContext.Response = new HttpResponseMessage(System.Net.HttpStatusCode.OK);
}
}

}

}
</code></pre>

为了模拟在项目中使用的post请求,于是我写个简单的html页面,使用表单来提交post请求


image

我们先运行项目(报错不用管,没有设置默认的路径)


image
image

然后打开这个页面,这个页面的表单提交的路径为运行项目的test Action路径。


image
image

这个时候直接提交,会被重定向到error的Action,放回的结果为error Action的放回结果
image

这是返回上个页面,在myname的文本框中输入tmm,这个是权限验证的规则,只有myname的值为tmm的时候,才不会对请求进行拦截,当然在实际的项目开发中肯定是更换为去用户的ID去数据库进行查询来验证用户是否有权限做这个事情。


image

这个时候再提交,可以看到就能狗进入test/test这个页面了。
image
再回过来看代码,我们只需要在Action上面加上这个特性就能进行过滤拦截,使用起来非常的方便,如果我们要对整个Controller进行权限过滤,哪就可以将这个特性直接加在Controller的类名上面就行了,当然也有特殊的情况,比如整个控制器中我大部分都要过滤,只有几个不要过滤,这样好像仅仅这样还是做不到可以有选择性的过滤,这个时候我们只需要对过滤器的类进行扩展,在构造函数中传入一些标记进去,然后进行一些判断出来,这样就能够对筛选过滤了。

权限验证过滤已经完了,身份验证,操作日志,和错误日志大致也是通过这些操作来完成了,AOP的编程思想,将这些耦合性特别高的代码实现了解耦,使用起来也非常的简单,这才是真正优雅的语法。

END

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,701评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,649评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,037评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,994评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,018评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,796评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,481评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,370评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,868评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,014评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,153评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,832评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,494评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,039评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,156评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,437评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,131评论 2 356

推荐阅读更多精彩内容