day99:MoFang:Flask-JSONRPC提供RPC接口&在APP进行窗口页面操作(窗口-帧-帧组)

1.服务端基于Flask-JSONRPC提供RPC接口

1.Flask-JSONRPC简介

1.什么是Flask-JSONRPC??

JSON-RPC是一个无状态的、轻量级的远程过程调用（RPC）协议。

所谓的RPC，Remote Procedure Call的简写，中文译作远程过程调用或者远程服务调用。

直观的理解就是，通过网络请求远程服务，获取指定接口的数据，而不用知晓底层网络协议的细节。

RPC支持的格式很多，比如XML格式，JSON格式等等。最常用的肯定是json-rpc。

-----------------------------------------------------

在flask中要实现提供json-rpc接口，开发中一般使用Flask JSON-RPC模块来实现。

git地址：https://github.com/cenobites/flask-jsonrpc

文档：http://wiki.geekdream.com/Specification/json-rpc_2.0.html

2.Flask-JSONRPC的实现原理

JSON-RPC协议中的客户端一般是为了向远程服务器请求执行某个方法/函数。客户端向实现了JSON-RPC协议的服务端发送请求，多个输入参数能够通过数组或者对象传递到远程方法，这个远程方法也能返回多个输出数据，具体是什么，当然要看具体的方法实现。因为RPC可以通俗理解为:

客户端请求服务端完成某一个服务行为,所以RPC规范要求: 客户端发送的所有请求都是POST请求!!!

所有的传输数据都是单个对象，用JSON格式进行序列化。

3.Flask-JSONRPC的请求和响应

请求要求包含三个特定属性：

jsonrpc: 用来声明JSON-RPC协议的版本，现在基本固定为“2.0”

method，方法，是等待调用的远程方法名，字符串类型

params，参数，对象类型或者是数组，向远程方法传递的多个参数值

id，任意类型值，用于和最后的响应进行匹配，也就是这里设定多少，后面响应里这个值也设定为相同的

响应的接收者必须能够给出所有请求以正确的响应。这个值一般不能为Null，且为数字时不能有小数。

响应也有三个属性：

jsonrpc, 用来声明JSON-RPC协议的版本，现在基本固定为“2.0”

result，结果，是方法的返回值，调用方法出现错误时，必须不包含该成员。

error，错误，当出现错误时，返回一个特定的错误编码，如果没有错误产生，必须不包含该成员。

id，就是请求带的那个id值，必须与请求对象中的id成员的值相同。请求对象中的id时发生错误（如：转换错误或无效的请求），它必须为Null

当然，有一些场景下，是不用返回值的，比如只对客户端进行通知，由于不用对请求的id进行匹配，所以这个id就是不必要的，置空或者直接不要了。

2.安装Flask-JSONRPC模块

pip install Flask-JSONRPC==0.3.1

3.快速实现一个测试的RPC接口

1.初始化jsonRPC

例如，我们直接在application/__init__.py项目初始化文件中进行初始化jsonrpc并关闭csrf防范机制

import os,logging

from flask_jsonrpc import JSONRPC

# 初始化jsonrpc模块

jsonrpc = JSONRPC(service_url='/api')

def init_app(config_path):

    """全局初始化"""

    # 初始化json-rpc

    jsonrpc.init_app(app)

2.编写接口代码

application/apps/home/views.py，编写接口代码

# 实现rpc接口

from application import jsonrpc

@jsonrpc.method(name="Home.index")

def index():

    return "hello world!"

1.客户端需要发起post请求，访问地址为：http://服务器地址:端口/api

2.注意：默认情况下，/api接口只能通过post请求访问。如果要使用jsonrpc提供的界面调试工具，则访问地址为：http://服务器地址端口/api/browse/

3.当然，我们可以通过postman发起post请求:

请求地址:http://127.0.0.1:5000/api

请求体:

{

    "jsonrpc":"2.0",

    "method":"Home.index",

    "params":{},

    "id":"1"

}

3.基于api接口接受来自客户端的参数

1.postman向http://127.0.0.1:5000/api发送POST请求

请求体内容:

请求地址:http://127.0.0.1:5000/api

请求体:

{

    "jsonrpc":"2.0",

    "method":"Home.index",

    "params":{"id":"abc"},

    "id":"1"

}

2.后端接口代码

from application import jsonrpc

@jsonrpc.method(name="Home.index")

def index(id):

    return "hello world!id=%s" % id

3.响应结果

响应内容:

{

    "id":1,

    "jsonrpc":"2.0",

    "result":"hello world!id=abc"

}