Mapperly 项目使用文档

Mapperly 项目使用文档

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

1. 项目的目录结构及介绍

Mapperly 是一个用于生成对象映射的 .NET 源代码生成器。以下是 Mapperly 项目的目录结构及其介绍：

mapperly/
├── src/
│   ├── Mapperly/
│   │   ├── Attributes/
│   │   ├── Builders/
│   │   ├── Diagnostics/
│   │   ├── Mappers/
│   │   ├── Options/
│   │   ├── Parser/
│   │   ├── Utilities/
│   │   ├── MapperlyGenerator.cs
│   │   ├── MapperlyGenerator.csproj
│   ├── Mapperly.Abstractions/
│   │   ├── MapperAttribute.cs
│   │   ├── Mapperly.Abstractions.csproj
├── tests/
│   ├── Mapperly.Tests/
│   │   ├── Mappers/
│   │   ├── Mapperly.Tests.csproj
├── .gitignore
├── Mapperly.sln
├── README.md

目录结构说明

• src/Mapperly/: 包含 Mapperly 的核心代码。
  • Attributes/: 包含用于定义映射器的属性。
  • Builders/: 包含用于构建映射代码的类。
  • Diagnostics/: 包含用于诊断和报告问题的类。
  • Mappers/: 包含具体的映射器实现。
  • Options/: 包含映射器的配置选项。
  • Parser/: 包含用于解析映射定义的类。
  • Utilities/: 包含各种工具类。
  • MapperlyGenerator.cs: 源代码生成器的主类。
  • MapperlyGenerator.csproj: Mapperly 项目的项目文件。
• src/Mapperly.Abstractions/: 包含映射器的抽象定义。
  • MapperAttribute.cs: 定义映射器属性的类。
  • Mapperly.Abstractions.csproj: 抽象定义的项目文件。
• tests/Mapperly.Tests/: 包含 Mapperly 的测试代码。
  • Mappers/: 包含映射器的测试类。
  • Mapperly.Tests.csproj: 测试项目的项目文件。
• .gitignore: Git 忽略文件。
• Mapperly.sln: Mapperly 的解决方案文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

Mapperly 的启动文件是 MapperlyGenerator.cs，它位于 src/Mapperly/ 目录下。这个文件包含了源代码生成器的主类 MapperlyGenerator，负责在编译时生成映射代码。

启动文件内容概述

// MapperlyGenerator.cs
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;

namespace Riok.Mapperly.Generators
{
    [Generator]
    public class MapperlyGenerator : ISourceGenerator
    {
        public void Initialize(GeneratorInitializationContext context)
        {
            // 初始化代码生成器
        }

        public void Execute(GeneratorExecutionContext context)
        {
            // 执行代码生成逻辑
        }
    }
}

启动文件功能说明

• Initialize 方法：用于初始化代码生成器。
• Execute 方法：包含具体的代码生成逻辑，负责生成映射代码。

3. 项目的配置文件介绍

Mapperly 的配置文件主要是项目文件 MapperlyGenerator.csproj 和 Mapperly.Abstractions.csproj，它们位于 src/Mapperly/ 和 src/Mapperly.Abstractions/ 目录下。

配置文件内容概述

MapperlyGenerator.csproj

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
    <PackageId>Riok.Mapperly</PackageId>
    <Version>1.0.0</Version>
    <Authors>Your Name</Authors

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