{"id":38012,"date":"2019-12-11T10:05:30","date_gmt":"2019-12-11T17:05:30","guid":{"rendered":"http:\/\/devblogs.microsoft.com\/premier-developer\/?p=38012"},"modified":"2020-01-09T06:45:52","modified_gmt":"2020-01-09T13:45:52","slug":"demystifying-the-new-net-core-3-worker-service","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/premier-developer\/demystifying-the-new-net-core-3-worker-service\/","title":{"rendered":"Demystifying the new .NET Core 3 Worker Service"},"content":{"rendered":"

Premier Developer Consultant Randy Patterson<\/a> discusses the benefits of using the new Worker Service project template introduced in .NET Core 3.<\/p>\n

\n

.NET Core 3 introduced a new project template called Worker Service. This template is designed to give you a starting point for cross-platform services. As an alternate use case, it sets up a very nice environment for general console applications that is perfect for containers and microservices.<\/p>\n

<\/p>\n

Some of the benefits of using this template include the following areas.<\/p>\n

Dependency Injection<\/h2>\n

The Worker Service template configures a default Dependency injection container, ready for us to use. This is a huge benefit compared to the generic Console template.<\/p>\n

Adding Services involves updating the ConfigureServices<\/em> method in the Program.cs<\/em> file:<\/p>\n

Host.CreateDefaultBuilder(args)\r\n   .ConfigureServices((hostContext, services) =>\r\n   {\r\n      services.AddTransient<ICustomerService,CustomerService>();\r\n      services.AddHostedService<Worker>();\r\n   });<\/pre>\n
 <\/p>\n
Configuration<\/h2>\n
The same configuration providers setup for ASP.NET Core are duplicated here for Worker Services. This gives us a powerful and familiar environment for storing configuration information:<\/p>\n
    \n
  1. appsettings.json<\/li>\n
  2. appsettings.{Environment}.json<\/li>\n
  3. User Secrets (for development only)<\/li>\n
  4. Environment Variables<\/li>\n
  5. Command Line arguments<\/li>\n<\/ol>\n
    For additional information on each of the providers please see my previous article posted here<\/a>.<\/p>\n
    Logging<\/h2>\n
    Likewise, logging providers have been configured to match the default setup for ASP.Net Core, giving you the following providers:<\/p>\n
      \n
    1. Console<\/li>\n
    2. Debug<\/li>\n
    3. EventSource<\/li>\n
    4. EventLog (only when running on Windows)<\/li>\n<\/ol>\n
      You can modify the logging providers by adding a ConfigureLogging<\/em> method to the Host <\/em>object in Program.cs<\/em>:<\/p>\n
      Host.CreateDefaultBuilder(args)\r\n   .ConfigureServices((hostContext, services) =>\r\n   {\r\n      services.AddHostedService<Worker>();\r\n   })\r\n   .ConfigureLogging(logging =>\r\n   {\r\n      logging.ClearProviders();\r\n      logging.AddConsole();\r\n   });<\/pre>\n
      For additional information on logging, please see the documentation<\/a> for ASP.NET Core.<\/p>\n
      Worker Startup Class<\/h2>\n
      Finally, the Worker.cs<\/em> file is where the bulk of your code will exist. There are 3 overridable methods from the base class BackgroundService<\/em> that let you tie into the lifecycle of your application:<\/p>\n
      ExecuteAsync<\/strong> \u2013 an abstract method used as the main entry point for your application. If this method exits, then your application shuts down.<\/p>\n
      StartAsync<\/strong> \u2013 A virtual method that, when overridden, is called when the service is starting, and can be used for one-time setup of resources.<\/p>\n
      StopAsync<\/strong> \u2013 A virtual method that is called when the application is shutting down, and is a good place to release resources and dispose objects.<\/p>\n
      Summary<\/h2>\n
      The new worker service template in .NET Core 3 creates a hosting environment that is well-suited for console applications, microservices, containerized applications, and cross-platform background services. While these benefits can be configured independently of the template, the Worker Service template gives us a consistent startup environment between ASP.NET Core and Console applications.<\/p>\n
       <\/p>\n","protected":false},"excerpt":{"rendered":"
      .NET Core 3 introduced a new project template called a Worker Service. This template is designed to give you a starting point for cross-platform services.  As an alternate use case, it sets up a very nice environment for general console applications perfect for containers and microservices.<\/p>\n","protected":false},"author":582,"featured_media":38022,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[80,1],"tags":[83,62,3],"class_list":["post-38012","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-net","category-permierdev","tag-net-core","tag-microservices","tag-team"],"acf":[],"blog_post_summary":"
      .NET Core 3 introduced a new project template called a Worker Service. This template is designed to give you a starting point for cross-platform services.  As an alternate use case, it sets up a very nice environment for general console applications perfect for containers and microservices.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/posts\/38012","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/users\/582"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/comments?post=38012"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/posts\/38012\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/media\/38022"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/media?parent=38012"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/categories?post=38012"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/premier-developer\/wp-json\/wp\/v2\/tags?post=38012"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}