用Shell实现RPC

最新推荐文章于 2022-12-06 14:15:49 发布

原创最新推荐文章于 2022-12-06 14:15:49 发布 · 1.7k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#shell #bash #rpc #脚本网络调用

一些代码专栏收录该内容

1 篇文章

订阅专栏

ShellRPC是一个用BASH实现的简易RPC框架，允许在Shell中实现跨机器的RPC调用。它支持proto解析代码自动生成，序列化与反序列化，服务端多进程处理模型及客户端异步调用。通过定义proto格式，可以轻松实现服务端和客户端的数据交互。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

对于常写脚本的程序员来说，有时候在实现业务逻辑的时候会用到网络调用，或者需要一个shell下网络通讯框架，通常的解决思路是通过实现相应的二进制工具，再通过shell将业业务逻辑串联进行实现，自己在项目中产出的一个简单shell实现RPC的框架，有兴趣的可以了解一下 github地址是：https://github.com/SunnyPirate/shellrpc。

ShellRPC

概述

项目用BASH实现的一个简易的RPC框架，你可以用Shell来实现跨机器的RPC的调用，也就是说你可以用Shell来写网络服务，当然BASH可能不是你最好的选择，但是这个小东西却提供了一个快速和简单的实现，让你用Shell也可以实现复杂的远程服务调用。

整体介绍

这个小东西整体上实现了如下几个核心功能：

proto解析代码自动生成，序列化与反序列化
service服务端的多进程处理模型
client端的对服务的异步调用

proto的解析

你可以像其他所有的RPC框架一样定义你自己的proto格式，我们以一个AddService为例，服务的功能是将客户端传递过来的两个数做加法运算，我们可以这样定义add_request.proto

param1：1
param2：2

接下来我们定义add_response.proto,也就是服务端返回给客户端的proto描述

sum：1

这样我们定义好我们的request和response的数据结构后，我们调用rpc_proto_cg.sh,命令如下：

sh rpc_proto_cg.sh ./add_request.proto
sh rpc_proto_cg.sh ./add_response.proto

这样我们将得到两个sh文件分别是proto_add_request.sh和proto_add_response.sh,这两个文件包含对其中字段的读取.写入以及序列化和反序列化的函数，这些函数不建议修改。

编写service

这里我们以AddService为例，首先我们先定义服务端处理的函数，如下所示:

function AddService {
  local request=${1}
  local param1=$(proto_add_request_get_param1 ${request})
  local param2=$(proto_add_request_get_param2 ${request})
  local sum=0
  let "sum=param1+param2"
  local response=$(proto_add_response_make)
  response=$(proto_add_response_put_sum ${response} ${sum})
  echo ${response}
}

函数比较好理解，首先我们调用自动生成的函数来获取client通过网络发送过来的传入的参数param1和param2,这里面底层涉及到解码和反序列化的过程，使用上可以忽略。然后我们对param1和param2进行加法计算，得到的结果我们通过构造一个response并把他放入之前我们定义的sum字段，最后把这个response输出，剩下的将交给框架处理，通过网络，最后的response会传递给client端。接下来我们编写客户端的回调函数AddServiceCallback，代码如下：

function AddServiceCallback {
  local response=${1}
  local sum=$(proto_add_response_get_sum ${response})
  RPCLog "[INFO]AddService return ${sum}"
}

这里的回调函数在客户端运行，因为目前只实现了异步调用，所以需要写回调函数来处理返回结果。当然，同步是在异步的基础上实现的，未来不久将提供。

实现调用

对于客户端你需要先初始化client的环境，然后创建client的stub，最后通过对应的异步函数发起rpc调用，大概的代码如下：

function MainProcess {
  local ip=$(IONetGetLocalIPDec)
  local rpc_server_port=8877
  InitRPCClientEnv
  if [ ${RPC_FAIL} -eq $? ];then
    RPCLog "[Error] init RPC client env fail"
    return ${RPC_FAIL}
  fi
  CreateRPCClientStubNoSafe
  local add_request=$(proto_add_request_make)
  add_request=$(proto_add_request_put_param1 ${add_request} "1")
  add_request=$(proto_add_request_put_param2 ${add_request} "2")

  RPCClientAsyncCall "${ip}:${rpc_server_port}/AddService" ${add_request} AddServiceCallback
  if [ ${RPC_SUCCESS} -ne $? ];then
     echo "Send Request fail"
  fi
}

这里需要注意的对服务的调用格式是***ip:port/service_name***