深入理解C#管道式編程

更新時(shí)間：2021年07月08日 17:15:38 作者：hippiezhou

這篇文章主要給大家介紹了關(guān)于C#管道式編程的介紹與實(shí)現(xiàn)方法，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家學(xué)習(xí)或者使用C#具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧

前言

在 C# 編程中，管道式編程（Pipeline Style programming）其實(shí)存在已久，最明顯的就是我們經(jīng)常使用的 LINQ。在進(jìn)入 DotNetCore 世界后，這種編程方式就更加明顯，比如各種中間件的使用。通過使用這種編程方式，大大提高了代碼的可維護(hù)性，優(yōu)化了的業(yè)務(wù)的組合方式。

管道式編程具有如下優(yōu)點(diǎn)：

創(chuàng)建一個(gè)流暢的編程范例，將語句轉(zhuǎn)換為表達(dá)式并將它們鏈接在一起
用線性排序替換代碼嵌套
消除變量聲明 - 甚至不需要 var
提供某種形式的可變不變性和范圍隔離
將結(jié)構(gòu)代碼編寫成具有明確職責(zé)的小 lambda 表達(dá)式
......

基礎(chǔ)實(shí)現(xiàn)

在該示例中，我們通過構(gòu)建一個(gè) double->int->string 的類型轉(zhuǎn)換的管道來將一個(gè)目標(biāo)數(shù)據(jù)最終轉(zhuǎn)化為一個(gè)字符串。

首先，我們需要定義一個(gè)功能接口，用于約束每個(gè)功能函數(shù)的具體實(shí)現(xiàn)，示例代碼如下所示：

public interface IPipelineStep<INPUT, OUTPUT>
{
    OUTPUT Process(INPUT input);
}

然后，我們定義兩個(gè)類型轉(zhuǎn)換的功能類，繼承并實(shí)現(xiàn)上述接口，示例代碼如下所示：

public class DoubleToIntStep : IPipelineStep<double, int>
{
    public int Process(double input)
    {
        return Convert.ToInt32(input);
    }
}
public class IntToStringStep : IPipelineStep<int, string>
{
    public string Process(int input)
    {
        return input.ToString();
    }
}

接著，定義一個(gè)擴(kuò)展函數(shù)，用于連接上述的各個(gè)功能函數(shù)，示例代碼如下所示：

public static class PipelineStepExtensions
{
    public static OUTPUT Step<INPUT, OUTPUT>(this INPUT input, IPipelineStep<INPUT, OUTPUT> step)
    {
        return step.Process(input);
    }
}

最后，我們就可以構(gòu)建一個(gè)完整的管道，用于我們的數(shù)據(jù)類型轉(zhuǎn)換，示例代碼如下所示：

class Program
{
    static void Main(string[] args)
    {
        double input = 1024.1024;
        // 構(gòu)建并使用管道
        string result = input.Step(new DoubleToIntStep())
                             .Step(new IntToStringStep());
        Console.WriteLine(result);
    }
}

此時(shí)，我們成功將一個(gè) double 類型的數(shù)據(jù)轉(zhuǎn)化為了 string 類型。通過介紹上述示例，我們可以簡(jiǎn)單將管道式編程概括為：定義功能接口 -> 實(shí)現(xiàn)功能函數(shù) -> 組裝功能函數(shù) 。

依賴注入

上述代碼在一般的情況下是可以正常運(yùn)行的，但是如果希望以依賴注入(DI) 的方式注入的話，我們就需要將我們的管道組裝進(jìn)行封裝，方便作為一個(gè)統(tǒng)一的服務(wù)注入到系統(tǒng)中。

首先，我們需要定義一個(gè)抽線類，用于管道組裝的抽象封裝，示例代碼如下所示：

public abstract class Pipeline<INPUT,OUTPUT>
{
    public Func<INPUT, OUTPUT> PipelineSteps { get; protected set; }
    public OUTPUT Process(INPUT input)
    {
        return PipelineSteps(input);
    }
}

然后，我們就可以創(chuàng)建一個(gè)繼承上述抽象類的具體管道組裝類，示例代碼如下所示：

public class TrivalPipeline : Pipeline<double, string>
{
    public TrivalPipeline()
    {
        PipelineSteps = input => input.Step(new DoubleToIntSetp())
                                      .Step(new IntToStringStep());
    }
}

最后，我們可以將 TrivalPipeline 這個(gè)具體的管道注入到我們的系統(tǒng)中。同樣的，我們也可以直接使用，示例代碼如下所示：

class Program
{
    static void Main(string[] args)
    {
        double input = 1024.1024;
        // 需要安裝 Microsoft.Extensions.DependencyInjection
        var services = new ServiceCollection();
        services.AddTransient<TrivalPipeline>();
        var  provider = services.BuildServiceProvider();
        var trival = provider.GetService<TrivalPipeline>();
        string result = trival.Process(input);
        Console.WriteLine(result);
    }
}

條件式組裝

上述兩個(gè)示例代碼展示的管道組裝式不帶任何條件限制的，無論參數(shù)是否合法都是這樣組裝進(jìn)管道，但是在實(shí)際的開發(fā)過程中，我們需要對(duì)一定的業(yè)務(wù)模塊進(jìn)行條件性組裝，所以這個(gè)時(shí)候我們就需要完善一下我們的代碼。

首先，我們需要修改上面的 Pipeline<INPUT,OUTPUT> 類，使其繼承 IPipelineStep<INPUT, OUTPUT> 接口，示例代碼如下所示：

public abstract class Pipeline<INPUT, OUTPUT> : IPipelineStep<INPUT, OUTPUT>
{
    public Func<INPUT, OUTPUT> PipelineSteps { get; protected set; }
    public OUTPUT Process(INPUT input)
    {
        return PipelineSteps(input);
    }
}

然后，我們定義一個(gè)帶條件的管道裝飾器類，示例代碼如下所示：

public class OptionalStep<INPUT, OUTPUT> : IPipelineStep<INPUT, OUTPUT> where INPUT : OUTPUT
{
    private readonly IPipelineStep<INPUT, OUTPUT> _step;
    private readonly Func<INPUT, bool> _choice;
    public OptionalStep(Func<INPUT,bool> choice,IPipelineStep<INPUT,OUTPUT> step)
    {
        _choice = choice;
        _step = step;
    }
    public OUTPUT Process(INPUT input)
    {
        return _choice(input) ? _step.Process(input) : input;
    }
}

接著，我們定義一個(gè)新的功能類和支持條件判斷的管道包裝類，示例代碼如下所示：

public class ThisStepIsOptional : IPipelineStep<double, double>
{
    public double Process(double input)
    {
        return input * 10;
    }
}
public class PipelineWithOptionalStep : Pipeline<double, double>
{
    public PipelineWithOptionalStep()
    {
        // 當(dāng)輸入?yún)?shù)大于 1024，執(zhí)行 ThisStepIsOptional() 功能
        PipelineSteps = input => input.Step(new OptionalStep<double, double>(i => i > 1024, new ThisStepIsOptional()));
    }
}

最后，我們可以使用如下方式進(jìn)行測(cè)試：

class Program
{
    static void Main(string[] args)
    {
        PipelineWithOptionalStep step = new PipelineWithOptionalStep();
        Console.WriteLine(step.Process(1024.1024));  // 輸出 10241.024
        Console.WriteLine(step.Process(520.520));    // 輸出 520.520
    }
}

事件監(jiān)聽

有的時(shí)候，我們希望在我們管道中執(zhí)行的每一步，在開始和結(jié)束時(shí)，上層模塊都能獲得相應(yīng)的事件通知，這個(gè)時(shí)候，我們就需要需改一下我們的管道包裝器，使其支持這個(gè)需求。

首先，我們需要實(shí)現(xiàn)一個(gè)支持事件監(jiān)聽的具體功能類，示例代碼代碼如下所示：

public class EventStep<INPUT, OUTPUT> : IPipelineStep<INPUT, OUTPUT>
{
    public event Action<INPUT> OnInput;
    public event Action<OUTPUT> OnOutput;
    private readonly IPipelineStep<INPUT, OUTPUT> _innerStep;
    public EventStep(IPipelineStep<INPUT,OUTPUT> innerStep)
    {
        _innerStep = innerStep;
    }
    public OUTPUT Process(INPUT input)
    {
        OnInput?.Invoke(input);
        var output = _innerStep.Process(input);
        OnOutput?.Invoke(output);
        return output;
    }
}

然后，我們需要定義一個(gè)能夠傳遞事件參數(shù)的管道包裝器類，示例代碼如下所示：

public static class PipelineStepEventExtensions
{
    public static OUTPUT Step<INPUT, OUTPUT>(this INPUT input, IPipelineStep<INPUT, OUTPUT> step, Action<INPUT> inputEvent = null, Action<OUTPUT> outputEvent = null)
    {
        if (inputEvent != null || outputEvent != null)
        {
            var eventDecorator = new EventStep<INPUT, OUTPUT>(step);
            eventDecorator.OnInput += inputEvent;
            eventDecorator.OnOutput += outputEvent;
            return eventDecorator.Process(input);
        }
        return step.Process(input);
    }
}

最后，上層調(diào)用就相對(duì)簡(jiǎn)單很多，示例代碼如下所示：

public class DoubleStep : IPipelineStep<int, int>
{
    public int Process(int input)
    {
        return input * input;
    }
}
class Program
{
    static void Main(string[] args)
    {
        var input = 10;
        Console.WriteLine($"Input Value:{input}[{input.GetType()}]");
        var pipeline = new EventStep<int, int>(new DoubleStep());
        pipeline.OnInput += i => Console.WriteLine($"Input Value:{i}");
        pipeline.OnOutput += o => Console.WriteLine($"Output Value:{o}");
        var output = pipeline.Process(input);
        Console.WriteLine($"Output Value: {output} [{output.GetType()}]");
        Console.WriteLine("\r\n");
        //補(bǔ)充：使用擴(kuò)展方法進(jìn)行調(diào)用
        Console.WriteLine(10.Step(new DoubleStep(), i => 
        {
            Console.WriteLine($"Input Value:{i}");
        }, 
        o => 
        {
            Console.WriteLine($"Output Value:{o}");
        }));
    }
}

輸出結(jié)果如下圖所示：

可迭代執(zhí)行

可迭代執(zhí)行是指當(dāng)我們的管道中注冊(cè)了多個(gè)功能模塊時(shí)，不是一次性執(zhí)行完所以的功能模塊，而是每次只執(zhí)行一個(gè)功能，后續(xù)功能會(huì)在下次執(zhí)行該管道對(duì)應(yīng)的代碼塊時(shí)接著執(zhí)行，直到該管道中所有的功能模塊執(zhí)行完畢為止。該特性主要是通過 yield return 來實(shí)現(xiàn)。

首先，我們需要實(shí)現(xiàn)一個(gè)該特性的管道包裝器類，示例代碼如下所示：

public class LoopStep<INPUT, OUTPUT> : IPipelineStep<IEnumerable<INPUT>, IEnumerable<OUTPUT>>
{
    private readonly IPipelineStep<INPUT, OUTPUT> _internalStep;
    public LoopStep(IPipelineStep<INPUT,OUTPUT> internalStep)
    {
        _internalStep = internalStep;
    }
    public IEnumerable<OUTPUT> Process(IEnumerable<INPUT> input)
    {
        foreach (INPUT item in input)
        {
            yield return _internalStep.Process(item);
        }
        //等價(jià)于下述代碼段
        //return from INPUT item in input
        //       select _internalStep.Process(item);
    }
}

然后，定義一個(gè)支持上述類型的功能組裝的擴(kuò)展方法，示例代碼如下所示：

public static class PipelineStepLoopExtensions
{
    public static IEnumerable<OUTPUT> Step<INPUT, OUTPUT>(this IEnumerable<INPUT> input, IPipelineStep<INPUT, OUTPUT> step)
    {
        LoopStep<INPUT, OUTPUT> loopDecorator = new LoopStep<INPUT, OUTPUT>(step);
        return loopDecorator.Process(input);
    }
}

最后，上層調(diào)用如下所示：

class Program
{
    static void Main(string[] args)
    {
        var list = Enumerable.Range(0, 10);
        foreach (var item in list.Step(new DoubleStep()))
        {
            Console.WriteLine(item);
        }
    }
}