ASP.NET Core - 选项系统之选项验证 - 啊晚
source link: https://www.cnblogs.com/wewant/p/17111667.html
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
就像 Web Api 接口可以对入参进行验证，避免用户传入非法的或者不符合我们预期的参数一样，选项也可以对配置源的内容进行验证，避免配置中的值与选项类中的属性不对应或者不满足预期，毕竟大部分配置都是通过字符串的方式，验证是很有必要的。
1. 注解验证
像入参验证一样，选项验证也可以通过特性注解方便地对选项类中的某个属性进行验证，这种是最简单便捷的方式。使用选项标签注解验证，需要引入 Microsoft.Extensions.Options.DataAnnotations Nuget 包。
在选项类中通过以下方式添加数据验证规则：
public class BlogOptions
{
public const string Blog = "Blog";
[StringLength(10, ErrorMessage = "Title is too long. {0} Length <= {1}")]
public string Title { get; set; }
public string Content { get; set; }
public DateTime CreateTime { get; set; }
}
之后在进行选项类配置的时候就不能直接使用 Configure 方法了，而是要用以下方式：
builder.Services.AddOptions<BlogOptions>()
.Bind(builder.Configuration.GetSection(BlogOptions.Blog))
.ValidateDataAnnotations();
2. 自定义验证逻辑
预定义的数据注解毕竟有限，在某些验证逻辑比较复杂的情况下，数据注解可能并不能完全满足我们的需求，我们可以通过 OptionsBuilder 类中的 Validate 方法传入一个委托来实现自己的验证逻辑。
builder.Services.AddOptions<BlogOptions>()
.Bind(builder.Configuration.GetSection(BlogOptions.Blog))
.Validate(options =>
{
// 标题中不能包含特殊字符
if (options.Title.Contains("eval"))
{
// 验证失败
return false;
}
// 验证通过
return true;
});
3. IValidateOptions 验证接口
如果逻辑更加复杂，通过 Validate 方法会导致代码臃肿，不好管理和维护，这时候我们可以通过 IValidateOptions 接口实现相应的选项验证类。
public class BlogValidation : IValidateOptions<BlogOptions>
{
public ValidateOptionsResult Validate(string name, BlogOptions options)
{
var failures = new List<string>();
if(options.Title.Length > 100)
{
failures.Add($"博客标题长度不能超过100个字符。");
}
if(options.Content.Length > 10000)
{
failures.Add($"博客内容太长，不能超过10000字。");
}
if (failures.Any())
{
return ValidateOptionsResult.Fail(failures);
}
return ValidateOptionsResult.Success;
}
}
然后将其注入到依赖注入容器中，可以同时注入针对同一个选项类的验证逻辑类，这些验证类都会被调用，只有全部验证逻辑通过才能正常配置。
builder.Services.Configure<BlogOptions>(builder.Configuration.GetSection(BlogOptions.Blog));
builder.Services.TryAddEnumerable(ServiceDescriptor.Singleton<IValidateOptions<BlogOptions>, BlogValidation>());
参考文章：
ASP.NET Core 中的选项模式 | Microsoft Learn
选项模式 - .NET | Microsoft Learn
面向 .NET 库创建者的选项模式指南 - .NET | Microsoft Learn
理解ASP.NET Core - 选项(Options)
ASP.NET Core 系列：
Recommend
-
7
1. IStartupFilter 上面讲到的方式虽然能够根据不同环境将Startup中的启动逻辑进行分离，但是有些时候我们还会可以根据应用中的功能点将将一系列相关中间件的注册封装到一起，从 Startup 类中分离，单独进行维护，以便更清晰地管理...
-
5
ASP.NET Core - .NET 6 的入口文件 自从.NET 6 开始，微...
-
6
1. 请求管道 请求管道是什么？请求管道描述的是一个请求进到我们的后端应用，后端应用如何处理的过程，从接收到请求，之后请求怎么流转，经过哪些处理，最后怎么返回响应。请求管道就是一次请求在后端应用的生命周期。了解请求管道，有助于...
-
7
ASP.NET Core - 自定义中间件 上一章讲了...
-
8
1. Ioc 与 DI Ioc 和DI 这两个词大家都应该比较熟悉，这两者已经在各种开发语言各种框架中普遍使用，成为框架中的一种基本设施了。 Ioc 是控制反转， Inversion of Control 的缩写，DI 是依赖注入，Inject Dependency 的缩写。...
-
12
.NET Core 依赖注入的基本用法 话接上篇，这一章介绍 .NET Core 框架自带的轻量级 Ioc 容器下服务使用的一些知识点，大家可以先看看上一篇文章 [ASP.NET Core - 依赖注入(一)] 2.3 服务...
-
6
4. ASP.NET Core默认服务 之前讲了中间件，实际上一个中间件要正常进行工作，通常需要许多的服务配合进行，而中间件中的服务自然也是通过 Ioc 容器进行注册和注入的。前面也讲到，按照约定中间件的封装一般会提供一个 User{Midd...
-
11
一个应用要运行起来，往往需要读取很多的预设好的配置信息，根据约定好的信息或方式执行一定的行为。 配置的本质就是软件运行的参数，在一个软件实现中需要的参数非常多，如果我们以 Hard Code(硬编码)的方式写在应用代码中，这样配置就会很乱，而且后续也不...
-
10
2. 配置添加 配置系统可以读取到配置文件中的信息，那必然有某个地方可以将配置文件添加到配置系统中。之前的文章中讲到 ASP.NET Core 入口文件中，builder(WebApplicationBuilder 对象) 中有一个 Configuration 属性，这里就是我们扩展添...
-
8
.NET Core 选项系统的主要实现在 Microsoft.Extensions.Options 和 Microsoft.Extensions.Options.ConfigurationExtensions 两个 Nuget 包。对于一个框架的源码进行解读，我们可以从我们常用的框架中的类或方法入手，这些类或方法就是我们解读的入口。 从上面...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK