Spectre.Console.Cli注入服务的几种姿势
Spectre.Console
大家可能都不陌生,写控制台程序美化还是不错的,支持着色,表格,图标等相当nice,如果对这个库不熟悉我强烈推荐你了解一下,对于写一些CLI小工具还是相当方便的, 本文主要讲讲 Spectre.Console.Cli
的服务注入, TA是 Spectre.Console 库的一部分,用于创建命令行界面(CLI)应用程序。它提供了一个强大且易于使用的API来定义命令、参数和选项,同时支持 Spectre.Console 的丰富输出格式化功能。
一个官方极简的例子,定义一个GreetCommand:
public class GreetCommand : Command<GreetCommand.Settings>
{
public class Settings : CommandSettings
{
[CommandArgument(0, "<name>")]
[Description("The name of the person to greet.")]
public string Name { get; set; }
[CommandOption("-r|--repeat <times>")]
[Description("The number of times to repeat the greeting.")]
[DefaultValue(1)]
public int Repeat { get; set; }
}
public override int Execute(CommandContext context, Settings settings)
{
for (int i = 0; i < settings.Repeat; i++)
{
Console.WriteLine($"Hello, {settings.Name}!");
}
return 0;
}
}
接下来,在程序的入口点配置Command
public class Program
{
public static int Main(string[] args)
{
var app = new CommandApp();
app.Configure(config =>
{
config.AddCommand<GreetCommand>("greet");
});
return app.Run(args);
}
}
那么我们需要在GreetCommand中注入服务应该怎么做呢? 比如下面的一个服务:
public class HelloService(ILogger<HelloService> logger)
{
public Task<string> SayHello(string name, int age)
{
//注入的logger
logger.LogInformation("SayHello called with name:{name},age:{age}", name, age);
return Task.FromResult($"Hello,My name is {name}, I`m {age} years old!");
}
}
其实Spectre.Console.Cli
内置了最简单的方式,我们只需要在app.Configure
中完成:
var services = new ServiceCollection();
//添加服务
services.AddSingleton<HelloService>();
//添加日志
services.AddLogging(config =>
{
config.AddConsole();
});
var sp = services.BuildServiceProvider();
app.Configure(config =>
{
//添加Commands
config.AddCommand<OneCommand>("one");
config.AddCommand<AnotherCommand>("another");
//注册Services
config.Settings.Registrar.RegisterInstance(sp.GetRequiredService<HelloService>());
});
注册的服务就可以直接使用了:
public class HelloCommand(HelloService helloService) : AsyncCommand<HelloCommand.HelloSettings>
{
private readonly HelloService _helloService = helloService;
public class HelloSettings : CommandSettings
{
[CommandArgument(0, "<name>")]
[Description("The target to say hello to.")]
public string Name { get; set; } = null!;
}
public override async Task<int> ExecuteAsync(CommandContext context, HelloSettings settings)
{
var message = await _helloService.SayHello(settings.Name, settings.Age);
AnsiConsole.MarkupLine($"[blue]{message}[/]");
return 0;
}
}
另外的一个注入方式是实现ITypeRegistrar
,官方提供MSDI的用例,自己也可以实现Autofac
等其他DI,下面是MSDI的实现:
namespace Infrastructure
{
public sealed class MsDITypeRegistrar(IServiceCollection services) : ITypeRegistrar
{
private readonly IServiceCollection _services =
services ?? throw new ArgumentNullException(nameof(services));
public ITypeResolver Build()
{
return new TypeResolver(_services.BuildServiceProvider());
}
public void Register(Type service, Type implementation)
{
_services.AddSingleton(service, implementation);
}
public void RegisterInstance(Type service, object implementation)
{
_services.AddSingleton(service, implementation);
}
public void RegisterLazy(Type service, Func<object> factory)
{
_services.AddSingleton(service, (provider) => factory());
}
}
internal sealed class TypeResolver(IServiceProvider provider) : ITypeResolver
{
public object? Resolve(Type? type)
{
if (provider is null || type is null)
{
return null;
}
return ActivatorUtilities.GetServiceOrCreateInstance(provider, type);
}
}
}
使用的话只需要实例化CommandApp
时候传入MsDITypeRegistrar即可:
var services = new ServiceCollection();
//添加服务...
var app = new CommandApp(new MsDITypeRegistrar(services));
app.Configure(config =>
{
//...
});
return app.Run(args);
除了上面的方式,我们其实还可以使用ICommandInterceptor
切面的方式来完成注入的操作:
下面我们定义一个AutoDIAttribute
特性,实现一个AutoDIInterceptor
的拦截器,后者主要给标记了AutoDI
的属性服务赋值
[AttributeUsage(AttributeTargets.Property, Inherited = true)]
public class AutoDIAttribute : Attribute{ }
/// <summary>
/// 自动注入的拦截器
/// </summary>
internal class AutoDIInterceptor(IServiceProvider serviceProvider) : ICommandInterceptor
{
public void Intercept(CommandContext context, CommandSettings settings)
{
var type = settings.GetType();
var properties = type.GetProperties();
foreach (var property in properties)
{
var isAutoInject = property.GetCustomAttributes<AutoDIAttribute>(true).Any();
if (isAutoInject)
{
var service = ActivatorUtilities.GetServiceOrCreateInstance(serviceProvider, property.PropertyType);
property.SetValue(settings, service);
}
}
}
}
接下来在CommandSettings中标记需要自动注入服务的属性,如下面的HelloService
:
internal class AutoDICommand : AsyncCommand<AutoDICommand.AnotherInjectSettings>
{
public class AnotherInjectSettings : CommandSettings
{
/// <summary>
/// 使用切面装载的服务
/// </summary>
[AutoDI]
public HelloService HelloService { get; set; } = null!;
[Description("user name")]
[DefaultValue("vipwan"), CommandOption("-n|--name")]
public string Name { get; set; } = null!;
[Description("user age")]
[DefaultValue(12), CommandOption("-a|--age")]
public int Age { get; set; }
}
public override async Task<int> ExecuteAsync(CommandContext context, AnotherInjectSettings settings)
{
var message = await settings.HelloService.SayHello(settings.Name, settings.Age);
AnsiConsole.MarkupLine($"[green]{message}[/]");
return 0;
}
}
然后在app.Configure
中使用AutoDIInterceptor
切面:
var services = new ServiceCollection();
//添加服务
services.AddSingleton<HelloService>();
var sp = services.BuildServiceProvider();
app.Configure(config =>
{
//设置自动注入的拦截器
config.SetInterceptor(new AutoDIInterceptor(sp));
config.AddCommand<AutoDICommand>("di");
//...
});
然后测试运行程序:
dotnet run -- di -n "vipwan"
大功告成:
24.cnblogs.com/blog/127598/202407/127598-20240724180421239-1298412615.png)
以上就介绍了几种在Spectre.Console.Cli
注入服务的方式,当然没有最优的只有最适合自己的,如果代码存在不足,或者你有更好的建议 欢迎留言交流!
Spectre.Console.Cli注入服务的几种姿势的更多相关文章
- Angular服务的5种创建方式
config配置块 Angular应用的运行主要分为两部分:app.config()和app.run(),config是你设置任何的provider的阶段,从而使应用可以使用正确的服务,需要注意的是在 ...
- 介绍Angular的注入服务
其实angular的注入服务是挺复杂的,目前看源码也只看懂了一半,为了不误导大家,我也不讲敢讲太复杂,怕自己都理解错了. 首先我们要知道angular的三种注入方式: 第一种:inference va ...
- angularJS自定义服务的几种方式
在angularJS中定义服务共有四种常见的方式:factory,service,provider,constant,value 使用形式的不同: 1)factory以返回对象的形式定义服务: mya ...
- 【aspnetcore】在过滤器(Filter)中使用注入服务(ServiceFilter|TypeFilter)
在MVC中,AOP是很常用的功能,我们经常会使用如 ActionFilter,IAuthorizeFilter 等描述对Controller和Action进行约束和扩展,一般做法如下: public ...
- ASPNETCOREAPI 跨域处理 SQL 语句拼接 多条件分页查询 ASPNET CORE 核心 通过依赖注入(注入服务)
ASPNETCOREAPI 跨域处理 AspNetCoreApi 跨域处理 如果咱们有处理过MV5 跨域问题这个问题也不大. (1)为什么会出现跨域问题: 浏览器安全限制了前端脚本跨站点的访问资源, ...
- .net core 注入中的三种模式:Singleton、Scoped 和 Transient
从上篇内容不如题的文章<.net core 并发下的线程安全问题>扩展认识.net core注入中的三种模式:Singleton.Scoped 和 Transient 我们都知道在 Sta ...
- 避免在ASP.NET Core 3.0中为启动类注入服务
本篇是如何升级到ASP.NET Core 3.0系列文章的第二篇. Part 1 - 将.NET Standard 2.0类库转换为.NET Core 3.0类库 Part 2 - IHostingE ...
- .NET 使用自带 DI 批量注入服务(Service)和 后台服务(BackgroundService)
今天教大家如何在asp .net core 和 .net 控制台程序中 批量注入服务和 BackgroundService 后台服务 在默认的 .net 项目中如果我们注入一个服务或者后台服务,常规的 ...
- springboot+dubbo之多端口注入服务
前面介绍了,springboot+dubbo基础整合,这篇介绍多端口注入服务. springboot使用@Bean注入dubbo服务,当你是单一的ProviderConfig实例,dubbo的@Ser ...
- Guice 学习(六)使用Provider注入服务( Provider Inject Service)
1.定义接口 package com.guice.providerInject; import com.google.inject.ProvidedBy; public interface Servi ...
随机推荐
- Java 8 中Stream用法
Stream是Java 8新增的接口,Stream可以认为是一个高级版本的 Iterator. 废话不多说直接上代码 package com.example.demo; import org.juni ...
- k8s 怎么精准获取deployment关联的pods?
标签获取 我们获取那些pods属于某个deployment时最先想到的可能是通过标签获取,其实这个是不准确的.因为标签并不是唯一的,也就是说不同deployment其实是能有相同标签的. replic ...
- 最好的在线PDF转换工具服务
工作中有时候会碰到需要转换PDF文件的情况,现在网上就要很多免费的在线工具,可以进行PDF文件的转换,下面就来介绍一些可以直接在浏览器中将文档.电子表格.和图片转换为PDF或者互相转换的服务工具. ...
- Qt-FFmpeg开发-视频播放【硬解码】(2)
Qt-FFmpeg开发-视频播放[硬解码] 目录 Qt-FFmpeg开发-视频播放[硬解码] 1.概述 2.实现效果 3.FFmpeg硬解码流程 4.主要代码 6.完整源代码 更多精彩内容 个人内容分 ...
- uniapp 输入有值后按钮变色
我们在开发中难免会遇到一些登录注册输入框中的值为空时,按钮的状态变成为不可点击的状态,当输入框有值后就把按钮变为可点击的状态 代码部分: <input placeholder="请输入 ...
- 使用itextPDF实现PDF电子公章工具类
使用itextPDF实现PDF电子公章工具类 一.制作公章 在线网站:印章生成器 - Kalvin在线工具 (kalvinbg.cn) 然后对公章进行下载保存 盖章图片: 二.生成数字签名 2.1: ...
- The solution of P3012
problem & blog 很明显是个 DP. 于是我们定义 \(dp_{i,j,k}\) 为末尾的字符的 ASCII 码为 \(i\),有 \(j\) 个大写字母,\(k\) 个小写字母. ...
- win11 恢复Win10右键菜单的方法
1.Win+R运行CMD 2.输入:reg add HKCU\Software\Classes\CLSID\{86ca1aa0-34aa-4e8b-a509-50c905bae2a2}\InprocS ...
- AgileConfig-1.9.4 发布,支持 OpenTelemetry
Hello 大家好,最新版的 AgileConfig 1.9.4 发布了.现在它可以通过 OpenTelemetry 对外提供 logs,traces,metrics 三个维度的数据.用户可以自由选择 ...
- 使用嵌套的ScriptableObject及ReorderableList创建习题持久化数据
使用嵌套的ScriptableObject及ReorderableList创建习题持久化数据 效果展示 题集持久化数据:存储题目,可以直接在inspector面板上创建对应的问题子项 问题持久化数据 ...