العلاقة بين C # و C #: REST و gRPC وكل شيء بينهما

السيناريو الأمثل

// on client side
public void Foo()
{
    var server = new MyServer(new Uri("https://www.myserver.com/");)
    int sum = server.Calculator.SumNumbers(12,13); 
}

// on server side
class CalculatorController : Controller{
    public int SumNumbers(int a, int b)
    {
        return a + b;
    }
}

• فصول ثابتة بطرق ثابتة فقط.
• فئات POCO التي لا يوجد فيها سوى الحقول والخصائص التي يكون نوعها بدائيًا أو فئة POCO أخرى.

نهج REST التقليدي

• يتم استخدام GET للحصول على المورد
• يستخدم PUT لتغيير حالة المورد.
• يستخدم POST لإنشاء مورد.
• يستخدم DELETE لحذف مورد.

[Route("People")]
public class PeopleController : Controller
{
    [HttpGet]
    public Person GetPersonById(int id)
    {
        Person person = _db.GetPerson(id);
        return person;//Automatically serialized to JSON
    }
} 

var client = new HttpClient();
string resultJson = await client.GetStringAsync("https://www.myserver.com/People/GetPersonById?id=123");
Person person = JsonConvert.DeserializeObject<Person>(resultJson);

مجددة

public interface IMyEmployeeApi
{
    [Get("/employee/{id}")]
    Task<Employee> GetEmployee(string id);
}

var api = RestService.For<IMyEmployeeApi>("https://www.myserver.com");
var employee = await api.GetEmployee("abc");

اختيال

• جميع المسارات (عناوين URL) في واجهة برمجة التطبيقات.
• العمليات المتوقعة (GET ، POST ، ...) لكل مسار. يمكن لكل مسار معالجة عمليات مختلفة. على سبيل المثال ، يمكن أن يقبل المسار نفسه mystore.com/Product عملية POST التي تضيف منتجًا وعملية GET التي تُرجع منتجًا.
• المعلمات المتوقعة لكل مسار وعملية.
• الإجابات المتوقعة لكل مسار.
• أنواع كل معلمة وكائن استجابة.

{ 
   "swagger":"2.0",
   "info":{ 
      "version":"1.0.0",
      "title":"Swagger Petstore",
      "description":"A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
   },
   "host":"petstore.swagger.io",
   "basePath":"/api",
   "schemes":[ 
      "http"
   ],
   "consumes":[ 
      "application/json"
   ],
   "produces":[ 
      "application/json"
   ],
   "paths":{ 
      "/pets":{ 
         "get":{ 
            "description":"Returns all pets from the system that the user has access to",
            "operationId":"findPets",
            "produces":[ 
               "application/json",
               "application/xml",
            ],
            "parameters":[ 
               { 
                  "name":"tags",
                  "in":"query",
                  "description":"tags to filter by",
                  "required":false,
                  "type":"array",
                  "items":{ 
                     "type":"string"
                  },
                  "collectionFormat":"csv"
               },
               { 
                  "name":"limit",
                  "in":"query",
                  "description":"maximum number of results to return",
                  "required":false,
                  "type":"integer",
                  "format":"int32"
               }
            ],
            "responses":{ 
               "200":{ 
                  "description":"pet response",
                  "schema":{ 
                     "type":"array",
                     "items":{ 
                        "$ref":"#/definitions/Pet"
                     }
                  }
               },
...
 

إضافة Swagger إلى خادم ASP.NET الخاص بك

services.AddSwaggerGen(options => 
	options.SwaggerDoc("v1", new OpenApiInfo {Title = "My Web API", Version = "v1"}));

app.UseSwagger();

[HttpPost]
public async Task AddEmployee([FromBody]Employee employee)
{
    //...
}
 
[HttpGet]
public async Task<Employee> Employee([FromQuery]string id)
{
    //...
}

إنشاء عميل من Swagger باستخدام AutoRest

autorest --input-file="./swagger.json" --output-folder="GeneratedClient" --namespace="MyClient" --override-client-name="MyClient" --csharp

var client = new MyClient();
Employee employee = client.Employee(id: "abc");

REST التقليدية مقابل Swagger مقابل ReFit

• إذا كان لديك REST API خاص بسيط للغاية ، فقد لا تقلق بشأن إنشاء العميل والواجهات الشائعة. مهمة صغيرة لا تبرر بذل جهد إضافي.
• يدعم Swagger العديد من اللغات ، و ReFit يدعم .NET فقط. Swagger هو أيضًا أساس للعديد من الأدوات والاختبارات وأدوات الأتمتة وأدوات واجهة المستخدم. قد يكون هذا هو الخيار الأفضل إذا كنت تقوم بإنشاء واجهة برمجة تطبيقات عامة كبيرة.
• Swagger أكثر تعقيدًا بكثير من ReFit. مع ReFit ، فإن الأمر يتعلق فقط بإضافة واجهة واحدة إلى كل من خادمك ومشروع العميل. من ناحية أخرى ، مع ReFit ، سيتعين عليك إنشاء واجهات جديدة لكل وحدة تحكم ، بينما تعتني Swagger بذلك تلقائيًا.

gRPC

• مثل REST ، gRPC هي لغة مستقلة. هناك أدوات لجميع اللغات الشائعة ، بما في ذلك C #.
• gRPC قائم على العقد ويستخدم ملفات .proto لتحديد العقد. هذا يشبه إلى حد ما Swagger swagger.json وواجهة ReFit الشائعة. يمكن إنشاء عميل لأي لغة برمجة من هذه الملفات.
• gRPC Protocol Buffer (Protobuf). REST, JSON XML. , , .
• gRPC HTTP/2. . , REST HTTP 1.x ( HTTP 1.1).
• HTTP 1.1 TCP- () , HTTP/2 .
• HTTP/2 . , TCP- . , , HTTP 1.1.
• gRPC .

GRPC لجانب خادم .NET

public class GreeterService : Greeter.GreeterBase
{
    public override Task<HelloReply> SayHello(HelloRequest request,
        ServerCallContext context)
    {
        _logger.LogInformation("Saying hello to {Name}", request.Name);
        return Task.FromResult(new HelloReply 
        {
            Message = "Hello " + request.Name
        });
    }
}

app.UseEndpoints(endpoints =>
{
    endpoints.MapGrpcService<GreeterService>();
});

syntax = "proto3";
 
service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply);
}
 
message HelloRequest {
  string name = 1;
}
 
message HelloReply {
  string message = 1;
}

<ItemGroup>
  <Protobuf Include="Protos\greet.proto"/>
</ItemGroup>

GRPC لجانب عميل .NET

var channel = GrpcChannel.ForAddress("https://localhost:5001");
var client = new Greeter.GreeterClient(channel);
 
var response = await client.SayHello(
    new HelloRequest { Name = "World" });
 
Console.WriteLine(response.Message);

gRPC مقابل REST

طرق أخرى للتواصل

• GraphQL هي لغة استعلام API تم تطويرها بواسطة Facebook. يسمح هذا للعميل بطلب البيانات التي يحتاجها بالضبط من الخادم. وبالتالي ، يمكنك إنشاء نقطة نهاية واحدة فقط على الخادم ، والتي ستكون مرنة للغاية وستعيد فقط البيانات التي يحتاجها العميل. أصبح GraphQL شائعًا جدًا في السنوات الأخيرة.
• TcpClient TcpListener ( System.Net.Sockets) TCP. , . , ASP.NET API.
• UdpClient UDP. TCP , UDP . TCP , , UDP — . UDP , , . : , IP (VoIP).
• WCF هي تقنية قديمة تستخدم بشكل أساسي الاتصالات بين العمليات القائمة على SOAP. هذا إطار عمل ضخم لن أخوض فيه ، لا يسعني إلا أن أقول أنه فقد شعبيته في حمولات REST و JSON.