SimpleFactoryGenerator 0.4.0

.NET Standard 2.0 .NET Framework 4.6.2

Requires NuGet 2.12 or higher.

Install-Package SimpleFactoryGenerator -Version 0.4.0
dotnet add package SimpleFactoryGenerator --version 0.4.0
<PackageReference Include="SimpleFactoryGenerator" Version="0.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SimpleFactoryGenerator --version 0.4.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SimpleFactoryGenerator, 0.4.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install SimpleFactoryGenerator as a Cake Addin
#addin nuget:?package=SimpleFactoryGenerator&version=0.4.0

// Install SimpleFactoryGenerator as a Cake Tool
#tool nuget:?package=SimpleFactoryGenerator&version=0.4.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SimpleFactoryGenerator version

本库用于辅助简单工厂模式(Simple Factory Pattern)的实现,即在编译时自动生成简单工厂中的条件分支语句(switch-caseif-else),从而解决该模式违背“开闭原则”(The Open/Closed Principle)的问题。

为什么使用?

关于简单工厂模式(factory-comparison)的介绍与使用,此处不予赘述。该模式的一个缺点是:需要维护一个(可能十分巨大)的条件分支结构,用于根据给定的枚举类型创建具体的实例。因此,该模式违背了“对扩展开放,对修改封闭”的设计原则,本仓库解决了这个问题。思路非常简单:设计原则只是为了便于人类维护代码的一套经验规则,用于弥补人类思维的一些局限性,那么,只需要将这部分难以维护的代码交给编译器维护,就不存在违背“设计原则”的说法了。

如何使用?

我们先来看一个传统方式实现的简单工厂,以便于对比本仓库所代替的部分:

public interface IProduct
{
}

public class Product1 : IProduct
{
}

public class Product2 : IProduct
{
}

public class SimpleFactory
{
    public IProduct Create(string type)
    {
        // NOTE: 此处便是违背了开闭原则的分支判断,例:当加入 Product3 后,
        // 需要手动在此添加一个分支 `"product_c" => new Product3(),`
        return type switch
        {
            "product_a" => new Product1(),
            "product_b" => new Product2(),
            _ => throw new IndexOutOfRangeException(),
        }
    }
}

// 使用
public static void Main()
{
    var factory = new SimpleFactory();
    IProduct product = factory.Create("product_a");
}

在使用本仓库后,将省去 SimpleFactory 的编写,而代替地,需要在具体的 Product 类型上声明一个 ProductOfSimpleFactoryAttribute<T, K>。你已经注意到:该 Attribute 使用了泛型,这需要 C# 11 的支持,为此,你需要使用 VS2022,并在 *.csproj 文件中配置:<LangVersion>preview</LangVersion>

如果你的项目无法配置 C# 11 或使用 VS 2022,导致无法直接使用 Generic-Attribute,可以参考 1.1 小节,自定义一个 Attribute 继承自 ProductOfSimpleFactoryAttribute<T, K> 即可(在 C# 11 之前允许定义泛型 Attribute,只是无法直接使用而已)。

// 也可以是 abstract class,或普通的 class,不强制要求是 interface。
public interface IProduct
{
}

[ProductOfSimpleFactory<IProduct, string>("product_a")]
public class Product1 : IProduct
{
}

[ProductOfSimpleFactory<IProduct, string>("product_b")]
public class Product2 : IProduct
{
}

// 使用
public static void Main()
{
    // SimpleFactory 静态类由本仓库提供。
    var factory = SimpleFactory
        .For<IProduct, string>()
        // .WithCache() 是可选的,使用后将帮助实现“享元模式”,缓存已创建的实例(即多次创建 key 相同的实例,将返回同一个实例。)
        .WithCache();
    IProduct product = factory.Create("product_a");
}

高级使用

其实没有多高级,就这么简单的一个需求,你还指望有什么高级的东西?

1.1 自定义 Attribute

如果你觉得 ProductOfSimpleFactoryAttribute<T, K> 声明太长、太丑、太麻烦(或者无法使用 C# 11 的泛型 Attribute 语法),可以自定义一个 Attribute 继承它,也是生效的,如:

// Generic
public class ProductAttribute : ProductOfSimpleFactoryAttribute<IPorduct, string>
{
    public ProductAttribute(string productName) : base(productName)
    {
    }
}

// Non-generic
public class ProductAttribute : ProductOfSimpleFactoryAttribute
{
    public ProductAttribute(string productName) : base(productName)
    {
    }
}

[Product("product_a")]
public class Product1 : IProduct
{
}

1.2 映射到多个目标接口

对于同一个具体产品类型,是允许供应给多个不同的目标接口的,如:

[Product("product_a")]
[Mobile("iPhone")]
public class Product1 : IProduct, IMobile
{
}

// 使用
public static void Main()
{
    var factory = SimpleFactory.For<IProduct, string>();
    IProduct product = factory.Create("product_a");

    var factory = SimpleFactory.For<IMobile, string>();
    IProduct mobile = factory.Create("iPhone");
}
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.6.2

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0 89 4/14/2022
0.3.1 72 4/3/2022
0.2.0 57 3/28/2022