快捷導(dǎo)航

c# RPC框架的使用簡介

更新時間：2021年02月07日 11:00:37 作者：Supper_litt

這篇文章主要介紹了c# RPC框架的使用簡介，幫助大家更好的理解和使用c#，感興趣的朋友可以了解下

寫在前面：

　　RPC，聽過很有段時間了，但是一直都不太清楚是干嘛的，今天我們來捋一捋。

解釋：

　　【Remote Procedure Call Protocol】遠(yuǎn)程過程調(diào)用（就是說，A程序要調(diào)用一個b方法，然而這個b方法的實現(xiàn)在B程序內(nèi)部，B程序還可能和A不在一個電腦上面，怎么調(diào)用？http可以調(diào)用/rpc也可以，讓他像調(diào)用本地方法一樣調(diào)用）

使用初探：

　　用了一下市面上的，rpc框架，步驟如下：

　　1、寫一個基本的代碼，告訴有哪些方法。

　　2、然后服務(wù)端集成，

　　3、客戶端集成，

　　4、OK調(diào)用生效了。

　　感覺有點像TCP在傳輸數(shù)據(jù)，從A服務(wù)器傳遞，傳遞類名，方法名，參數(shù)，值，然后B服務(wù)器拿到數(shù)據(jù)，計算結(jié)果，然后把數(shù)據(jù)在回傳給A。。。這樣理解一下的話，就很簡單了。

　下面動手寫一個吧。

自己動手：

　　服務(wù)端：

　　既然服務(wù)端是實現(xiàn)的地方，我們寫一個算是實現(xiàn)類的方法試試：寫了一個接口和一個實現(xiàn)，為了演示效果，寫了兩個方法。

public interface IMyTestService
  {
    int calc(int x, int y);

    bool login(string name, string pwd);
  }

  public class MyTestServiceImpl : IMyTestService
  {
    public int calc(int x, int y)
    {
      return x + y;
    }

    public bool login(string name, string pwd)
    {
      if (name == "test" && pwd == "123456")
      {
        return true;
      }

      return false;
    }
  }

　　OK，服務(wù)端的大部分完成了。

　　然后就是TCP服務(wù)器，TCP服務(wù)器對大家來說，就太簡單不過了，不就是創(chuàng)建一個Socket對象，綁定一個端口，獲取客戶端請求的Socket對象，然后和他交互么。沒啥多說的。

class Program
  {
    static void Main(string[] args)
    {
      Socket server = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
      server.Bind(new IPEndPoint(IPAddress.Any, 10000));
      server.Listen(1000);

      Thread t = new Thread(Execute);
      t.IsBackground = true;
      t.Start(server);

      Console.WriteLine("rpc服務(wù)器已啟動");
      Console.ReadLine();
    }

    private static void Execute(Object obj)
    {
      Socket server = obj as Socket;
      while (true)
      {
        Socket client = server.Accept();

        Thread t = new Thread(SingleExecute);
        t.IsBackground = true;
        t.Start(client);
      }
    }

    private static void SingleExecute(object obj)
    {
      // 讀取 
      Socket client = obj as Socket;

      byte[] buffer = new byte[8192];
      int count = client.Receive(buffer);
      if (count > 0)
      {
        var data = ServiceHelpercs.Handle(buffer);
        client.Send(data);
      }

      client.Shutdown(SocketShutdown.Both);
    }
  }

　　我們假定，所有的客戶端數(shù)據(jù)，可以在一個請求包里面解析掉，因為如果一次的數(shù)據(jù)接收不能解析，那就還要添加一個大小了，客戶端要告訴我你給我了多少消息，然后我再讀取指定數(shù)據(jù)，拿到所有的內(nèi)容

　　這里創(chuàng)建，一個ServiceHelpers來幫助對，真實算法的調(diào)用。如下：

public class ServiceHelpercs
  {
    public static byte[] Handle(byte[] buffer)
    {
      MemoryStream ms = new MemoryStream(buffer);
      BinaryReader br = new BinaryReader(ms);

      int inter_len = br.ReadByte();
      string inter_name = Encoding.UTF8.GetString(br.ReadBytes(inter_len));

      int method_len = br.ReadByte();
      string method_name = Encoding.UTF8.GetString(br.ReadBytes(method_len));

      int args_length = br.ReadByte();
      int return_type = br.ReadByte();

      List<object> list = new List<object>();
      for (int i = 0; i < args_length; i++)
      {　　　　　　　　  // 0:void 忽略 1:int 2:bool 3:string
        int arg_type = br.ReadByte();
        if (arg_type == 1)
        {
          byte[] values = br.ReadBytes(4);
          list.Add(bytes2int(values));
        }
        else if (arg_type == 2)
        {
          bool value = br.ReadByte() == 1;
          list.Add(value);
        }
        else if (arg_type == 3)
        {
          int str_len = bytes2int(br.ReadBytes(4));
          string str = Encoding.UTF8.GetString(br.ReadBytes(str_len));
          list.Add(str);
        }
      }

      Type inter_type = null;
      var types = Assembly.GetExecutingAssembly().GetTypes();
      foreach (var type in types)
      {
        var ts = type.GetInterfaces();
        foreach (var t in ts)
        {
          if (t.Name == inter_name)
          {
            inter_type = type;
            break;
          }
        }
      }

      MethodInfo invokeMethod = null;
      if (inter_type != null)
      {
        var methods = inter_type.GetMethods();
        foreach (var method in methods)
        {
          if (method.Name == method_name)
          {
            invokeMethod = method;
            break;
          }
        }
      }

      if (invokeMethod != null)
      {
        Object thisObj = Activator.CreateInstance(inter_type);
        object result = invokeMethod.Invoke(thisObj, list.ToArray());
        if (return_type == 1)
        {
          int value = Convert.ToInt32(result);

          return int2bytes(value);
        }
        else if (return_type == 2)
        {
          return new byte[1] { Convert.ToBoolean(result) ? (byte)1 : (byte)0 };
        }
        else if (return_type == 2)
        {
          List<byte> result_data = new List<byte>();
          var str = (result == null ? "" : result.ToString());
          var data = Encoding.UTF8.GetBytes(str);

          result_data.AddRange(int2bytes(data.Length));
          result_data.AddRange(data);

          return result_data.ToArray();
        }
      }

      return new byte[1] { 0xFF };
    }

    public static byte[] int2bytes(int len)
    {
      byte[] data_len = new byte[4];
      data_len[0] = (byte)((len >> 8 * 3) & 0xFF);
      data_len[1] = (byte)((len >> 8 * 2) & 0xFF);
      data_len[2] = (byte)((len >> 8 * 1) & 0xFF);
      data_len[3] = (byte)(len & 0xFF);

      return data_len;
    }

    public static int bytes2int(byte[] buffer)
    {
      int value = 0;
      value += (int)(buffer[0] << (8 * 3));
      value += (int)(buffer[1] << (8 * 2));
      value += (int)(buffer[2] << (8 * 1));
      value += (int)(buffer[3]);

      return value;
    }
  }

　　解析的類很簡單，因為這里創(chuàng)建的數(shù)據(jù)結(jié)構(gòu)很簡單。

　　按照我們的約定，這里，對數(shù)據(jù)按照我定義的方式來進(jìn)行解包即可。

　　服務(wù)器就完成了，是不是很簡單。當(dāng)然客戶端也需要按照一樣的方式處理打包即可

　　客戶端：

　　客戶端就很簡單了，只需要連接到服務(wù)器，通過我們自動生成的代碼（這里沒有寫自動生成，就手動了），然后就直接可以返回結(jié)果了

class Program
  {
    static void Main(string[] args)
    {
      IMyService service = new MyServiceProxy();
      DateTime startTime = DateTime.Now;
      int result = service.add(123, 321);

      int min_seconds = (int)(DateTime.Now - startTime).TotalMilliseconds;

      Console.WriteLine(result + " 耗時 " + min_seconds);
      Console.ReadLine();
    }
  }

　　上面直接調(diào)用了，接口，至于接口的實現(xiàn)，這里的步驟就三個：1、構(gòu)造需要請求的數(shù)據(jù)，2、連接服務(wù)器并發(fā)送數(shù)據(jù)，3、接收返回內(nèi)容，并解析結(jié)果。

public class MyServiceProxy : IMyService
  {
    public int add(int x, int y)
    {
      List<ArgInfo> argList = new List<ArgInfo>();
      argList.Add(new ArgInfo(TypeEnu.Int, x));
      argList.Add(new ArgInfo(TypeEnu.Int, y));

      byte[] send_data = create_send_package("IMyService", "add", 2, TypeEnu.Int, argList);
      Socket client = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
      client.Connect(new IPEndPoint(IPAddress.Parse("192.168.0.105"), 10000));
      client.Send(send_data);

      byte[] buffer = new byte[4];
      int count = client.Receive(buffer);
      if (count > 0)
      {
        return bytes2int(buffer);
      }

      throw new Exception("系統(tǒng)異常");
    }

    public bool login(string name, string pwd)
    {
      List<ArgInfo> argList = new List<ArgInfo>();
      argList.Add(new ArgInfo(TypeEnu.String, name));
      argList.Add(new ArgInfo(TypeEnu.String, pwd));

      byte[] send_data = create_send_package("IMyService", "login", 2, TypeEnu.Bool, argList);
      Socket client = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
      client.Connect(new IPEndPoint(IPAddress.Parse("192.168.0.105"), 10000));
      client.Send(send_data);

      byte[] buffer = new byte[1];
      int count = client.Receive(buffer);
      if (count > 0)
      {
        return buffer[0] == 1;
      }

      throw new Exception("系統(tǒng)異常");
    }

    private byte[] create_send_package(string inter_name, string method_name, int arg_length, TypeEnu return_type, List<ArgInfo> argList)
    {
      List<byte> list = new List<byte>();
      list.Add((byte)inter_name.Length);
      list.AddRange(Encoding.UTF8.GetBytes(inter_name));

      list.Add((byte)method_name.Length);
      list.AddRange(Encoding.UTF8.GetBytes(method_name));

      list.Add((byte)arg_length);
      list.Add((byte)return_type);

      foreach (var arg in argList)
      {
        list.Add((byte)arg.type);
        if (arg.type == TypeEnu.Int)
        {
          list.AddRange(int2bytes(Convert.ToInt32(arg.value)));
        }
        else if (arg.type == TypeEnu.Bool)
        {
          bool value = Convert.ToBoolean(arg.value);
          list.Add(value ? (byte)1 : (byte)0);
        }
        else if (arg.type == TypeEnu.String)
        {
          string value = arg.value.ToString();
          list.AddRange(int2bytes(value.Length));
          list.AddRange(Encoding.UTF8.GetBytes(value));
        }
      }

      return list.ToArray();
    }

    public byte[] int2bytes(int len)
    {
      byte[] data_len = new byte[4];
      data_len[0] = (byte)((len >> 8 * 3) & 0xFF);
      data_len[1] = (byte)((len >> 8 * 2) & 0xFF);
      data_len[2] = (byte)((len >> 8 * 1) & 0xFF);
      data_len[3] = (byte)(len & 0xFF);

      return data_len;
    }

    public int bytes2int(byte[] buffer)
    {
      int value = 0;
      value += (int)(buffer[0] << (8 * 3));
      value += (int)(buffer[1] << (8 * 2));
      value += (int)(buffer[2] << (8 * 1));
      value += (int)(buffer[3]);

      return value;
    }
  }

  public class ArgInfo
  {
    public TypeEnu type { get; set; }

    public object value { get; set; }

    public ArgInfo(TypeEnu type, object value)
    {
      this.type = type;
      this.value = value;
    }
  }

  public enum TypeEnu
  {
    Void = 0,
    Int = 1,
    Bool = 2,
    String = 3
  }

　　接口的定義沿用服務(wù)端的即可。說明一點：MyServiceProxy這個類，這里我是手寫的，真實的環(huán)境，這個類，應(yīng)該是由我們定義的某種格式，然后寫一個代碼生成器，讓他自動生成，然后就可以不用費(fèi)力，兼容所有的調(diào)用了，

當(dāng)然這里只支持了四種類型，我們還可以擴(kuò)充更多類型，只需要找到傳遞數(shù)據(jù)的方式即可。譬如一種對象，我們不知道如何傳遞，可以直接把對象定義成一個json字符串，或者序列化成二進(jìn)制，只要兩端，都知道了這個類型，就可以了。

相當(dāng)于設(shè)計模式里面的（約定大于配置了）