C# 管道式編程

来源:https://www.cnblogs.com/hippieZhou/archive/2019/07/17/11174644.html
-Advertisement-
Play Games

受 F 中的管道運算符和 C 中的 LINQ 語法，管道式編程為 C 提供了更加靈活性的功能性編程。通過使用 擴展函數 可以將多個功能連接起來構建成一個管道。 前言 在 C 編程中，管道式編程（Pipeline Style programming）其實存在已久，最明顯的就是我們經常使用的 LINQ。 ...


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

前言

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

管道式編程具有如下優點：

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

初體驗

基礎實現

在該示例中，我們通過構建一個 double->int->string 的類型轉換的管道來將一個目標數據最終轉化為一個字元串。

  • 首先，我們需要定義一個功能介面，用於約束每個功能函數的具體實現，示例代碼如下所示：
public interface IPipelineStep<INPUT, OUTPUT>
{
    OUTPUT Process(INPUT input);
}
  • 然後，我們定義兩個類型轉換的功能類，繼承並實現上述介面，示例代碼如下所示：
public class DoubleToIntSetp : 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 DoubleToIntSetp())
                             .Step(new IntToStringStep());
        Console.WriteLine(result);
    }
}

此時，我們成功將一個 double 類型的數據轉化為了 string 類型。通過介紹上述示例，我們可以簡單將管道式編程概括為：定義功能介面 -> 實現功能函數 -> 組裝功能函數 。

依賴註入

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

  • 首先，我們需要定義一個抽線類，用於管道組裝的抽象封裝，示例代碼如下所示：
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);
    }
}

條件式組裝

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

  • 首先，我們需要修改上面的 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
    }
}

事件監聽

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

  • 首先，我們需要實現一個支持事件監聽的具體功能類，示例代碼代碼如下所示：
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()}]");
    }
}

輸出結果如下圖所示：

可迭代執行

可迭代執行是指當我們的管道中註冊了多個功能模塊時，不是一次性執行完所以的功能模塊，而是每次只執行一個功能，後續功能會在下次執行該管道對應的代碼塊時接著執行，直到該管道中所有的功能模塊執行完畢為止。該特性主要是通過 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 部分示例代碼的不斷改進，最終我們實現了一個支持依賴註入和條件式組裝的管道，瞭解瞭如何進行管道式編程。掌握管道式編程可以讓我們對整個項目的架構和代碼質量都有很大幫助，感興趣的朋友可以自行查閱相關資料進行深入研究。

相關參考


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Abp小知識-如何全局設置DontWrapResult屬性
    demo地址 GitHub相關demo地址： 對demo說明一下，非abp官網模板，使用Visual Studio 2019創建的 項目，引入Abp.AspNetCore包，簡單改造一下。 適配Abp 簡單列舉改造步驟： 1. "初始化項目" 2. "通過nuget引入Abp.AspNetCore" ...
  • angularJS 在edge瀏覽器上傳文件，無法主動觸發ng-click
    今天發現的問題 在谷歌瀏覽器一直運行良好的功能，在edge瀏覽器不能使用。 代碼參考我的另一篇博客：WebAPI Angularjs 上傳文件 不能運行的原因 下圖紅框中的代碼在edge瀏覽器中無法執行，也就不能執行下麵的上傳文件代碼。 解決方案 既然原因找到了，就可以尋找解決方案了，找了一下午，有 ...
  • C#開發中常用的加密解密方法
    相信很多人在開發過程中經常會遇到需要對一些重要的信息進行加密處理，今天給大家分享我個人總結的一些加密演算法： 常見的加密方式分為可逆和不可逆兩種方式 可逆：RSA,AES,DES等 不可逆：常見的MD5，SHAD等 一、MD5消息摘要演算法 我想這是大家都常聽過的演算法，可能也用的比較多。那麼什麼是MD5 ...
  • 日誌的類
    public static class LogHelper { private static string strLogFolder; private static string strLogFile; private static object _obj = new object(); publi ...
  • 寫一個操作 .ini文件的類
    class IniHelp { private string iniPath; [DllImport("kernel32")] private static extern long WritePrivateProfileString(string section, string key, strin ...
  • WPF TextBox綁定Int類型的屬性
    TextBox雙向綁定int屬性，清空輸入框時Setter方法未觸發。 我的解決方案： 1、屬性置為int?； 2、xmlns:sys="clr-namespace:System;assembly=mscorlib" 3、Text="{Binding Number,Mode=TwoWay,Targe ...
  • C#自定義消息函數，需要一個TextBox，一個委托，直接上代碼；
    private delegate void de_OutputMessage(string str); public void OutputMessage(string str) { if (textBoxMessage.InvokeRequired) { this.BeginInvoke(new ...
  • .NET Core CSharp初級篇 1-1
    .NET Core CSharp 初級篇 1 1 本節內容是對於C 基礎類型的存儲方式以及C 基礎類型的理論介紹 基礎數據類型介紹 例如以下這句話：“張三是一名程式員，今年15歲重50.3kg，他的代號是‘A’，他家的經緯度是(N30,E134)。”，這句話就是一個字元串，使用雙引號括起來。而15則 ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類