Start Me Up: Configuration and DI in ASP.NET Core

Slide 1

Slide 1 text

#startMeUp C O N F I G A N D D I I N A S P . N E T C O R E @ j e f f r e y s t r a u ss

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

global.asax web.config

Slide 4

Slide 4 text

No content

Slide 5

Slide 5 text

No content

Slide 6

Slide 6 text

No content

Slide 7

Slide 7 text

ASP.NET Core

Slide 8

Slide 8 text

ASP.NET Core PROGRAM STARTUP

Slide 9

Slide 9 text

host

Slide 10

Slide 10 text

public class Program { public static Main(string[] args) { CreateWebHostBuilder(args).Build().Run(); } public static IWebHostBuilder CreateWebHostBuilder(string[] args) => WebHost.CreateDefaultBuilder(args) .UseStartup(); } PROGRAM.CS

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

IWebHostBuilder

Slide 14

Slide 14 text

WebHost.CreateDefaultBuilder

Slide 15

Slide 15 text

public static IWebHostBuilder CreateWebHostBuilder(string[] args) => WebHost.CreateDefaultBuilder(args) .UseStartup(); PROGRAM.CS

Slide 16

Slide 16 text

public static IWebHostBuilder CreateWebHostBuilder(string[] args) => new WebHostBuilder() .UseContentRoot(Directory.GetCurrentDirectory()) .UseKestrel() .UseIISIntegration() .UseEnvironment("Development") .UseStartup(); PROGRAM.CS

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

3.0

Slide 20

Slide 20 text

generic host

Slide 21

Slide 21 text

generic host MESSAGING BACKGROUND TASKS NON-HTTP

Slide 22

Slide 22 text

public class Program { public static Main(string[] args) { CreateHostBuilder(args).Build().Run(); } public static IHostBuilder CreateHostBuilder(string[] args) => Host.CreateDefaultBuilder(args); } PROGRAM.CS

Slide 23

Slide 23 text

Slide 24

Slide 24 text

configuration

Slide 25

Slide 25 text

web.config

Slide 26

Slide 26 text

WEB.CONFIG

Slide 27

Slide 27 text

web.config

Slide 28

Slide 28 text

configuration providers

Slide 29

Slide 29 text

providers SETTINGS FILES USER SECRETS ENVIRONMENT COMMAND LINE

Slide 30

Slide 30 text

appsettings.json

Slide 31

Slide 31 text

appsettings.{env}.json

Slide 32

Slide 32 text

{ "FooServiceSettings": { "Url": "api.fooservice.nl", "Timeout": 60 }, "Setting1": "Value1" } APPSETTINGS.JSON

Slide 33

Slide 33 text

{ "FooServiceSettings": { "Url": "dev-api.fooservice.nl", "Persist": false } } APPSETTINGS.DEVELOPMENT .JSON

Slide 34

Slide 34 text

{ "FooServiceSettings": { "Url": "dev-api.fooservice.nl", "Persist": false } } APPSETTINGS.DEVELOPMENT .JSON

Slide 35

Slide 35 text

No content

Slide 36

Slide 36 text

user secrets

Slide 37

Slide 37 text

Slide 38

Slide 38 text

netcoreapp2.2 18b6c74c-731d-4590-8a07-3d46a29b9228 MYDEMO.CSPROJ

Slide 39

Slide 39 text

../MyDemo/ $ dotnet user-secrets list No secrets configured for this application. CLI TOOLING

Slide 40

Slide 40 text

../MyDemo/ $ dotnet user-secrets list No secrets configured for this application. ../MyDemo/ $ dotnet user-secrets set "FooServiceSettings:ApiKey" "abcde12345" Successfully saved FooServiceSettings:ApiKey = abcde12345 to the secret store. CLI TOOLING

Slide 41

Slide 41 text

secrets.json

Slide 42

Slide 42 text

No content

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

ASPNETCORE_

Slide 45

Slide 45 text

3.0

Slide 46

Slide 46 text

DOTNET_

Slide 47

Slide 47 text

launchSettings.json

Slide 48

Slide 48 text

launch.json

Slide 49

Slide 49 text

new WebHostBuilder() .ConfigureAppConfiguration((builderContext, config) => { config.AddJsonFile("settings.json") .AddXmlFile("config.xml", optional: true) .AddInMemoryCollection( Dictionary ) .AddCommandLine(args) }) .UseStartup(); PROGRAM.CS

Slide 50

Slide 50 text

WebHost.CreateDefaultBuilder(args) .ConfigureAppConfiguration((builderContext, config) => { config.AddJsonFile("settings.json") .AddXmlFile("config.xml", optional: true) .AddInMemoryCollection( Dictionary ) .AddCommandLine(args) }) .UseStartup(); PROGRAM.CS

Slide 51

Slide 51 text

No content

Slide 52

Slide 52 text

IConfiguration

Slide 53

Slide 53 text

// assuming IConfiguration is injected as _config _config.GetValue("Setting1"); // "Value1" _config.GetValue("FooServiceSettings:ApiKey"); // "abcde12345" DEMOCLASS.CS

Slide 54

Slide 54 text

// assuming IConfiguration is injected as _config _config.GetValue("Setting1"); // "Value1" _config.GetValue("FooServiceSettings:ApiKey"); // "abcde12345" var section = _config.GetSection("FooServiceSettings"); section.GetValue("Timeout") // 60 DEMOCLASS.CS

Slide 55

Slide 55 text

No content

Slide 56

Slide 56 text

public class FooServiceSettings { public string Url { get; set; } public string ApiKey { get; set; } public int Timeout { get; set; } public bool Persist { get; set; } } FOOSERVICESETTINGS.CS

Slide 57

Slide 57 text

// assuming IConfiguration is injected as _config var options = new FooServiceSettings(); var configSection = _config.GetSection("FooServiceSettings"); DEMOCLASS.CS configSection.Bind(options);

Slide 58

Slide 58 text

// options: {FooServiceSettings} // ApiKey [string]: "abcde12345" // Persist [bool]: false // Timeout [int]: 60 // Url [string]: dev-api.fooservice.nl DEMOCLASS.CS configSection.Bind(options);

Slide 59

Slide 59 text

IOptions

Slide 60

Slide 60 text

services

Slide 61

Slide 61 text

startup

Slide 62

Slide 62 text

public class Startup { public void ConfigureServices(IServiceCollection services) { // optionally register services here... } public void Configure(IApplicationBuilder app, IHostingEnvironment env) { // register middleware and build HTTP pipeline here... } } STARTUP .CS

Slide 63

Slide 63 text

Slide 64

Slide 64 text

No content

Slide 65

Slide 65 text

IServiceCollection

Slide 66

Slide 66 text

public void ConfigureServices(IServiceCollection services) {b private IConfiguration _config; public Startup(IConfiguration config) {c _config = config; }c public class Startup {a }a STARTUP .CS

Slide 67

Slide 67 text

}c STARTUP .CS public void ConfigureServices(IServiceCollection services) {b services.Configure(b _config.GetSection("FooServiceSettings") ); }b public class Startup {a }a

Slide 68

Slide 68 text

public class FooService { private FooServiceSettings _settings; public FooService(IOptions settings) { _settings = settings.Value; } } FOOSERVICE.CS

Slide 69

Slide 69 text

public class FooService { private FooServiceSettings _settings; public FooService(IOptions settings) { _settings = settings.Value; } } FOOSERVICE.CS

Slide 70

Slide 70 text

IOptionsSnapshot

Slide 71

Slide 71 text

IOptionsMonitor

Slide 72

Slide 72 text

No content

Slide 73

Slide 73 text

public interface IFooService { void Connect(); List GetFoos(); } IFOOSERVICE.CS public class FooService : IFooService { public void Connect() { // ... } public List GetFoos() { // ... } } FOOSERVICE.CS

Slide 74

Slide 74 text

STARTUP .CS public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddScoped(); } }

Slide 75

Slide 75 text

STARTUP .CS public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddScoped( typeof(IFooService), typeof(FooService) ); } }

Slide 76

Slide 76 text

STARTUP .CS public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddScoped( new FooService( args ) ); } }

Slide 77

Slide 77 text

service lifetimes TRANSIENT SCOPED SINGLETON

Slide 78

Slide 78 text

extension methods

Slide 79

Slide 79 text

services.AddDbContext(options => options.UseSqlServer( Configuration.GetConnectionString("FooConn") )b ); STARTUP .CS public class Startup {a public void ConfigureServices(IServiceCollection services) {a }a }a

Slide 80

Slide 80 text

services.AddMvc(); )b ); STARTUP .CS public class Startup {a public void ConfigureServices(IServiceCollection services) {a }a }a

Slide 81

Slide 81 text

3.0

Slide 82

Slide 82 text

services.AddControllers(); services.AddControllersWithViews(); services.AddRazorPages(); )b ); STARTUP .CS public class Startup {a public void ConfigureServices(IServiceCollection services) {a }a }a

Slide 83

Slide 83 text

No content

Slide 84

Slide 84 text

public static class FooExtensions { public static IServiceCollection AddFoo( this IServiceCollection services, string logPath) { services.AddSingleton(); services.AddScoped(); services.AddSingleton(sp => new FooLogger(logPath)); return services; } } FOOEXTENSIONS.CS

Slide 85

Slide 85 text

Slide 86

Slide 86 text

Slide 87

Slide 87 text

Slide 88

Slide 88 text

STARTUP .CS public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddMvc() .AddFoo( path ) .AddDbContext(...) .AddIdentity(...) } }

Slide 89

Slide 89 text

pipeline

Slide 90

Slide 90 text

middleware

Slide 91

Slide 91 text

Middleware 1 Middleware 2 Middleware 3 // inbound logic await next(); // inbound logic // inbound logic // outbound logic // outbound logic // outbound logic Request Response await next();

Slide 92

Slide 92 text

Middleware 1 Middleware 2 Middleware 3 // inbound logic await next(); // inbound logic // inbound logic // outbound logic // outbound logic // outbound logic Request Response await next();

Slide 93

Slide 93 text

Middleware 1 Middleware 2 Middleware 3 // inbound logic await next(); // inbound logic // inbound logic // outbound logic // outbound logic // outbound logic Request Response

Slide 94

Slide 94 text

if (env.IsDevelopment()) STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) {a }a

Slide 95

Slide 95 text

app.UseHttpsRedirection(); if (env.IsDevelopment()) {a app.UseDeveloperExceptionPage(); }a else {a app.UseHsts(); }a STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) {a }a

Slide 96

Slide 96 text

app.UseHttpsRedirection(); app.UseStaticFiles(); app.UseMvc(routes => {a routes.MapRoute( "default", "{controller=Home}/{action="Index"}/{id?}"); }); else {a app.UseHsts(); }a STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) {a }a

Slide 97

Slide 97 text

Slide 98

Slide 98 text

app.UseHttpsRedirection(); app.UseStaticFiles(); app.UseMvc(routes => { routes.MapRoute( "default", "{controller=Home}/{action="Index"}/{id?}"); }); else { app.UseHsts(); } STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) {a }a

Slide 99

Slide 99 text

No content

Slide 100

Slide 100 text

STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) { app.Run(async (context) => { // do some logic on the context await context.Response.WriteAsync("I'm done!"); }); }

Slide 101

Slide 101 text

STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) { app.Use(async (context, next) => { // do some inbound logic on the request await next(); // do some outbound logic on the response }); }

Slide 102

Slide 102 text

STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) { app.UseHttpsRedirection(); app.Use(async (context, next) => { // do some inbound logic on the request await next(); // do some outbound logic on the response }); app.UseStaticFiles(); }

Slide 103

Slide 103 text

public async Task Invoke(HttpContext context) {a private readonly RequestDelegate _next; public FooMiddleware(RequestDelegate next) {a _next = next; }a public class FooMiddleware {b }b FOOMIDDLEWARE.CS

Slide 104

Slide 104 text

public async Task Invoke(HttpContext context) {a // do some inbound logic on the request await next(); // do some outbound logic on the response }a }a public class FooMiddleware {b }b FOOMIDDLEWARE.CS

Slide 105

Slide 105 text

FOOMIDDLEWAREEXTENSIONS.CS public static class FooMiddlewareExtensions {b public static IApplicationBuilder UseFoo( this IApplicationBuilder app) { return app.UseMiddleware(); } }b

Slide 106

Slide 106 text

STARTUP .CS public void Configure( IApplicationBuilder app, IHostingEnvironment env) { app.UseHttpsRedirection(); app.UseFoo(); app.UseStaticFiles(); }