Dubbo Samples on Apache Dubbo

Dubbo Body

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

Get the parameter from the body

POST request samples

Passthroughs

Api Config

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"

when passthroughs, mapTo: 0 needed

Dubbo Body(Http)

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

Get the parameter from the body

POST request

Passthroughs

Api Config

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/user'
 type: restful
 description: user
 methods:
 - httpVerb: POST
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 queryStrings:
 - name: name
 required: true
 integrationRequest:
 requestType: http
 host: 127.0.0.1:8889
 path: /UserProvider/CreateUser
 group: "test"
 version: 1.0.0

Request

curl host:port/api/v1/test-dubbo/user -X POST -d '{"name": "tiecheng","id": "0002","code": 3,"age": 18}' --header "Content-Type: application/json"

Response

If first add, return like:

{
 "id": "0002",
 "code": 3,
 "name": "tiecheng",
 "age": 18,
 "time": "0001-01-01T00:00:00Z"
}

If you add user multi, return like:

{
 "message": "data is exist"
}

Dubbo Error

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

How to check dubbo error

Pixiu bug condition

Server log.

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

If this case happens, pixiu will return nil because dubbo server return nil. You can see dubbo log follow when log format is debug.

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>

When generic invoke, err will return nil, because wrote the code as below.

Dubbo Incomplete

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

Dubbo incomplete

Args will nil

fix in dubbogo 1.5.4

When the response is User, see below code:

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

Although User struct has Time value, generic invoke will return nil. the simple response time field is disappear.

So I suggest you can use string to time type for a short time.

Dubbo Mix

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

Get the parameter from the part of uri,query,body

GET request samples

Simple Demo

Api Config

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"

Test

from uri and query

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

result

Dubbo Multi

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

Get the parameter from the part of uri

GET request sample

Simple Demo

Api Config

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: "dubbogoproxy.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"

Test

from 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

result

Dubbo Query

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

Get the parameter from the query

GET request samples

Simple Demo{simple}

Api Config

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"

Test

single param string

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

If exist, will return:

Dubbo Query(Http)

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

Get the parameter from the query

GET request

Simple Demo

Api Config

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-dubbo/user'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 queryStrings:
 - name: name
 required: true
 integrationRequest:
 requestType: http
 host: 127.0.0.1:8889
 path: /UserProvider/GetUserByName
 mappingParams:
 - name: queryStrings.name
 mapTo: queryStrings.name
 group: "test"
 version: 1.0.0

Request

curl http://localhost:8888/api/v1/test-dubbo/user?name=tc -X GET

Response

Successful result will return:

{
 "id": "0001",
 "code": 1,
 "name": "tc",
 "age": 18,
 "time": "2020-12-24T16:46:31.8409857+08:00"
}

Dubbo Registry

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

Generate API config automatically from dubbogo registry

Doc metions below fit the code in the samples/dubbogo/simple/registry

Define Pixiu Config

static_resources:
 listeners:
 - name: "net/http"
 protocol_type: "HTTP"
 address:
 socket_address:
 address: "0.0.0.0"
 port: 8881
 filter_chains:
 filters:
 - name: dgp.filter.httpconnectionmanager
 config:
 route_config:
 routes:
 - match:
 prefix: "/"
 route:
 cluster: "test-dubbo"
 cluster_not_found_response_code: 505
 http_filters:
 - name: dgp.filter.http.apiconfig
 config:
 dynamic: true
 dynamic_adapter: test
 # configure the dubbogo registry
 - name: dgp.filter.http.dubboproxy
 config:
 dubboProxyConfig:
 registries:
 "zookeeper":
 protocol: "zookeeper"
 timeout: "3s"
 address: "127.0.0.1:2181"
 username: ""
 password: ""
 timeout_config:
 connect_timeout: 5s
 request_timeout: 5s
 - name: dgp.filter.http.response
 config:
 server_name: "test_http_dubbo"
 generate_request_id: false
 config:
 idle_timeout: 5s
 read_timeout: 5s
 write_timeout: 5s
 clusters:
 - name: "test-dubbo"
 lb_policy: "RoundRobin"
 registries:
 "zookeeper":
 timeout: "3s"
 address: "127.0.0.1:2181"
 username: ""
 password: ""
 shutdown_config:
 timeout: "60s"
 step_timeout: "10s"
 reject_policy: "immediacy"
 adapters:
 - id: test
 name: dgp.adapter.dubboregistrycenter
 config:
 registries:
 "zookeeper":
 protocol: zookeeper
 address: "127.0.0.1:2181"
 timeout: "5s"

We should configure the dgp.filter.http.dubboproxy filter in the configuration file.

Dubbo Related

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

Dubbo Catalog

http to dubbo-protocol-base dubbo request

http to http-protocl-base dubbo request

Based on samples

How do I run a simple test example document

Dubbo Simple Run

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

How run dubbo simple test samples

Start Pixiu

cd sample dir

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

use start.sh to start pixiu and server quickly

start.sh help for help info

./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

Use ./start.sh [action] [project] to start sample，for exmaple：

Dubbo Universality

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

Use dubbo request universality

POST request samples

Suggest

In this way, you can request your dubbo rpc service by defined one api for every cluster.

Api Config

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"

Test

single param 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 Uri

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

Get the parameter from the uri

GET request samples

Simple Demo

Api Config

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"

Test

single param string

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

If exist, will return:

HTTP Body

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

Get the parameter from the body

POST request

Passthroughs

Api Config

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-http/user'
 type: restful
 description: user
 methods:
 - httpVerb: POST
 enable: true
 timeout: 10s
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: http
 host: "127.0.0.1:1314"
 path: "/user/"

Request

curl host:port/api/v1/test-http/user -X POST -d '{"name": "tiecheng1","code": 4,"age": 18}' --header "Content-Type: application/json"

Response

If first add, return like:

{
 "id": "XVlBz",
 "name": "tiecheng1",
 "age": 18,
 "time": "0001-01-01T00:00:00Z"
}

If you add user multi, return like:

{
 "message": "data is exist"
}

Http Query

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

Get the parameter from the query

GET request

Simple Demo

Api Config

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-http/user'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 queryStrings:
 - name: name
 required: true
 integrationRequest:
 requestType: http
 host: "127.0.0.1:1314"
 path: "/user"
 - httpVerb: POST
 enable: true
 timeout: 10s
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: http
 host: "127.0.0.1:1314"
 path: "/user/"

Request

curl http://localhost:8888/api/v1/test-http/user?name=tc -X GET

Response

Successful result will return:

{
 "id": "0001",
 "name": "tc",
 "age": 18,
 "time": "2020-12-30T14:07:07.9432117+08:00"
}

Http Uri

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

Get the parameter from the URI

GET request
downstream service url is 127.0.0.1:1314/user?name=tc downstream service url is 127.0.0.1:1314/user/:name

POST request
downstream service url is 127.0.0.1:1314/user request body as below:
type User struct {
Name string json:"name"
Age int32 json:"age"
Time time.Time json:"time"
}

Simple Demo

Api Config

name: pixiu
description: pixiu sample
resources:
 - path: '/api/v1/test-http/user'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 queryStrings:
 - name: name
 required: true
 integrationRequest:
 requestType: http
 host: "127.0.0.1:1314"
 path: "/user"
 - httpVerb: POST
 enable: true
 timeout: 10s
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: http
 host: "127.0.0.1:1314"
 path: "/user/"
 resources:
 - path: '/:name'
 type: restful
 description: user
 methods:
 - httpVerb: GET
 enable: true
 timeout: 1000ms
 inboundRequest:
 requestType: http
 queryStrings:
 - name: name
 required: true
 integrationRequest:
 requestType: http
 mappingParams:
 - name: uri.name
 mapTo: uri.name
 host: "127.0.0.1:1314"
 path: "/user/:name"
 - httpVerb: POST
 enable: true
 timeout: 10s
 inboundRequest:
 requestType: http
 integrationRequest:
 requestType: http
 host: "127.0.0.1:1314"
 path: "/user/"
 mappingParams:
 - name: uri.name
 mapTo: requestBody.name
 - name: requestBody.age
 mapTo: requestBody.age
 - name: queryStrings.time
 mapTo: requestBody.time

Sample Requests

Passthrough Get request

curl --request GET 'localhost:8888/api/v1/test-http/user?name=joe2'

Response

If exist, will return:

{
 "id": "XVlBz",
 "name": "joe2",
 "age": 20,
 "time": "2021-01-01T00:00:00Z"
}

Not found, return: nil

Mix Post request

curl --request POST 'localhost:8888/api/v1/test-http/user/tc2?time=2021-01-01T00:00:00Z' \
--header 'Content-Type: application/json' \
--data-raw '{
 "age": 19
}'

Response

{
 "id": "XVlBz",
 "name": "tc2",
 "age": 19,
 "time": "2021-01-01T00:00:00Z"
}

Mix GET request

curl --request GET 'localhost:8888/api/v1/test-http/user/tc'

Response

{
 "id": "0001",
 "name": "tc",
 "age": 18,
 "time": "2020-12-28T13:38:25.687309+08:00"
}