README-zh-hans.md

English | 中文版

rpcplus

rpcplus是一个基于Go语言标准rpc包进行优化的库，提供了一系列增强功能，用于提升RPC体验。

主要特点

• 支持RPC服务端直接注册函数，简化服务提供过程。
• 允许注册匿名函数，为灵活编程提供便利。
• 自动注册接收者的所有适用的方法（通常是结构体）
  • 适用的定义请查阅函数注册
• 函数支持接收多个参数，提高调用的灵活性。
• 支持传递context.Context参数，用于更复杂的上下文管理, 如超时、取消等。
• 支持 Go 风格的返回值模式，允许函数返回 (T, error)或者error。
• 保留jsonrpc支持，提升跨语言通讯的便捷性

以上关键特性使得 rpcplus 成为一个功能全面而强大的 RPC 框架。

使用

• 服务端

      package  main
      import (
          "context"
          "github.com/vito-go/rpcplus"
          "log"
          "net"
      )
      // look at the example/example.go Stu and Add 
      func main()  {
          log.SetFlags(log.Lshortfile | log.LstdFlags)
          s := rpcplus.NewServer()
          err := s.RegisterRecv(&Stu{})
          if err != nil {
              panic(err)
          }
          err = s.RegisterFunc("Add", Add)
          if err != nil {
              panic(err)
          }
          err = s.RegisterFunc("Anonymous", func(ctx context.Context, x int, y int) (int64, error) {
              return int64(x * y), nil
          })
          if err != nil {
              panic(err)
          }
          lis, err := net.Listen("tcp", ":8081")
          if err != nil {
              panic(err)
          }
          log.Println("rpcplus: Starting server on port 8081")
          s.Serve(lis)
      }

• 客户端

      package main
      import (
          "context"
          "github.com/vito-go/rpcplus"
          "net"
      )
      // look at the example/example.go UserInfo
      func main()  {
          dialer, err := net.Dial("tcp", "127.0.0.1:8081")
          if err != nil {
              panic(err)
          }
          cli := rpcplus.NewClient(dialer)
          ctx := context.Background()
          var result UserInfo
          err = cli.Call(ctx, "Stu.GetUserInfoByUserId", &result, 181)
          if err != nil {
              panic(err)
          }
      }
  

函数注册

• 要求函数满足以下条件：

  • 一个参数或多个参数，首个为 context.Context 类型
  • 返回类型：单个 error 或两个值，第二个为 error 类型。

• 示例

    func add(ctx context.Context, x int,y int) (int, error)
    
    func GetAgeByName(ctx context.Context, name string) (int, error)
    
    func GetAgeByClassIdAndName(ctx context.Context,classId int,name string) (int, error)
    
    type UserInfo struct{
        Name string
        Age int
        ClassId int
    }
    
    func GetUserInfoByUserId(ctx context.Context,userId int) (*UserInfo, error)
    
    func UpdateUserInfo(ctx context.Context, u *UserInfo) (int64, error)

服务函数列表 (测试用例)

• 来自 debugHTTP

  Service	MethodType	Calls
  Arith.Add	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  Arith.Div	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  Arith.Error	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  Arith.Mul	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  Arith.Scan	func(context.Context, string) (*rpcplus.Reply, error)	0
  Arith.SleepMilli	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  Arith.String	func(context.Context, *rpcplus.Args) (*string, error)	0
  Embed.Exported	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.Add	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.Div	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.Error	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.Mul	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.Scan	func(context.Context, string) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.SleepMilli	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  net.rpcplus.Arith.String	func(context.Context, *rpcplus.Args) (*string, error)	0
  newServer.Arith.Add	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  newServer.Arith.Div	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  newServer.Arith.Error	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  newServer.Arith.Mul	func(context.Context, *rpcplus.Args) (*rpcplus.Reply, error)	0
  newServer.Arith.Scan	func(context.Context, string) (*rpcplus.Reply, error)	0
  newServer.Arith.SleepMilli	func(context.Context, rpcplus.Args) (*rpcplus.Reply, error)	0
  newServer.Arith.String	func(context.Context, *rpcplus.Args) (*string, error)	0

测试用例

本项目已经通过了全部的测试用例，确保了代码的质量和可靠性。我们鼓励贡献者在提交代码前运行测试，以维护项目的稳定性。