-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathadd-custom-configuration-file-using-options-and-configuration-objects.html
182 lines (171 loc) · 7.97 KB
/
add-custom-configuration-file-using-options-and-configuration-objects.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
<!DOCTYPE html>
<html lang="en-US" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
<title>Add custom configuration file in a ASP.NET Core Web Application using options and configuration objects</title>
<link rel="shortcut icon" href="/wwwroot/favicon.ico" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="language" content="en" />
<meta name="keywords" content="ASP.NET Core,ASP.NET Core web application,ASP.NET Core Configuration,appsettings.json" />
<meta name="description" content="How to add a custom configuration file in a ASP.NET Core Web Application using options and configuration objects" />
<meta name="author" content="Adrien Torris" />
<meta name="robots" content="index,follow" />
<meta name="generator" content="No404! 0.1" />
<!--<link rel="alternate" href="https://adrientorris.github.io/aspnet-core/add-custom-configuration-file-using-options-and-configuration-objects.html" hreflang="en-en" />-->
<link href="/wwwroot/css/style.css" rel="stylesheet" />
<script defer src="https://use.fontawesome.com/releases/v5.0.7/js/all.js"></script>
</head>
<body>
<div id="main_ctn" class="post_ctn">
<header>
<div id="header-content">
<h2>Blog</h2>
<ul id="social_links">
<li id="twitter_link">
<a href="https://twitter.com/AdrienTorris" target="_Blank" rel="nofollow" title="Adrien Torris sur Twitter">
<i class="fab fa-twitter fa-2x"></i>
</a>
</li>
<li id="github_link" title="Adrien Torris sur GitHub">
<a href="https://github.com/AdrienTorris" target="_Blank" rel="nofollow">
<i class="fab fa-github fa-2x"></i>
</a>
</li>
<li id="so_link">
<a href="https://stackoverflow.com/users/story/4428633" target="_Blank" rel="nofollow" title="Adrien Torris sur StackOverflow">
<i class="fab fa-stack-overflow fa-2x"></i>
</a>
</li>
<li id="linkedin_link">
<a href="https://www.linkedin.com/in/adrientorris/" target="_Blank" rel="nofollow" title="Adrien Torris sur LinkedIn">
<i class="fab fa-linkedin fa-2x"></i>
</a>
</li>
<li id="gplus_link">
<a href="https://plus.google.com/u/0/+AdrienTorris" target="_Blank" rel="nofollow" title="Adrien Torris sur Google Plus">
<i class="fab fa-google-plus-g fa-2x"></i>
</a>
</li>
</ul>
</div>
</header>
<div id="arianne_wrapper">
<ul>
<li><a href="https://adrientorris.github.io/index.html" title="">Home</a></li>
<li>ASP.NET Core</li>
<li class="active"><a href="https://adrientorris.github.io/aspnet-core/add-custom-configuration-file-using-options-and-configuration-objects.html" title="Add custom configuration file using options and configuration objects">Add custom configuration file using options and configuration objects</a></li>
</ul>
</div>
<div id="post_ctn">
<h1>Add custom configuration file using options and configuration objects</h1>
<p>It can be usefull to have multiple configuration files, and it follows some develoment best practices like the Interface Segregation Principle or the Separation of Concerns. Moreover, it allows you to have the behavior you want on each configuration file.</p>
<p>It's very simple and asy to do this using options and configuration objects.</p>
<p>The first step is to add a file in your project, here <span class="thnclwrd">customSettings.json</span>, with the content :</p>
<pre><code class="json">
{
"CustomSection1": {
"Hi": "Hi!",
"Hello": "Hello!"
},
"CustomSection2": {
"Bye": "Bye!"
}
}
</code></pre>
<p>Create the model of the configuration settings you want to add :</p>
<pre><code class="csharp">
namespace WebApplication1.Models.CustomSettings
{
public class CustomSection1
{
public string Hi { get; set; }
public string Hello { get; set; }
}
public class CustomSection2
{
public string Bye { get; set; }
}
}
</code></pre>
<p>Then, use the configuration provider you want (the <span class="thnclwrd">JSON</span> one here), and add your class to the service container and bound to configuration :</p>
<pre><code class="csharp">
public class Startup
{
public Startup(IHostingEnvironment env)
{
var builder = new ConfigurationBuilder()
.SetBasePath(env.ContentRootPath)
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
.AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
.AddJsonFile($"customSettings.json", optional: true, reloadOnChange: true)
.AddEnvironmentVariables();
if (env.IsDevelopment())
{
// This will push telemetry data through Application Insights pipeline faster, allowing you to view results immediately.
builder.AddApplicationInsightsSettings(developerMode: true);
}
Configuration = builder.Build();
}
public IConfigurationRoot Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
// Add framework services.
services.AddApplicationInsightsTelemetry(Configuration);
services.Configure<CustomSection1>(options => Configuration.GetSection("CustomSection1").Bind(options));
services.Configure<CustomSection2>(options => Configuration.GetSection("CustomSection2").Bind(options));
services.AddMvc();
}
</code></pre>
<p>Work is done ! You can now access your settings from your controllers using <span class="thnclwrd">Dependency Injection</span> on <span class="thnclwrd">IOptions<TOptions></span> :</p>
<pre><code class="csharp">
public class HomeController : Controller
{
private readonly CustomSection1 _customSection1;
private readonly CustomSection2 _customSection2;
public HomeController(
IOptions<CustomSection1> customSection1
, IOptions<CustomSection2> customSection2)
{
_customSection1 = customSection1.Value;
_customSection2 = customSection2.Value;
}
</code></pre>
<div id="crdny">December 27, 2016</div>
<div id="tags_wrapper">
<ul>
<li>ASP.NET Core</li>
<li>ASP.NET Core Configuration</li>
</ul>
</div>
<div id="refs_wrapper">
<ul>
<li><a href="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration" title="Official documentation about Configuration" target="_blank">Configuration Docs</a></li>
</ul>
</div>
</div>
<footer>
</footer>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js" type="text/javascript"></script>
<script src="/wwwroot/js/Infra.js" type="text/javascript"></script>
<link type="text/css" rel="stylesheet" href="/wwwroot/lib/highlight/styles/vs.css" />
<script type="text/javascript" src="/wwwroot/lib/highlight/highlight.pack.js"></script>
<script type="text/javascript">hljs.initHighlightingOnLoad();</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-85948839-1', 'auto');
ga('send', 'pageview');
</script>
<script async src="https://www.googletagmanager.com/gtag/js?id=G-F924P8Y6HC"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-F924P8Y6HC');
</script>
</body>
</html>