使用WebApi+Vue3从0到1搭建《权限管理系统》:二、搭建JWT系统鉴权

一份缠绵不绝

视频地址：【WebApi+Vue3从0到1搭建《权限管理系统》系列视频：搭建JWT系统鉴权-哔哩哔哩】 https://b23.tv/R6cOcDO
qq群:801913255
一、在appsettings.json中设置鉴权属性

1. /*jwt鉴权*/
2. "JwtSetting": {
3.    "Issuer": "zhangsan", //发行人
4.    "Audience": "zhangsan", //订阅人
5.    "ExpireSeconds": 120, //过期时间，默认分钟
6.    "ENAlgorithm": "HS256", //秘钥算法
7.    "SecurityKey": "Zmz=Start2024013OverallAuth.WebApi" //秘钥构成
8. },

复制代码

二、新建模型
添加模型JwtSettingModel其中字段和appsettings.json中的字段一样，如下

1. /// <summary>
2. /// jwt 配置模型
3. /// </summary>
4. public class JwtSettingModel
5. {
6.     /// <summary>
7.     /// 发行人
8.     /// </summary>
9.     public string Issuer { get; set; }
11.     /// <summary>
12.     /// 订阅人
13.     /// </summary>
14.     public string Audience { get; set; }
16.     /// <summary>
17.     /// 过期时间，默认分钟
18.     /// </summary>
19.     public int  ExpireSeconds { get; set; }
21.     /// <summary>
22.     /// 秘钥算法
23.     /// </summary>
24.     public string ENAlgorithm { get; set; }
26.     /// <summary>
27.     /// 秘钥构成
28.     /// </summary>
29.     public string SecurityKey { get; set; }
31. }

复制代码

三、新建解析appsettings.json节点的帮助类

1. /// <summary>
2. /// 配置文件解析帮助类
3. /// </summary>
4. public class ConfigurationHelper
5. {
6.      /// <summary>
7.      /// 配置项
8.      /// </summary>
9.      public static IConfiguration configuration { get; set; }
11.      /// <summary>
12.      /// 构造实例化
13.      /// </summary>
14.      static ConfigurationHelper()
15.      {
16.          configuration = new ConfigurationBuilder().Add(new JsonConfigurationSource { Path = "appsettings.json", ReloadOnChange = true }).Build();
17.      }
19.      /// <summary>
20.      /// 获取appsetings 配置节点
21.      /// </summary>
22.      /// <typeparam name="T"></typeparam>
23.      /// <param name="node"></param>
24.      /// <returns></returns>
25.      public static T GetNode<T>(string node) where T : new()
26.      {
27.          T mode = configuration.GetSection(node).Get<T>();
28.          return mode;
29.      }
31. }

复制代码

四、在Startup.cs编写鉴权代码
找到ConfigureServices方法，在方法中添加如下代码

1. //添加jwt鉴权
2. services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme).AddJwtBearer(JwtBearerDefaults.AuthenticationScheme, option =>
3. {
4.      var jwtsetting = ConfigurationHelper.GetNode<JwtSettingModel>("JwtSetting");
5.      Configuration.Bind("JwtSetting", jwtsetting);
6.      option.SaveToken = true;
7.      option.TokenValidationParameters = new TokenValidationParameters()
8.      {
9.          ValidIssuer = jwtsetting.Issuer,//发行人
10.          ValidAudience = jwtsetting.Audience,//订阅人
11.          IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(jwtsetting.SecurityKey)),//解密的密钥
12.          ValidateIssuerSigningKey = true,//是否验证签名,不验证的画可以篡改数据，不安全
13.          ValidateIssuer = true,//是否验证发行人，就是验证载荷中的Iss是否对应ValidIssuer参数
14.          ValidateAudience = true,//是否验证订阅人，就是验证载荷中的Aud是否对应ValidAudience参数
15.          ValidateLifetime = true,//是否验证过期时间，过期了就拒绝访问
16.          ClockSkew = TimeSpan.Zero,//这个是token缓冲过期时间,如果设置了，token过期时间就是缓冲时间+过期时间
17.          //RequireExpirationTime = true,
18.      };
20. });

复制代码

并在Configure方法中添加jwt授权代码 app.UseAuthorization();
五、编写Jwt帮助类

1. /// <summary>
2. /// jwt帮助类
3. /// </summary>
4. public static class JwtHelper
5. {
6.     /// <summary>
7.     /// 生成token
8.     /// </summary>
9.     /// <param name="loginResult"></param>
10.     /// <returns></returns>
11.     public static string BuildToken(LoginModel loginResult)
12.     {
13.         LoginModel result = new();
14.         var jwtsetting = ConfigurationHelper.GetNode<JwtSettingModel>("JwtSetting");
16.         //获取登录信息
17.         var calime = loginResult.PropValueType().Select(x => new Claim(x.Name, x.Value.ToString(), x.Type)).ToList();
19.         //记录登录信息
20.         var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(jwtsetting.SecurityKey));
21.         var creds = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);
22.         var header = new JwtHeader(creds);
23.         var paylod = new JwtPayload(jwtsetting.Issuer, jwtsetting.Audience, calime, DateTime.Now, DateTime.Now.AddMinutes(jwtsetting.ExpireSeconds));
25.         //正式创建令牌
26.         var token = new JwtSecurityToken(header, paylod);
27.         var tokenStr = new JwtSecurityTokenHandler().WriteToken(token);
28.         var  ddd = token.ValidTo.AddHours(8).ToString();
29.         return tokenStr;
30.     }
32.     /// <summary>
33.     /// 反射获取字段信息
34.     /// </summary>
35.     /// <param name="obj">模型</param>
36.     /// <returns></returns>
37.     public static IEnumerable<(string Name, object Value, string Type)> PropValueType(this object obj)
38.     {
39.         List<(string a, object b, string c)> result = new();
40.         var type = obj.GetType();
41.         var props = type.GetProperties();
42.         foreach (var item in props)
43.         {
44.             result.Add((item.Name, item.GetValue(obj), item.PropertyType.Name));
45.         }
46.         return result;
47.     }
48. }

复制代码

然后再webapi接口控制器上方添加鉴权特性[Authorize]，这样所有接口都会遵守jwt鉴权协议
 
六、Swagger接口文档使用Jwt鉴权
做好以上五点，webapi中就能正常使用jwt鉴权，但如果你使用Swagger测试接口，那么就要让Swagger遵守Jwt协议
所以必须在添加以下代码，注意这段代码是写在AddSwaggerGen中

1. //把jwt添加到swagger中
2. optinos.AddSecurityDefinition("OverallAuth.WebApi", new OpenApiSecurityScheme
3. {
4.      Description = "直接在下框中输入Bearer token（注意两者之间是一个空格）",
5.      Name = "Authorization",//jwt默认的参数名称
6.      In = ParameterLocation.Header,//jwt默认存放请求头中
7.      Type = SecuritySchemeType.ApiKey
8. });
10. //swagger遵守jwt授权协议
11. optinos.AddSecurityRequirement(new OpenApiSecurityRequirement
12.      {
13.         {
14.              new OpenApiSecurityScheme{
15.                  Reference = new OpenApiReference {
16.                              Type = ReferenceType.SecurityScheme,
17.                              Id = "OverallAuth.WebApi"
18.                  }
19.             },new string[] { }
20.          }
21.      });

复制代码

以上就是在webapi中使用jwt的详细代码
 

来源:https://www.cnblogs.com/cyzf/p/18143537
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！