淺入 AutoMapper
在 Nuget 搜尋即可安裝，目前筆者使用的版本是 10.1.1，AutoMapper 的程式集大約 280KB。
AutoMapper 主要功能是將一個物件的欄位的值對映到另一個物件相應的欄位中，AutoMapper 大家應該很熟悉，這裡就不贅述了。
AutoMapper 基本使用
假如兩個如下型別：
public class TestA
{
public int A { get; set; }
public string B { get; set; }
// 剩下 99 個欄位省略
}
public class TestB
{
public int A { get; set; }
public string B { get; set; }
// 剩下 99 個欄位省略
}
我們可以通過 AutoMapper 快速將 TestA 中所有欄位的值複製一份到 TestB 中。
建立 TestA 到 TestB 的對映配置：
MapperConfiguration configuration = new MapperConfiguration(cfg =>
{
// TestA -> TestB
cfg.CreateMap<TestA, TestB>();
});
建立對映器：
IMapper mapper = configuration.CreateMapper();
使用 .Map() 方法將 TestA 中欄位的值複製到 TestB 中。
TestA a = new TestA();
TestB b = mapper.Map<TestB>(a);
對映配置
上面我們用 cfg.CreateMap<TestA, TestB>(); 建立了 TestA 到 TestB 的對映，在不配置的情況下，AutoMapper 預設會對映所有欄位。
當然，我們可以在 MapperConfiguration 中，為每個欄位定義對映邏輯。
MapperConfiguration 的建構函式定義如下：
public MapperConfiguration(Action<IMapperConfigurationExpression> configure);
這個 IMapperConfigurationExpression 是一個鏈式函式，可以為對映中的每個欄位定義邏輯。
將上面的模型類修改為如下程式碼：
public class TestA
{
public int A { get; set; }
public string B { get; set; }
public string Id { get; set; }
}
public class TestB
{
public int A { get; set; }
public string B { get; set; }
public Guid Id { get; set; }
}
建立對映表示式如下：
MapperConfiguration configuration = new MapperConfiguration(cfg =>
{
// TestA -> TestB
cfg.CreateMap<TestA, TestB>()
// 左邊是 TestB 的欄位，右邊是為欄位賦值的邏輯
.ForMember(b => b.A, cf => cf.MapFrom(a => a.A))
.ForMember(b => b.B, cf => cf.MapFrom(a => a.B))
.ForMember(b => b.Id, cf => cf.MapFrom(a => Guid.Parse(a.Id)));
});
.ForMember() 方法用於建立一個欄位的對映邏輯，有兩個表示式 ({表示式} , {表示式2})，其中表示式1代表 TestB 對映的欄位；表示式2代表這個欄位的值從何處來。
表示式2有常用幾種對映來源：
.MapFrom()從 TestA 取得；.AllowNull()設定空值；.Condition()有條件地對映；.ConvertUsing()型別轉換；
這裡筆者演示一下 .ConvertUsing() 的使用方法：
cfg.CreateMap<string, Guid>().ConvertUsing(typeof(GuidConverter));
這樣可以將 string 轉換為 Guid，其中 GuidConverter 是 .NET 自帶的轉換器，我們也可以自定義轉換器。
當然，即使不定義轉換器，string 預設也可以轉換成 Guid，因為 AutoMapper 比較機智。
對於其它內容，這裡不再贅述，有興趣可查閱文件。
對映檢查
假如 TestA 有的欄位 TestB 沒有，則不復制；TestB 有的欄位 TestA 中沒有，則此欄位不做處理(初始化值)。
預設情況，TestA 跟 TestB 中的欄位不太一致的話，可能有些地方容易造成忽略，開發者可以使用檢查器去檢查。
只需要在定義 MapperConfiguration 以及對映關係後，呼叫：
configuration.AssertConfigurationIsValid();
這個檢查方法，只應在 Debug 下使用。
當對映沒有被覆蓋時
你可以在 TestB 中增加一個 D 欄位，然後啟動程式，會提示：
AutoMapper.AutoMapperConfigurationException
因為 TestB 中的 D 欄位，沒有相應的對映。這樣，當我們在編寫對映關係時，就可以避免漏值的情況。
效能
剛使用 AutoMapper 時，大家可能會在想 AutoMapper 的原理，反射？效能如何？
這裡我們寫一個示例用 BenchmarkDotNet 測試一下。
定義 TestA：
public class TestB
{
public int A { get; set; }
public string B { get; set; }
public int C { get; set; }
public string D { get; set; }
public int E { get; set; }
public string F { get; set; }
public int G { get; set; }
public string H { get; set; }
}
定義 TestB 的屬性同上。
[SimpleJob(runtimeMoniker: RuntimeMoniker.NetCoreApp31)]
public class Test
{
private static readonly MapperConfiguration configuration = new MapperConfiguration(cfg =>
{
cfg.CreateMap<TestA, TestB>();
});
private static readonly IMapper mapper = configuration.CreateMapper();
private readonly TestA a = new TestA
{
A = 1,
B = "aaa",
C = 1,
D = "aaa",
E = 1,
F = "aaa",
G = 1,
H = "aaa",
};
[Benchmark]
public TestB Get1()
{
return new TestB { A = a.A, B = a.B, C = a.C, D = a.D, E = a.E, F = a.F, G = a.G, H = a.H };
}
[Benchmark]
public TestB Get2()
{
return mapper.Map<TestB>(a);
}
[Benchmark]
public TestA Get3()
{
return mapper.Map<TestA>(a);
}
}
測試結果如下：
BenchmarkDotNet=v0.12.1, OS=Windows 10.0.19042
Intel Core i7-3740QM CPU 2.70GHz (Ivy Bridge), 1 CPU, 8 logical and 4 physical cores
.NET Core SDK=5.0.200-preview.20601.7
[Host] : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT
.NET Core 3.1 : .NET Core 3.1.9 (CoreCLR 4.700.20.47201, CoreFX 4.700.20.47203), X64 RyuJIT
Job=.NET Core 3.1 Runtime=.NET Core 3.1
| Method | Mean | Error | StdDev |
|------- |----------:|---------:|---------:|
| Get1 | 16.01 ns | 0.321 ns | 0.284 ns |
| Get2 | 204.63 ns | 3.009 ns | 2.349 ns |
| Get3 | 182.53 ns | 2.215 ns | 2.072 ns |
Outliers
Test.Get1: .NET Core 3.1 -> 1 outlier was removed (25.93 ns)
Test.Get2: .NET Core 3.1 -> 3 outliers were removed (259.39 ns..320.99 ns)
可以看到，效能相差了 10 倍。
在提高靈活性等情況下，會犧牲一些效能，主要不是大量計算的情況下，並不會有太大效能問題。
Profile 配置
除了 MapperConfiguration 外，我們還可以使用繼承 Profile 的方式定義對映配置，實現更小粒度的控制以及模組化，ABP 框架中正是推薦了 AutoMapper 的此種方式，配合模組化。
示例如下：
public class MyProfile : Profile
{
public MyProfile()
{
// 這裡就不贅述了
base.CreateMap<TestA, TestB>().ForMember(... ...);
}
}
如果我們使用 ABP，那麼每個模組都可以定義一個 Profiles 資料夾，在裡面定義一些 Profile 規則。
一種對映定義一個 Profile 類？這樣太浪費空間了；一個模組定義一個 Profile 類？這樣太雜了。不同的程式有自己的架構，按照專案架構選擇 Profile 的粒度就好。
依賴注入
AutoMapper 依賴注入很簡單，前面我們學會了 Profile 定義配置對映，這樣我們就可用很方便地使用依賴注入框架處理對映。
①
我們在 ASP.NET Core 的 StartUp 或者 ConsoleApp 的 IServiceCollection 中，注入：
services.AddAutoMapper(assembly1, assembly2 /*, ...*/);
AutoMapper 會自動掃描 程式集(Assembly) 中型別，把繼承了 Profile 的型別提取出來。
②
如果你想更小粒度地控制 AutoMapper ，則可以使用：
services.AddAutoMapper(type1, type2 /*, ...*/);
.AddAutoMapper() 註冊的 AutoMapper 的生命週期為 transient。
③
如果你不喜歡 Profile ，那麼還可以繼續使用前面的 MapperConfiguration，示例程式碼如下：
MapperConfiguration configuration = new MapperConfiguration(cfg =>
{
cfg.CreateMap<TestA, TestB>();
});
services.AddAutoMapper(configuration);
之後我們可以通過依賴注入使用 AutoMapper，使用形式是 IMapper 型別：
public class HomeController {
private readonly IMapper _mapper;
public HomeController(IMapper mapper)
{
_mapper = mapper;
}
}
IMapper 有一個 .ProjectTo<>() 方法，可以幫助處理 IQueryable 查詢。
List<TestA> a = new List<TestA>();
... ...
_ = mapper.ProjectTo<TestB>(a.AsQueryable()).ToArray();
或者：
_ = a.AsQueryable().ProjectTo<TestB>(configuration).ToArray();
還可以配置 EFCore 使用：
_ = _context.TestA.ProjectTo<TestB>(configuration).ToArray();
_ = _context.TestA.ProjectTo<TestB>(mapper.ConfigurationProvider).ToArray();
表示式與 DTO
AutoMapper 有著不少擴充，這裡筆者介紹一下 AutoMapper.Extensions.ExpressionMapping，在 Nuget 裡面可以搜尋到。
AutoMapper.Extensions.ExpressionMapping 這個擴充實現了大量的表示式樹查詢，這個庫實現了 IMapper 擴充。
假如：
public class DataDBContext : DbContext
{
public DbSet<TestA> TestA { get; set; }
}
... ...
DataDBContext data = ... ...
配置：
private static readonly MapperConfiguration configuration = new MapperConfiguration(cfg =>
{
cfg.AddExpressionMapping();
cfg.CreateMap<TestA, TestB>();
});
假如，你要實現過濾功能：
// It's of no use
Expression<Func<TestA, bool>> filter = item => item.A > 0;
var f = mapper.MapExpression<Expression<Func<TestA, bool>>>(filter);
var someA = data.AsQueryable().Where(f); // data is _context or conllection
當然，這段程式碼沒有任何用處。
你可以實現自定義的擴充方法、表示式樹，更加便利地對 DTO 進行操作。
下面是示例：
public static class Test
{
// It's of no use
//public static TB ToType<TA, TB>(this TA a, IMapper mapper, Expression<Func<TA, TB>> func)
//{
// //Func<TA, TB> f1 = mapper.MapExpression<Expression<Func<TA, TB>>>(func).Compile();
// //TB result = f1(a);
// return mapper.MapExpression<Expression<Func<TA, TB>>>(func).Compile()(a);
//}
public static IEnumerable<TB> ToType<TA, TB>(this IEnumerable<TA> list, IMapper mapper, Expression<Func<TA, TB>> func)
{
var one = mapper.MapExpression<Expression<Func<TA, TB>>>(func).Compile();
List<TB> bList = new List<TB>();
foreach (var item in list)
{
bList.Add(one(item));
}
return bList;
}
}
當你查詢時，可以這樣使用這個擴充：
_ = _context.TestA.ToArray().ToType(mapper, item => mapper.Map<TestB>(item));