.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.mzph.cn/diannao/49230.shtml

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

相关文章

设计模式实战:库存管理系统的设计与实现

简介 本篇文章将介绍如何设计一个库存管理系统,系统包括商品的创建、库存操作(如入库、出库)、库存检查等功能。我们将通过这一项目,应用工厂模式、策略模式和模板方法模式来解决具体的设计问题。 问题描述 设计一个库存管理系统,用户可以创建商品,进行入库和出库操作…

Vue.js 2 项目实战(五):水果购物车

前言 Vue.js 是一个用于构建用户界面的渐进式 JavaScript 框架。它的设计目标是通过采用易于上手的结构和强大的功能&#xff0c;使前端开发变得更加简便和高效。以下是 Vue.js 的一些关键特性和优点&#xff1a; 核心特性 声明式渲染 Vue.js 使用声明式语法来描述用户界面&a…

MybatisPlus的使用与详细讲解

今天我们来讲解一下Mybatis的升级版&#xff0c;就是MybatisPlus. MybatisPlus是如何获取实现CRUD的数据库表信息的&#xff1f; 默认以类名驼峰转下划线作为表名 默认把名为id的字段作为主键 默认把变量名驼峰转下划线作为表的字段名 1.MybatisPlus中比较常见的注解 TableN…

宠物空气净化器哪款除臭效果好?质量好的养狗空气净化器排名

作为一个宠物家电小博主&#xff0c;炎炎夏日&#xff0c;家中的宠物给你带来的不仅仅是温暖的陪伴&#xff0c;还有那挥之不去的宠物异味。普通空气净化器虽然能够应对一般的空气净化需求&#xff0c;但对于养猫家庭特有的挑战&#xff0c;如宠物毛发、皮屑和异味等&#xff0…

mysql中的索引和分区

目录 1.编写目的 2.索引 2.1 创建方法 2.2 最佳适用 2.3 索引相关语句 3.分区 3.1 创建方法 3.2 最佳适用 Welcome to Code Blocks blog 本篇文章主要介绍了 [Mysql中的分区和索引] ❤博主广交技术好友&#xff0c;喜欢文章的可以关注一下❤ 1.编写目的 在MySQL中&…

ros2--接口

什么是接口 这里的接口不是编程语言中的函数接口。而是应该理解为在ros2中进行数据通信的接口&#xff1b;这些接口在ros2中使用时必须有统一的标准&#xff0c;就像陷淖USB接口一样有着统一的通信协议。所以这里的接口更好的理解是&#xff1a;ros2数据通信的统一接口。 我们…

JAVA中的输入输出流

FileInputStream、FileOutputStream&#xff08;字节流&#xff09; 字节输入流InputStream主要方法&#xff1a; read() &#xff1a;从此输入流中读取一个数据字节。 read(byte[] b) &#xff1a;从此输入流中将最多 b.length 个字节的数据读入一个 byte 数组中。 read(b…

单例模式懒汉模式和饿汉模式

线程安全 单例模式在单线程中&#xff0c;当然是安全的。但是如果在多线程中&#xff0c;由于并行判断&#xff0c;可能会导致创建多个实例。那么如何保证在多线程中单例还是只有一个实例呢? 常见的三种方式: 局部静态变量 原理和饿汉模式相似&#xff0c;利用static只会初始…

cURL自动读取小工具

做自动化测试的时候Postman判断数据什么的太麻烦&#xff0c;做个脚本代替一下 curl_parser.py import redef parse_curl(curl_command):# 匹配所有的 -H "key: value"header_pattern re.compile(r-H "([^:]): ([^"])")headers dict(header_patte…

Redis系列命令更新--Redis有序集合命令

Redis有序集合&#xff08;sorted set&#xff09; &#xff08;1&#xff09;说明&#xff1a; A、Redis有序集合和集合一样也是string类型元素的集合&#xff0c;且不允许重复的成员&#xff1b;不同的是每个元素都会关联一个double类型的分数&#xff1b;redis正式通过分数…

Web开发:元素

元素 基础结构元素文本内容元素列表元素多媒体元素表格元素表单元素语义元素示例结构分析基础结构元素头部和导航主页部分关于部分服务部分联系部分侧边栏页脚 基础结构元素 <!DOCTYPE html>&#xff1a;声明文档类型&#xff0c;告诉浏览器使用HTML5标准解析文档。它必…

MongoDB 文档存储

安装 下载&#xff1a; Download MongoDB Community Server | MongoDB 说明&#xff1a; 现在基本都安装的是4.4以后的版本。安装完成后使用 mongod 来查看是否安装成功 会输出一堆内容 而如果想要操作数据库&#xff0c;则需要安装一个工具&#xff0c;mongosh-2.2.12-x64.m…

【2024最新华为OD-C/D卷试题汇总】[支持在线评测] 堆内存申请(100分) - 三语言AC题解(Python/Java/Cpp)

🍭 大家好这里是清隆学长 ,一枚热爱算法的程序员 ✨ 本系列打算持续跟新华为OD-C/D卷的三语言AC题解 💻 ACM银牌🥈| 多次AK大厂笔试 | 编程一对一辅导 👏 感谢大家的订阅➕ 和 喜欢💗 🍿 最新华为OD机试D卷目录,全、新、准,题目覆盖率达 95% 以上,支持题目在线…

linux(CentOS、Ubuntu)安装python3.12.2环境

1.下载官网Python安装包 wget https://www.python.org/ftp/python/3.12.2/Python-3.12.2.tar.xz 1.1解压 tar -xf Python-3.12.2.tar.xz 解压完后切换到Python-3.12.2文件夹(这里根据自己解压的文件夹路径) cd /usr/packages/Python-3.12.2/ 1.2升级软件包管理器 CentOS系…

微信小程序canvas 使用案例(一)

一、cavans 对象获取、上线文创建 1.wxml <!-- canvas.wxml --><canvas type"2d" id"myCanvas"></canvas> 2.js /*** 生命周期函数--监听页面加载*/onLoad(options) {const query wx.createSelectorQuery()query.select(#myCanvas).f…

mysql练习3

1.修改student 表中年龄(sage)字段属性&#xff0c;数据类型由int 改变为smallint 2.为Course表中Cno 课程号字段设置索引,并查看索引 3.为SC表建立按学号(sno)和课程号(cno)组合的升序的主键索引&#xff0c;索引名为SC_INDEX 4.创建一视图 stu info,查询全体学生的姓名&#…

IDEA的APIPost接口测试插件详解

APIPOST官方网址 一、安装APIPost插件 打开IntelliJ IDEA&#xff1a; 启动您的IntelliJ IDEA开发环境。 导航到插件设置&#xff1a; 在Windows或Linux上&#xff0c;点击 File > Settings。在macOS上&#xff0c;点击 IntelliJ IDEA > Preferences。 搜索并安装APIPo…

前端:上传2进制图片

1、let formData new FormData(); 2、添加要传的字段&#xff1a;formData.append("avatarfile", data); &#xff08;key,value&#xff09; 3、上传文件 function uploadImg() {// 1定义FormDatalet formData new FormData();// 2添加字段formData.append("…

安装好anaconda,打开jupyter notebook,新建 报500错

解决办法&#xff1a; 打开anaconda prompt 输入 jupyter --version 重新进入jupyter notebook&#xff1a; 可以成功进入进行代码编辑

建筑工程企业项目管理系统哪个好?试试企智汇工程项目管理系统

在建筑工程行业中&#xff0c;项目管理的复杂性和挑战性是众所周知的。随着项目规模的扩大和技术的不断进步&#xff0c;传统的管理方法已经难以满足现代建筑工程的需求。企智汇工程项目管理系统应运而生&#xff0c;为建筑工程企业提供了一个全面、智能、高效的解决方案。 一…