Hexalith.Commons.Configurations 1.66.4

Hexalith.Commons.Configurations

Overview

Hexalith.Commons.Configurations is a .NET library that provides utilities for handling configuration settings in .NET applications. It simplifies the process of retrieving, validating, and managing configuration settings using Microsoft's configuration and options patterns.

Features

• Interface-based configuration settings with ISettings
• Helper methods for retrieving settings from configuration
• FluentValidation integration for validating configuration options
• Exception handling for configuration errors
• Support for Microsoft's Options pattern

Installation

Package Manager Console

Install-Package Hexalith.Commons.Configurations

.NET CLI

dotnet add package Hexalith.Commons.Configurations

Usage

Defining Settings

using Hexalith.Commons.Configurations;

public class MyAppSettings : ISettings
{
    public string ConnectionString { get; set; } = string.Empty;
    public int Timeout { get; set; } = 30;
    
    public static string ConfigurationName() => "MyApp";
}

Retrieving Settings

using Hexalith.Commons.Configurations;

// Get settings using the helper method
MyAppSettings settings = configuration.GetSettings<MyAppSettings>();

Dependency Injection

Add the settings to the service collection and configure them using the ConfigureSettings method.

using Hexalith.Commons.Configurations;

// Register services
builder.Services.ConfigureSettings<MyAppSettings>(builder.Configuration);

Get a comprehensive error message on the invalid setting in your application.

using Hexalith.Commons.Configurations;

public class MyClass 
{
    private readonly string _connectionString;

    public MyClass(IOptions<MyAppSettings> options)
    {
        // Check if the options are valid and throw a detailed exception if not
        SettingsException<MyAppSettings>.ThrowIfUndefined(options.Value.ConnectionString);
        _connectionString = options.Value.ConnectionString;
    }
}

Validating Settings with FluentValidation

using FluentValidation;
using Hexalith.Commons.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

// Create a validator for your settings
public class MyAppSettingsValidator : AbstractValidator<MyAppSettings>
{
    public MyAppSettingsValidator()
    {
        RuleFor(x => x.ConnectionString).NotEmpty();
        RuleFor(x => x.Timeout).GreaterThan(0);
    }
}

// Register settings with validation
services.ConfigureSettings<MyAppSettings>(configuration);

ISettings Interface

public interface ISettings
{
    // The name of the configuration section. For example, "MyApp:MySettings".
    static abstract string ConfigurationName();
}

The ISettings interface defines a contract for configuration settings classes. It requires implementing a static ConfigurationName() method that returns the name of the configuration section.

SettingsHelper Class

public static class SettingsHelper
{
    public static TSettings GetSettings<TSettings>(this IConfiguration configuration)
        where TSettings : class, ISettings, new();
}

The SettingsHelper class provides extension methods for retrieving settings from configuration.

FluentValidateOptions Class

public class FluentValidateOptions<TOptions> : IValidateOptions<TOptions>
    where TOptions : class
{
    public FluentValidateOptions(string? name, IServiceProvider provider);
    public ValidateOptionsResult Validate(string? name, TOptions options);
}

The FluentValidateOptions class implements IValidateOptions<TOptions> to provide FluentValidation integration for the Options pattern.

Dependencies

• FluentValidation.DependencyInjectionExtensions
• Microsoft.Extensions.Configuration.Binder
• Microsoft.Extensions.Logging.Abstractions
• Microsoft.Extensions.Options
• Microsoft.Extensions.Options.ConfigurationExtensions
• Microsoft.Extensions.Options.DataAnnotations

License

This project is licensed under the MIT License - see the LICENSE file in the project root for details.

Links

• GitHub Repository
• Project Website