• 【笔记】ASP.NET Core 2.2 Web API —— 学习笔记

    当年刚接触 ASP.NET Core 2.2 时，留下的学习笔记。现在把它挪到 CSDN，也是对过去学习 ASP.NET Core 痕迹进行记录。

    VS 2019 + ASP.NET Core 2.2 + sqlSugarCore (ORM)

    1. 仓储模式 + 服务 + 抽象接口

    1.1 新建asp.net core 2.2 WebApi项目

    nmmking.Core.Api
    nmmking.Core.Common
    nmmking.Core.IRepository
    nmmking.Core.IServices
    nmmking.Core.Model
    nmmking.Core.Repository
    nmmking.Core.Services
    nmmking.Core.Test

    2.nmmking.Core.Model 使用 Sqlsuger Code first

    2.1用 nuget 安装 sqlSugarCore ，新建 model 类

    1. namespace nmmking.Core.Model.Models
    2. {
    3.     public class User
    4.     {
    5.         [SugarColumn(IsNullable =false,IsPrimaryKey =true,IsIdentity =true)]
    6.         public int Id { get; set; }
    7.         [SugarColumn(Length =50)]
    8.         public string Name { get; set; }
    9.         [SugarColumn(Length =50,IsNullable =true)]
    10.         public string Password { get; set; }
    11.     }
    12. }

    2.2 新建IDbContext接口

    1. namespace nmmking.Core.Model
    2. {
    3.     public interface IDbContext
    4.     {
    5.         /// 
    6.         /// 操作数据库对象
    7.         /// 
    8.         SqlSugarClient db { get; }
    9.  
    10.         /// 
    11.         /// 创建数据表
    12.         /// 
    13.         /// 是否备份
    14.         /// string类型映射的长度
    15.         /// 要创建的数据表
    16.         void CreateTable(bool Backup = false, int StringDefaultLength = 50, params Type[] types);
    17.  
    18.         /// 
    19.         /// 创建表
    20.         /// 
    21.         /// 是否备份
    22.         /// string类型映射的长度
    23.         //public void CreateAllTable(bool Backup = false, int StringDefaultLength = 50);
    24.     }
    25. }

    2.3 新建MyContext类

    1. public class MyContext: IDbContext
    2.     {
    3.  
    4.         public SqlSugarClient db
    5.         {
    6.             get
    7.             {
    8.                 return new SqlSugarClient(new ConnectionConfig()
    9.                 {
    10.                     ConnectionString = "server=.;database=nmmkingCoreDb;uid=sa;pwd=123456;",
    11.                     DbType = DbType.SqlServer,//数据库类型
    12.                     IsAutoCloseConnection = true,//自动释放数据务，如果存在事务，在事务结束后释放
    13.                     InitKeyType = InitKeyType.Attribute,//从实体特性中读取主键自增列信息
    14.                 });
    15.             }
    16.         }
    17.  
    18.         //public static SqlSugarClient GetInstance()
    19.         //{
    20.         //    db = new SqlSugarClient(new ConnectionConfig()
    21.         //    {
    22.         //        ConnectionString = "server=.;database=StudentDb;uid=sa;pwd=123456;",
    23.         //        DbType = DbType.SqlServer,//设置数据库类型
    24.         //        IsAutoCloseConnection = true,//自动释放数据库，如果存在事务，在事务结束之后释放。
    25.         //        InitKeyType = InitKeyType.Attribute//从实体特性中读取主键自增列信息   
    26.         //    });
    27.  
    28.         //    //db.Aop.OnLogExecuting = (sql, pars) =>
    29.         //    //{
    30.         //    //    Console.WriteLine(sql + "\r\n" + db.Utilities.SerializeObject
    31.         //    //        (pars.ToDictionary(it => it.ParameterName, it => it.Value)));
    32.         //    //    Console.WriteLine();
    33.         //    //};
    34.  
    35.         //    return db;
    36.         //}
    37.  
    38.         public void CreateTable(bool Backup = false, int StringDefaultLength = 50, params Type[] types)
    39.         {
    40.             //设置varchar的默认长度
    41.             db.CodeFirst.SetStringDefaultLength(StringDefaultLength);
    42.             db.DbMaintenance.CreateDatabase();
    43.  
    44.             //创建表
    45.             if (Backup)
    46.             {
    47.                 db.CodeFirst.BackupTable().InitTables(types);
    48.             }
    49.             else
    50.             {
    51.                 db.CodeFirst.InitTables(types);
    52.             }
    53.         }
    54.  
    55.         public SimpleClient<User> userDb { get { return new SimpleClient(db); } }
    56.  
    57.         //public SqlSugarClient db => throw new NotImplementedException();
    58.     }

    2.4 使用

    1. namespace nmmking.Core.Test
    2. {
    3.     class Program
    4.     {
    5.         static void Main(string[] args)
    6.         {
    7.             MyContext context = new MyContext();
    8.             context.CreateTable(false, 50, typeof(User));
    9.  
    10.             //AppDbContext context = new AppDbContext();
    11.             //context.CreateTable(false, 50, typeof(Students), typeof(Schools));
    12.  
    13.             Console.WriteLine("Hello World!");
    14.         }
    15.     }
    16. }

    3. 仓储层

    3.1 IBaseRepository

    1. namespace nmmking.Core.IRepository
    2. {
    3.     public interface IBaseRepository<T> where T:class
    4.     {
    5.         Task QueryById(object id, bool IsUseCache = false); //根据id查询
    6.  
    7.         Task> GetEntities(Expressionbool>> whereLambda); //根据查询条件查询
    8.  
    9.         Task<bool> Add(T entity);
    10.  
    11.         Task<bool> DeleteById(object Id);
    12.  
    13.         Task<bool> Update(T entity);
    14.     }
    15. }

    3.2 BaseRepository

    1. namespace nmmking.Core.Repository
    2. {
    3.     public class BaseRepository<T> : IBaseRepository<T> where T : class, new()
    4.     {
    5.         private readonly IDbContext _dbContext;
    6.  
    7.         public BaseRepository(IDbContext dbContext)
    8.         {
    9.             this._dbContext = dbContext;
    10.         }
    11.  
    12.         // 增加单条数据
    13.         public async Task<bool> Add(T entity)
    14.         {
    15.             return await _dbContext.db.Insertable(entity).ExecuteCommandAsync() > 0;
    16.         }
    17.  
    18.         // 根据id删除单条数据
    19.         public async Task<bool> DeleteById(object id)
    20.         {
    21.             return await _dbContext.db.Deleteable(id).ExecuteCommandHasChangeAsync();
    22.         }
    23.  
    24.         // 查询数据列表
    25.         public async Task<List<T>> GetEntities(Expressionbool>> whereExpression)
    26.         {
    27.             return await _dbContext.db.Queryable().WhereIF(whereExpression != null, whereExpression).ToListAsync();
    28.         }
    29.  
    30.         // 根据Id查询一条数据
    31.         public async Task QueryById(object id, bool IsUseCache =false)
    32.         {
    33.             return await _dbContext.db.Queryable().WithCacheIF(IsUseCache).In(id).SingleAsync();
    34.         }
    35.  
    36.         // 更新实体数据
    37.         public Task<bool> Update(T entity)
    38.         {
    39.             var i = await Task.Run(() => dbcontext.Updateable(model).ExecuteCommand());
    40.             return i > 0;
    41.         }
    42.     }
    43. }

    4.读取 appsettings.json 文件

    4.1 nuget 安装 Microsoft.Extensions.Configuration.Binder，Microsoft.Extensions.Configuration.Json。

    4.2 新建 Appsettings 类

    1. namespace nmmking.Core.Common.Helper
    2. {
    3.     /// 
    4.     /// appsettings.json操作类
    5.     /// 
    6.     public class Appsettings
    7.     {
    8.         static IConfiguration Configuration { get; set; }
    9.         static string contentPath { get; set; }
    10.  
    11.  
    12.         static Appsettings()
    13.         {
    14.             //如果你把配置文件 是 根据环境变量来分开了，可以这样写
    15.             //Path = $"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json";
    16.  
    17.             Configuration = new ConfigurationBuilder()
    18.                .Add(new JsonConfigurationSource { Path = "appsettings.json", ReloadOnChange = true })//请注意要把当前appsetting.json 文件->右键->属性->复制到输出目录->始终复制
    19.                .Build();
    20.         }
    21.  
    22.         /// 
    23.         /// 封装要操作的字符
    24.         /// 
    25.         /// 节点配置
    26.         /// 
    27.         public static string app(params string[] sections)
    28.         {
    29.             try
    30.             {
    31.  
    32.                 if (sections.Any())
    33.                 {
    34.                     return Configuration[string.Join(":", sections)];
    35.                 }
    36.             }
    37.             catch (Exception) { }
    38.  
    39.             return "";
    40.         }
    41.  
    42.         /// 
    43.         /// 递归获取配置信息数组
    44.         /// 
    45.         /// 
    46.         /// 
    47.         /// 
    48.         public static List<T> app<T>(params string[] sections)
    49.         {
    50.             List list = new List();
    51.             // 引用 Microsoft.Extensions.Configuration.Binder 包
    52.             Configuration.Bind(string.Join(":", sections), list);
    53.             return list;
    54.         }
    55.     }
    56. }

    4.3 使用

    1. string iss = Appsettings.app(new string[] { "Audience", "Issuer" });
    2. string aud = Appsettings.app(new string[] { "Audience", "Audience" });

    5.使用Cors跨域

    5.1 允许所有域名访问接口
    在Startup.cs文件的ConfigureServices方法添加：

    1. public void ConfigureServices(IServiceCollection services)
    2.         {
    3.             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
    4.  
    5.             services.AddCors(c => 
    6.             {
    7.                 c.AddPolicy("LimitRequests", policy => 
    8.                 {
    9.                     policy
    10.                     .AllowAnyOrigin()
    11.                     .AllowAnyHeader()
    12.                     .AllowAnyMethod();
    13.                 });
    14.             });
    15.  
    16.             services.AddTransient(typeof(IBaseRepository<>), typeof(BaseRepository<>));
    17.  
    18.             services.AddTransient();
    19.  
    20.             services.AddTransient();
    21.         }
    在Startup.cs文件的 Configure 方法 添加： 
    1. public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    2. {
    3.         if (env.IsDevelopment())
    4.         {
    5.             app.UseDeveloperExceptionPage();
    6.         }
    7.         app.UseCors("LimitRequests");
    8.         app.UseMvc();
    9. }

    运行：http://localhost:61576/api/values

    测试一下，打开百度地址：https://www.baidu.com/，按F12，在Console输入：

    1. $.get("http://localhost:61576/api/values",function(data,status){
    2. 	console.log(data);
    3. });

    5.2 限制域的访问

    1.             services.AddCors(c => 
    2.             {
    3.                 c.AddPolicy("LimitRequests", policy => 
    4.                 {
    5.                     policy
    6.                     //.AllowAnyOrigin()
    7.                     .WithOrigins(new string[]{ "http://localhost:8881" })
    8.                     //.WithOrigins(Appsettings.app(new string[] { "Startup", "Cors", "IPs" }).Split(','))
    9.                     .AllowAnyHeader()
    10.                     .AllowAnyMethod();
    11.                 });
    12.             });
    13.  
    1. public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    2.         {
    3.             if (env.IsDevelopment())
    4.             {
    5.                 app.UseDeveloperExceptionPage();
    6.             }
    7.             app.UseCors("LimitRequests");
    8.             app.UseMvc();
    9.         }

    5.3 跨域访问

    下载 nginx ，http://nginx.org/en/download.html，配置 nginx。

    新建 index.html

    6.  
    8. If you click on me, I will disappear.
    10.  
    11.

    出现跨域问题

    修改访问地址

    1.             services.AddCors(c => 
    2.             {
    3.                 c.AddPolicy("LimitRequests", policy => 
    4.                 {
    5.                     policy
    6.                     //.AllowAnyOrigin()
    7.                     .WithOrigins(new string[]{ "http://localhost:8889" })
    8.                     //.WithOrigins(Appsettings.app(new string[] { "Startup", "Cors", "IPs" }).Split(','))
    9.                     .AllowAnyHeader()
    10.                     .AllowAnyMethod();
    11.                 });
    12.             });
    刷新一下index.html，弹出界面，访问成功

    6.使用Log4Net日志处理

    安装

    注册服务

    1. public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    2.             WebHost.CreateDefaultBuilder(args)
    3.                  .UseStartup()
    4.                     .ConfigureLogging((hostingContext, builder) =>
    5.                     {
    6.                         //过滤掉系统默认的一些日志
    7.                         builder.AddFilter("System", LogLevel.Error);
    8.                         builder.AddFilter("Microsoft", LogLevel.Error);
    9.                         //builder.AddFilter();
    10.  
    11.                         //可配置文件
    12.                         var path = Path.Combine(Directory.GetCurrentDirectory(),
    13.                             "Log4net.config");
    14.                         builder.AddLog4Net(path);
    15.                     });

    配置文件，下面文件配置了error和info两种级别的日志

    1. "1.0" encoding="utf-8"?>
    2. <log4net>
    3. 	
    4. 	
    5. 	
    6. 	<appender name="ErrorLog" type="log4net.Appender.RollingFileAppender">
    7. 		<file value="Log/"/>
    8. 		<appendToFile value="true" />
    9. 		<rollingStyle value="Date" />
    10. 		
    11. 		<datePattern value=""GlobalExceptionLogs_"yyyyMMdd".log"" />
    12. 		
    13. 		<StaticLogFileName value="false"/>
    14. 		
    15. 		<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    16. 		
    17. 		<layout type="log4net.Layout.PatternLayout">
    18. 			<conversionPattern value="%date| %-5level %newline%message%newline--------------------------------%newline" />
    19. 		layout>
    20. 		<filter type="log4net.Filter.LevelRangeFilter">
    21. 			<levelMin value="ERROR" />
    22. 			<levelMax value="FATAL" />
    23. 		filter>
    24. 	appender>
    25. 	
    26.  
    27. 	
    28. 	<appender name="InfoLog" type="log4net.Appender.RollingFileAppender">
    29. 		
    30. 		<file value="Log/"/>
    31. 		<appendToFile value="true" />
    32. 		<rollingStyle value="Date" />
    33. 		
    34. 		<StaticLogFileName value="false"/>
    35. 		
    36. 		<datePattern value=""GlobalInfoLogs_"yyyyMMdd".log"" />
    37. 		
    38. 		<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    39. 		
    40. 		<layout type="log4net.Layout.PatternLayout">
    41. 			<conversionPattern value="%date| %-5level %newline%message%newline--------------------------------%newline" />
    42. 		layout>
    43. 		<filter type="log4net.Filter.LevelRangeFilter">
    44. 			<levelMin value="DEBUG" />
    45. 			<levelMax value="WARN" />
    46. 		filter>
    47. 	appender>
    48. 	
    49.  
    50. 	<root>
    51. 		
    52. 		
    53. 		
    54. 		<level value="ALL" />
    55. 		
    56. 		<appender-ref ref="ErrorLog" />
    57. 		<appender-ref ref="InfoLog" />
    58. 	root>
    59. log4net>

    使用

    1. [Produces("application/json")]
    2.     [Route("api/Values")]
    3.     [AllowAnonymous]
    4.     public class ValuesController : ControllerBase
    5.     {
    6.         private readonly IUserService _userService;
    7.         private readonly ILogger _logger;
    8.  
    9.         public ValuesController(IUserService userService,ILogger logger)
    10.         {
    11.             this._userService = userService;
    12.             this._logger = logger;
    13.         }
    14.  
    15.         // GET api/values
    16.         [HttpGet]
    17.         public ActionResultstring>> Get()
    18.         {
    19.             _logger.LogError("this is an error");
    20.             return new string[] { "value1", "value2" };
    21.         }
    22. }

    7.JWT基于策略的授权

    安装 Microsoft.IdentityModel.Tokens 和 System.IdentityModel.Tokens.Jwt

    新建Jwt操作类

    1.  public class JwtHelper
    2.     {
    3.  
    4.         /// 
    5.         /// 颁发JWT字符串
    6.         /// 
    7.         /// 
    8.         /// 
    9.         public static string IssueJWT(TokenModelJWT tokenModel)
    10.         {
    11.             var dateTime = DateTime.UtcNow;
    12.  
    13.             string iss = Appsettings.app(new string[] { "Audience", "Issuer" });
    14.             string aud = Appsettings.app(new string[] { "Audience", "Audience" });
    15.             string secret = Appsettings.app(new string[] { "Audience", "Secret" });
    16.  
    17.             //var claims = new Claim[] //old
    18.             var claims = new List
    19.                 {
    20.                     //下边为Claim的默认配置
    21.                 new Claim(JwtRegisteredClaimNames.Jti, tokenModel.Uid.ToString()),
    22.                 new Claim(JwtRegisteredClaimNames.Iat, $"{new DateTimeOffset(DateTime.Now).ToUnixTimeSeconds()}"),
    23.                 new Claim(JwtRegisteredClaimNames.Nbf,$"{new DateTimeOffset(DateTime.Now).ToUnixTimeSeconds()}") ,
    24.                 //这个就是过期时间，目前是过期100秒，可自定义，注意JWT有自己的缓冲过期时间
    25.                 new Claim (JwtRegisteredClaimNames.Exp,$"{new DateTimeOffset(DateTime.Now.AddSeconds(100)).ToUnixTimeSeconds()}"),
    26.                 new Claim(JwtRegisteredClaimNames.Iss,iss),
    27.                 new Claim(JwtRegisteredClaimNames.Aud,aud),
    28.  
    29.                 //new Claim(ClaimTypes.Role,tokenModel.Role),//为了解决一个用户多个角色(比如：Admin,System)，用下边的方法
    30.                };
    31.  
    32.             // 可以将一个用户的多个角色全部赋予；
    33.             // 作者：DX 提供技术支持；
    34.             claims.AddRange(tokenModel.Role.Split(',').Select(s => new Claim(ClaimTypes.Role, s)));
    35.  
    36.  
    37.  
    38.             //秘钥 (SymmetricSecurityKey 对安全性的要求，密钥的长度太短会报出异常)
    39.             var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(secret));
    40.             var creds = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);
    41.  
    42.             var jwt = new JwtSecurityToken(
    43.                 issuer: iss,
    44.                 claims: claims,
    45.                 signingCredentials: creds);
    46.  
    47.             var jwtHandler = new JwtSecurityTokenHandler();
    48.             var encodedJwt = jwtHandler.WriteToken(jwt);
    49.  
    50.             return encodedJwt;
    51.         }
    52.  
    53.         /// 
    54.         /// 解析
    55.         /// 
    56.         /// 
    57.         /// 
    58.         public static TokenModelJWT SerializeJWT(string jwtStr)
    59.         {
    60.             var jwtHandler = new JwtSecurityTokenHandler();
    61.             JwtSecurityToken jwtToken = jwtHandler.ReadJwtToken(jwtStr);
    62.             object role = new object(); ;
    63.             try
    64.             {
    65.                 jwtToken.Payload.TryGetValue(ClaimTypes.Role, out role);
    66.             }
    67.             catch (Exception e)
    68.             {
    69.                 Console.WriteLine(e);
    70.                 throw;
    71.             }
    72.             var tm = new TokenModelJWT
    73.             {
    74.                 Uid = Convert.ToInt32(jwtToken.Id),
    75.                 Role = role != null ? role.ToString() : "",
    76.             };
    77.             return tm;
    78.         }
    79.     }
    80.  
    81.     /// 
    82.     /// 令牌
    83.     /// 
    84.     public class TokenModelJWT
    85.     {
    86.         /// 
    87.         /// Id
    88.         /// 
    89.         public long Uid { get; set; }
    90.         /// 
    91.         /// 角色
    92.         /// 
    93.         public string Role { get; set; }
    94.         /// 
    95.         /// 职能
    96.         /// 
    97.         public string Work { get; set; }
    98.  
    99.     }

    配置文件appsettings.json

    1. {
    2.   "Logging": {
    3.     "LogLevel": {
    4.       "Default": "Warning"
    5.     }
    6.   },
    7.   "Audience": {
    8.     "Secret": "sdfsdfsrty45634kkhllghtdgdfss345t678fs", //至少要16位
    9.     "Issuer": "nmmking.Core",
    10.     "Audience": "yika"
    11.   },
    12.   "Startup": {
    13.     "Cors": {
    14.       "IPs": "http://127.0.0.1:2364,http://localhost:2364,http://localhost:8080,http://localhost:8021,http://localhost:1818"
    15.     }
    16.   },
    17.     "AllowedHosts": "*"
    18.   }
    在Startup.cs文件注册和配置到管道 

    1.             #region 基于策略的授权（简单版）
    2.             // 1【授权】、这个和上边的异曲同工，好处就是不用在controller中，写多个 roles 。
    3.             // 然后这么写 [Authorize(Policy = "Admin")]
    4.             services.AddAuthorization(options =>
    5.             {
    6.                 options.AddPolicy("Client", policy => policy.RequireRole("Client").Build());
    7.                 options.AddPolicy("Admin", policy => policy.RequireRole("Admin").Build());
    8.                 options.AddPolicy("SystemOrAdmin", policy => policy.RequireRole("Admin", "System"));
    9.             });
    10.  
    11.             #endregion
    12.  
    13.             #region 【认证】
    14.             //读取配置文件
    15.             var audienceConfig = Configuration.GetSection("Audience");
    16.             var symmetricKeyAsBase64 = audienceConfig["Secret"];
    17.             var keyByteArray = Encoding.ASCII.GetBytes(symmetricKeyAsBase64);
    18.             var signingKey = new SymmetricSecurityKey(keyByteArray);
    19.  
    20.             //2.1【认证】
    21.             services.AddAuthentication(x =>
    22.             {
    23.                 x.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
    24.                 x.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
    25.             })
    26.              .AddJwtBearer(o =>
    27.              {
    28.                  o.TokenValidationParameters = new TokenValidationParameters
    29.                  {
    30.                      ValidateIssuerSigningKey = true,
    31.                      IssuerSigningKey = signingKey,
    32.                      ValidateIssuer = true,
    33.                      ValidIssuer = audienceConfig["Issuer"],//发行人
    34.                      ValidateAudience = true,
    35.                      ValidAudience = audienceConfig["Audience"],//订阅人
    36.                      ValidateLifetime = true,
    37.                      ClockSkew = TimeSpan.Zero,
    38.                      RequireExpirationTime = true,
    39.                  };
    40.  
    41.              });
    42.             #endregion
    app.UseAuthentication();

    接口 GetJWTToken

    1.     [Produces("application/json")]
    2.     [Route("api/[controller]/[action]")]
    3.     public class ValuesController : ControllerBase
    4.     {
    5.     }
    1.   /// 
    2.         /// 登录接口：随便输入字符，获取token，然后添加 Authoritarian
    3.         /// 
    4.         /// 
    5.         /// 
    6.         /// 
    7.         [HttpGet]
    8.         public async Task<object> GetJWTToken(string name, string pass)
    9.         {
    10.             string jwtStr = string.Empty;
    11.             bool suc = false;
    12.             //这里就是用户登陆以后，通过数据库去调取数据，分配权限的操作
    13.             //这里直接写死了
    14.  
    15.  
    16.             if (string.IsNullOrEmpty(name) || string.IsNullOrEmpty(pass))
    17.             {
    18.                 return new JsonResult(new
    19.                 {
    20.                     Status = false,
    21.                     message = "用户名或密码不能为空"
    22.                 });
    23.             }
    24.  
    25.             TokenModelJWT tokenModel = new TokenModelJWT();
    26.             tokenModel.Uid = 1;
    27.             tokenModel.Role = name;
    28.  
    29.             jwtStr = JwtHelper.IssueJWT(tokenModel);
    30.             suc = true;
    31.  
    32.  
    33.             return Ok(new
    34.             {
    35.                 success = suc,
    36.                 token = jwtStr
    37.             });
    38.         }

    测试1：测试 Get 

    1.         /// 
    2.         /// 这个也需要认证，只不过登录即可，不一定是Admin
    3.         /// 
    4.         /// 
    5.         /// 
    6.         [HttpGet]
    7.         [Authorize]
    8.         public ActionResult<string> Get()
    9.         {
    10.             return "value";
    11.         }
    token 逾期，访问 Get 接口， 结果提示没有权限（未授权），如下图所示：

    用户重新登录获取 token （这里没有指定的用户，只要登录就行），如下图所示：

     ​​​​​​再次访问 Get 接口，访问成功如下图所示：

    接口2：

    1.         /// 
    2.         /// 这个需要认证，角色必须是Admin，其他的不需要
    3.         /// 
    4.         /// 
    5.         [HttpGet]
    6.         [Authorize(Policy = "SystemOrAdmin")]
    7.         public ActionResultstring>> GetData()
    8.         {
    9.             _logger.LogError("this is an error");
    10.             return new string[] { "value1", "value2" };
    11.         }

    随意的用户登录获取 token，如下所示

     登录的用户不是 Admin，结果是拒绝访问

     如果是admin用户，请求参数和请求头如下：

    请求成功 

     

    8.Swagger和JWT设置

    nuget 安装 Microsoft.OpenApi ，Swashbuckle.AspNetCore，Swashbuckle.AspNetCore.Filters。

    在Startup.cs设置：

    1. private const string ApiName = "nmmking.Core.Api";
    2. private readonly string version = "V1";
    1. public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    2.         {
    3.             if (env.IsDevelopment())
    4.             {
    5.                 app.UseDeveloperExceptionPage();
    6.             }
    7.  
    8.             app.UseCors("LimitRequests");
    9.  
    10.             //注册异常处理中间件
    11.             app.UseMiddleware();
    12.  
    13.             #region Swagger
    14.             app.UseSwagger();
    15.             app.UseSwaggerUI(c =>
    16.             {
    17.                 c.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"{ApiName} {version}");
    18.                 //c.IndexStream = () => GetType().GetTypeInfo().Assembly.GetManifestResourceStream("index.html");
    19.                 c.RoutePrefix = "";
    20.             });
    21.             #endregion
    22.             // 开启权限
    23.             app.UseAuthentication();
    24.  
    25.             app.UseMvc();
    26.         }
    1.         public IServiceProvider ConfigureServices(IServiceCollection services)
    2.         {
    3.             services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
    4.  
    5.             services.AddCors(c => 
    6.             {
    7.                 c.AddPolicy("LimitRequests", policy => 
    8.                 {
    9.                     policy
    10.                     //.AllowAnyOrigin()
    11.                     .WithOrigins(new string[]{ "http://localhost:8881" })
    12.                     //.WithOrigins(Appsettings.app(new string[] { "Startup", "Cors", "IPs" }).Split(','))
    13.                     .AllowAnyHeader()
    14.                     .AllowAnyMethod();
    15.                 });
    16.             });
    17.  
    18.             #region Swagger UI Service
    19.  
    20.             var basePath = Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath;
    21.             services.AddSwaggerGen(c =>
    22.             {
    23.                 //遍历出全部的版本，做文档信息展示
    24.                 c.SwaggerDoc(version, new OpenApiInfo
    25.                 {
    26.                     Version = version,
    27.                     Title = $"{ApiName} 接口文档——{RuntimeInformation.FrameworkDescription}",
    28.                     Description = $"{ApiName} HTTP API " + version,
    29.                     Contact = new OpenApiContact { Name = ApiName, Email = "nmmking.Core@xxx.com", Url = new Uri("http地址") },
    30.                     License = new OpenApiLicense { Name = ApiName + " 官方文档", Url = new Uri("http地址") }
    31.                 });
    32.                 c.OrderActionsBy(o => o.RelativePath);
    33.  
    34.  
    35.                 //就是这里
    36.                 var xmlPath = Path.Combine(basePath, "nmmking.Core.Api.xml");//这个就是刚刚配置的xml文件名
    37.                 c.IncludeXmlComments(xmlPath, true);//默认的第二个参数是false，这个是controller的注释，记得修改
    38.  
    39.                 var xmlPath2 = Path.Combine(basePath, "nmmking.Core.Model.xml");
    40.                 c.IncludeXmlComments(xmlPath2, true);
    41.  
    42.                 #region Token绑定到ConfigureServices
    43.  
    44.                 // 开启加权小锁
    45.                 c.OperationFilter();
    46.                 c.OperationFilter();
    47.  
    48.                 // 在header中添加token，传递到后台
    49.                 c.OperationFilter();
    50.  
    51.                 // Jwt Bearer 认证，必须是 oauth2
    52.                 c.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
    53.                 {
    54.                     Description = "JWT授权(数据将在请求头中进行传输) 直接在下框中输入Bearer {token}（注意两者之间是一个空格）\"",
    55.                     Name = "Authorization",//jwt默认的参数名称
    56.                     In = ParameterLocation.Header,//jwt默认存放Authorization信息的位置(请求头中)
    57.                     Type = SecuritySchemeType.ApiKey
    58.                 });
    59.                 #endregion
    60.             });
    61.  
    62.             #endregion
    63.  
    64.             #region 授权
    65.             // 读取配置文件
    66.             var audienceConfig = Configuration.GetSection("Audience");
    67.             var symmetricKeyAsBase64 = audienceConfig["Secret"];
    68.             var keyByteArray = Encoding.ASCII.GetBytes(symmetricKeyAsBase64);
    69.             var signingKey = new SymmetricSecurityKey(keyByteArray);
    70.  
    71.             var signingCredentials = new SigningCredentials(signingKey, SecurityAlgorithms.HmacSha256); //签名
    72.  
    73.             // 角色与接口的权限要求参数
    74.             var permissionRequirement = new PermissionRequirement(
    75.                 ClaimTypes.Role,//基于角色的授权
    76.                 audienceConfig["Issuer"],//发行人
    77.                 audienceConfig["Audience"],//听众
    78.                 signingCredentials,//签名凭据
    79.                 expiration: TimeSpan.FromSeconds(60 * 60)//接口的过期时间
    80.                 );
    81.  
    82.             // 授权
    83.             services.AddAuthorization(options =>
    84.             {
    85.                 // 权限变量配置
    86.                 options.AddPolicy("Permission",
    87.                          policy => policy.Requirements.Add(permissionRequirement));
    88.             });
    89.  
    90.             // 令牌验证参数
    91.             var tokenValidationParameters = new TokenValidationParameters
    92.             {
    93.                 ValidateIssuerSigningKey = true,
    94.                 IssuerSigningKey = signingKey,
    95.                 ValidateIssuer = true,
    96.                 ValidIssuer = audienceConfig["Issuer"],//发行人
    97.                 ValidateAudience = true,
    98.                 ValidAudience = audienceConfig["Audience"],//订阅人
    99.                 ValidateLifetime = true,
    100.                 ClockSkew = TimeSpan.FromSeconds(30),
    101.                 RequireExpirationTime = true,
    102.             };
    103.  
    104.             services.AddAuthentication("Bearer")
    105.              .AddJwtBearer(o =>
    106.              {
    107.                  o.TokenValidationParameters = tokenValidationParameters;
    108.                  o.Events = new JwtBearerEvents
    109.                  {
    110.                      OnAuthenticationFailed = context =>
    111.                      {
    112.                          // 如果过期，则把<是否过期>添加到，返回头信息中
    113.                          if (context.Exception.GetType() == typeof(SecurityTokenExpiredException))
    114.                          {
    115.                              context.Response.Headers.Add("Token-Expired", "true");
    116.                          }
    117.                          return Task.CompletedTask;
    118.                      }
    119.                  };
    120.              });
    121.  
    122.             services.AddSingleton(permissionRequirement);
    123.  
    124.             #endregion
    125.  
    126.             return services.BuildDynamicProxyProvider();
    127.         }

     

  • 相关阅读:
    Maven 使用过程中碰到的问题持续集成
    Z410 2023款无人机，专为零基础开发者打造的入门级开源无人机
    CF486D Valid Sets
    百度主动推送不能用了，百度自动推送代码送给大家
    29.STM32红外遥控器
    centost7下安装oracle11g 总结踩坑
    同步FIFO设计实现（8/7）
    【面试题- springcloud】- Ribbon 负载均衡
    【MindSpore】MindQuantum中如何处理遇到的一些问题
    ubuntu------anaconda和openvino安装
  • 原文地址：https://blog.csdn.net/nmmking/article/details/137844468