PrimaryConstructor：生成主构造函数的利器

PrimaryConstructor：生成主构造函数的利器

PrimaryConstructor Generate primary constructor from readonly fields 项目地址: https://gitcode.com/gh_mirrors/pr/PrimaryConstructor

项目介绍

PrimaryConstructor 是一个开源项目，旨在帮助 C# 开发者简化构造函数的生成过程。通过使用 PrimaryConstructor，开发者可以从只读字段和属性自动生成主构造函数，极大地提高了代码的编写效率。

项目技术分析

PrimaryConstructor 基于源生成器（Source Generators）技术，这是 C# 9.0 引入的一项新技术，允许在编译时生成额外的源代码。PrimaryConstructor 利用这一特性，自动生成符合特定规则的主构造函数。

技术要点

• 源生成器：利用 C# 9.0 的源生成器，PrimaryConstructor 能够在编译时动态生成代码。
• 依赖注入：通过自动生成的构造函数，PrimaryConstructor 支持将只读字段和属性作为依赖注入。
• 属性和字段标注：通过自定义属性，如 [PrimaryConstructor]、[IgnorePrimaryConstructor] 和 [IncludePrimaryConstructor]，开发者可以灵活控制哪些字段和属性应被包含或排除。

项目及技术应用场景

PrimaryConstructor 的主要应用场景是在进行依赖注入时，需要为类生成标准的主构造函数。以下是几个具体的应用场景：

1. 大型项目中的类管理：在大型项目中，手动编写每个类的主构造函数可能会非常耗时。PrimaryConstructor 可以自动化这一过程，提高开发效率。
2. 依赖注入框架：在使用依赖注入框架时，PrimaryConstructor 可以自动生成构造函数，使得依赖注入更加简单。
3. 代码重构：在重构旧代码时，PrimaryConstructor 可以帮助开发者快速生成符合新设计模式的构造函数。

使用方法

使用 PrimaryConstructor 非常简单。首先，确保你的 Visual Studio 版本为 16.8 或以上。然后，通过 NuGet 包管理器安装 PrimaryConstructor 包。

PM> Install-Package PrimaryConstructor

在类定义中使用 [PrimaryConstructor] 属性标注，并声明你的只读字段和属性。

[PrimaryConstructor]
public partial class MyService
{
    private readonly MyDependency _myDependency;
    ...
}

编译时，PrimaryConstructor 将自动生成相应的构造函数。

项目特点

PrimaryConstructor 具有以下特点：

1. 自动化生成：自动从只读字段和属性生成主构造函数，减少手动编写代码的工作量。
2. 灵活配置：通过自定义属性，开发者可以灵活控制哪些字段和属性应被包含或排除。
3. 支持继承：如果类有基类，只要基类也标注了 [PrimaryConstructor]，PrimaryConstructor 也会注入基类的字段和属性。
4. 错误提示处理：通过在 csproj 文件中添加特定配置，可以解决 Visual Studio 在源生成代码上显示错误标记的问题。

PrimaryConstructor 的出现，使得 C# 开发者在生成主构造函数时更加高效、灵活。无论是大型项目还是依赖注入框架，PrimaryConstructor 都能提供出色的支持。如果你还在手动编写构造函数，不妨尝试一下 PrimaryConstructor，体验自动化带来的便利。

PrimaryConstructor Generate primary constructor from readonly fields 项目地址: https://gitcode.com/gh_mirrors/pr/PrimaryConstructor