Skip to content

AiursoftWeb/Scanner

Repository files navigation

Aiursoft Scanner

MIT licensed Pipeline stat Test Coverage NuGet version (Aiursoft.Scanner) ManHours

An Automatic dependencies management system for ASP.NET Core and powers Aiursoft.

Why this project

The traditional way to add dependencies is:

service.AddScoped<MyScopedDependency>();

Which means that you have to manually inject all dependencies. When you have too many of them, it is possible to make a mistake.

How to use Aiursoft.Scanner

First, install Aiursoft.Scanner to your ASP.NET Core project from nuget.org:

dotnet add package Aiursoft.Scanner

Add the interface to your class like this:

using Aiursoft.Scanner.Abstractions;

public class MySingletonService : ISingletonDependency
{

}

public class MyScopedService : IScopedDependency
{

}

public class MyTransientService : ITransientDependency
{

}

And just call this in your StartUp.cs:

using Aiursoft.Scanner;

services.AddScannedDependencies();

That's all! All your dependencies are registered. Just use it like previous before:

public class MyController : Controller
{
    private readonly MyScopedService _service;
    public MyController(MyScopedService service)
    {
        _service = service;
    }
}

Advanced usage

When you want to register a dependency that implements an abstract, your previous way is:

public class MyClass : IAbstract
{

}
service.AddScoped<IAbstract, MyClass>();

That's fine. But now we want to register this automatically.

Add the dependency interface to your service like this:

public class MyClass : IAbstract, IScopedDependency
{

}

When you are registering all dependencies in your StartUp.cs, tell us that your project supports your abstract.

services.AddScannedDependencies(typeof(IAbstract));

And you can call it with multiple abstracts:

services.AddScannedDependencies(typeof(IAbstract1), typeof(IAbstract2), typeof(IAbstract3));

That's all! Enjoy!

How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.