【原创】WebApi开发框架：Token生成、Token缓存原理、Token验证、令牌机制与原理
【原创】WebApi开发框架：Token生成、Token缓存原理、Token验证、令牌机制与原理
令牌（Token）是什么？
在计算机身份认证中是令牌（暗号）的意思，一般作为邀请、登录以及安全认证使用。Token其实说的通俗点就是“暗号”，在一些数据传输之前，要先进行暗号的核对，不同的暗号被授权不同的数据操作。
随着互联网行业快速的发展逐渐的演变成了前后端分离，若项目中需要做登录的话，那么token成为前后端唯一的一个凭证。
Token最大的特点是系统临时分配的一组数据，可以设定过期时间，可以追踪令牌使用过程，可以通过令牌控制用户禁止或允许使用业务系统。
令牌（Token）如何产生？
用户登录业务系统后，后台程序给当前用户分配一个Token序号，如GUID32位的字符串，添加到Token缓存管理器，用户每次登录都会产生一个新的Token序号，而旧的Token随之作废。
通常Token是在后台生成，如用户登录逻辑，在SQLServer的存储过程中生成，生成的Token存储在一张物理表中以及令牌缓存管理器中。
在用户登录存储过程中添加生成令牌的业务逻辑：
SQL Code:
--生成令牌
DECLARE @Token VARCHAR(50)
SET @Token=NEWID();
DECLARE @TS DATETIME
SELECT @TS=GETDATE()
--当前用户存在令牌,更新令牌
IF EXISTS(SELECT * FROM dbo.Api_UserToken WHERE Account=@Account AND Client=@Client)
BEGIN
UPDATE dbo.Api_UserToken SET Token=@Token,Client=@Client,[Version]=@Version,MID=@DeviceMID,TS=@TS
WHERE Account=@Account AND Client=@Client
END
ELSE
BEGIN
--第一次生成令牌
INSERT INTO dbo.Api_UserToken( Account, Token, Client, [Version] ,TS,MID)
VALUES(@Account,@Token,@Client,@Version,@TS,@DeviceMID)
END
//来源:C/S框架网 | www.csframework.com | QQ:23404761
DECLARE @Token VARCHAR(50)
SET @Token=NEWID();
DECLARE @TS DATETIME
SELECT @TS=GETDATE()
--当前用户存在令牌,更新令牌
IF EXISTS(SELECT * FROM dbo.Api_UserToken WHERE Account=@Account AND Client=@Client)
BEGIN
UPDATE dbo.Api_UserToken SET Token=@Token,Client=@Client,[Version]=@Version,MID=@DeviceMID,TS=@TS
WHERE Account=@Account AND Client=@Client
END
ELSE
BEGIN
--第一次生成令牌
INSERT INTO dbo.Api_UserToken( Account, Token, Client, [Version] ,TS,MID)
VALUES(@Account,@Token,@Client,@Version,@TS,@DeviceMID)
END
//来源:C/S框架网 | www.csframework.com | QQ:23404761
Api_UserToken表
SQL Code:
CREATE TABLE [dbo].[Api_UserToken](
[isid] [int] IDENTITY(1,1) NOT NULL,
[Account] [varchar](20) NOT NULL,
[Token] [varchar](50) NOT NULL,
[MID] [varchar](50) NULL,
[Client] [varchar](50) NOT NULL,
[Version] [varchar](20) NULL,
[TS] [datetime] NULL,
CONSTRAINT [PK_tb_Token_1] PRIMARY KEY CLUSTERED
(
[isid] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
//来源:C/S框架网 | www.csframework.com | QQ:23404761
[isid] [int] IDENTITY(1,1) NOT NULL,
[Account] [varchar](20) NOT NULL,
[Token] [varchar](50) NOT NULL,
[MID] [varchar](50) NULL,
[Client] [varchar](50) NOT NULL,
[Version] [varchar](20) NULL,
[TS] [datetime] NULL,
CONSTRAINT [PK_tb_Token_1] PRIMARY KEY CLUSTERED
(
[isid] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
//来源:C/S框架网 | www.csframework.com | QQ:23404761
令牌缓存管理器（TokenProvider）
运行WebApi服务器，系统自动加载令牌数据到内存中进行缓存，由令牌缓存管理器(TokenProvider)统一管理，TokenProvider最主要功能是处理客户端调用WebApi接口时进行令牌验证，检查令牌在缓存管理器中是否存在，或进行其他逻辑运算，内存缓存机制有助于大幅提升系统运算性能。
Token缓存管理器提供加载令牌、添加新令牌、刷新令牌状态、删除令牌等功能。
C# Code:
/// <summary>
/// 加载所有token信息
/// </summary>
public static void RefreshAll(List<ModelTokenUser> list)
{
lock (_data)
{
_data.Clear();
foreach (ModelTokenUser user in list) _data.Add(user.Token, user);
}
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
/// 加载所有token信息
/// </summary>
public static void RefreshAll(List<ModelTokenUser> list)
{
lock (_data)
{
_data.Clear();
foreach (ModelTokenUser user in list) _data.Add(user.Token, user);
}
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
C# Code:
/// <summary>
/// 获取token数据
/// </summary>
/// <param name="userID"></param>
/// <returns></returns>
public static ModelTokenUser GetToken(string token)
{
if (token.ToStringEx() == "") return null;
if (!_data.ContainsKey(token)) return null;
ModelTokenUser user = _data[token];
double ms = (DateTime.Now - _data[token].TS).TotalMinutes;//计算在线时间
int expires = user.TokenExpires == 0 ? _TokenExpireMinutes : user.TokenExpires;
//expires=0，无限制
if (expires > 0 && ms > expires)//Token已过期
return null;
else
return user;
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
/// 获取token数据
/// </summary>
/// <param name="userID"></param>
/// <returns></returns>
public static ModelTokenUser GetToken(string token)
{
if (token.ToStringEx() == "") return null;
if (!_data.ContainsKey(token)) return null;
ModelTokenUser user = _data[token];
double ms = (DateTime.Now - _data[token].TS).TotalMinutes;//计算在线时间
int expires = user.TokenExpires == 0 ? _TokenExpireMinutes : user.TokenExpires;
//expires=0，无限制
if (expires > 0 && ms > expires)//Token已过期
return null;
else
return user;
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
C# Code:
/// <summary>
/// 用户登录成功刷新Token数据。首先删除旧的Token，添加新的Token，实现T用户的目的
/// </summary>
/// <param name="tokenUser"></param>
public static void RefreshLogin(ModelTokenUser tokenUser)
{
lock (_data)
{
//根据用户编号获取令牌信息
ModelTokenUser old = GetTokenByAccount(tokenUser.Account);
//如果有登录，删除Token
if (old != null) _data.Remove(old.Token);
//重新添加Token
_data.Add(tokenUser.Token, tokenUser);
}
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
/// 用户登录成功刷新Token数据。首先删除旧的Token，添加新的Token，实现T用户的目的
/// </summary>
/// <param name="tokenUser"></param>
public static void RefreshLogin(ModelTokenUser tokenUser)
{
lock (_data)
{
//根据用户编号获取令牌信息
ModelTokenUser old = GetTokenByAccount(tokenUser.Account);
//如果有登录，删除Token
if (old != null) _data.Remove(old.Token);
//重新添加Token
_data.Add(tokenUser.Token, tokenUser);
}
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
C# Code:
/// <summary>
/// 删除token
/// </summary>
/// <param name="token">token:令牌</param>
public static void DeleteUserToken(string token)
{
if (_data.ContainsKey(token))
{
lock (_data)
{
_data.Remove(token);
}
}
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
/// 删除token
/// </summary>
/// <param name="token">token:令牌</param>
public static void DeleteUserToken(string token)
{
if (_data.ContainsKey(token))
{
lock (_data)
{
_data.Remove(token);
}
}
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
C# Code:
/// <summary>
/// 用户令牌数据模型
/// </summary>
public class ModelTokenUser
{
/// <summary>
/// 用户编号，或APP系统唯一账号（对应手机号码）
/// </summary>
public string Account { get; set; }
/// <summary>
/// 令牌
/// </summary>
public string Token { get; set; }
/// <summary>
/// 手机号码
/// </summary>
public string Phone { get; set; }
/// <summary>
/// 客户端信息
/// </summary>
public string Client { get; set; }
/// <summary>
/// 版本
/// </summary>
public string Version { get; set; }
/// <summary>
/// 设备编码
/// </summary>
public string MID { get; set; }
/// <summary>
/// 生成Token时间
/// </summary>
public DateTime TS { get; set; }
/// <summary>
/// 过期时间
/// </summary>
public int TokenExpires { get; set; }
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
/// 用户令牌数据模型
/// </summary>
public class ModelTokenUser
{
/// <summary>
/// 用户编号，或APP系统唯一账号（对应手机号码）
/// </summary>
public string Account { get; set; }
/// <summary>
/// 令牌
/// </summary>
public string Token { get; set; }
/// <summary>
/// 手机号码
/// </summary>
public string Phone { get; set; }
/// <summary>
/// 客户端信息
/// </summary>
public string Client { get; set; }
/// <summary>
/// 版本
/// </summary>
public string Version { get; set; }
/// <summary>
/// 设备编码
/// </summary>
public string MID { get; set; }
/// <summary>
/// 生成Token时间
/// </summary>
public DateTime TS { get; set; }
/// <summary>
/// 过期时间
/// </summary>
public int TokenExpires { get; set; }
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
Token在WebApi接口的作用
用户登录业务系统后，后台程序给当前用户分配一个Token序号，并返回给前端。前端系统通过Token作为暗号与服务端通信。前端调用WebApi接口，传入Token以及请求参数即可与后端服务通信。
Token验证
主要是检查当前用户的Token是否有效，包括以下几种状态:
1.令牌不存在，2.令牌过期，3.令牌不同,异地用户登录(或相同用户重新登录)
验证失败WebApi服务器抛出ResponseException异常。
C# Code:
/// <summary>
/// 检查当前用户的Token: 1.令牌不存在，2.令牌过期，3.令牌不同,异地用户登录(或相同用户重新登录)
/// 验证失败抛出ResponseException异常.
/// </summary>
/// <param name="userID">用户编号，用户系统账号</param>
/// <param name="token">用户令牌</param>
public static void CheckToken(string userID, string token)
{
if (String.IsNullOrEmpty(userID) || String.IsNullOrEmpty(token))
throw new ResponseException(ErrorCodes.JsonFormatInvalide, ErrorCodes.JsonFormatInvalide_Msg);
//重点！！！必须使用账户判断令牌！！！
//返回null表示过期或用户不存在
ModelTokenUser tokenUser = TokenProvider.GetTokenByAccount(userID);
//无令牌
if (tokenUser == null)
throw new ResponseException(ErrorCodes.TokenExpired, ErrorCodes.TokenExpired_Msg);
//令牌不同,异地有用户登录
if (tokenUser.Token != token)
throw new ResponseException(ErrorCodes.TokenDuplicateLogin, ErrorCodes.TokenDuplicateLogin_MSG);
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
/// <summary>
/// 检查当前用户的Token: 1.令牌不存在，2.令牌过期，3.令牌不同,异地用户登录(或相同用户重新登录)
/// 验证失败抛出ResponseException异常.
/// </summary>
/// <param name="userID">用户编号，用户系统账号</param>
/// <param name="token">用户令牌</param>
public static void CheckToken(string userID, string token)
{
if (String.IsNullOrEmpty(userID) || String.IsNullOrEmpty(token))
throw new ResponseException(ErrorCodes.JsonFormatInvalide, ErrorCodes.JsonFormatInvalide_Msg);
//重点！！！必须使用账户判断令牌！！！
//返回null表示过期或用户不存在
ModelTokenUser tokenUser = TokenProvider.GetTokenByAccount(userID);
//无令牌
if (tokenUser == null)
throw new ResponseException(ErrorCodes.TokenExpired, ErrorCodes.TokenExpired_Msg);
//令牌不同,异地有用户登录
if (tokenUser.Token != token)
throw new ResponseException(ErrorCodes.TokenDuplicateLogin, ErrorCodes.TokenDuplicateLogin_MSG);
}
//来源:C/S框架网 | www.csframework.com | QQ:23404761
WebApi Token相关参考文章：
基于Web前端用户调用CSFramework.WebApi服务端登录登出接口实现
CSFramework.WebApi令牌管理器(Token Provider)实现添加、删除、刷新令牌过期控制
CSFramework.WebApi后端服务器框架：客户端调用WebApi接口方式（签名+Token令牌)
CSFramework.WebApi开发框架模拟Web用户端登录、调用WebApi接口增删改查数据
CSFramework.WebApi后端框架Token令牌工作机制以及Token刷新原理
ASP.NET WebApi快速开发框架|APP后端框架-标准版V1.0
适用开发：快速搭建APP、B/S、C/S、微信小程序、公众号、Web站点等后端应用服务程序。
运行平台：Windows + .NET Framework 4.5
开发工具：Visual Studio 2015+，C#语言
数据库：Microsoft SQLServer 2008R2+(支持多数据库：Oracle/MySql)
WebApi开发框架介绍
CSFramework.WebApi是服务端快速开发框架（后端框架），借助ASP.NET WebAPI底层架构的强大编程能力，封装成为可复用的以及可定制开发的服务端软件模板，CSFramework.WebApi提供可复用的软件架构和开发包，为用户快速轻松搭建基于HTTP协议、HTTPS协议以及支持多种客户端（如：APP、B/S、C/S、微信公众号、微信小程序等）各种跨平台移动终端的服务端应用程序。
服务端应用开发、后端接口开发是软件项目重要工作环节，服务端注重业务逻辑、数据处理和数据分析、算法等方面的设计和服务，前端主要体现在用户体验、界面操作和数据采集方面。前端软件系统和后端服务架构共同搭建跨平台大型数据管理应用系统。
扫一扫加微信
版权声明：本文为开发框架文库发布内容,转载请附上原文出处连接
NewDoc C/S框架网
