MicroFusion is a versatile set of utility libraries designed to streamline your web application and microservices development. These libraries can be used independently and are valuable tools for addressing common infrastructural concerns, such as routing, tracing, metrics, and more. MicroFusion also helps in supporting Domain-Driven Design (DDD) and Design by Contract principles, saving you time and effort in managing these critical aspects of your projects.
One of MicroFusion's key strengths is providing a consistent abstraction layer, enabling seamless integration with essential tools such as Jaeger for distributed tracing and Prometheus for metrics collection. This abstraction ensures a standardized approach to incorporating these powerful tools into your microservices architecture. By offering this consistent abstraction layer, MicroFusion simplifies the configuration and usage of these external tools, promoting a more straightforward and unified development experience. This, in turn, allows you to focus on building robust and scalable applications without getting bogged down by the complexities of tool integration."
| Component | Description |
|---|---|
| MicroFusion | All-in-one microservices framework. |
| MicroFusion.Auth | Authentication and authorization using Identity Server. |
| MicroFusion.DesignByContract | Supports the design by contract principle. |
| MicroFusion.Domain.Common | Common Domain-Driven Design (DDD) functionalities. |
| MicroFusion.Logging | Logging with Serilog and Seq. |
| MicroFusion.Logging.Autofac | Autofac interceptors for automatic logging. |
| MicroFusion.Mediator | Implementation of the mediator pattern. |
| MicroFusion.Metrics | Metrics with AppMetrics and Prometheus. |
| MicroFusion.Tracing.Jaeger.Masstransit | Integrates Jaeger with Masstransit for distributed tracing. |
| MicroFusion.Tracing.Jaeger | Jaeger tracing. |
To get started with MicroFusion, you can simply install the all in one package. This all in one package includes all the individual components, which can also be used independently if desired.
dotnet add package MicroFusion
After installing the package, you can utilize the "UseComponent" and "AddComponent" extension methods as needed for specific components, it's enabling you to customize your configuration within the "appsettings.json" file.
// program.cs
builder.Services
.AddEndpointsApiExplorer()
.AddMicroFusion(builder.Configuration,
typeof(OrderCommandService), // Command service for Mediator
typeof(OrderQueryService)); // Query service for Mediator
builder.UseMicroFusion();
// Register services with Autofac and enable automatic logging:
builder.RegisterAssemblyTypes(typeof(GetOrderQuery).Assembly)
.Where(x => x.Name.EndsWith("Service"))
.AsImplementedInterfaces()
.EnableInterfaceInterceptors()
.InterceptedBy(typeof(LogMethodCallInterceptor)) // Enable method call logging if needed.
.InterceptedBy(typeof(LogMethodResultInterceptor)); // Enable result logging if needed.// appsettings.json
{
"Tracing": {
"Enabled": true,
"Jaeger": {
"Enabled": true,
"MaxPacketSize": 1234,
"Sampler": "",
"Udp": {
"Enabled": true,
"Host": "localhost",
"Port": 6831
}
},
"Masstransit": {
"Enabled": true,
"Endpoint": "http://localhost:4317",
"Protocol": "HttpProtobuf"
}
},
"Metrics": {
"Enabled": true,
"EnablePrometheus": true
},
"logger": {
"level": "Information",
"excludePaths": [ "/swagger", "_framework", "/_vs" ],
"console": {
"enabled": true
},
"file": {
"enabled": true,
"path": "logs/logs.txt",
"interval": "day"
},
"seq": {
"enabled": true,
"url": "http://localhost:5341",
"apiKey": ""
}
}
}You can deactivate individual components by either setting "Enabled": false or by commenting out or removing sections like this one from the logger configuration:
"file": {
"enabled": true,
"path": "logs/logs.txt",
"interval": "day"
}If you provide an incorrect value, such as an empty string, it will result in an InvalidOperationException being thrown.
In contrast to other implementations of the Mediator pattern, our Mediator doesn't require the creation of a new class for each query or command. Instead, you can work with self-descriptive methods in one service class. This approach strikes a balance between design granularity (the number of classes) and code readability.
public interface IOrderCommandService
{
Task AwaitingValidationOrder(AwaitingValidationOrderCommand cmd);
Task CancelOrder(CancelOrderCommand cmd);
Task CreateOrder(CreateOrderCommand cmd);
Task CreateOrder(CreateOrderDraftCommand cmd);
}You can create commands and queries like the examples below:
public class CancelOrderCommand : ICommand
{
public CancelOrderCommand(Guid Orderid)
{
this.OrderId = Orderid;
}
public Guid OrderId { get; }
}public class GetOrderQuery : IQuery<OrderResource>
{
public Guid Id { get; }
public GetOrderQuery(Guid id)
{
Id = id;
}
}If necessary, you can add validation using FluentValidations to a command or query, as demonstrated here:
public class CancelOrderValidation : AbstractValidator<CancelOrderCommand>
{
public CancelOrderValidation()
{
RuleFor(x => x.OrderId).NotNull();
}
}You have the flexibility to utilize these commands or queries within any of your public service methods.
public async Task CancelOrder(CancelOrderCommand cmd)
{
OrderException.ThrowIfNull(cmd);
var order = await orderRepository.GetAsync(cmd.OrderId);
order.Cancel();
await orderRepository.SaveAsync(order);
}Commands and queries are designed to be used exclusively within a single method.
You can easily incorporate HTTP routing into services that utilize Mediator by using extension methods from MicroFusion.Mediator.EndpointsExtensions. For instance, simply including app.MapDelete<CancelOrderCommand>("Order") means that when you access the /order endpoint with the HTTP delete method and the CancelOrderCommand, Mediator will automatically execute the corresponding method in the appropriate service.
When FluentValidations are applied to commands or queries, validation is automatically performed. Users will receive the appropriate validation messages and corresponding HTTP status codes.
app.MapPost<CreateOrderCommand>("Order");
app.MapDelete<CancelOrderCommand>("Order");
app.MapPost<AwaitingValidationOrderCommand>("Order/AwaitingValidation");
app.MapPost<CreateOrderDraftCommand>("Order/Draf");
app.MapGet<GetOrderQuery, OrderResource>("Order");In our implementation of Design by Contract, we refrain from using traditional "Assert" and "Ensure" methods, as seen in the Eiffel language. Instead, we employ exceptions with self-factory methods, which throw themselves when the specific conditions are met. These methods of exception are specifically designed to support Domain Model, ensuring a more precise error message for each entity, aggregate, or value object."
Look on example:
public class BankAccount
{
public void Deposit(decimal depositAmount)
{
BankAccountException.ThrowIfNegative(depositAmount, DebitCard); //error message: "'depositAmount' in 'BankAccount' with 'DebitCard: 895f1098-8a80-4539-8648-bf80bf969e3b' should be positive."
BankAccountException.ThrowIfNegative(depositAmount, DebitCard, valueName: "Amount of deposit"); //error message: "'Amount of deposit' in 'BankAccount' with 'DebitCard: 895f1098-8a80-4539-8648-bf80bf969e3b' should be positive."
BankAccountException.ThrowIfNegative(depositAmount); //error message: "'depositAmount' should be positive."
BankAccountException.ThrowIfNegative(depositAmount, message: "Custome message."); //error message: "Custome message."
Balance += amount;
}
public decimal Balance { get; private set; }
public Guid DebitCard { get; }
}Creating of exception:
public class BankAccountException: Exception<BankAccountException, BankAccount>
{
public BankAccountException()
{
}
public BankAccountException(string? message) : base(message)
{
}
public BankAccountException(string? message, Exception? innerException) : base(message, innerException)
{
}
public BankAccountException(SerializationInfo info, StreamingContext context) : base(info, context)
{
}
}