A .NET library for managing application settings, supporting JSON serialization, default and user-specific settings, and integration with dependency injection.
Get Started
$ dotnet add package Oakrey.Applications.SettingsReadme
Oakrey.Applications.Settings
Overview of the "Settings" Project The "Settings" project is a .NET 8 library designed to manage application settings efficiently. It provides functionality for loading, saving, and managing both persistent and volatile settings, with support for JSON serialization and dependency injection.
Features
Settings Management:
SettingsService provides methods to load, save, and retrieve settings. Supports both persistent and volatile settings.
JSON Integration:
Uses JsonService for JSON-based serialization and deserialization of settings. Includes a custom SettingValueConverter for handling complex types during serialization.
Default and User Settings:
Loads default settings from a predefined path. Saves user-specific settings to a configurable path.
Dependency Injection:
SettingConfigurationExtension enables seamless integration with DI containers.
Error Handling and Logging:
Integrated with Oakrey.Log for logging errors and tracing operations.
Extensibility:
Implements ISettingsService for easy customization and testing.
Caller Member Name Support:
Simplifies setting retrieval and storage by using the caller's member name as the key.
Installation
You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.
NuGet Package Manager
- Open your project in Visual Studio.
- Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
- Search for
Oakrey.Applications.Settingsand click Install.
.NET CLI
Run the following command in your terminal:
dotnet add package Oakrey.Applications.Settings
Package Manager Console
Run the following command in your Package Manager Console:
Install-Package Oakrey.Applications.Settings
Requirements
- .NET 8 or higher
Project Information
- Author: Oakrey
- Company: Oakrey
- License: MIT
- Repository: Git Repository
- Project URL: Project Website
Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.
License
This project is licensed under the MIT License. See the LICENSE file for details.