Riok.Mapperly 安装与配置指南

Riok.Mapperly 安装与配置指南

mapperly A .NET source generator for generating object mappings. No runtime reflection. 项目地址: https://gitcode.com/gh_mirrors/ma/mapperly

什么是Mapperly

Mapperly是一个高性能的对象映射代码生成工具，它能在编译时自动生成对象映射代码，避免了传统映射库在运行时反射带来的性能损耗。通过使用Source Generator技术，Mapperly能够提供接近手写代码的性能表现。

安装步骤

通过NuGet安装

Mapperly可以通过NuGet包管理器轻松安装到项目中。以下是几种常见的安装方式：

1. 通过项目文件安装

编辑项目文件(.csproj)，添加以下PackageReference：

<PackageReference 
    Include="Riok.Mapperly" 
    Version="最新版本号" 
    ExcludeAssets="runtime" 
    PrivateAssets="all" />

2. 使用.NET CLI安装

在项目目录下执行以下命令：

dotnet add package Riok.Mapperly

安装完成后，建议修改生成的PackageReference，添加ExcludeAssets="runtime"和PrivateAssets="all"属性。

3. 使用Package Manager Console安装

在Visual Studio的Package Manager Console中执行：

Install-Package Riok.Mapperly

同样，安装后需要手动添加上述属性。

配置选项

保留运行时属性引用

默认情况下，Mapperly会在编译时移除属性引用。如果需要保留这些引用以便运行时使用，可以配置：

<PropertyGroup>
  <MapperlyAbstractionsScope>runtime</MapperlyAbstractionsScope>
</PropertyGroup>

或者通过定义常量：

<PropertyGroup>
  <DefineConstants>$(DefineConstants);MAPPERLY_ABSTRACTIONS_SCOPE_RUNTIME</DefineConstants>
</PropertyGroup>

注意事项

1. 当选择保留运行时属性引用时，确保PackageReference中没有排除runtime资产。

2. 如果使用的是预发布版本，请注意API可能会发生变化。

3. Mapperly的设计目标是零运行时依赖，因此默认配置会排除runtime资产。

最佳实践

1. 对于生产环境，建议使用稳定版本而非预发布版本。

2. 除非确实需要在运行时访问映射属性，否则保持默认配置以获得最佳性能。

3. 在团队项目中，建议统一安装方式以避免配置不一致问题。

通过以上步骤，你就可以成功将Mapperly集成到你的项目中，并开始享受高性能的对象映射体验了。

mapperly A .NET source generator for generating object mappings. No runtime reflection. 项目地址: https://gitcode.com/gh_mirrors/ma/mapperly