C# 管道式編程

時間  2019-11-21
標籤 c# 管道 編程 欄目 C# 简体版
原文   原文鏈接

受 F# 中的管道運算符和 C# 中的 LINQ 語法，管道式編程爲 C# 提供了更加靈活性的功能性編程。經過使用 擴展函數 能夠將多個功能鏈接起來構建成一個管道。git

前言

在 C# 編程中，管道式編程（Pipeline Style programming）其實存在已久，最明顯的就是咱們常用的 LINQ。在進入 DotNetCore 世界後， 這種編程方式就更加明顯，好比各類中間件的使用。經過使用這種編程方式，大大提升了代碼的可維護性，優化了的業務的組合方式。github

管道式編程具備以下優勢：編程

  • 建立一個流暢的編程範例，將語句轉換爲表達式並將它們連接在一塊兒
  • 用線性排序替換代碼嵌套
  • 消除變量聲明 - 甚至不須要 var
  • 提供某種形式的可變不變性和範圍隔離
  • 將結構代碼編寫成具備明確職責的小 lambda 表達式
  • ......

初體驗

基礎實現

在該示例中，咱們經過構建一個 double->int->string 的類型轉換的管道來將一個目標數據最終轉化爲一個字符串。c#

  • 首先，咱們須要定義一個功能接口，用於約束每一個功能函數的具體實現，示例代碼以下所示：
public interface IPipelineStep<INPUT, OUTPUT>
{
    OUTPUT Process(INPUT input);
}
  • 而後，咱們定義兩個類型轉換的功能類，繼承並實現上述接口，示例代碼以下所示：
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();
    }
}
  • 接着，定義一個擴展函數，用於鏈接上述的各個功能函數，示例代碼以下所示：
public static class PipelineStepExtensions
{
    public static OUTPUT Step<INPUT, OUTPUT>(this INPUT input, IPipelineStep<INPUT, OUTPUT> step)
    {
        return step.Process(input);
    }
}
  • 最後，咱們就能夠構建一個完整的管道，用於咱們的數據類型轉換，示例代碼以下所示：
class Program
{
    static void Main(string[] args)
    {
        double input = 1024.1024;

        // 構建並使用管道
        string result = input.Step(new DoubleToIntStep())
                             .Step(new IntToStringStep());
        Console.WriteLine(result);
    }
}

此時，咱們成功將一個 double 類型的數據轉化爲了 string 類型。經過介紹上述示例，咱們能夠簡單將管道式編程歸納爲：定義功能接口 -> 實現功能函數 -> 組裝功能函數 。架構

依賴注入

上述代碼在通常的狀況下是能夠正常運行的，可是若是但願以 依賴注入(DI) 的方式注入的話，咱們就須要將咱們的管道組裝進行封裝，方便做爲一個統一的服務注入到系統中。app

  • 首先，咱們須要定義一個抽線類，用於管道組裝的抽象封裝，示例代碼以下所示：
public abstract class Pipeline<INPUT,OUTPUT>
{
    public Func<INPUT, OUTPUT> PipelineSteps { get; protected set; }

    public OUTPUT Process(INPUT input)
    {
        return PipelineSteps(input);
    }
}
  • 而後，咱們就能夠建立一個繼承上述抽象類的具體管道組裝類，示例代碼以下所示：
public class TrivalPipeline : Pipeline<double, string>
{
    public TrivalPipeline()
    {
        PipelineSteps = input => input.Step(new DoubleToIntSetp())
                                      .Step(new IntToStringStep());
    }
}
  • 最後，咱們能夠將 TrivalPipeline 這個具體的管道注入到咱們的系統中。一樣的，咱們也能夠直接使用，示例代碼以下所示：
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);
    }
}

條件式組裝

上述兩個示例代碼展現的管道組裝式不帶任何條件限制的， 不管參數是否合法都是這樣組裝進管道，可是在實際的開發過程當中，咱們須要對必定的業務模塊進行條件性組裝，因此這個時候咱們就須要完善一下咱們的代碼。asp.net

  • 首先，咱們須要修改上面的 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);
    }
}
  • 而後，咱們定義一個帶條件的管道裝飾器類，示例代碼以下所示：
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;
    }
}
  • 接着，咱們定義一個新的功能類和支持條件判斷的管道包裝類，示例代碼以下所示：
public class ThisStepIsOptional : IPipelineStep<double, double>
{
    public double Process(double input)
    {
        return input * 10;
    }
}

public class PipelineWithOptionalStep : Pipeline<double, double>
{
    public PipelineWithOptionalStep()
    {
        // 當輸入參數大於 1024，執行 ThisStepIsOptional() 功能
        PipelineSteps = input => input.Step(new OptionalStep<double, double>(i => i > 1024, new ThisStepIsOptional()));
    }
}
  • 最後，咱們可使用以下方式進行測試：
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
    }
}

事件監聽

有的時候，咱們但願在咱們管道中執行的每一步，在開始和結束時，上層模塊都能得到相應的事件通知，這個時候，咱們就須要需改一下咱們的管道包裝器，使其支持這個需求。ide

  • 首先，咱們須要實現一個支持事件監聽的具體功能類，示例代碼代碼以下所示：
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;
    }
}
  • 而後，咱們須要定義一個可以傳遞事件參數的管道包裝器類，示例代碼以下所示：
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);
    }
}
  • 最後，上層調用就相對簡單不少，示例代碼以下所示：
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");

        //補充：使用擴展方法進行調用
        Console.WriteLine(10.Step(new DoubleStep(), i => 
        {
            Console.WriteLine($"Input Value:{i}");
        }, 
        o => 
        {
            Console.WriteLine($"Output Value:{o}");
        }));
    }
}

輸出結果以下圖所示：wordpress

可迭代執行

可迭代執行是指當咱們的管道中註冊了多個功能模塊時，不是一次性執行完因此的功能模塊，而是每次只執行一個功能，後續功能會在下次執行該管道對應的代碼塊時接着執行，直到該管道中全部的功能模塊執行完畢爲止。該特性主要是經過 yield return 來實現。函數

  • 首先，咱們須要實現一個該特性的管道包裝器類，示例代碼以下所示：
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);
        }

        //等價於下述代碼段
        //return from INPUT item in input
        //       select _internalStep.Process(item);
    }
}
  • 而後，定義一個支持上述類型的功能組裝的擴展方法，示例代碼以下所示：
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);
    }
}
  • 最後，上層調用以下所示：
class Program
{
    static void Main(string[] args)
    {
        var list = Enumerable.Range(0, 10);
        foreach (var item in list.Step(new DoubleStep()))
        {
            Console.WriteLine(item);
        }
    }
}

總結

經過上述 5 部分示例代碼的不斷改進，最終咱們實現了一個支持依賴注入和條件式組裝的管道，瞭解瞭如何進行管道式編程。掌握管道式編程可讓咱們對整個項目的架構和代碼質量都有很大幫助，感興趣的朋友能夠自行查閱相關資料進行深刻研究。

相關參考

讚揚

日期 讚揚者 金額 備註
2019-07-17 *強建 10元（支付寶） 但願結合 asp.net core 再出一個
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程