Bread.Ioc.Generator 1.5.7

Bread.IoC.Generator

Bread.IoC.Generator is a Source Generator for the Bread.IoC library. It simplifies dependency registration by automatically generating code at compile time, ensuring a seamless and efficient development experience.

Features

• Automatic Dependency Registration: Detects and registers dependencies in IoC containers automatically.
• Compile-Time Validation: Ensures correctness of dependency registration during compilation.
• Lightweight and Fast: Optimized for minimal overhead during the build process.
• Native AOT Compatibility: Fully supports .NET Native AOT scenarios.
• Customizable: Allows developers to extend and customize the generated code.

Installation

You can install Bread.IoC.Generator via NuGet:

dotnet add package Bread.IoC.Generator

Getting Started

1. Add the Source Generator to Your Project

Reference the Bread.IoC.Generator package in your project. Ensure it is added as an analyzer:

<ProjectReference Include="..\Bread.IoC.Generator\Bread.IoC.Generator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />

2. Define Your IoC Container

Create a class that inherits from IoCContainer and define your dependencies in the Bootstrap method:

using Bread.IoC;

public class MyIoCContainer : IoCContainer 
{ 
	protected override void Bootstrap(IBootstrapper ioc) 
	{
		ioc.Regist<MyService>();
	} 
}

3. Let the Generator Do the Work

The Source Generator will automatically detect and register dependencies during compilation. You can inspect the generated code in the obj\Debug\netX.X\generated directory.

Advanced Features

Custom Dependency Registration

The generator supports advanced scenarios, such as custom dependency registration patterns. For example:

ioc.Regist<IMyInterface, MyImplementation>();

Debugging the Source Generator

To debug the Source Generator, add the following code to the Initialize method in the generator:

if (!System.Diagnostics.Debugger.IsAttached) 
{
	System.Diagnostics.Debugger.Launch();
}

Then attach a debugger to the build process (dotnet or devenv).

Limitations

• Bread.IoC Dependency: Bread.IoC.Generator is designed to work exclusively with the Bread.IoC library.
• Singleton Only: The generator assumes all dependencies are registered as singletons.

License

This project is licensed under the MIT License.

Repository

For more information, visit the GitHub repository.

Start using Bread.IoC.Generator to simplify your dependency management today!