常見架構命名規則

1. 接口一般會包含一個Process 方法

public interface IEventHandler
    {
        void Process(HandlerContext context, object data, TaskCompletionSource<object> tcs = null);

    }

HandlerContext 類包含 Invoke

 

 public static Task<object> Invoke(HandlerContext context, object data, TaskCompletionSource<object> tcs = null)
        {
            var promise = tcs ?? new TaskCompletionSource<object>();
            if(context!=null)
            {
                context.Handler.Process(context, data, promise);

            }
            return promise.Task;
        }

2.  事件（event）委託 命名包含  Handler 後綴 , 處理方法 包含 On+ 委託實例

 

public delegate void MouseEventHandler(object sender, EventArgs e);

public event System.Windows.Forms.MouseEventHandler MouseUp;

Control.MouseDown+= OnMouseDown; 

 

 

轉：https://www.cnblogs.com/hippieZhou/p/11174644.html

依賴注入#

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

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

Copy
public abstract class Pipeline<INPUT,OUTPUT>
{
    public Func<INPUT, OUTPUT> PipelineSteps { get; protected set; }

    public OUTPUT Process(INPUT input)
    {
        return PipelineSteps(input);
    }
}

    然後，我們就可以創建一個繼承上述抽象類的具體管道組裝類，示例代碼如下所示：

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

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

Copy
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> 接口，示例代碼如下所示：

Copy
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);
    }
}

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

Copy
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;
    }
}

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

Copy
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()));
    }
}

    最後，我們可以使用如下方式進行測試：

Copy
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
    }
}

事件監聽#

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

    首先，我們需要實現一個支持事件監聽的具體功能類，示例代碼代碼如下所示：

Copy
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;
    }
}

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

Copy
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);
    }
}

    最後，上層調用就相對簡單很多，示例代碼如下所示：

Copy
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}");
        }));
    }
}

輸出結果如下圖所示：

可迭代執行#

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

    首先，我們需要實現一個該特性的管道包裝器類，示例代碼如下所示：

Copy
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);
    }
}

    然後，定義一個支持上述類型的功能組裝的擴展方法，示例代碼如下所示：

Copy
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);
    }
}

    最後，上層調用如下所示：

Copy
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 部分示例代碼的不斷改進，最終我們實現了一個支持依賴注入和條件式組裝的管道，瞭解瞭如何進行管道式編程。掌握管道式編程可以讓我們對整個項目的架構和代碼質量都有很大幫助，感興趣的朋友可以自行查閱相關資料進行深入研究。
相關參考#

    Walkthrough: Creating a Dataflow Pipeline
    PipelineStyle
    AN ALTERNATIVE APPROACH TO PIPELINES