https://github.com/existall/SimpleConfig
https://github.com/existall/SimpleConfig
configuration di-container options settings simpleconfig
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/existall/SimpleConfig
- Owner: existall
- License: mit
- Created: 2017-04-06T21:46:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-12-16T21:59:49.000Z (almost 5 years ago)
- Last Synced: 2024-11-01T07:07:24.469Z (11 months ago)
- Topics: configuration, di-container, options, settings, simpleconfig
- Language: C#
- Size: 338 KB
- Stars: 22
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ExistsForAll.SimpleSetting (previously SimpleConfig)
=====================
## Installation
`Install-Package ExistForAll.SimpleSettings`
## Table of Content
1.Introduction
2.[Getting started](https://github.com/existall/SimpleConfig/blob/master/docs/getting_started.md)
3.[Building the collection](https://github.com/existall/SimpleConfig/blob/master/docs/building_the_collection.md)
4.[Building Config Interfaces](https://github.com/existall/SimpleConfig/blob/master/docs/Build%20Config%20Interface.md)
5.[DefaultValue](https://github.com/existall/SimpleConfig/blob/master/docs/Default%20Values.md)
6.[Build Section Binders](https://github.com/existall/SimpleConfig/blob/master/docs/Build%20a%20SectionBinder.md)
7.[Extending SimpleConfig](https://github.com/existall/SimpleConfig/blob/master/docs/Extend%20Simple%20Config.md)
Introduction - or why SimpleConfig was created
----------------------------------------------
With the release of Asp.Net Core and .Net Core Microsoft has introduced `IOptions<>`.
While `IOptions<>` is a great concept it lacks in implementation.
`IOptions<>` provide a way to insert parameters into your app dynamically.
For example you have an email service that requires some URL to the email server.
``` c#
public class EmailSender
{
public EmailSender(string emailServiceUrl, ... )
{
}
}
```
All of the good IOC containers out there will tell you that injecting a string into a service is a bad idea.
The best of them won't let you do it.
`IOptions<>` to the rescue, with `IOptions<>` you can request the option class that can provide the string you want provided from any data store you want (json file, database and so on).
``` c#
public class EmailSender
{
public EmailSender(IOption configuration, ... ) { }
}
```
BUT `IOptions<>` is not the way to do this.
Why you ask ?
1. As Uncle Bob said, your application must be independent from frameworks this the application code takes an unnecessary dependency on a framework abstraction, this is a violation of DIP.
2. In order to inject `IOption` `SomeClass` have to be a concrete class and not an interface.
3. To use `IOption` you must call `services.Configure` in the `Setup` class, this is not scale-able in any way and the last thing we want to do is to manually configure each configuration class.
4. Registering `IOption<>` in any other DI container different from Microsoft new DI container won't be a ball park.
For better understanding you can read this [explenation](http://https://simpleinjector.readthedocs.io/en/latest/aspnetintegration.html#working-with-ioption-t) from the SimpleInjecor docs.
### TL;DR - or what SimpleConfig does?
Remember the `IOption configuration`?
what if we could build an interface like so
``` c#
public interface IEmailServiceConfig
{
[DefaultValue("SomeUrl")]
string ServiceUrl {get; set;}
}
```
and use it like so
``` c#
public class EmailSender : IEmailSender
{
public EmailSender(IEmailServiceConfig emailServiceConfig, ... ) { }
public void SendEmail(...)
{
Send(emailServiceConfig.ServiceUrl, ...);
}
}
```