Silky 微服务框架

简体中文 |English

项目介绍

框架特性

服务引擎

模块化/插件化设计

RPC通信

服务治理

通过.net主机构建

安全设计

多种配置方式

链路跟踪

支持分布式事务

支持websocket通信

入门

示例项目

Silky.Hero权限管理系统

快速开始

基础服务

docker-compose -f docker-compose.zookeeper.yml up -d

docker-compose -f docker-compose.redis.yml up -d

创建网关

usingGateway;varhostBuilder=Host.CreateDefaultBuilder().ConfigureSilkyGatewayDefaults(webHostBuilder=>webHostBuilder.UseStartup<Startup>());awaithostBuilder.Build().RunAsync();

namespaceGateway;publicclassStartup{publicvoidConfigureService(IServiceCollectionservices){services.AddSilkyHttpServices().AddRouting().AddSwaggerDocuments().AddMiniProfiler();}publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){if(env.IsDevelopment()){app.UseSwaggerDocuments();app.UseMiniProfiler();}app.UseRouting();app.UseEndpoints(endpoints=>{endpoints.MapSilkyRpcServices();});}}

rpc:token:ypjdYOzNd4FwENJiEARMLWwK0v7QUHPWregistrycenter:type:ZookeeperconnectionStrings:127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183;127.0.0.1:2184,127.0.0.1:2185,127.0.0.1:2186distributedCache:redis:isEnabled:trueconfiguration:127.0.0.1:6379,defaultDatabase=0

业务微服务

usingMicrosoft.Extensions.Hosting;varhostBuilder=Host.CreateDefaultBuilder().ConfigureSilkyGeneralHostDefaults();awaithostBuilder.Build().RunAsync();

rpc:token:ypjdYOzNd4FwENJiEARMLWwK0v7QUHPWport:2200registrycenter:type:ZookeeperconnectionStrings:127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183;127.0.0.1:2184,127.0.0.1:2185,127.0.0.1:2186distributedCache:redis:isEnabled:trueconfiguration:127.0.0.1:6379,defaultDatabase=0

[ServiceRoute]publicinterfaceIHelloAppService{Task<string>SayHi([FromQuery]stringname);}

publicclassHelloAppService:IHelloAppService{publicTask<string>SayHi(stringname){returnTask.FromResult($"Hello{name??"World"}");}}

服务与服务之间的调用方式

publicclassPermissionManager:IPermissionManager,IScopedDependency{privatereadonlyIUserAppService_userAppService;privatereadonlyIRoleAppService_roleAppService;publicPermissionManager(IUserAppServiceuserAppService,IRoleAppServiceroleAppService){_userAppService=userAppService;_roleAppService=roleAppService;}publicasyncTask<ICollection<string>>GetUserRoleNamesAsync(longuserId){varuserRoleOutput=await_userAppService.GetRolesAsync(userId);returnuserRoleOutput.RoleNames;}publicasyncTask<ICollection<long>>GetUserRoleIdsAsync(longuserId){varuserRoleIds=await_userAppService.GetRoleIdsAsync(userId);returnuserRoleIds;}publicasyncTask<ICollection<string>>GetRolePermissionsAsync(longroleId){varrolePermissions=await_roleAppService.GetPermissionsAsync(roleId);returnrolePermissions;}}

publicclassAuthorizationHandler:SilkyAuthorizationHandlerBase{privatereadonlyIInvokeTemplate_invokeTemplate;privateconststringCheckPermissionServiceEntryId="Silky.Permission.Application.Contracts.Permission.IPermissionAppService.CheckPermissionAsync.permissionName_Get";privateconststringCheckRoleServiceEntryId="Silky.Permission.Application.Contracts.Permission.IPermissionAppService.CheckRoleAsync.roleName_Get";publicAuthorizationHandler(IInvokeTemplateinvokeTemplate){_invokeTemplate=invokeTemplate;}protectedoverrideasyncTask<bool>PolicyPipelineAsync(AuthorizationHandlerContextcontext,HttpContexthttpContext,IAuthorizationRequirementrequirement){if(requirementisPermissionRequirementpermissionRequirement){if(EngineContext.Current.HostEnvironment.EnvironmentName==SilkyHeroConsts.DemoEnvironment&&httpContext.Request.Method!="GET"){thrownewUserFriendlyException("演示环境不允许修改数据");}varserviceEntryDescriptor=httpContext.GetServiceEntryDescriptor();if(serviceEntryDescriptor.GetMetadata<bool>("IsSilkyAppService")){// todoreturntrue;}returnawait_invokeTemplate.InvokeForObjectByServiceEntryId<bool>(CheckPermissionServiceEntryId,permissionRequirement.PermissionName);}returntrue;}protectedoverrideasyncTask<bool>PipelineAsync(AuthorizationHandlerContextcontext,HttpContexthttpContext){varserviceEntryDescriptor=httpContext.GetServiceEntryDescriptor();varroles=serviceEntryDescriptor.AuthorizeData.Where(p=>!p.Roles.IsNullOrEmpty()).SelectMany(p=>p.Roles?.Split(",")).ToList();foreach(varroleinroles){if(!await_invokeTemplate.InvokeForObjectByServiceEntryId<bool>(CheckRoleServiceEntryId,role)){returnfalse;}}returntrue;}}

通过项目模板快速创建应用

> dotnet new--install Silky.App.Template

PS> dotnet new silky.app-hSilky App (C#)作者: LiuhllUsage:  dotnet new silky.app [options] [模板选项]Options:-n,--name<name>       正在创建的输出名称。如未指定名称，则使用输出目录的名称。-o,--output<output>   要放置生成的输出的位置。--dry-run               如果运行给定命令行将导致模板创建，则显示将发生情况的摘要。--force                 强制生成内容 (即使它会更改现有文件)。--no-update-check       在实例化模板时，禁用对模板包更新的检查。--project<project>     应用于上下文评估的项目。-lang,--language<C#>  指定要实例化的模板语言。--type<project>        指定要实例化的模板类型。模板选项:-t,--param:type<param:type>  Set the silky host type, optional values: webhost, generalhost,wshost, gateway                                 类型: string                                 默认: generalhost-do,--dockersupport           Add docker supportfor Silky                                 类型: bool                                 默认: true-r,--rpcport<rpcport>        Set the portfor rpc listening                                 类型: int                                 默认:2200-in,--infrastr                only include basic service orchestration files                                 类型: bool                                 默认: false-e,--env<env>                Set dotnet env                                 类型: string                                 默认: Development-m,--module                   Is it a module project                                 类型: bool                                 默认: false-p:i,--includeinfr            Whether to include the basic orchestration service.                                 类型: bool

# 创建网关> dotnet new silky.app-t gateway-n Silky.Gateway# 创建业务微服务> dotnet new silky.app-t generalhost-n Silky.Demo

贡献