ardalis / cleanarchitecture.workerservice Goto Github PK

View Code? Open in Web Editor NEW

702.0 15.0 94.0 113 KB

A solution template using Clean Architecture for building a .NET Core Worker Service.

License: MIT License

C# 97.10% Dockerfile 2.90%

clean-code clean-architecture architecture hacktoberfest

cleanarchitecture.workerservice's Introduction

CleanArchitecture.WorkerService

A solution template using Clean Architecture for building a .NET 7.0 Worker Service.

Give a Star! ⭐

If you like or are using this project to learn or start your solution, please give it a star. Thanks!

Credits

Big thanks to all of the great contributors to this project!

Build Status

Getting Started

Clone or download the repository.

Install the ef core cli tools dotnet tool install --global dotnet-ef. If you already have an old version, first try dotnet tool update --global dotnet-ef --version 6.0.0-*, if that doesn't work, see Updating Ef Core Cli First, delete C:\Users{yourUser}.dotnet\tools.store\dotnet-ef tool.

This app is currently configured to run against a localdb SQL Server instance. To initialized the database, you will need to run this command in the /src/CleanArchitecture.Worker folder:

dotnet ef database update -c appdbcontext -p ../CleanArchitecture.Infrastructure/CleanArchitecture.Infrastructure.csproj -s CleanArchitecture.Worker.csproj

Check the connection string in appsettings.json in the CleanArchitecture.Worker project to verify its details if you have problems.

Open the solution in Visual Studio and run it with ctrl-F5 (the CleanArchitecture.Worker project should be the startup project) or in the console go to the src/CleanArchitecture.Worker folder and run dotnet run.

On startup the app queues up 10 URLs to hit (google.com) and you should see it make 10 requests and save them to the database and then do nothing, logging each second.

Using this for your own worker service

To use this as a template for your own worker server projects, make the following changes:

Rename CleanArchitecture to YourAppName or YourCompany.YourAppName
Configure the connection string to your database if you're using one
Replace InMemory queue implementations with Azure, AWS, Rabbit, etc. actual queues you're using
Remove UrlStatusHistory and related services and interfaces

References

Useful Pluralsight courses:

cleanarchitecture.workerservice's People

Contributors

Stargazers

Watchers

Forkers

joaodotnet billdo ulasyagan gustavogodinho rajukottedi agrwalmohit alexvarrese marcusbrunello tuongntk mridulsri john-norbjerg-hansen tirael gbarska rajakishore quaredevil bytedecoder juanmanuelcadena izrael0101 cwrx777 spartan73rmy garora alextalavari drewkill32 pgadea locmxse60602 memosoftware sji-home kubano nakunxuanviet kokaruk alexmachadodev mikos7 taherkheli duhowise uniondirfolder claireaa ppshoo moinnn toanbkmt awesomedotnetcore tsalaam dariushdragon arquitetomovel baridavid shadynagy stgrobotics ritasker anton-petrov eliezercm mohammadaminyza hadugit shivakb bintopia gayankanishka cfcrotty ermerson ucrengineer thethomashu romeriomatos nguyenducmanh2106 metosch natevolt sylla-linoha abolfathi mthadisena nealhoang yeongseon metmoawad mimranyaseenatwork minhhungit pedroduarte0 yinchinan010 heroes-and-empires-he hughlee2016 zenonfs mahendran-murugesan skadluba monicafgz angelodotnet satyadeep007-otis safouenmzah aistan-inc vasiya99 studies2023 chunweiz menteshashvili jafbueno besmiralia nordin-ma joaofranco91 carman8910 vtuxm aslanshemilov

cleanarchitecture.workerservice's Issues

change db

how can I update the db to use DynamoDB (aws)
dynamodb info:

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/CRUDHighLevelExample1.html
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GettingStarted.NET.html
https://www.youtube.com/watch?v=B190tcu1ERk
http://cdn.cdata.com/help/DDE/ado/pg_usingEFCoreIntro.htm

How to use a DbContext service in the Worker Template

I want to know how to use a dbcontext in this clean architecture worker service, because dbcontext is a scoped service and this will be a singleton.
I know that I need to use the Services.CreateScope thing, but the challenge is which project should it go? In the worker project? Core? or Infrastructure? and how?

For an ongoing project I'm creating a scope in Worker project, but I need to pass the scope service as a parameter, and that doesn't seem me right.

Create a 'dotnet new' template

See CleanArchitecture. Create and publish a dotnet new template for worker services that use Clean Architecture.

https://github.com/ardalis/CleanArchitecture/blob/main/CleanArchitecture.nuspec

Images

Add Spectre.Console to the Worker project

Make it prettier and consider using some of the color and other features by default.

See: https://www.youtube.com/watch?v=rXJ2p2Am_0I&ab_channel=NimblePros

Upgrade to .NET 6.0

Maybe, it's time to update this awesome template to .net v6.0?

Need an example of Faking IServiceScopeFactory and testing in ExecuteAsync

In the existing EntryPointServiceExecute test, null is passed into the new EntryPointService(.....).

How do I fake IServiceScopeFactory, so that I can test pieces inside of the using in ExecuteAsync of EntryPointService?

using (var scope = _serviceScopeFactory.CreateScope())
{
  // test my code here...

{"Cannot access a disposed object.\r\nObject name: 'IServiceProvider'."} after multiple runs

I added the ServiceLocator in #3. I've now found that when I run the service for multiple loops, we get {"Cannot access a disposed object.\r\nObject name: 'IServiceProvider'."}.

Upgrade to .Net Core 3.1

I need to use the template again and want it to be 3.1 for the LTS. Especially since 3.0 is only good until March 2020.

https://devblogs.microsoft.com/dotnet/announcing-net-core-3-1/

https://docs.microsoft.com/en-us/aspnet/core/migration/30-to-31?view=aspnetcore-3.1&tabs=visual-studio

I'm working on this now

Configure CI build pipeline and put build status in readme file

.NET 8 and C#12 Updates

Update Target Framework to net8.0
Use C# 12 features as applicable (primary constructors mostly)

Add Support For FastEndpoints

We already have support for Minimal API results so it would be awesome to see what work is needed to also support FastEndpoints like we do for Controllers/APIEndpoints. If any code is needed it could probably be added to the AspNetCore package unless we would like to add an Ardalis.Result.FastEndpoints package