Provedores de Serviço

Provedores de Serviço são uma forma de portar sua aplicação Sisk para diferentes ambientes com um arquivo de configuração portátil. Esse recurso permite alterar a porta do servidor, parâmetros e outras opções sem precisar modificar o código da aplicação para cada ambiente. Este módulo depende da sintaxe de construção do Sisk e pode ser configurado através do método UsePortableConfiguration.

Um provedor de configuração é implementado com IConfigurationProvider, que fornece um leitor de configuração e pode receber qualquer implementação. Por padrão, o Sisk fornece um leitor de configuração JSON, mas também há um pacote para arquivos INI. Você também pode criar seu próprio provedor de configuração e registrá-lo com:

using var app = HttpServer.CreateBuilder()
    .UsePortableConfiguration(config =>
    {
        config.WithConfigReader<MyConfigurationReader>();
    })
    .Build();

Como mencionado anteriormente, o provedor padrão é um arquivo JSON. Por padrão, o nome de arquivo procurado é service-config.json, e ele é buscado no diretório atual do processo em execução, não no diretório do executável.

Você pode escolher alterar o nome do arquivo, bem como onde o Sisk deve procurar o arquivo de configuração, com:

using Sisk.Core.Http;
using Sisk.Core.Http.Hosting;

using var app = HttpServer.CreateBuilder()
    .UsePortableConfiguration(config =>
    {
        config.WithConfigFile("config.toml",
            createIfDontExists: true,
            lookupDirectories:
                ConfigurationFileLookupDirectory.CurrentDirectory |
                ConfigurationFileLookupDirectory.AppDirectory);
    })
    .Build();

O código acima procurará o arquivo config.toml no diretório atual do processo em execução. Se não for encontrado, ele buscará então no diretório onde o executável está localizado. Se o arquivo não existir, o parâmetro createIfDontExists será respeitado, criando o arquivo, sem conteúdo, no último caminho testado (com base em lookupDirectories), e um erro será lançado no console, impedindo a inicialização da aplicação.

Lendo configurações de um arquivo JSON #

Por padrão, o Sisk fornece um provedor de configuração que lê configurações de um arquivo JSON. Este arquivo segue uma estrutura fixa e é composto pelos seguintes parâmetros:

{
    "Server": {
        "DefaultEncoding": "UTF-8",
        "ThrowExceptions": true,
        "IncludeRequestIdHeader": true
    },
    "ListeningHost": {
        "Label": "My sisk application",
        "Ports": [
            "http://localhost:80/",
            "https://localhost:443/",  // Arquivos de configuração também suportam comentários
        ],
        "CrossOriginResourceSharingPolicy": {
            "AllowOrigin": "*",
            "AllowOrigins": [ "*" ],   // new on 0.14
            "AllowMethods": [ "*" ],
            "AllowHeaders": [ "*" ],
            "MaxAge": 3600
        },
        "Parameters": {
            "MySqlConnection": "server=localhost;user=root;"
        }
    }
}

Os parâmetros criados a partir de um arquivo de configuração podem ser acessados no construtor do servidor:

using var app = HttpServer.CreateBuilder()
    .UsePortableConfiguration(config =>
    {
        config.WithParameters(paramCollection =>
        {
            string databaseConnection = paramCollection.GetValueOrThrow("MySqlConnection");
        });
    })
    .Build();

Cada leitor de configuração fornece uma forma de ler os parâmetros de inicialização do servidor. Algumas propriedades são indicadas para estar no ambiente do processo em vez de serem definidas no arquivo de configuração, como dados sensíveis de API, chaves de API, etc.

Estrutura do arquivo de configuração #