使用C#?11的靜態(tài)接口方法改進?面向約定?的設計方法

更新時間：2022年12月12日 09:36:08 作者：Artech

我們知道接口是針對契約的定義，但是一直以來它只能定義一組“實例”的契約，而不能定義類型的契約，因為定義在接口中的方法只能是實例方，這篇文章主要介紹了使用C#?11的靜態(tài)接口方法改進面向約定?的設計,需要的朋友可以參考下

C# 11帶來了一個我期待已久的特性——接口方法。我們知道接口是針對契約的定義，但是一直以來它只能定義一組“實例”的契約，而不能定義類型（的靜態(tài)成員）的契約，因為定義在接口中的方法只能是實例方法。由于缺乏針對“類型契約”的支持，我們在設計一些框架或者類庫的時候，只能采用“按照約定”的設計，比如ASP.NET Core Minimal API針對參數(shù)的綁定就是一個典型的案例。

C# 11帶來了一個我期待已久的特性——靜態(tài)接口方法。我們知道接口是針對契約的定義，但是一直以來它只能定義一組“實例”的契約，而不能定義類型（的靜態(tài)成員）的契約，因為定義在接口中的方法只能是實例方法。由于缺乏針對“類型契約”的支持，我們在設計一些框架或者類庫的時候，只能采用“按照約定”的設計，比如ASP.NET Core Minimal API針對參數(shù)的綁定就是一個典型的案例。以如下這個簡單的應用為例，我們采用Minimal API的形式注冊了一個針對根地址“/”的路由，作為處理器的委托的輸出和輸出都是我們自定義的Point對象。

var app = WebApplication.Create();
app.Map("/", (Point point) => point);
app.Run();

public class Point
{
    public double X { get; }
    public double Y { get; }
    public Point(double x, double y)
    {
        X = x;
        Y = y;
    }

    public override string ToString() => $"{X},{Y}";

    public static bool TryParse(string expression, out Point? result)
    {
        result = default;
        var parts = expression.Split(',');
        if (parts.Length != 2) return false;
        if (!double.TryParse(parts[0], out var x) || !double.TryParse(parts[1], out var y)) return false;
        result = new Point(x, y);
        return true;
    }
}

Minimal API的約定，如果我們?yōu)镻oint類型定義了具有如上聲明的TryParse方法，該方法就會用來幫助我們綁定處理方法的Point參數(shù)，如下的演示結果證實了這一點。

其實針對參數(shù)綁定，我們還可以定義如下這樣BindAsync參數(shù)來完成。

public class Point
{
    ...
    public static ValueTask<Point?> BindAsync(HttpContext httpContext, ParameterInfo parameter)
    {
        Point? result = default;
        var name = parameter.Name;
        var value = httpContext.GetRouteData().Values.TryGetValue(name!, out var v) ? v : httpContext.Request.Query[name!].SingleOrDefault();
        if (value is string expression && TryParse(expression, out var point))
        {
            result = point;
        }
        return new ValueTask<Point?>(result);
    }
}

對于這種“基于約定”的編程，可以你覺得還不錯，但是我想有90%的ASP.NET Core的開發(fā)者不知道有這個特性，就從這一點就充分證明了這樣的設計還不夠好。這樣的實現(xiàn)也比較繁瑣，我們不得不通過反射檢驗待綁定參數(shù)的類型是否滿足約定，并以反射（或者表達式樹）的方式調(diào)用對應的方法。其實上述兩個方法本應該寫入“契約”，無奈它們是靜態(tài)方法，沒法定義在接口中?，F(xiàn)在我們有了靜態(tài)接口方法，它們可以定義如下所示的IBindable<T>和IParsable<T>。

public interface IBindable<T>
{
    abstract static ValueTask<T?> BindAsync(HttpContext httpContext, ParameterInfo parameter);
}

public interface IParsable<T>
{
    abstract static bool TryParse(string expression, out T? result);
}

public class Point : IBindable<Point>, IParsable<Point>
{
    public double X { get; }
    public double Y { get; }
    public Point(double x, double y)
    {
        X = x;
        Y = y;
    }

    public override string ToString() => $"{X},{Y}";

    public static bool TryParse(string expression, out Point? result)
    {
        result = default;
        var parts = expression.Split(',');
        if (parts.Length != 2) return false;
        if (!double.TryParse(parts[0], out var x) || !double.TryParse(parts[1], out var y)) return false;
        result = new Point(x, y);
        return true;
    }

    public static ValueTask<Point?> BindAsync(HttpContext httpContext, ParameterInfo parameter)
    {
        Point? result = default;
        var name = parameter.Name;
        var value = httpContext.GetRouteData().Values.TryGetValue(name!, out var v) ? v : httpContext.Request.Query[name!].SingleOrDefault();
        if (value is string expression && TryParse(expression, out var point))
        {
            result = point;
        }
        return new ValueTask<Point?>(result);
    }
}

實際上IParsable<T>已經(jīng)存在了，它真正的定義是這樣的。如果有了這樣的接口，確定帶綁定參數(shù)類型是否滿足之前的約定條件只需要確定其是否實現(xiàn)了對應的接口就可以了。

public interface IParsable<TSelf> where TSelf : IParsable<TSelf>?
{
    static TSelf Parse(string s, IFormatProvider? provider);
    static bool TryParse([NotNullWhen(true)] string? s, IFormatProvider? provider, [MaybeNullWhen(false)] out TSelf result);
}

靜態(tài)接口設計被應用到基于微服務框架go-micro開發(fā)gRPC應用程序中，我在表示gRPC服務的接口中定義了如下的靜態(tài)方法Bind將本服務類型中定義的gRPC方法綁定成路由。

public interface IGrpcService<TService> where TService : class
{
    static abstract void Bind(IServiceBinder<TService> binder);
}

[GrpcService(ServiceName = "Greeter")]
public class GreeterService: IGrpcService<GreeterService>
{
    public Task<HelloReply> SayHelloUnaryAsync(HelloRequest request, ServerCallContext context);

    public async Task<HelloReply> SayHelloClientStreamingAsync(IAsyncStreamReader<HelloRequest> reader, ServerCallContext context);

    public  async Task SayHelloServerStreamingAsync(Empty request, IServerStreamWriter<HelloReply> responseStream, ServerCallContext context);

    public async Task SayHelloDuplexStreamingAsync(IAsyncStreamReader<HelloRequest> reader, IServerStreamWriter<HelloReply> writer, ServerCallContext context);

    public static void Bind(IServiceBinder<GreeterService> binder)
    {
        binder
            .AddUnaryMethod<HelloRequest, HelloReply>(it =>it.SayHelloUnaryAsync(default!,default!), HelloRequest.Parser)
            .AddClientStreamingMethod<HelloRequest, HelloReply>(it => it.SayHelloClientStreamingAsync(default!, default!), HelloRequest.Parser)
            .AddServerStreamingMethod<Empty, HelloReply>(nameof(SayHelloServerStreamingAsync), it => it.SayHelloServerStreamingAsync, Empty.Parser)
            .AddDuplexStreamingMethod<HelloRequest, HelloReply>(nameof(SayHelloDuplexStreamingAsync), it => it.SayHelloDuplexStreamingAsync, HelloRequest.Parser);
    }

到此這篇關于使用C# 11的靜態(tài)接口方法改進面向約定的設計的文章就介紹到這了,更多相關C# 11的靜態(tài)接口方法內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: