dubbo-rpc-jsonrpc 项目技术文档

2024-12-18 06:03:48作者：范靓好Udolf

1. 安装指南

1.1 Maven 依赖

首先，确保你的项目使用 Maven 进行依赖管理。在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>com.qianmi</groupId>
    <artifactId>dubbo-rpc-jsonrpc</artifactId>
    <version>1.0.1</version>
</dependency>

1.2 Jetty 依赖（可选）

如果你选择使用 Jetty 作为服务器，还需要添加 Jetty 的依赖：

<dependency>
  <groupId>org.mortbay.jetty</groupId>
  <artifactId>jetty</artifactId>
  <version>6.1.26</version>
</dependency>

2. 项目使用说明

2.1 配置 JSON-RPC 协议

在 dubbo 配置文件中定义 JSON-RPC 协议：

<dubbo:protocol name="jsonrpc" port="8080" server="jetty" />

2.2 设置默认协议

如果你想将 JSON-RPC 设置为默认协议，可以使用以下配置：

<dubbo:provider protocol="jsonrpc" />

2.3 设置服务协议

为特定的服务设置 JSON-RPC 协议：

<dubbo:service protocol="jsonrpc" />

2.4 多端口配置

如果你需要配置多个端口，可以使用以下方式：

<dubbo:protocol id="jsonrpc1" name="jsonrpc" port="8080" />
<dubbo:protocol id="jsonrpc2" name="jsonrpc" port="8081" />

2.5 多协议配置

你还可以同时使用多种协议来暴露服务：

<dubbo:protocol name="dubbo" port="20880" />
<dubbo:protocol name="jsonrpc" port="8080" />

<dubbo:service id="helloService" interface="com.alibaba.hello.api.HelloService" version="1.0.0" protocol="dubbo,jsonrpc" />

2.6 Servlet Bridge 配置（推荐）

使用 Servlet Bridge 作为服务器：

<dubbo:protocol ... server="servlet" />

在 web.xml 中配置 Servlet：

<servlet>
    <servlet-name>dubbo</servlet-name>
    <servlet-class>com.alibaba.dubbo.remoting.http.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>dubbo</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>

注意：协议端口和 Servlet 容器端口必须一致，协议上下文路径和 Servlet 应用上下文路径也必须一致。

2.7 CORS 支持

如果你需要支持跨域资源共享（CORS），可以按如下配置：

<dubbo:protocol name="jsonrpc" ...  />
    <dubbo:parameter key="cors" value="true" />
</dubbo:protocol>

3. 项目API使用文档

3.1 Java API 示例

定义一个接口：

public interface PhoneNoCheckProvider {
    boolean isPhoneNoLimit(Operators operators, String no, String userid);
}

3.2 客户端调用示例

使用 curl 命令进行调用：

curl -i -H 'content-type: application/json' -X POST -d '{"jsonrpc": "2.0", "method": "isPhoneNoLimit", "params": [ "MOBILE", "130000", "A001"], "id": 1 }' 'http://127.0.0.1:18080/com.qianmi.api.PhoneNoCheckProvider'

3.3 Python 客户端示例

使用 Python 进行调用：

import httplib
import json

def raw_client(app_params):
    headers = {"Content-type": "application/json-rpc", "Accept": "text/json"}
    h1 = httplib.HTTPConnection('172.19.32.135', port=18080)
    h1.request("POST", '/com.qianmi.ofdc.api.phone.PhoneNoCheckProvider', json.dumps(app_params), headers)
    response = h1.getresponse()
    return response.read()

if __name__ == '__main__':
    app_params = {
        "jsonrpc": "2.0",
        "method": "isPhoneNoLimit",
        "params": ["MOBILE", "130000", "A001"],
        "id": 1
    }
    print json.loads(raw_client(app_params), encoding='utf-8')