AnnotationServiceBuilder 1.1.9
dotnet add package AnnotationServiceBuilder --version 1.1.9
NuGet\Install-Package AnnotationServiceBuilder -Version 1.1.9
<PackageReference Include="AnnotationServiceBuilder" Version="1.1.9" />
paket add AnnotationServiceBuilder --version 1.1.9
#r "nuget: AnnotationServiceBuilder, 1.1.9"
// Install AnnotationServiceBuilder as a Cake Addin #addin nuget:?package=AnnotationServiceBuilder&version=1.1.9 // Install AnnotationServiceBuilder as a Cake Tool #tool nuget:?package=AnnotationServiceBuilder&version=1.1.9
AnnotationServiceBuilder
Annotation Service Builder is an ASP.NET library that simplifies dependency injection by using custom annotations to automatically register services in the DI container.
Prerequisites
Web Application
- .NET 6.0 or later
- Visual Studio 2022 (or any other IDE with .NET support)
Important Note
Ensure that your .NET SDK is up-to-date. This project requires .NET 6.0 or later.
Setting up Annotations
The Annotations
folder in the project contains the key attributes used for automatically registering services in the DI container. Below are the files and their purposes, along with examples of how they are used.
Installing AnnotationServiceBuilder
Step 1: Install the AnnotationServiceBuilder NuGet Package
You can install the AnnotationServiceBuilder package via NuGet.
Using .NET Core CLI
dotnet add package AnnotationServiceBuilder
Usage
Registering Services with AnnotationServiceRegistrar
To register your services, follow these steps:
- Initialize the
AnnotationServiceRegistrar
:
AnnotationServiceRegistrar.Initialize(Assembly.GetExecutingAssembly());
- Add your services to the DI container:
AnnotationServiceRegistrar.AddSingletonServices(services);
AnnotationServiceRegistrar.AddScopedServices(services);
AnnotationServiceRegistrar.AddTransientServices(services);
AnnotationServiceRegistrar.AddRefitClients(services, "https://api.yourservice.com"); // Replace with your API base URL
If you need to use a custom DelegatingHandler
, use the following:
var customHandler = new MyCustomHandler();
AnnotationServiceRegistrar.AddRefitClients(services, "https://api.yourservice.com", customHandler);
Other Examples
1. Using Scoped Services
using AnnotationServiceBuilder.Annotations.Scoped;
[ScopedService(typeof(IMyScopedService))]
public class MyScopedService : IMyScopedService
{
// Implementation...
}
2. Using Singleton Services
using AnnotationServiceBuilder.Annotations.Singleton;
[SingletonService]
public class MySingletonService
{
// Implementation...
}
3. Using Transient Services
using AnnotationServiceBuilder.Annotations.Transient;
[TransientService]
public class MyTransientService
{
// Implementation...
}
4. Example of a Refit Client
using AnnotationServiceBuilder.Annotations.Refit;
using AnnotationServiceBuilder.Data.Models;
using Refit;
namespace AnnotationServiceBuilder.Network.Repositories
{
[RefitClient]
public interface IPostsApi
{
[Get("/posts")]
Task<List<Post>> GetPostsAsync();
[Get("/posts/{id}")]
Task<Post> GetPostByIdAsync(int id);
}
}
5. Example with Different baseUrl
for Multiple Refit Clients
using AnnotationServiceBuilder.Annotations.Refit;
using Refit;
namespace AnnotationServiceBuilder.Network.Repositories
{
[RefitClient(BaseUrl = "https://api.service1.com")]
public interface IService1Api
{
[Get("/endpoint1")]
Task<List<ResponseModel1>> GetService1DataAsync();
}
[RefitClient(BaseUrl = "https://api.service2.com")]
public interface IService2Api
{
[Get("/endpoint2")]
Task<List<ResponseModel2>> GetService2DataAsync();
}
[RefitClient(BaseUrl = "https://api.service3.com")]
public interface IService3Api
{
[Get("/endpoint3")]
Task<List<ResponseModel3>> GetService3DataAsync();
}
}
Trimming Safety Considerations
To ensure that your services are not trimmed during the optimization process, use the trimming-safe registration methods provided by AnnotationServiceBuilder. These methods will guarantee that necessary types are preserved and registered correctly.
AnnotationServiceRegistrar.Initialize(Assembly.GetExecutingAssembly());
AnnotationServiceRegistrar.AddSingletonServicesWithTrimmingSafety(services);
AnnotationServiceRegistrar.AddScopedServicesWithTrimmingSafety(services);
AnnotationServiceRegistrar.AddTransientServicesWithTrimmingSafety(services);
AnnotationServiceRegistrar.AddRefitClientsWithTrimmingSafety(services, "https://api.yourservice.com"); // Replace with your API base URL
Manual Trimming Considerations
If this approach doesn't help, you may try to manually apply trimming safety considerations.
Example of Using DynamicDependency
using System.Diagnostics.CodeAnalysis;
[SingletonService]
public class StockPartsService
{
[DynamicDependency(DynamicallyAccessedMemberTypes.All, typeof(MyDependentService))]
public StockPartsService()
{
// Method implementation ensuring MyDependentService is retained
}
}
Example of Using Preserve
using System.Runtime.CompilerServices;
[Preserve]
[SingletonService]
public class MyDependentService
{
public void PerformOperation()
{
// Implementation that must be retained during trimming
}
}
ASB: Observing the Logic of Pattern Standards
Note: Factory patterns have been moved to a new library, AnnotationServiceBuilder.Patterns. Please update your code accordingly to use the new library. For more details, see: AnnotationServiceBuilder.Patterns.
Benefits of Using AnnotationServiceBuilder
1. Automation of Service Registration
Automatically register your services in the DI container without needing to manually add each service in Startup.cs
or Program.cs
. This reduces boilerplate code and makes your setup process much more streamlined.
2. Clear and Organized Codebase
Annotations define the lifetime of services (Singleton, Scoped, Transient), making your code more organized and easier to maintain.
3. Time Efficiency
Automating service registration saves time, especially in large projects. Developers can focus on building features instead of managing service registrations manually.
4. Ease of Use
The library provides a simple, intuitive API for registering services and Refit clients, making the process user-friendly.
5. Caching for Performance
Registered classes and interfaces are cached to improve performance and reduce the overhead of repeated reflection operations.
Video Guides
For video guides on how to use AnnotationServiceBuilder, you can watch these YouTube videos:
Additional Resources
Contributing
We welcome contributions! Please submit a pull request or open an issue to discuss your ideas or report bugs.
License
This project is licensed under the MIT License.
MIT License
Copyright (c) 2024 Gennadii Ianchev
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Refit (>= 7.1.2)
- Refit.HttpClientFactory (>= 7.1.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.