fix use and add name

.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on: [create]
+
+jobs:
+  build:
+    name: Build Project
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '3.1.101'
+    - name: Build
+      run: dotnet build
+  
+  publish:
+    needs: build
+    name: Publish Project to Nuget
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Setup .NET Core
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: '3.1.101'
+    - name: Publish
+      run: |
+        version=`git describe --tags`
+        dotnet pack --configuration release -p:PackageVersion=$version
+        dotnet nuget push bin/release/YY-Tech.YYApi.$version.nupkg -k ${APIKEY} -s https://www.nuget.org/api/v2/package
+      env:
+        APIKEY: ${{ secrets.APPKEY }}

.github/workflows/publish-nuget.yml

@@ -1,16 +0,0 @@
-name: PublishToNuget
-
-on: [push]
-
-jobs:
-  build:
-    name: publish to nuget
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 2 
-    - name: Publish NuGet
-      uses: rohith/publish-nuget@v1.0.3
-      with:
-        nuget_key: ${{ secrets.NugetKey }}

.gitignore

@@ -1,6 +1,7 @@
 # Created by .ignore support plugin (hsz.mobi)
 ### C template
 # Prerequisites
+*.sln:
 *.d
 
 # Object files

Communications/Base.cs

@@ -25,6 +25,7 @@ namespace YYApi.Communications
         private readonly Dictionary<int, string> MsgBox = new Dictionary<int, string>()
         {
             {200, "成功"},
+            {204, "没有数据"},
             {400, "参数错误"},
             {401, "需要登录"},
             {403, "无权访问"},
@@ -100,14 +101,52 @@ namespace YYApi.Communications
     }
 
     /// <summary>
-    /// 动态内容
+    /// 动态内容分页
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    public class BasePageResponse<T> : BaseResponse
+    {
+        /// <summary>
+        /// 动态内容列表
+        /// </summary>
+        public T List { get; set; }
+        //当前页码
+        public int Page { get; set; }
+        //每页条数
+        public int Count { get; set; }
+        //总计条数
+        public int Total { get; set; }
+    }
+
+    /// <summary>
+    /// 动态Data返回
     /// </summary>
     /// <typeparam name="T"></typeparam>
     public class BaseResponse<T> : BaseResponse
     {
         /// <summary>
-        /// 动态内容
+        /// 动态内容列表
         /// </summary>
         public T Data { get; set; }
     }
+
+
+    //===========》请求《===============
+
+    /// <summary>
+    /// 只有ID的请求
+    /// </summary>
+    public class IdOnlyRequest
+    {
+        public int Id { get; set; }
+    }
+
+    /// <summary>
+    /// 基础分页请求
+    /// </summary>
+    public class BasePageRequest
+    {
+        public int Page { get; set; }
+        public int Count { get; set; }
+    }
 }

Controllers/BaseController.cs

@@ -46,7 +46,7 @@ namespace YYApi.Controllers
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述(若是常规错误,代码可自动带取描述)</param>
         /// <returns></returns>
-        protected static void Error(int code, string message = null)
+        protected static void Error(int code, string message = "")
         {
             throw new ApiException(code, message);
         }
@@ -57,7 +57,7 @@ namespace YYApi.Controllers
         /// <param name="condition">检测条件</param>
         /// <param name="code">错误代码</param>
         /// <param name="message">错误描述</param>
-        protected static void ErrorWhen(bool condition, int code, string message = null)
+        protected static void ErrorWhen(bool condition, int code, string message = "")
         {
             if (condition)
             {
@@ -65,6 +65,17 @@ namespace YYApi.Controllers
             }
         }
 
+        /// <summary>
+        /// 检测给定的变量是否为NUll
+        /// </summary>
+        /// <param name="condition">检测条件</param>
+        /// <param name="code">错误代码</param>
+        /// <param name="message">错误描述</param>
+        protected static void ErrorWhenNull(object condition, int code, string message = "")
+        {
+            ErrorWhen(condition == null, code, message);
+        }
+
         /// <summary>
         /// 错误回馈页面
         /// </summary>
@@ -78,5 +89,10 @@ namespace YYApi.Controllers
             response.SetCode(code);
             return response;
         }
+
+        protected BaseResponse<string> UploadFile()
+        {
+            return new BaseResponse<string>();
+        }
     }
 }

Extensions.cs

@@ -12,18 +12,10 @@ namespace YYApi
     /// </summary>
     public static class Extensions
     {
-        /// <summary>
-        /// 添加自定义授权认证中间价
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <returns></returns>
-        public static IServiceCollection AddAuth(this IServiceCollection builder)
-        {
-            return builder.AddScoped<Auth>();
-        }
+        //**********快捷添加**************
 
         /// <summary>
-        /// 添加整个YYAPI
+        /// 添加整个YYAPI,同时增加CORS规则
         /// </summary>
         /// <param name="builder"></param>
         /// <param name="title"></param>
@@ -32,7 +24,34 @@ namespace YYApi
         public static IServiceCollection AddYYApi(this IServiceCollection builder, string title,
             string description = null)
         {
-            return builder.AddAuth().AddApiDoc(title, description);
+            return builder.AddYYAuth().AddYYDoc(title, description).AddCors(x => x.AddDefaultPolicy(po => po.AllowAnyHeader().AllowAnyMethod().AllowAnyOrigin()));
+        }
+
+        /// <summary>
+        /// 使用所有YYApi自定义中间件
+        /// </summary>
+        /// <param name="builder"></param>
+        /// <param name="title"></param>
+        /// <param name="submitMethods"></param>
+        /// <returns></returns>
+        public static IApplicationBuilder UseYYApi(this IApplicationBuilder builder, string title = "API文档",
+            params SubmitMethod[] submitMethods)
+        {
+            return builder.UseYYException().UseYYDoc(title, submitMethods).UseMiddleware<AuthMiddleware>();
+        }
+
+
+
+        //*********组件快捷方式*************
+
+        /// <summary>
+        /// 添加自定义授权认证中间价
+        /// </summary>
+        /// <param name="builder"></param>
+        /// <returns></returns>
+        public static IServiceCollection AddYYAuth(this IServiceCollection builder)
+        {
+            return builder.AddScoped<Auth>();
         }
 
         /// <summary>
@@ -42,7 +61,7 @@ namespace YYApi
         /// <param name="title">文档标题</param>
         /// <param name="description">文档描述</param>
         /// <returns></returns>
-        public static IServiceCollection AddApiDoc(this IServiceCollection builder, string title,
+        public static IServiceCollection AddYYDoc(this IServiceCollection builder, string title,
             string description = null)
         {
             return builder.AddSwaggerGen(x =>
@@ -64,12 +83,13 @@ namespace YYApi
             });
         }
 
+
         /// <summary>
         /// 使用异常中间价扩展
         /// </summary>
         /// <param name="builder"></param>
         /// <returns></returns>
-        public static IApplicationBuilder UseExceptionMiddleware(this IApplicationBuilder builder)
+        public static IApplicationBuilder UseYYException(this IApplicationBuilder builder)
         {
             return builder.UseMiddleware<ExceptionMiddleware>();
         }
@@ -81,7 +101,7 @@ namespace YYApi
         /// <param name="title">文档标题</param>
         /// <param name="submitMethods">文档支持的提交方式(如果不指定,默认使用POST)</param>
         /// <returns></returns>
-        public static IApplicationBuilder UseApiDoc(this IApplicationBuilder builder, string title,
+        public static IApplicationBuilder UseYYDoc(this IApplicationBuilder builder, string title,
             params SubmitMethod[] submitMethods)
         {
             return builder.UseSwagger(x => x.RouteTemplate = "docs/{documentName}.json").UseSwaggerUI(x =>
@@ -111,10 +131,10 @@ namespace YYApi
         /// <param name="title">文档标题</param>
         /// <param name="submitMethods">API提交方式定义</param>
         /// <returns></returns>
-        public static IApplicationBuilder UseDocAndException(this IApplicationBuilder builder, string title = "API文档",
+        public static IApplicationBuilder UseYYDocEx(this IApplicationBuilder builder, string title = "API文档",
             params SubmitMethod[] submitMethods)
         {
-            return builder.UseExceptionMiddleware().UseApiDoc(title, submitMethods);
+            return builder.UseYYException().UseYYDoc(title, submitMethods);
         }
 
         /// <summary>
@@ -122,22 +142,11 @@ namespace YYApi
         /// </summary>
         /// <param name="builder"></param>
         /// <returns></returns>
-        public static IApplicationBuilder UseAuthMiddleware(this IApplicationBuilder builder)
+        public static IApplicationBuilder UseYYAuth(this IApplicationBuilder builder)
         {
             return builder.UseMiddleware<AuthMiddleware>();
         }
 
-        /// <summary>
-        /// 使用所有YYApi自定义中间件
-        /// </summary>
-        /// <param name="builder"></param>
-        /// <param name="title"></param>
-        /// <param name="submitMethods"></param>
-        /// <returns></returns>
-        public static IApplicationBuilder UseYYApiMiddleware(this IApplicationBuilder builder, string title = "API文档",
-            params SubmitMethod[] submitMethods)
-        {
-            return builder.UseExceptionMiddleware().UseApiDoc(title, submitMethods).UseMiddleware<AuthMiddleware>();
-        }
+
     }
 }

Helpers/AuthMiddleware.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Linq;
 using System.Text.Json;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
@@ -56,12 +57,39 @@ namespace YYApi.Helpers
     /// </summary>
     public class CheckAuthAttribute : ActionFilterAttribute
     {
+        private string[] Types { get; }
+
+        //默认是user登录类型
+        public CheckAuthAttribute()
+        {
+            Types = new[] { "user" };
+        }
+
+        //只检测一种用户类型的快捷方式
+        public CheckAuthAttribute(string type)
+        {
+            Types = new[] { type };
+        }
+
+        //设定特定类型的检测
+        public CheckAuthAttribute(string[] types)
+        {
+            Types = types;
+        }
+
         public override void OnActionExecuting(ActionExecutingContext context)
         {
-            if (context.HttpContext.Items["LoginId"] == null)
+            var loginInfo = (LoginInfoItem)context.HttpContext.Items["LoginInfo"];
+            //检测是否登录
+            if (loginInfo == null)
             {
                 throw new ApiException(401);
             }
+            //检测用户类型
+            if (!Types.Contains(loginInfo.Type))
+            {
+                throw new ApiException(403);
+            }
         }
     }
 
@@ -82,7 +110,7 @@ namespace YYApi.Helpers
         /// </summary>
         /// <param name="id"></param>
         /// <returns></returns>
-        public string SetId(int id, string type = "user")
+        public string Set(int id, string type = "user")
         {
             var uuid = GetUUID();
             var loginItem = new LoginInfoItem

JobService/HFDashboardAuth.cs

@@ -0,0 +1,124 @@
+using System;
+using Hangfire.Dashboard;
+using Microsoft.Extensions.Configuration;
+using Microsoft.AspNetCore.Http;
+using StackExchange.Redis;
+using System.Collections.Generic;
+using System.Text;
+using System.Security.Cryptography;
+
+namespace YYApi.JobService
+{
+    /// <summary>
+    /// Redis缓存Key定义
+    /// </summary>
+    public struct CacheKey
+    {
+        public const string HangfireDashboardAuthPrefix = "{hangfire}:dashboard:auth:";
+    }
+
+    /// <summary>
+    /// HangFire Dashboard Digest认证.
+    /// </summary>
+    public class HFDashboardAuth : IDashboardAuthorizationFilter
+    {
+        private IConfiguration _config { get; }
+        private IDatabase _redis { get; }
+        public HFDashboardAuth(IConfiguration config, IDatabase redis)
+        {
+            _redis = redis;
+            _config = config;
+        }
+
+        public bool Authorize(DashboardContext context)
+        {
+            var http = context.GetHttpContext();
+            if (http.Request.Headers.ContainsKey("Authorization"))
+            {
+                var authObj = _processAuthHeader(http.Request.Headers["Authorization"].ToString());
+                if (http.Request.QueryString.ToString().Contains("logout"))
+                {
+                    _redis.KeyDelete(CacheKey.HangfireDashboardAuthPrefix + authObj["opaque"]);
+                    _redirect(http);
+                    return true;
+                }
+                if (authObj["username"] == _config["Hangfire:User"])
+                {
+                    var a1 = _md5(string.Format("{0}:Need Login:{1}", authObj["username"], _config["Hangfire:Pass"]));
+                    var a2 = _md5(string.Format("{0}:{1}", http.Request.Method, authObj["uri"]));
+                    var nonce = _redis.StringGet(CacheKey.HangfireDashboardAuthPrefix + authObj["opaque"]);
+                    var validCode = _md5(string.Format("{0}:{1}:{2}:{3}:{4}:{5}", a1, nonce, authObj["nc"], authObj["cnonce"], authObj["qop"], a2));
+                    if (authObj["response"] == validCode)
+                    {
+                        _redis.StringSet(CacheKey.HangfireDashboardAuthPrefix + authObj["opaque"], nonce, new TimeSpan(0, 5, 0));
+                        return true;
+                    }
+                }
+            }
+            _challenge(http);
+            return false;
+        }
+
+        /// <summary>
+        /// 生成401认证header
+        /// </summary>
+        /// <returns>The challenge.</returns>
+        private void _challenge(HttpContext http)
+        {
+            var response = http.Response;
+            var guid = Guid.NewGuid().ToString();
+            var opaque = _md5(guid);
+            _redis.StringSet(CacheKey.HangfireDashboardAuthPrefix + opaque, guid, new TimeSpan(0, 0, 30));
+            response.StatusCode = 401;
+            response.Headers.Add("WWW-Authenticate", string.Format("Digest realm=\"Need Login\",qop=\"auth\",nonce=\"{0}\",opaque=\"{1}\"", guid, opaque));
+        }
+
+        /// <summary>
+        /// 跳转到页面不附加参数
+        /// </summary>
+        /// <param name="http">Http.</param>
+        private void _redirect(HttpContext http)
+        {
+            var response = http.Response;
+            response.StatusCode = 302;
+            response.Headers.Add("Location", (http.Request.PathBase + http.Request.Path).ToString());
+        }
+
+        /// <summary>
+        /// 处理DigestHeader中的参数为字典
+        /// </summary>
+        /// <returns>The auth header.</returns>
+        /// <param name="authData">Auth data.</param>
+        private Dictionary<string, string> _processAuthHeader(string authData)
+        {
+            var authDataArray = authData.Replace("Digest ", string.Empty).Replace("\"", string.Empty).Split(", ");
+            var authDic = new Dictionary<string, string>();
+            foreach (var item in authDataArray)
+            {
+                var tmp = item.Split("=", 2);
+                authDic.Add(tmp[0], tmp[1]);
+            }
+            return authDic;
+        }
+
+        /// <summary>
+        /// 计算字符串32位MD5
+        /// </summary>
+        /// <returns>The md5.</returns>
+        /// <param name="source">Source.</param>
+        private string _md5(string source)
+        {
+            byte[] sor = Encoding.UTF8.GetBytes(source);
+            var md5 = MD5.Create();
+            byte[] result = md5.ComputeHash(sor);
+            StringBuilder strbul = new StringBuilder(40);
+            for (int i = 0; i < result.Length; i++)
+            {
+                strbul.Append(result[i].ToString("x2"));//加密结果"x2"结果为32位,"x3"结果为48位,"x4"结果为64位
+
+            }
+            return strbul.ToString();
+
+        }
+    }
+}

JobService/JobDashboardConfig.cs

@@ -0,0 +1,10 @@
+using System;
+namespace YYApi.JobService
+{
+    public class JobDashboardConfig
+    {
+        public string Path { get; set; }
+        public string Username { get; set; }
+        public string Password { get; set; }
+    }
+}

JobService/JobStorage.cs

@@ -0,0 +1,10 @@
+using System;
+namespace YYApi.JobService
+{
+    public class JobStorage
+    {
+        public JobStorage()
+        {
+        }
+    }
+}

README.md

@@ -1,5 +1,7 @@
 # YYApi 基于Asp.net Core 3的一个基础辅助包
 
+![CI](https://github.com/YY-Tech/YYApi/workflows/CI/badge.svg)
+
 ### 包含了以下组件:
 
 1. 统一的参数检测,基础认证服务
@@ -15,7 +17,7 @@ namespace Controllers
         /// <summary>
         /// 获取登录用户信息
         /// </summary>
-        protected User LoginInfo => (User) HttpContext.Items["LoginInfo"];
+        protected LoginInfoItem LoginInfo => (LoginInfoItem) HttpContext.Items["LoginInfo"];
     }
 }
 ```
@@ -40,7 +42,7 @@ namespace Controllers
 #Startup.cs
 service.AddAuth();
 ```
-添加时候, 可以从DI中获取 Auth 类,调用 Auth.SetId(int) 将用户ID和生成的Token绑定,本方法返回缓存中的Key名称
+添加时候, 可以从DI中获取 Auth 类,调用 Auth.Set(int,string) 将用户ID/类型和生成的Token绑定,本方法返回缓存中的Key名称
 
 ```C#
 #Startup.cs

YYApi.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <OutputType>Library</OutputType>
     <PackOnBuild>true</PackOnBuild>
-    <Version>0.1.3</Version>
+    <Version>0.2.3</Version>
     <Authors>xRain@YYTech</Authors>
     <Description>AspNetCore一个方便的API文档,捕获异常,统一输入输出的API类库</Description>
     <PackageId>YY-Tech.YYApi</PackageId>
@@ -17,13 +17,15 @@
     <Folder Include="Helpers\" />
     <Folder Include="Communications\" />
     <Folder Include="Controllers\" />
+    <Folder Include="JobService\" />
   </ItemGroup>
   <ItemGroup>
-    <Content Remove="Properties\launchSettings.json" />
-  </ItemGroup>
-  <ItemGroup>
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.0.0-rc5" />
-    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.0.0-rc5" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="5.0.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="5.0.0" />
+    <PackageReference Include="HangFire.Core" Version="1.7.8" />
+    <PackageReference Include="Hangfire.AspNetCore" Version="1.7.8" />
+    <PackageReference Include="Hangfire.Console" Version="1.4.2" />
+    <PackageReference Include="Hangfire.Redis.StackExchange" Version="1.8.1" />
   </ItemGroup>
   <ProjectExtensions>
     <MonoDevelop>