尤其给力的是在课程当天做到了.NET Core,新浪上一度有人出了相关的多重小说

在微软Tech Summit 2017 大会上和豪门大快朵颐了一门科目《.NET Core
在腾讯财付通的商号级应用开发实践》,其中重点是依据ASP.NET
Core创设可增加的高质量公司级API网关,以开源的API网关Ocelot为根基结合自个儿的工作特点,当天课程唯有40分钟,有过多内容都没有展开,接下去就用一篇小文章来聊下Ocelot
的达成原理,大家在行使的历程中也得以协同来进献。 总体来说那是二个ASP.NET
Core
高级编程的内容,此前在斯Leica号里已经发过不少各位朋友写的稿子,明日都会在那篇作品中引用,让你尤其深入学习。

连锁知识点

不再对IdentityServer4做相关介绍,微博上曾经有人出了相关的层层小说,不打听的可以看一下:

蟋蟀大神的:菜肴学习编程-IdentityServer4

晓晨Master:IdentityServer4

以及Identity,Claim等连锁知识:

Savorboard:ASP.NET Core 之 Identity
入门(一)
ASP.NET
Core 之 Identity
入门(二)

图片 1

创建IndentityServer4 服务

创建贰个名为QuickstartIdentityServer的ASP.NET Core Web 空项目(asp.net
core 2.0),端口5000

图片 2

图片 3

NuGet包:

图片 4

修改Startup.cs 设置使用IdentityServer:

public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            // configure identity server with in-memory stores, keys, clients and scopes
            services.AddIdentityServer()
                .AddDeveloperSigningCredential()
                .AddInMemoryIdentityResources(Config.GetIdentityResourceResources())
                .AddInMemoryApiResources(Config.GetApiResources())
                .AddInMemoryClients(Config.GetClients())
                .AddResourceOwnerValidator<ResourceOwnerPasswordValidator>()
                .AddProfileService<ProfileService>();
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseIdentityServer();
        }
    }

添加Config.cs配置IdentityResource,ApiResource以及Client:

 public class Config
    {
        public static IEnumerable<IdentityResource> GetIdentityResourceResources()
        {
            return new List<IdentityResource>
            {
                new IdentityResources.OpenId(), //必须要添加,否则报无效的scope错误
                new IdentityResources.Profile()
            };
        }
        // scopes define the API resources in your system
        public static IEnumerable<ApiResource> GetApiResources()
        {
            return new List<ApiResource>
            {
                new ApiResource("api1", "My API")
            };
        }

        // clients want to access resources (aka scopes)
        public static IEnumerable<Client> GetClients()
        {
            // client credentials client
            return new List<Client>
            {
                new Client
                {
                    ClientId = "client1",
                    AllowedGrantTypes = GrantTypes.ClientCredentials,

                    ClientSecrets = 
                    {
                        new Secret("secret".Sha256())
                    },
                    AllowedScopes = { "api1",IdentityServerConstants.StandardScopes.OpenId, //必须要添加,否则报forbidden错误
                  IdentityServerConstants.StandardScopes.Profile},

                },

                // resource owner password grant client
                new Client
                {
                    ClientId = "client2",
                    AllowedGrantTypes = GrantTypes.ResourceOwnerPassword,

                    ClientSecrets = 
                    {
                        new Secret("secret".Sha256())
                    },
                    AllowedScopes = { "api1",IdentityServerConstants.StandardScopes.OpenId, //必须要添加,否则报forbidden错误
                  IdentityServerConstants.StandardScopes.Profile }
                }
            };
        }
    }

因为要利用登录的时候要接纳数据中保存的用户展开表达,要实IResourceOwnerPasswordValidator接口:

public class ResourceOwnerPasswordValidator : IResourceOwnerPasswordValidator
    {
        public ResourceOwnerPasswordValidator()
        {

        }

        public async Task ValidateAsync(ResourceOwnerPasswordValidationContext context)
        {
            //根据context.UserName和context.Password与数据库的数据做校验,判断是否合法
            if (context.UserName=="wjk"&&context.Password=="123")
            {
                context.Result = new GrantValidationResult(
                 subject: context.UserName,
                 authenticationMethod: "custom",
                 claims: GetUserClaims());
            }
            else
            {

                 //验证失败
                 context.Result = new GrantValidationResult(TokenRequestErrors.InvalidGrant, "invalid custom credential");
            }
        }
        //可以根据需要设置相应的Claim
        private Claim[] GetUserClaims()
        {
            return new Claim[]
            {
            new Claim("UserId", 1.ToString()),
            new Claim(JwtClaimTypes.Name,"wjk"),
            new Claim(JwtClaimTypes.GivenName, "jaycewu"),
            new Claim(JwtClaimTypes.FamilyName, "yyy"),
            new Claim(JwtClaimTypes.Email, "977865769@qq.com"),
            new Claim(JwtClaimTypes.Role,"admin")
            };
        }
    }

IdentityServer提供了接口访问用户音讯,不过暗中认同重返的数量只有sub,就是地点安装的subject:
context.UserName,要回来越多的信息,要求完毕IProfileService接口:

public class ProfileService : IProfileService
    {
        public async Task GetProfileDataAsync(ProfileDataRequestContext context)
        {
            try
            {
                //depending on the scope accessing the user data.
                var claims = context.Subject.Claims.ToList();

                //set issued claims to return
                context.IssuedClaims = claims.ToList();
            }
            catch (Exception ex)
            {
                //log your error
            }
        }

        public async Task IsActiveAsync(IsActiveContext context)
        {
            context.IsActive = true;
        }

context.Subject.Claims就是前边已毕IResourceOwnerPasswordValidator接口时claims:
GetUserClaims()给到的数量。
除此以外,经过调试发现,呈现执行ResourceOwnerPasswordValidator
里的ValidateAsync,然后实施ProfileService里的IsActiveAsync,GetProfileDataAsync。

启航项目,使用postman举办呼吁就足以拿到到token:

图片 5

再用token获取相应的用户音信:

图片 6

token认证服务一般是与web程序分其余,下边创设的QuickstartIdentityServer项目就相当于服务端,大家须要写作业逻辑的web程序就相当于客户端。当用户请求web程序的时候,web程序拿着用户已经报到取得的token去IdentityServer服务端校验。

 

创建web应用

创办1个名为API的ASP.NET Core Web 空项目(asp.net core 2.0),端口5001。

NuGet包:

图片 7

修改Startup.cs 设置使用IdentityServer举行校验:

public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvcCore(option=>
            {
                option.Filters.Add(new TestAuthorizationFilter());
            }).AddAuthorization()
                .AddJsonFormatters();

            services.AddAuthentication("Bearer")
                .AddIdentityServerAuthentication(options =>
                {
                    options.Authority = "http://localhost:5000";
                    options.RequireHttpsMetadata = false;

                    options.ApiName = "api1";
                });
        }

        public void Configure(IApplicationBuilder app)
        {
            app.UseAuthentication();

            app.UseMvc();
        }
    }

创建IdentityController:

[Route("[controller]")]
    public class IdentityController : ControllerBase
    {
        [HttpGet]
        [Authorize]
        public IActionResult Get()
        {
            return new JsonResult("Hello Word");
        }

    }

独家运营QuickstartIdentityServer,API项目。用生成的token访问API:

图片 8

因而上述顺序,已经足以做八个左右端分离的报到作用。

骨子里,web应用程序中大家平日索要拿到当前用户的连带信息举行操作,比如记录用户的有个别操作日志等。此前说过IdentityServer提供了接口/connect/userinfo来获取用户的相干音讯。从前作者的想法也是web程序中拿着token去伏乞这些接口来赢得用户音讯,并且第五次拿走后做相应的缓冲。但是觉得微微古怪,IdentityServer不容许没有想到这或多或少,平常的做法应该是校验通过会将用户的音讯重临的web程序中。难题又来了,假使IdentityServer真的是那样做的,web程序该怎么获取到呢,查了合法文档也没有找到。然后就拿着”Claim”关键字查了一通(从前没通晓过ASP.NET
Identity),最后经过HttpContext.User.Claims取到了设置的用户消息:

修改IdentityController :

[Route("[controller]")]
    public class IdentityController : ControllerBase
    {
        [HttpGet]
        [Authorize]
        public IActionResult Get()
        {
            return new JsonResult(from c in HttpContext.User.Claims select new { c.Type, c.Value });
        }

    }

图片 9

小编在github上的地址https://github.com/geffzhang
欢迎互粉,Ocelot在github的地方 https://github.com/TomPallister/Ocelot
, 至极给力的是在科目当天做到了.NET Core
2.0的晋升,升级历程请看https://github.com/TomPallister/Ocelot/issues/114
。前天作者花了半小时就把自个儿的此外二个POC项目Nanofabric  
https://github.com/geffzhang/NanoFabric 升级到了.NET Core 2.0,
那么些POC项目也是本身的享受的花色的原型,可以这么说.NET Core 2.0
2月份正式文告,经过三个月时间的升高,社区生态已经都已经办好了预备,开发新项目方可选用.NET
Core 2,Ocelot 是二个集成社区中众多美好开源项目的象征。

权力决定

IdentityServer4
也提供了权力管理的意义,大约看了一眼,没有高达本身想要(没耐心去探讨)。
自家急需的是指向不一致的模块,功效定义权限码(字符串),各个权限码对应相应的成效权限。当用户展开呼吁的时候,判断用户是不是有所相应成效的权力(是还是不是授予了对应的权柄字符串编码),来达到权限决定。

IdentityServer的校验是通过Authorize脾气来判断相应的Controller或Action是不是需求校验。那里也经过自定义天性来落到实处权力的校验,并且是在原始的Authorize个性上拓展增添。可行的方案继承AuthorizeAttribute,重写。不过在.net
core中晋升没有OnAuthorization方法可开展重写。最终参考的ABP的做法,过滤器和特色共同使用。

新建TestAuthorizationFilter.cs

public class TestAuthorizationFilter : IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
            if (context.Filters.Any(item => item is IAllowAnonymousFilter))
            {
                return;
            }

            if (!(context.ActionDescriptor is ControllerActionDescriptor))
            {
                return;
            }
            var attributeList = new List<object>();
            attributeList.AddRange((context.ActionDescriptor as ControllerActionDescriptor).MethodInfo.GetCustomAttributes(true));
            attributeList.AddRange((context.ActionDescriptor as ControllerActionDescriptor).MethodInfo.DeclaringType.GetCustomAttributes(true));
            var authorizeAttributes = attributeList.OfType<TestAuthorizeAttribute>().ToList();
            var claims = context.HttpContext.User.Claims;
            // 从claims取出用户相关信息,到数据库中取得用户具备的权限码,与当前Controller或Action标识的权限码做比较
            var userPermissions = "User_Edit";
            if (!authorizeAttributes.Any(s => s.Permission.Equals(userPermissions)))
            {
                context.Result = new JsonResult("没有权限");
            }
            return;

        }
    }

新建TestAuthorizeAttribute

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
    public class TestAuthorizeAttribute: AuthorizeAttribute
    {

        public string Permission { get; set; }

        public TestAuthorizeAttribute(string permission)
        {
            Permission = permission;
        }

    }

将IdentityController
[Authorize]改为[TestAuthorize(“User_Edit”)],再运行API项目。

透过修改权限码,验证是不是起效果

图片 10

除却行使过滤器和性子结合使用,貌似还有其他情势,有空再探讨。

正文中的源码

图片 11

图片 12

工作的火速发展,发生的老大多的对外的服务接口,分散在集团的依次地点须求展开联合的田间管理,而且大家的条件是linux和windows的鱼目混珠环境,我们的目的是联合在公司的Linux环境,.NET
Core对于.NET 技术团队来说是一个老大棒的技能,而且.NET
Core本身的架构万分好,质量就更好了。

图片 13

图片 14

那里列出了Ocelot近日辅助的特征:

  • Routing
    • 用户可以内定上游请求之间的照耀,并将其转化到下游服务上的不相同U奇骏L。
  • Service Discovery
    • Ocelot可以查阅你的劳动意识,并找到它应该转载下游请求的服务。它可以在那几个劳务中间展开负载平衡。.
  • Authentication using IdentityServer

    • 你可以将端点标记为已注脚,并应用IdentityServer承载标记对你的用户举办身份验证.
  • Authorisation using Claims
    • 即使应用 bearer tokens, 可以行使 claims 标记特定
      endpoints是授权的
  • Claims Transformation
    • Ocelot提供了一种语法来转换给下游请求,并将宣示数据增进到标题,UXC60L参数,其余评释等等
  • Quality of service
    • Retries, circuit breaker, timeouts etc.
  • Request / Correlation Ids
  • Caching
  • Logging
  • Custom Middleware

更详尽的情节参看文档 https://github.com/TomPallister/Ocelot/wiki 

上边介绍了Ocelot的功效特色,接下去大家进入介绍Ocelot
的落到实处原理分析,大旨是是ASP.NET Core Middleware 以及 ASP.NET Core
DependencyInjection:

图片 15

ASP.NET Core 古板的ASP.NET
在架设上有很大的精益求精,越发的模块化,下图形象的表明了他们中间不相同,Application
和 Middleware 是一致的,比如ASP.NET Core
MVC也是二个Middleware,通过Middleware那样的布局我们万分不难的恢宏大家的应用程序。

图片 16

Ocelot就是运用Middleware来成功网关的保有机能,每种小功效就是3个Middleware,具体可以看代码
https://github.com/TomPallister/Ocelot/blob/develop/src/Ocelot/Middleware/OcelotMiddlewareExtensions.cs
,Ocelot 是什么样把各种Middleware串起来共同已毕一个API网关的功效。 asp.net
core 十二分巧妙的安排,把Middleware抽象成了三个委托RequestDelegate,
ASP.NET Core 的各种 Request 都会通过每种所注册的 Middleware,Response
也是种种回传,以先进后出的法子处理每二个封包:

图片 17

具体内容参考: ASP.NET Core HTTP
管道中的那三个事情

何以一分钟从头打造二个 ASP.NET Core
中间件

大家在Middleware的编程进度中要求关爱HttpContext 以及管道的注册者和打造者
ApplicationBuilder。

 图片 18

ASP.NET Core 使用了大气的 DI (Dependency Injection)
设计,同样大家在Ocelot的筹划中也利用了多量的DI设计,具体参看源码https://github.com/TomPallister/Ocelot/blob/develop/src/Ocelot/DependencyInjection/ServiceCollectionExtensions.cs 

登记 瑟维斯 有分两种办法:

  • Transient  每一次注入时,都再也 new 二个新的实体。
  • Scoped    逐个 Request 都重新 new 1个新的实体。
  • Singleton 程序运营后会 new 2个实体。相当于运转时期只会有一个实体。

下边那张图来自https://blog.johnwu.cc/article/asp-net-core-dependency-injection.html
,形象的以身作则了目的生命周期。

图片 19

  • A 为 Singleton
  • B 为 Scoped
  • C 为 Transient

上边介绍完了Ocelot开发的基本原理,近来Ocelot 由17 个Middleware
来落成,在各种Middleware的中间贯彻上还有涉及到无数业务的学识,本篇小说先不做展开,后续写实际的篇章详细分析。接下来大家来说说怎么着自定义扩张,在大家的类型中主要在八个地点拓展了扩张:

壹 、自定义伸张API 接口验证

图片 20

Ocelot 暗中同意帮忙基于IdentityServer4的验证,要求自定义表明,可以参考
https://github.com/TomPallister/Ocelot/pull/110,添加自定义的认证,但是.net
core 2.0 认证部分基本上重写了。

贰 、自定义扩充下游通信协议

图片 21

Ocelot
暗中认同支持Http的广播发表,在我们的实际上项目中有许多老的服务是RAV4PC调用,使用的是个体的Relay通信框架,在API网关上需求做协议转换,自动将Http的请求改换到Relay的tcp通信。

三 、自定义管理控制台

图片 22

ocelot 有保管API,可以依据管理API 做自定义的治本控制台,github 有个
https://github.com/dbarkwell/Ocelot.ConfigEditor,那几个类型落到实处了asp.net
core mvc 的在线编辑路由。

相关文章