FreeMapper 1.3.8

FreeMapper nuget

Table of contents

• About
• Installation
• Usage
• Contact and Contribute

About

• Quick summary

  This is free mapper between 2 c# objects, something like AutoMapper but lightweight. It doesn't need a mapping profile to work and don't throw exceptions for missing mapping profiles.

• Targeted framework

  .net8, .net10

• Version

  1.3.8

Installation

Add 'FreeMapper' nuget to project

Usage

Implementation

Implementation is very simple, you can use dependency injection or call initialization manually. You don't need a mapping profile, if something cannot be mapped it is only skipped. If you don't have configuration, than fields in objects are mapped by name and type. To implement a mapping profile you need to inherit FreeMapperProfileBase class and use Add<Destination, Source>() method in constructor to add class mappings. If source definition has only member expression (x=>x.Name) and member points to class, mapper automatically searches for profile definition for that class.

There are 4 initialization methods:

• FreeMapper.Mapper() - slowest one, in background searches all assemblies for mapping configurations
• FreeMapper.Mapper(Action<FreeMapperConfiguration> configuration) - same as above but with configuration
• FreeMapper.Mapper(Type t) - fast one, in background searches only assembly with defined type
• FreeMapper.Mapper() - same as above but with configuration

Mapper configuration exposes 4 options:

• CaseSensitiveMap - if true, property mapping is case sensitive (when map configuration is not present)(default true)
• MapDestinationPublicFields - if true, public fields + properties of destination are mapped(default false), properties are always mapped
• MapSourcePublicFields - if true, public fields + properties of source are mapped(default false), properties are always mapped
• UseAutomaticDeepMap - if true, child properties of object type are automatically mapped, if false configuration is needed(default true)

Mapper.Map function has overloaded members with posibility to set above configuration fields per call. It is possible to ignore destination fields with IgnoreField mapping function. Supported types: value types + DateTime + TimeSpan + Guid, IEnumerable + Array, Dictionary, KeyValuPair, Class/Struct (with public fields/properties).

This is example of implementation of profile:

    ```
    public class MyMappingProfile : FreeMapperProfileBase
    {
        public MyMappingProfile()
        {
            Add<Class1, Class2>()
                .AddField(dest => dest.Field1, src => src.SomeField)
                .AddField(dest => dest.ChildClass, src => src.SomeChildClass);
            Add<ChildClass, SomeChildClass>()
                .AddField(dest => dest.Field3, src => src.Field2)
        }

        public string GetWeatherForecast([Required] string from, string to)
        {
                ...
        }
        ...
    }
    ```

This is example of manual initialization and usage, for example in console project:

    ```
    Console.WriteLine("Hello, World!");
    var mapper = new FreeMapper.Mapper();
    var result = mapper.Map<SomeClass>(SomeObject);
    ```

This is example of dependency injection initialization and usage, for example in API project:

    ```
    var builder = WebApplication.CreateBuilder(args);
    builder.Services.AddFreeMapper();
    ```

Related Packages

• Microsoft.Extensions.DependencyInjection.Abstractions

Contact and Contribute

• Project owner

  Senad Lakača, senad.lakaca@gmail.com

• Git