Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alsami/automapper.contrib.autofac.dependencyinjection
Autofac plug-in for AutoMapper.
https://github.com/alsami/automapper.contrib.autofac.dependencyinjection
autofac autofac-container automapper ioc object-to-object
Last synced: about 1 month ago
JSON representation
Autofac plug-in for AutoMapper.
- Host: GitHub
- URL: https://github.com/alsami/automapper.contrib.autofac.dependencyinjection
- Owner: alsami
- License: mit
- Created: 2019-05-16T06:24:36.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T10:44:46.000Z (10 months ago)
- Last Synced: 2024-10-31T04:48:10.682Z (about 2 months ago)
- Topics: autofac, autofac-container, automapper, ioc, object-to-object
- Language: C#
- Homepage:
- Size: 83 KB
- Stars: 20
- Watchers: 2
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# AutoMapper.Contrib.Autofac.DependencyInjection
[](https://github.com/alsami/AutoMapper.Contrib.Autofac.DependencyInjection/actions/workflows/push.yml)
[](https://codecov.io/gh/alsami/AutoMapper.Contrib.Autofac.DependencyInjection)
[](https://www.nuget.org/packages/AutoMapper.Contrib.Autofac.DependencyInjection)
[](https://www.nuget.org/packages/AutoMapper.Contrib.Autofac.DependencyInjection)
This is a cross platform library, written in .netstandard 2.0, that serves as an extension for [autofac's containerbuilder](https://autofac.org/).
It will register all necessary classes and interfaces of Jimmy Bogard's [AutoMapper](https://github.com/AutoMapper/AutoMapper) implementation to the autofac-container
so you can use AutoMapper and object-mapping right ahead without worrying about setting up required infrastructure code.
## Installation
This package is available via nuget. You can install it using Visual-Studio-Nuget-Browser or by using the dotnet-cli
```
dotnet add package AutoMapper.Contrib.Autofac.DependencyInjection
```
If you want to add a specific version of this package
```
dotnet add package AutoMapper.Contrib.Autofac.DependencyInjection --version 1.0.0
```
For more information please visit the official [dotnet-cli documentation](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-add-package).
## Usage sample
After installing the package you define your entities and dtos and create profiles for them.
```csharp
public class Customer
{
public Guid Id { get; }
public string Name { get; }
public Customer(Guid id, string name)
{
Id = id;
Name = name;
}
}
public class CustomerDto
{
public Guid Id { get; }
public string Name { get; }
public CustomerDto(Guid id, string name)
{
Id = id;
Name = name;
}
}
public class CustomerProfile : Profile
{
public CustomerProfile()
{
CreateMap()
.ConstructUsing(user => new UserDto(user.Id, user.Name))
.ReverseMap()
.ConstructUsing(userDto => new User(userDto.Id, userDto.Name));
}
}
public static class Program
{
public static void Main(string args[])
{
var containerBuilder = new ContainerBuilder();
// here you have to pass in the assembly (or assemblies) containing AutoMapper types
// stuff like profiles, resolvers and type-converters will be added by this function
containerBuilder.RegisterAutoMapper(typeof(Program).Assembly);
var container = containerBuilder.Build();
var mapper = container.Resolve();
var customer = new Customer(Guid.NewGuid(), "Google");
var customerDto = mapper.Map(customer);
}
}
```
### Support for Property Injection
You can set `propertiesAutowired` to true to enable property based injection, just modify the prior example like so:
```csharp
public static class Program
{
public static void Main(string args[])
{
var containerBuilder = new ContainerBuilder();
// Update this line with the setting:
containerBuilder.RegisterAutoMapper(typeof(Program).Assembly, propertiesAutowired: true);
var container = containerBuilder.Build();
var mapper = container.Resolve();
var customer = new Customer(Guid.NewGuid(), "Google");
var customerDto = mapper.Map(customer);
}
}
```
### Validating your configuration
`AutoMapper` allows the user to validate their mappings. **This should only be done within a test project, since it's time-consuming**
```csharp
var containerBuilder = new ContainerBuilder();
containerBuilder.RegisterAutoMapper(typeof(Program).Assembly);
var container = containerBuilder.Build();
var mapperConfiguration = container.Resolve();
// this line will throw when mappings are not working as expected
// it's wise to write a test for that, which is always executed within a CI pipeline for your project.
mapperConfiguration.AssertConfigurationIsValid();
```