https://github.com/dreamescaper/servicescan.sourcegenerator

Assembly scanning source generator for Microsoft.Extensions.DependencyInjection
https://github.com/dreamescaper/servicescan.sourcegenerator

assembly-scanning dependency-injection dotnet source-generator

Last synced: 12 days ago
JSON representation

Assembly scanning source generator for Microsoft.Extensions.DependencyInjection

• Host: GitHub
• URL: https://github.com/dreamescaper/servicescan.sourcegenerator
• Owner: Dreamescaper
• License: mit
• Created: 2024-05-02T12:13:07.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-10-06T17:30:07.000Z (about 1 month ago)
• Last Synced: 2024-10-30T23:49:56.438Z (20 days ago)
• Topics: assembly-scanning, dependency-injection, dotnet, source-generator
• Language: C#
• Homepage:
• Size: 69.3 KB
• Stars: 26
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ServiceScan.SourceGenerator

[![NuGet Version](https://img.shields.io/nuget/v/ServiceScan.SourceGenerator)](https://www.nuget.org/packages/ServiceScan.SourceGenerator/)

Source generator for services registrations inspired by [Scrutor](https://github.com/khellang/Scrutor/).

Code generation allows to have AOT-compatible code, without an additional hit on startup performance due to runtime assembly scanning.

## Installation 

Add the NuGet Package to your project:

```

dotnet add package ServiceScan.SourceGenerator

```

## Usage

`ServiceScan` generates a partial method implementation based on `GenerateServiceRegistrations` attribute. This attribute can be added to a partial method with `IServiceCollection` parameter. 

For example, based on the following partial method:

```csharp

public static partial class ServicesExtensions

{

    [GenerateServiceRegistrations(AssignableTo = typeof(IMyService), Lifetime = ServiceLifetime.Scoped)]

    public static partial IServiceCollection AddServices(this IServiceCollection services);

}

```

`ServiceScan` will generate the following implementation:

```csharp

public static partial class ServicesExtensions

{

    public static partial IServiceCollection AddServices(this IServiceCollection services)

    {

        return services

            .AddScoped()

            .AddScoped();

    }

}

```

The only thing left is to invoke this method on your `IServiceCollection` instance

```csharp

services.AddServices();

```

## Examples

### Register all [FluentValidation](https://github.com/FluentValidation/FluentValidation) validators

Unlike using `FluentValidation.DependencyInjectionExtensions` package, `ServiceScan` is AOT-compatible, and doesn't affect startup performance:

```csharp

[GenerateServiceRegistrations(AssignableTo = typeof(IValidator<>), Lifetime = ServiceLifetime.Singleton)]

public static partial IServiceCollection AddValidators(this IServiceCollection services);

```

### Add [MediatR](https://github.com/jbogard/MediatR) handlers

```csharp

public static IServiceCollection AddMediatR(this IServiceCollection services)

{

    return services

        .AddTransient()

        .AddMediatRHandlers();

}

[GenerateServiceRegistrations(AssignableTo = typeof(IRequestHandler<>), Lifetime = ServiceLifetime.Transient)]

[GenerateServiceRegistrations(AssignableTo = typeof(IRequestHandler<,>), Lifetime = ServiceLifetime.Transient)]

private static partial IServiceCollection AddMediatRHandlers(this IServiceCollection services);

```

It adds MediatR requests handlers, although you might need to add other types like PipelineBehaviors or NotificationHandlers.

### Add all repository types from your project based on name filter as their implemented interfaces:

```csharp

[GenerateServiceRegistrations(

    TypeNameFilter = "*Repository",

    AsImplementedInterfaces = true,

    Lifetime = ServiceLifetime.Scoped)]

private static partial IServiceCollection AddRepositories(this IServiceCollection services);

```

## Parameters

`GenerateServiceRegistrations` attribute has the following properties:

| Property | Description |

| --- | --- |

| **FromAssemblyOf** |Set the assembly containing the given type as the source of types to register. If not specified, the assembly containing the method with this attribute will be used. |

| **AssignableTo** | Set the type that the registered types must be assignable to. Types will be registered with this type as the service type, unless `AsImplementedInterfaces` or `AsSelf` is set. |

| **Lifetime** | Set the lifetime of the registered services. `ServiceLifetime.Transient` is used if not specified. |

| **AsImplementedInterfaces** | If true, the registered types will be registered as implemented interfaces instead of their actual type. |

| **AsSelf** | If true, types will be registered with their actual type. It can be combined with `AsImplementedInterfaces`. In that case implemeted interfaces will be "forwarded" to an actual implementation type |

| **TypeNameFilter** | Set this value to filter the types to register by their full name. You can use '*' wildcards. You can also use ',' to separate multiple filters. |

| **KeySelector** | Set this value to a static method name returning string. Returned value will be used as a key for the registration. Method should either be generic, or have a single parameter of type `Type`. |