FactoryGenerator.Abstractions by Ivan Mazurenko

NuGet / site data
Details
Installation
Usage
How to use
- Example (source csproj, source files)
- Generated Files
Useful

NuGet / site data

Details

Info

info

Name: FactoryGenerator.Abstractions

Package Description

Author: Ivan Mazurenko

NuGet: https://www.nuget.org/packages/FactoryGenerator.Abstractions/

https://www.nuget.org/packages/FactoryGenerator.Microsoft.Extensions.DependencyInjection/

You can find more details at https://github.com/ivmazurenko/factory-generator

Source: https://github.com/ivmazurenko/factory-generator

Author

note

Ivan Mazurenko Alt text

Original Readme

note

FactoryGenerator

.NET source generator that automatically generates and registers factories

Installation

Add the following packages to your project:

$ dotnet add package FactoryGenerator.Abstractions
$ dotnet add package FactoryGenerator.Microsoft.Extensions.DependencyInjection

Usage

Add the attribute to your class

Use one of the GenerateIFactory attributes to specify how your factory should be generated:

[GenerateIFactory<int>]
public class Service(int value, Dependency dependency)
{
    // ...
}

This will generate an implementation of IFactory<int, Service>, allowing you to create instances of Service with an int parameter while automatically resolving other dependencies from the DI container. FactoryGenerator provides multiple attribute variations depending on the number of parameters your factory should accept.

Register generated factories in the DI container

The RegisterGeneratedFactories() method automatically registers all factories created by the source generator.

var serviceCollection = new ServiceCollection()
    .RegisterGeneratedFactories();

Use the factory

using var serviceProvider = serviceCollection.BuildServiceProvider();

var factory = serviceProvider.GetRequiredService<IFactory<int, Service>>();

var service = factory.Create(1);

Full sample can be found here.

About

note

Generating DI Factory based on the first parameter(s)

How to use

Example (source csproj, source files)

CSharp Project
Program.cs
Person.cs

This is the CSharp Project that references FactoryGenerator.Abstractions

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net8.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>
	<PropertyGroup>
		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
		<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath>
	</PropertyGroup>
	<ItemGroup>
	  <PackageReference Include="FactoryGenerator.Abstractions" Version="0.0.23" />
	  <PackageReference Include="FactoryGenerator.Microsoft.Extensions.DependencyInjection" Version="0.0.22" />
	  <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.8" />
	</ItemGroup>
	
</Project>

This is the use of FactoryGenerator.Abstractions in Program.cs

using FactoryGenerator.Abstractions;
using InjectDemo;
using Microsoft.Extensions.DependencyInjection;
using System;
using AutoGeneratedNamespaceFromFactoryGenerator;

Console.WriteLine("Hello, World!");
var services = new ServiceCollection();
services.RegisterGeneratedFactories();
var prov = services.BuildServiceProvider();
var factory = prov.GetRequiredService<IFactory<PersonType, PersonFactory>>();
var factoryEmployee = factory.Create(PersonType.Employee);
Console.WriteLine(factoryEmployee.Create().TypeName);

This is the use of FactoryGenerator.Abstractions in Person.cs

using FactoryGenerator.Abstractions;

namespace InjectDemo;
public enum PersonType
{
    Employee,
    Customer
}
[GenerateIFactory<PersonType>]
public class PersonFactory
{
    private readonly PersonType person;

    public PersonFactory(PersonType person)
    {
        this.person = person;
    }
    public Person Create()
    {
        return person switch
        {
            PersonType.Employee => new Employee()
            {
                TypeName = nameof(Employee)
            },
            PersonType.Customer => new Customer()
            {
                TypeName = nameof(Customer)
            },
            _ => throw new NotImplementedException()
        };
    }
}

public class Person
{
    public string Name \{ get; set; \} = string.Empty;
    public string TypeName \{ get;init; \} = string.Empty;
}

public class Employee : Person
{
}
public class Customer : Person
{
}

Generated Files

Those are taken from $(BaseIntermediateOutputPath)\GX

FactoryGenerator.Microsoft.Extensions.DependencyInjection.ServiceCollectionExtensions.g.cs
InjectDemo.PersonTypePersonFactoryFactory.g.cs

// <auto-generated/>
using FactoryGenerator.Abstractions;
using Microsoft.Extensions.DependencyInjection;

namespace AutoGeneratedNamespaceFromFactoryGenerator;

public static class ServiceCollectionExtensions
{
    public static IServiceCollection RegisterGeneratedFactories(this IServiceCollection self)
    {
        self.AddTransient<FactoryGenerator.Abstractions.IFactory<global::InjectDemo.PersonType, InjectDemo.PersonFactory>, InjectDemo.PersonTypePersonFactoryFactory>();

        return self;
    }
}

// <auto-generated/>

using FactoryGenerator.Abstractions;

namespace InjectDemo;

public sealed class PersonTypePersonFactoryFactory : FactoryGenerator.Abstractions.IFactory<global::InjectDemo.PersonType, InjectDemo.PersonFactory>
{
    

    public PersonTypePersonFactoryFactory()
    {
        
    }

    public InjectDemo.PersonFactory Create(global::InjectDemo.PersonType dependency0)
    {
        return new InjectDemo.PersonFactory(dependency0);
    }
}