sunyata是一个Python3 RPC框架,client和server既可以直连,也可以通过Consul或ETCD做服务注册发现。
Python 版本 >= 3.6
pip install sunyata
创建文件myservice.py
from sunyata.rpc import rpc
@rpc
def hello(name):
return 'hello ' + name
启动:
sunyata --run myservice
下面是一个TCP协议的服务端例子。
from sunyata.rpc.server import TcpRpcServer, rpc
import asyncio
@rpc
class TestService:
def hello(self, name):
return "Hello, {}!".format(name)
async def add(self, a, b, c):
asyncio.sleep(1)
return a + b + c
@rpc
def hello(name):
return "Hello, {}!".format(name)
server = TcpRpcServer('0.0.0.0', 9988)
server.serve()
from sunyata.rpc.client import TcpRpcClient
cli = TcpRpcClient('127.0.0.1', 9988, timeout = 2)
resp = cli.TestService.hello('xiaoming')
print(resp)
#或者使用call方法
resp = cli.call('TestService.add', a=1, b=2, c=3)
print(resp)
resp = cli.call('hello', name = 'xiaoming')
print(resp)
from sunyata.rpc.client import TcpRpcClient
c = TcpRpcClient(servers = ['127.0.0.1:9988', '127.0.0.1:9989'])
resp = c.call('hello', 'zhangsan')
print(resp)
底层是基于内置web框架实现的,使用起来非常简单,和TcpRpcServer的用法类似:
from sunyata.rpc.server import HttpRpcServer, rpc
@rpc
def sayHello(name):
return 'hello ' + name
s = HttpRpcServer('0.0.0.0', 9988, workers=1)
s.serve()
客户端使用对应的HttpRpcClient对象:
from sunyata.rpc.client import HttpRpcClient
c = HttpRpcClient('127.0.0.1', 9988)
resp = c.call('sayHello', 'zhangsan')
print(resp)
将TcpRpcServer替换为UdpRpcServer即可。
from sunyata.rpc.server import UdpRpcServer, rpc
@rpc
def sayHello(name):
return 'hello ' + name
server = UdpRpcServer('0.0.0.0', 9988)
server.serve()
from sunyata.rpc.client import UdpRpcClient
cli = UdpRpcClient('127.0.0.1', 9988)
resp = cli.call('sayHello', name = 'xiaoming' )
print(resp)
除了客户端与服务端直连,也支持服务注册发现(客户端与服务端直连的例子,请参考上面的TcpRpcServer部分)。 目前支持基于Consul 或 etcd 进行服务注册发现, 下面的例子先以Consul为例。
基于Consul的Check机制,服务注册后,自动添加一个定期的检查任务。默认为TCP端口检查,支持TCP/HTTP RPC服务端,UDP服务端暂不支持。一旦服务进程挂掉,那么客户端会请求到其他健康的服务端节点上。
from sunyata.rpc.discovery import DiscoveryConfig
disconf = DiscoveryConfig(
consulHost = '192.168.19.103',
consulPort = 8500,
serviceName = 'test-rpc-server',
serviceHost = local_ip(),
servicePort = 9988
)
说明: 1.consulHost 和 consulPort 参数指定Consul的地址和端口 2.ServiceName 参数用于标记服务端名称,并通过服务名称进行服务发现,需要保证全局唯一 3.serviceHost和servicePort参数指定服务端监听的端口和地址
s = TcpRpcServer('0.0.0.0', 9988)
s.regist(sayHello)
disconf = DiscoveryConfig(
consulHost = '192.168.19.103',
consulPort = 8500,
serviceName = 'test-rpc-server',
serviceHost = local_ip(),
servicePort = 9988
)
s.setDiscoverConfig(disconf)
s.serve()
from sunyata.rpc.server import TcpRpcServer, rpc
from sunyata.rpc.discovery import DiscoveryConfig
from sunyata.util import local_ip
@rpc
def sayHello(name):
return 'hello ' + name
disconf = DiscoveryConfig(
consulHost = '192.168.19.103',
consulPort = 8500,
consulToken = 'd8ba9c48-c01a-a78e-ce8d-b65593a56419',
serviceName = 'UserService',
serviceHost = local_ip(),
servicePort = 9988,
)
server = TcpRpcServer('0.0.0.0', 9988)
server.setDiscoverConfig(disconf)
server.serve()
from sunyata.rpc.client import TcpRpcClient
from sunyata.rpc.discovery import DiscoveryConfig
cli = TcpRpcClient()
disconf = DiscoveryConfig(
consulHost= '192.168.19.103',
consulPort= 8500,
serviceName='test-rpc-server'
)
cli.setDiscoveryConfig(disconf)
resp = cli.call('sayHello', name = 'mary')
print(resp)
说明: 1.etcdHost 和 etcdPort 参数指定etcd的地址和端口 2.ServiceName 参数用于标记服务端名称,并通过服务名称进行服务发现,需要保证全局唯一 3.serviceHost和servicePort参数指定服务端监听的端口和地址
from sunyata.rpc.server import HttpRpcServer
from sunyata.rpc.discovery import DiscoveryConfig
from sunyata.util import local_ip
def sayHello(name):
return 'hello ' + name
server = HttpRpcServer('0.0.0.0', 10031)
disconf = DiscoveryConfig(
etcdHost='192.168.19.103',
etcdPort=2379,
serviceName = 'test-http-rpc-server-etcd',
serviceHost = local_ip(),
servicePort = 10031
)
server.setDiscoverConfig(disconf)
server.regist(sayHello)
server.serve()
from sunyata.rpc.client import HttpRpcClient
from sunyata.rpc.discovery import DiscoveryConfig
client = HttpRpcClient()
disconf = DiscoveryConfig(
etcdHost='192.168.19.103',
etcdPort=2379,
serviceName = 'myservice'
)
client.setDiscoveryConfig(disconf)
resp = client.sayHello('xiaoming')
assert (resp == 'hello xiaoming')
默认采用lz4进行压缩、解压缩(经过测试,它的压缩效果和gzip, zlib比较接近,压缩、解压缩性能是zlib的10倍左右)。 在数据传输大于4KB时,自动开启进行压缩。对端根据一个标记位进行判断,自动进行解压缩处理(或不处理,未经过压缩的情况)。开发者无需关心 数据的压缩、解压缩过程,经过测试对性能的影响极低(由于采用了level1级别的压缩),最高可减少75%的网络IO。
sunyata也可以作为一个web框架来使用, HttpRpcServer在此基础上构建。
from sunyata.http.server import HttpServer, route
@route('/hello', methods=['GET'])
def hello(request):
name = request.data.get('name', '')
return 'Hello ' + name
hs = HttpServer(bind='0.0.0.0', port=9989)
hs.serve()
可以通过继承Middleware类,重写handle方法,添加中间件。所有请求的都会先经过多个中间件,可用于身份验证的场景,下面是一个例子。
from sunyata.http.server import HttpServer, route
from sunyata.http.middleware import Middleware
import logging
class LogMiddleware(Middleware):
def handle(self, request):
logging.info('path:' + request.uri + ' method:' + request.method)
class AuthMiddleware(Middleware):
def handle(self, request):
if request.headers.get('token') != 'abc':
self.abort(403, 'invalid token')
@route('/api/v1/getUserName', methods=['POST', 'GET'])
def getUserName(request):
return 'tom'
app = HttpServer(port=9990, accessLog=True)
app.middlewares = [
LogMiddleware(),
AuthMiddleware(),
]
app.serve()
下面是一个dns查询场景的微服务案例,dns_service.py负责提供底层dns查询服务,dns_web.py启动http api负责提供对外接口。dns_web与dns_service之间通过rpc进行通信。
dns_service.py
from sunyata.rpc.server import HttpRpcServer, rpc
@rpc
class DnsService(object):
def query(self, domain):
print('domain', domain)
return domain + ' A IN 192.168.1.1'
rpcServer = HttpRpcServer(host='0.0.0.0', port=9988)
rpcServer.serve()
dns_web.py
from sunyata.http.server import HttpServer, route
from sunyata.rpc.client import HttpRpcClient
@route('/query', methods=['GET'])
def query(request):
domain = request.data.get('domain')
cli = HttpRpcClient('127.0.0.1', 9988)
ip = cli.DnsService.query(domain)
return ip
app = HttpServer()
app.serve()
请求dns_web curl 'http://127.0.0.1:9989/query?domain=www.a.com' 返回 www.a.com A IN 192.168.1.1
由于底层通过python特有的pickle方式进行序列化,目前只支持python语言编写的服务之间的rpc通信,暂不支持其他语言。好处是不需要 编写protobuf文件。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型