Dubbo案例 on Apache Dubbo

Dubbo URI

Mon, 01 Jan 0001 00:00:00 +0000

从请求的URI部分获取参数

GET 请求 samples

简单示例

接口配置

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/user/name/:name'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 uri:
 - name: name
 required: true
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 applicationName: "UserProvider"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/user/code/:code'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 uri:
 - name: code
 required: true
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.code
 mapTo: 0
 mapType: "int"
 applicationName: "UserProvider"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByCode"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/user/name/:name/age/:age'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 uri:
 - name: name
 required: true
 - name: age
 required: true
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 - name: uri.age
 mapTo: 1
 mapType: "int"
 applicationName: "UserProvider"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByNameAndAge"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"

测试

单个 string 参数

curl localhost:port/api/v1/test-dubbo/user/name/tc -X GET

如果存在数据，返回:

Dubbo 查询

Mon, 01 Jan 0001 00:00:00 +0000

从表单请求里面获取参数

GET 请求 samples

简单示例{simple}

接口配置

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/userByName'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: queryStrings.name
 mapTo: 0
 mapType: "string"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/userByNameAndAge'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: queryStrings.name
 mapTo: 0
 mapType: "string"
 - name: queryStrings.age
 mapTo: 1
 mapType: "int"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByNameAndAge"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/userByCode'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: queryStrings.code
 mapTo: 0
 mapType: "int"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByCode"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"

测试

单个 string 参数

curl localhost:port/api/v1/test-dubbo/userByName?name=tc -X GET

如果存在数据，返回:

Dubbo 错误

Mon, 01 Jan 0001 00:00:00 +0000

如何排查dubbo的错误

Pixiu 网关异常场景

服务端日志如下：

2020-11-19T20:30:26.070+0800 ERROR filter_impl/generic_service_filter.go:98 [Generic Service Filter] method:GetUserTimeout invocation arguments number was wrong
github.com/apache/dubbo-go/common/logger.Errorf

出现该情况时，由于 Dubbo 服务端返回空值（nil），Pixiu 网关也会返回空值。若日志级别设置为 Debug，可查看以下 Dubbo 日志：

2020-11-19T20:30:26.072+0800 DEBUG pixiu/pixiu.go:172 [makeDubboCallPixiu] result: 0xc0001aeeb0, err: <nil>
2020-11-19T20:30:26.072+0800 DEBUG dubbo/dubbo.go:152 [dubbo-go-pixiu] dubbo client resp:<nil>
2020-11-19T20:30:26.073+0800 DEBUG remote/call.go:117 [dubbo-go-pixiu] client call resp:<nil>

通用调用（generic invoke）场景下返回错误为 nil，原因是代码实现如下：

	if len(oldParams) != len(argsType) {
		logger.Errorf("[Generic Service Filter] method:%s invocation arguments number was wrong", methodName)
		return &protocol.RPCResult{}
	}

Pixiu 网关中的错误日志

Dubbo 服务端返回错误时：

2020-11-17T11:19:18.019+0800 ERROR remote/call.go:87 [dubbo-go-pixiu] client call err:data is exist!
github.com/apache/dubbo-go-pixiu/pixiu/pkg/logger.Errorf
 /Users/tc/Documents/workspace_2020/dubbo-go-pixiu/pkg/logger/logging.go:52
github.com/apache/dubbo-go-pixiu/pkg/filter/remote.(*clientFilter).doRemoteCall
 /Users/tc/Documents/workspace_2020/dubbo-go-pixiu/pkg/filter/remote/call.go:87
github.com/apache/dubbo-go-pixiu/pkg/filter/remote.(*clientFilter).Do.func1
 /Users/tc/Documents/workspace_2020/dubbo-go-pixiu/pkg/filter/remote/call.go:65
github.com/apache/dubbo-go-pixiu/pkg/context/http.(*HttpContext).Next
 /Users/tc/Documents/workspace_2020/dubbo-go-pixiu/pkg/context/http/context.go:54
github.com/apache/dubbo-go-pixiu/pkg/filter/timeout.(*timeoutFilter).Do.func1.1
 /Users/tc/Documents/workspace_2020/dubbo-go-pixiu/pkg/filter/timeout/timeout.go:70

返回结果：

Dubbo 混合多个部分获取参数

Mon, 01 Jan 0001 00:00:00 +0000

从 URI，Query，Body 各个部分获取参数

GET 请求 samples

简单示例

接口配置

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/user/:name'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 - name: queryStrings.age
 mapTo: 1
 mapType: "int"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "GetUserByNameAndAge"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - httpVerb: PUT
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 - name: requestBody._all
 mapTo: 1
 mapType: "object"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "UpdateUserByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/user'
 type: restful
 description: user
 methods:
 - httpVerb: PUT
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: queryStrings.name
 mapTo: 0
 mapType: "string"
 - name: requestBody._all
 mapTo: 1
 mapType: "object"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "UpdateUserByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"

测试

来自 uri 和 query

curl localhost:port/api/v1/test-dubbo/user/tc?age=99 -X GET

结果

Dubbo 结合

Mon, 01 Jan 0001 00:00:00 +0000

从 URI获取参数

GET 请求 sample

简单示例

接口配置

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/student/:name'
 type: restful
 description: student
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 applicationName: "StudentService"
 interface: "com.dubbogo.pixiu.StudentService"
 method: "GetStudentByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - httpVerb: PUT
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 - name: requestBody._all
 mapTo: 1
 mapType: "object"
 applicationName: "StudentService"
 interface: "com.dubbogo.pixiu.StudentService"
 method: "UpdateStudentByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/teacher/:name'
 type: restful
 description: teacher
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 applicationName: "TeacherService"
 interface: "com.dubbogo.pixiu.TeacherService"
 method: "GetTeacherByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - httpVerb: PUT
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: uri.name
 mapTo: 0
 mapType: "string"
 - name: requestBody._all
 mapTo: 1
 mapType: "object"
 applicationName: "TeacherService"
 interface: "com.dubbogo.pixiu.TeacherService"
 method: "UpdateTeacherByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"

server config

# dubbo server yaml configure file
# application config
application:
 organization: "dubbogopixiu.com"
 name: "BDTService"
 module: "dubbogo user-info server"
 version: "0.0.1"
 owner: "ZX"
 environment: "dev"

registries:
 "demoZk1":
 protocol: "zookeeper"
 timeout: "3s"
 address: "127.0.0.1:2181"
 "demoZk2":
 protocol: "zookeeper"
 timeout: "3s"
 address: "127.0.0.1:2182"

services:
 "StudentProvider":
 registry: "demoZk1, demoZk2"
 protocol: "dubbo"
 # Equivalent to the interface in the dubbo.xml file
 interface: "com.dubbogo.pixiu.StudentService"
 loadbalance: "random"
 warmup: "100"
 cluster: "failover"
 group: test
 version: 1.0.0
 methods:
 - name: "GetStudentByName"
 retries: 1
 loadbalance: "random"
 "TeacherProvider":
 registry: "demoZk1, demoZk2"
 protocol: "dubbo"
 # Equivalent to the interface in the dubbo.xml file
 interface: "com.dubbogo.pixiu.TeacherService"
 loadbalance: "random"
 warmup: "100"
 cluster: "failover"
 group: test
 version: 1.0.0
 methods:
 - name: "GetTeacherByName"
 retries: 1
 loadbalance: "random"

protocols:
 "dubbo":
 name: "dubbo"
 port: 20000

protocol_conf:
 dubbo:
 session_number: 700
 session_timeout: "20s"
 getty_session_param:
 compress_encoding: false
 tcp_no_delay: true
 tcp_keep_alive: true
 keep_alive_period: "120s"
 tcp_r_buf_size: 262144
 tcp_w_buf_size: 65536
 pkg_rq_size: 1024
 pkg_wq_size: 512
 tcp_read_timeout: "1s"
 tcp_write_timeout: "5s"
 wait_timeout: "1s"
 max_msg_len: 1024
 session_name: "server"

测试

来自 uri

curl localhost:8888/api/v1/test-dubbo/student/tc-student -X GET 
and
curl localhost:8888/api/v1/test-dubbo/teacher/tc-teacher -X GET

结果

Dubbo 请求体

Mon, 01 Jan 0001 00:00:00 +0000

从请求体里面获取参数

POST 请求 samples

透传

接口配置

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/user'
 type: restful
 description: user
 methods:
 - httpVerb: POST
 enable: true
 timeout: 10s
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: requestBody._all
 mapTo: 0
 mapType: "object"
 applicationName: "UserProvider"
 interface: "com.dubbogo.pixiu.UserService"
 method: "CreateUser"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - httpVerb: PUT
 enable: true
 timeout: 10s
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: requestBody._all
 mapTo: 0
 mapType: "object"
 applicationName: "UserProvider"
 interface: "com.dubbogo.pixiu.UserService"
 method: "UpdateUser"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"
 - path: '/api/v1/test-dubbo/user2'
 type: restful
 description: user
 methods:
 - httpVerb: PUT
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: requestBody.name
 mapTo: 0
 mapType: "string"
 - name: requestBody.user
 mapTo: 1
 mapType: "object"
 applicationName: "UserService"
 interface: "com.dubbogo.pixiu.UserService"
 method: "UpdateUserByName"
 group: "test"
 version: 1.0.0
 clusterName: "test_dubbo"

当使用透传的时候, mapTo: 0 是需要配置的

Dubbo 数据不完整

Mon, 01 Jan 0001 00:00:00 +0000

Dubbo 响应数据不完整

参数为空场景（Args will nil）

已在 dubbogo 1.5.4 版本中修复

当接口响应数据类型为 User 时，其结构体定义如下：

type User struct {
	ID string
	Name string
	Age int32
	Time time.Time
}

尽管 User 结构体中包含 Time 字段，但通过通用调用（generic invoke）返回的该字段值会为空（nil）。简单响应中，time 字段会直接缺失。

因此建议你短期内可将 time 类型改为 string 类型，以规避该问题。

Dubbo 通用请求

Mon, 01 Jan 0001 00:00:00 +0000

使用 dubbo 通用性请求

POST 请求 samples

建议

使用此方式，你能够给一个集群定义一个接口来请求对应 dubbo 提供的服务

接口配置

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/:application/:interface'
 type: restful
 description: common
 methods:
 - httpVerb: POST
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: dubbo
 mappingParams:
 - name: requestBody.values
 mapTo: opt.values
 - name: requestBody.types
 mapTo: opt.types
 - name: uri.application
 mapTo: opt.application
 - name: uri.interface
 mapTo: opt.interface
 - name: queryStrings.method
 mapTo: opt.method
 - name: queryStrings.group
 mapTo: opt.group
 - name: queryStrings.version
 mapTo: opt.version
 # Notice: this is the really paramTypes to dubbo service, it takes precedence over paramTypes when it is finally called.
 clusterName: "test_dubbo"

测试例子

单个 string 参数

curl host:port/api/v1/test-dubbo/UserService/com.dubbogo.proxy.UserService?group=test&version=1.0.0&method=GetUserByName -X POST -d '{"types":["string"],"values":"tc"}' --header "Content-Type: application/json"

result

Dubbo 运行简单例子

Mon, 01 Jan 0001 00:00:00 +0000

如何运行 dubbo 简单的测试例子

启动 Pixiu

打开 samples 路径

cd /dubbo-go-pixiu/samples/dubbogo/simple

使用 start.sh 启动案例

使用 start.sh help 来获取帮助信息

./start.sh help 

dubbo-go-pixiu start helper
./start.sh action project
hint:
./start.sh prepare body for prepare config file and up docker in body project
./start.sh startPixiu body for start dubbo or http server in body project
./start.sh startServer body for start pixiu in body project
./start.sh startTest body for start unit test in body project
./start.sh clean body for clean

使用 ./start.sh [action] [project] 来启动案例，比如说：

Dubbo 案例

Mon, 01 Jan 0001 00:00:00 +0000

Dubbo

基于的例子 samples

如何运行简单的测试例子文档