INI 配置提供程序

Sisk 有一种除了 JSON 之外的获取启动配置的方法。实际上，任何实现 IConfigurationReader 的管道都可以与 PortableConfigurationBuilder.WithConfigurationPipeline一起使用，读取服务器配置从任何文件类型。

Sisk.IniConfiguration 包提供了一个基于流的 INI 文件读取器，不会为常见的语法错误抛出异常，并且具有简单的配置语法。该包可以在 Sisk 框架之外使用，为需要高效 INI 文档读取器的项目提供灵活性。

安装 #

要安装包，可以从以下开始：

Bash

$ dotnet add package Sisk.IniConfiguration

您也可以安装核心包，它不包括 INI IConfigurationReader，也不包括 Sisk 依赖项，只包括 INI 序列化器：

Bash

$ dotnet add package Sisk.IniConfiguration.Core

使用主包，您可以在代码中使用它，如下面的示例所示：

class Program
{
    static HttpServerHostContext Host = null!;

    static void Main(string[] args)
    {
        Host = HttpServer.CreateBuilder()
            .UsePortableConfiguration(config =>
            {
                config.WithConfigFile("app.ini", createIfDontExists: true);
                
                // 使用 IniConfigurationReader 配置读取器
                config.WithConfigurationPipeline<IniConfigurationReader>();
            })
            .UseRouter(r =>
            {
                r.MapGet("/", SayHello);
            })
            .Build();
        
        Host.Start();
    }

    static HttpResponse SayHello(HttpRequest request)
    {
        string? name = Host.Parameters["name"] ?? "world";
        return new HttpResponse($"Hello, {name}!");
    }
}

上面的代码将在进程的当前目录（CurrentDirectory）中查找 app.ini 文件。INI 文件如下所示：

INI

[Server]
# 支持多个监听地址
Listen = http://localhost:5552/
Listen = http://localhost:5553/
ThrowExceptions = false
AccessLogsStream = console

[Cors]
AllowMethods = GET, POST
AllowHeaders = Content-Type, Authorization
AllowOrigin = *

[Parameters]
Name = "Kanye West"

INI 风格和语法 #

当前实现风格：

属性和节名称是 大小写不敏感 的。
属性名称和值是修剪的，除非值被引号括起来。
值可以用单引号或双引号括起来。引号内可以有换行符。
支持使用 # 和 ; 的注释。尾部注释也是允许的。
属性可以有多个值。

详细来说，Sisk 中使用的 INI 解析器的“风格”文档可在此文档中找到。

使用以下 INI 代码作为示例：

INI

One = 1
Value = 这是一个值
Another value = "这个值
    有一个换行符"
; 下面的代码有一些颜色
[some section]
Color = Red
Color = Blue
Color = Yellow ; 不要使用黄色

解析它：

// 从字符串解析 INI 文本
IniDocument doc = IniDocument.FromString(iniText);

// 获取一个值
string? one = doc.Global.GetOne("one");
string? anotherValue = doc.Global.GetOne("another value");

// 获取多个值
string[]? colors = doc.GetSection("some section")?.GetMany("color");

配置参数 #

节和名称	允许多个值	描述
`Server.Listen`	Yes	服务器监听地址/端口。
`Server.Encoding`	No	服务器默认编码。
`Server.MaximumContentLength`	No	服务器最大内容长度（以字节为单位）。
`Server.IncludeRequestIdHeader`	No	指定 HTTP 服务器是否应发送 X-Request-Id 标头。
`Server.ThrowExceptions`	No	指定是否应抛出未处理的异常。
`Server.AccessLogsStream`	No	指定访问日志输出流。
`Server.ErrorsLogsStream`	No	指定错误日志输出流。
`Cors.AllowMethods`	No	指定 CORS Allow-Methods 标头值。
`Cors.AllowHeaders`	No	指定 CORS Allow-Headers 标头值。
`Cors.AllowOrigins`	No	指定多个 Allow-Origin 标头，逗号分隔。 AllowOrigins 有更多信息。
`Cors.AllowOrigin`	No	指定一个 Allow-Origin 标头。
`Cors.ExposeHeaders`	No	指定 CORS Expose-Headers 标头值。
`Cors.AllowCredentials`	No	指定 CORS Allow-Credentials 标头值。
`Cors.MaxAge`	No	指定 CORS Max-Age 标头值。