.NET C# 配置 Options

.NET C# 配置 Options

使用 options 模式可以带来许多好处,包括清晰的配置管理、类型安全、易于测试和灵活性。但在使用过程中,也需要注意配置复杂性、性能开销和依赖框架等问题。通过合理设计和使用,可以充分发挥 options 模式的优势,提高代码的可维护性和可靠性。

文章目录

  • .NET C# 配置 Options
    • 1 IConfigureOptions
      • 1.1 说明
      • 1.2 使用
    • 2 IOptionsMonitor
      • 2.1 说明
      • 2.2 使用
    • 3 IValidateOptions
      • 3.1 说明
      • 3.2 使用

环境 .NET6

1 IConfigureOptions

1.1 说明

IConfigureOptions<TOptions> 接口用于配置选项类的实例。通过实现 IConfigureOptions<TOptions> 接口,你可以在应用程序启动时对选项进行额外的配置。

IConfigureOptions<TOptions> 接口定义了一个方法 Configure,用于配置选项类的实例。其定义如下:

public interface IConfigureOptions<in TOptions> where TOptions : class
{void Configure(TOptions options);
}
优点说明
集中配置可以在一个地方集中配置选项,避免在多个地方重复配置。
动态配置可以根据运行时条件动态配置选项。
分离关注点将配置逻辑与业务逻辑分离,提高代码的可维护性。
易于测试可以单独测试配置逻辑,确保配置的正确性。
缺点
增加复杂性对于简单配置场景,使用 IConfigureOptions<TOptions> 可能会增加额外的复杂性。
配置顺序依赖配置的顺序可能会影响最终的配置结果,需要注意配置的执行顺序。

1.2 使用

配置类:

public class SettingsBase
{public override string ToString(){return string.Join(Environment.NewLine, this.GetType().GetProperties().Select(p =>{if (p.GetValue(this, null) is IList list){return p.Name + " = " + string.Join(", ", list.Cast<object>());}return p.Name + " = " + p.GetValue(this, null);}));}
}public class TestSettings : SettingsBase
{public string StringSetting { get; set; }public int IntSetting { get; set; }public bool BoolSetting { get; set; }public double DoubleSetting { get; set; }public DateTime DateTimeSetting { get; set; }public List<string> ListSetting { get; set; }
}

配置器:

public class TestSettingsConfigurator : IConfigureOptions<TestSettings>
{public void Configure(TestSettings options){options.BoolSetting = true;options.DateTimeSetting = DateTime.Now;options.DoubleSetting = 0.123456789;options.IntSetting = 123456789;options.ListSetting = new List<string> { "Item1", "Item2", "Item3" };options.StringSetting = "Test String";}
}

依赖注入:

public class Program
{public static void Main(string[] args){var builder = WebApplication.CreateBuilder(args);// Add services to the container.builder.Services.AddControllers();// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbucklebuilder.Services.AddEndpointsApiExplorer();builder.Services.AddSwaggerGen();// 注册配置器builder.Services.AddSingleton<IConfigureOptions<TestSettings>, TestSettingsConfigurator>();var app = builder.Build();// Configure the HTTP request pipeline.if (app.Environment.IsDevelopment()){app.UseSwagger();app.UseSwaggerUI();}app.UseHttpsRedirection();app.UseAuthorization();app.MapControllers();app.Run();}
}

控制器:

[Route("api/[controller]")]
[ApiController]
public class ConfigsController : ControllerBase
{private readonly IOptions<TestSettings> _testSettingsOptions;private readonly ILogger<ConfigsController> _logger;public ConfigsController(ILogger<ConfigsController> logger, IOptions<TestSettings> testConfigureOptions){_testSettingsOptions = testConfigureOptions;_logger = logger;}[HttpGet("GetConfig")]public IActionResult GetConfig(){return Ok(_testSettingsOptions.Value);}
}

测试:

image-20240719142932647

2 IOptionsMonitor

2.1 说明

IOptionsMonitor<TOptions> ,用于监控选项更改并提供选项的即时快照。它的主要作用是提供一种方法来在选项值更改时得到通知,并且在应用程序运行时获取当前的选项值。

//
// 摘要:
//     用于在选项实例更改时通知。
//
// 类型参数:
//   TOptions:
//     选项类型。
public interface IOptionsMonitor<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] out TOptions>
{//// 摘要://     使用Microsoft.Extensions.Options.Options.DefaultName返回当前的options实例。TOptions CurrentValue { get; }//// 摘要://     返回具有给定名称的配置的TOptions实例。TOptions Get(string name);//// 摘要://     注册一个监听器,当命名选项发生变化时调用。//// 参数://   listener://     当选项发生变化时调用的操作。//// 返回结果://     一个可销毁对象,以停止监听变化。IDisposable OnChange(Action<TOptions, string> listener);
}

IOptionsMonitor<TOptions> 提供以下功能:

  1. 获取当前值:可以获取选项的当前值。
  2. 变更通知:当选项值更改时,可以订阅通知。

IOptionsMonitor<TOptions> 应用场景:

  • 需要在运行时动态更新配置。
  • 需要对配置的变化进行响应。

2.2 使用

控制器:

[HttpGet("GetMonitorConfig")]
public IActionResult GetMonitorConfig()
{return Ok(_testSettingsMonitor.CurrentValue);
}

测试:

image-20240719144542637

3 IValidateOptions

3.1 说明

IValidateOptions<TOptions> ,用于验证选项值的有效性。通过实现这个接口,你可以确保配置的值符合预期的规则和约束,在应用程序启动时或配置变更时进行验证。IValidateOptions<TOptions> 接口定义了一种方法,用于验证选项实例的值,并返回验证结果。它提供了一种集中管理选项验证逻辑的方式。

public interface IValidateOptions<TOptions> where TOptions : class
{//// 摘要://     验证指定的命名选项实例(当name为null时,验证全部)。//// 参数://   name://     正在验证的选项实例的名称。////   options://     options实例。//// 返回结果://     Microsoft.Extensions.Options.ValidateOptionsResult 结果。ValidateOptionsResult Validate(string name, TOptions options);
}

3.2 使用

验证器:

public class TestSettingsValidator : IValidateOptions<TestSettings>
{public ValidateOptionsResult Validate(string? name, TestSettings options){if (string.IsNullOrEmpty(options.StringSetting)){return ValidateOptionsResult.Fail("StringSetting cannot be null or empty.");}if (options.DoubleSetting >= 1){return ValidateOptionsResult.Fail("DoubleSetting must be greater than 1.");}return ValidateOptionsResult.Success;}
}

依赖注入:

builder.Services.AddSingleton<IValidateOptions<TestSettings>, TestSettingsValidator>();

测试:

202407191458490

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/380126.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【.NET全栈】ASP.NET开发Web应用——计算器

文章目录 一、简单计算器二、复杂计算器 一、简单计算器 新建Web应用项目&#xff0c;窗体页面 窗体设计代码&#xff1a; <% Page Language"C#" AutoEventWireup"true" CodeBehind"Default.aspx.cs" Inherits"AdoDemo.Default"…

JVM:常用工具总结

文章目录 一、jstat工具 一、jstat工具 Jstat工具是JDK自带的一款监控工具&#xff0c;可以提供各种垃圾回收、类加载、编译信息等不同的数据。使用方法为&#xff1a;jstat -gc进程ID每次统计的时间间隔&#xff08;毫秒&#xff09;统计次数。 C代表Capacity容量&#xff0c…

数据库系统概论:事务与并发一致性问题

随着网络应用的普及&#xff0c;数据库并发问题变得越来越重要。数据库并发指的是多个用户或进程同时访问和操作数据库的能力。它是数据库系统性能优化的重要方面&#xff0c;旨在提高系统的吞吐量和响应时间&#xff0c;以满足多用户同时访问数据库的需求。然而&#xff0c;这…

使用viso画流程图做PPT

参考链接&#xff1a;Visio如何快速制作流程图_哔哩哔哩_bilibili 调出框图&#xff1a; 将需要的图形拖过来 小四的话&#xff0c;是12pt 连接框图 改变线的连接类型 添加箭头 选中所有需要添加箭头的图片&#xff0c;然后选择不同样式的箭头&#xff0c;查看号他们的朝向…

测试用例的设计方法

等价类 等价类概念&#xff1a;在所有测试的数据中&#xff0c;具有某种共同特征的数据子集 边界值 边界值分析是对程序输入或输出的边界值进行测试的一种黑盒测试方法 边界值是作为等价类的补充&#xff0c;其主要区别是&#xff1a; 边界值测试设计不是从某一个等价类中…

jenkins 插件版本冲突

一、Jenkins安装git parameter 插件重启后报错与临时解决方案 cd /root/.jenkins cp config.xml config.xml.bak vim config.xml <authorizationStrategy class"hudson.security.FullControlOnceLoggedInAuthorizationStrategy"><denyAnonymousReadAcces…

邮件安全篇:邮件传输加密(SSL/TLS or STATRTTLS)

1. 前言 使用过邮件客户端的同学一定见过下面这张图。这是客户端账号配置界面&#xff0c;里面有SSL、STARTTLS选项。刚接触邮件客户端的同学肯定会有这些疑问&#xff1a;什么是SSL&#xff1f;什么是STARTTLS&#xff1f;两者有什么区别&#xff1f;具体该如何选择呢&#x…

echarts实现3d柱状效果

代码如下&#xff0c;单个的调第一个方法&#xff0c;多个柱状的调第二个方法&#xff0c;具体情况修改参数或者二次开发即可 //3d柱状图 export function getEcharts3DBar (xAxisData:string[][name1,name2,name3], data:number[][1,2,3], colorObj:IBaseObject{topStartColo…

ubuntu 更新源

前言 实现一键替换在线源 一键更新源 ubuntu 全球镜像站以下支持现有ubuntu 20&#xff0c;22&#xff0c;24 echo "Delete the default source" rm -rf /etc/apt/sources.listecho "Build a new source" cat <<EOF>>/etc/apt/sources.li…

Kafka介绍及Go操作kafka详解

文章目录 Kafka介绍及Go操作kafka详解项目背景解决方案面临的问题业界方案ELKELK方案的问题日志收集系统架构设计架构设计组件介绍将学到的技能消息队列的通信模型点对点模式 queue发布/订阅 topicKafka介绍Kafka的架构图工作流程选择partition的原则ACK应答机制Topic和数据日志…

Unity: TextMeshPro生成中文字体(附3.5k,7k,2w常用字集)

免费常用3千5&#xff0c;7千字&#xff0c;2万字中文字体包 1.选择Window/TextMeshPro/Font Asset Creator 注&#xff1a;准备字体&#xff1a;从字体库或其他来源获取中文字体文件&#xff0c;通常为.ttf、.otf或.ttc格式。最简单的方式是从Windows系统文件的Font文件夹里…

Kafka(四) Consumer消费者

一&#xff0c;基础知识 1&#xff0c;消费者与消费组 每个消费者都有对应的消费组&#xff0c;不同消费组之间互不影响。 Partition的消息只能被一个消费组中的一个消费者所消费&#xff0c; 但Partition也可能被再平衡分配给新的消费者。 一个Topic的不同Partition会根据分配…

Linux云计算 |【第一阶段】SERVICES-DAY4

主要内容&#xff1a; DHCP概述、PXE批量装机、配置PXE引导、Kickstart自动应答、Cobbler装机平台 一、DHCP服务概述及原理 DHCP动态主机配置协议&#xff08;Dynamic Host Configuration Protocol&#xff09;&#xff0c;由IETF&#xff08;Internet网络工程师任务小组&…

【JavaScript 算法】最长公共子序列:字符串问题的经典解法

&#x1f525; 个人主页&#xff1a;空白诗 文章目录 一、算法原理状态转移方程初始条件 二、算法实现注释说明&#xff1a; 三、应用场景四、总结 最长公共子序列&#xff08;Longest Common Subsequence&#xff0c;LCS&#xff09;是字符串处理中的经典问题。给定两个字符串…

[算法题]买卖股票的最好时机(一)

题目链接: 买卖股票的最好时机(一) 利用贪心, 并且遍历求解, 从前往后遍历, 每遍历到一个位置就在该天卖出, 利用一个变量保存在第 i 天卖出时, 在区间 [0, i-1] 中的最小买入价格, 再用一个变量保存每次卖出的最大值, 不断遍历更新卖出的最大值即可. 图示: 题解代码: #inc…

PHP上门按摩专业版防东郊到家系统源码小程序

&#x1f486;‍♀️【尊享级体验】上门按摩专业版&#xff0c;告别东郊到家&#xff0c;解锁全新放松秘籍&#xff01;&#x1f3e0;✨ &#x1f525;【开篇安利&#xff0c;告别传统束缚】&#x1f525; 亲们&#xff0c;是不是厌倦了忙碌生活中的疲惫感&#xff1f;想要享…

问题:4、商业保险与政策性保险的主要不同之处是:经营主体不同、经营目标不同、承保机制不同。 #学习方法#其他#学习方法

问题&#xff1a;4、商业保险与政策性保险的主要不同之处是&#xff1a;经营主体不同、经营目标不同、承保机制不同。 参考答案如图所示

CH552G使用IAP下载

常见下载中的方式ISP&#xff0c;IAP&#xff0c;ICP 参考&#xff0c;CH552G中文手册&#xff0c;参考1 ISP&#xff1a;In System Programing&#xff0c;在系统编程。是常见的&#xff0c;使用软件&#xff0c;先将某个引脚&#xff08;例如boot&#xff09;连接到合适的电…

从微软发iPhone,聊聊企业设备管理

今天讲个上周的旧闻&#xff0c;微软给员工免费发iPhone。其实上周就有很多朋友私信问我&#xff0c;在知乎上邀请我回答相关话题&#xff0c;今天就抽点时间和大家一起聊聊这事。我不想讨论太多新闻本身&#xff0c;而是更想聊聊事件的主要原因——微软企业设备管理&#xff0…

私有化种子索引器bitmagnet

本文软件由网友 P家单推人 推荐 什么是 bitmagnet &#xff1f; bitmagnet 是一个自托管的 BitTorrent 索引器、DHT 爬虫、内容分类器和 torrent 搜索引擎&#xff0c;带有 Web UI、GraphQL API 和 Servarr 堆栈集成。 需要注意的是&#xff0c;该软件目前还处于 alpha 阶段。它…