Asp.Net Core基于JWT认证的数据接口网关Demo

系统管理员 2022-02-14 19:06 147阅读 0赞

近日，应一位朋友的邀请写了个Asp.Net Core基于JWT认证的数据接口网关Demo。朋友自己开了个公司，接到的一个升级项目，客户要求用Aps.Net Core做数据网关服务且基于JWT认证实现对前后端分离的数据服务支持，于是想到我一直做.Net开发，问我是否对.Net Core有所了解？能不能做个简单Demo出来看看？我说，分道扬镳之后我不是调用别人的接口就是提供接口给别人调用，于是便有了以下示例代码。

示例要求能演示获取Token及如何使用该Token访问数据资源，在Demo中实现了JWT的颁发及验证以及重写一个ActionAuthorizeAttribute实现对具体数据接口的调用权限控制，先看一下项目截图：

![项目截图][1563651-20190307213517737-1956768216.png]\[项目截图\]

## 项目文件介绍 ##

解决方案下只有一个项目，项目名称就叫**Jwt.Gateway**，包含主要文件有：

1.  Controllers目录下的**ApiActionFilterAttribute.cs**文件，继承**Microsoft.AspNetCore.Mvc.Filters.ActionFilterAttribute**，用于校验接口调用者对具体接口的访问权限。
2.  Controllers目录下的**ApiBase.cs**文件，继承**Microsoft.AspNetCore.Mvc.Controller**，具有**Microsoft.AspNetCore.Authorization.Authorize**特性引用，用于让所有数据接口用途的控制器继承，定义有CurrentAppKey属性(来访应用程序的身份标识)并在**OnActionExecuting**事件中统一分析Claims并赋值。
3.  Controllers目录下的**TokenController.cs**控制器文件，用于对调用方应用程序获取及注销Token。
4.  Controllers目录下的**UsersController.cs**控制器文件，继承**ApiBase.cs**，作为数据调用示例。
5.  MiddleWares目录下的**ApiCustomException.cs**文件，是一个数据接口的统一异常处理中间件。
6.  Models目录下的**ApiResponse.cs**文件，用于做数据接口的统一数据及错误信息输出实体模型。
7.  Models目录下的**User.cs**文件，示例数据实体模型。
8.  **Program.cs**及**Startup.cs**文件就不介绍了，随便建个空项目都有。

## 项目文件代码 ##

### ApiActionFilterAttribute.cs ###

Controllers目录下的**ApiActionFilterAttribute.cs**文件，继承**Microsoft.AspNetCore.Mvc.Filters.ActionFilterAttribute**，用于校验接口调用者对具体接口的访问权限。

设想每一个到访的请求都是一个应用程序，每一个应用程序都分配有基本的Key和Password，每一个应用程序具有不同的接口访问权限，所以在具体的数据接口上应该声明该接口所要求的权限值，比如修改用户信息的接口应该在接口方法上声明需要具有“**修改用户**”的权限，用例：\[ApiActionFilter("用户修改")\]。

大部分情况下一个接口(方法)对应一个操作，这样基本上就能应付了，但是不排除有时候可能需要多个权限组合进行验证，所以该文件中有一个对多个权限值进行校验的“**与**”和“**和**”枚举，用例：\[ApiActionFilter(new string\[\] \{ "用户修改", "用户录入", "用户删除" \},ApiActionFilterAttributeOption.AND)\]，这样好像就差不多了。

由于在一个接口调用之后可能需要将该接口所声明需要的权限值记入日志等需求，因此权限值集合将被写入到HttpContext.Items\["Permissions"\]中以方便可能的后续操作访问，看代码：

![ContractedBlock.gif][] ApiActionAuthorizeAttribute.cs

### ApiBase.cs    ###

Controllers目录下的**ApiBase.cs**文件，继承**Microsoft.AspNetCore.Mvc.Controller**，具有**Microsoft.AspNetCore.Authorization.Authorize**特性引用，用于让所有数据接口用途的控制器继承，定义有CurrentAppKey属性(来访应用程序的身份标识)并在**OnActionExecuting**事件中统一分析Claims并赋值。

通过验证之后，Aps.Net Core会在HttpContext.User.Claims中将将来访者的身份信息记录下来，我们可以通过该集合得到来访者的身份信息。

![ContractedBlock.gif][] ApiBase.cs

### TokenController.cs ###

Controllers目录下的**TokenController.cs**控制器文件，用于对调用方应用程序获取及注销Token。

![ContractedBlock.gif][] TokenController.cs

### UsersController.cs ###

Controllers目录下的**UsersController.cs**控制器文件，继承**ApiBase.cs**，作为数据调用示例。

该控制器定义了对User对象常规的 明细、列表、录入、修改、删除 等操作。

![ContractedBlock.gif][] UsersController.cs

### ApiCustomException.cs ###

MiddleWares目录下的**ApiCustomException.cs**文件，是一个数据接口的统一异常处理中间件。

该文件整理并抄袭自：https://www.cnblogs.com/ShenNan/p/10197231.html

在此特别感谢一下作者的先行贡献，并请原谅我无耻的抄袭。

![ContractedBlock.gif][] ApiCustomException.cs

### 配置相关 ###

#### appsettings.json ####

算法'HS256'要求SecurityKey.KeySize大于'128'位，所以JwtSecurityKey可不要太短了哦。

![ContractedBlock.gif][] appsettings.json

#### Startup.cs ####

关于JWT的配置可以在通过JwtBearerOptions加入一些自己的事件处理逻辑，共有4个事件可供调用：OnAuthenticationFailed,OnMessageReceived,OnTokenValidated,OnChallenge, 本示例中是在OnTokenValidated中插入Token黑名单的校验逻辑。黑名单应该是Jwt应用场景中主动使Token过期的主流做法了。

![ContractedBlock.gif][] Startup.cs

#### Program.cs ####

![ContractedBlock.gif][] Program.cs

## 运行截图 ##

![运行截图-获取Token][-_Token]\[运行截图-获取Token\]

![运行截图-配置Fiddler调用接口获取数据][-_Fiddler]\[运行截图-配置Fiddler调用接口获取数据\]

![运行截图-获取到数据][-]\[运行截图-获取到数据\]

如果Token校验失败将会返回401错误！

如果你发现有错误，请善意指出，谢谢！

原文地址[https://www.cnblogs.com/ruzi/p/10493501.html][https_www.cnblogs.com_ruzi_p_10493501.html]

[1563651-20190307213517737-1956768216.png]: https://img2018.cnblogs.com/blog/1563651/201903/1563651-20190307213517737-1956768216.png
[ContractedBlock.gif]: /images/20220214/4707ecf9de574de78d8fbf81afad9e8b.png
[-_Token]: https://img2018.cnblogs.com/blog/1563651/201903/1563651-20190307234511305-1870202987.png
[-_Fiddler]: https://img2018.cnblogs.com/blog/1563651/201903/1563651-20190308000156226-1840303944.png
[-]: https://img2018.cnblogs.com/blog/1563651/201903/1563651-20190308000226558-419698161.png
[https_www.cnblogs.com_ruzi_p_10493501.html]: https://www.cnblogs.com/ruzi/p/10493501.html