mirror of
https://gitee.com/durcframework/SOP.git
synced 2025-08-18 08:31:55 +08:00
110 lines
2.1 KiB
Markdown
110 lines
2.1 KiB
Markdown
# 自定义返回结果
|
||
|
||
网关默认对业务结果进行合并，然后返回统一的格式。
|
||
|
||
针对`alipay.story.find`接口，微服务端返回结果如下：
|
||
|
||
```json
|
||
{
|
||
"name": "白雪公主",
|
||
"id": 1,
|
||
"gmtCreate": 1554193987378
|
||
}
|
||
```
|
||
|
||
网关合并后，最终结果如下
|
||
|
||
```json
|
||
{
|
||
"alipay_story_find_response": {
|
||
"msg": "Success",
|
||
"code": "10000",
|
||
"name": "白雪公主",
|
||
"id": 1,
|
||
"gmtCreate": 1554193987378
|
||
},
|
||
"sign": "xxxxx"
|
||
}
|
||
```
|
||
|
||
其中`alipay_story_find_response`是它的数据节点。规则是：
|
||
|
||
> 将接口名中的点`.`转换成下划线`_`，后面加上`_response`
|
||
|
||
代码实现如下：
|
||
|
||
```java
|
||
String method = "alipay.story.find";
|
||
return method.replace('.', '_') + "_response";
|
||
```
|
||
|
||
详见`DefaultDataNameBuilder.java`
|
||
|
||
如果要更改数据节点，比如`result`，可使用`CustomDataNameBuilder.java`。
|
||
|
||
```java
|
||
@Configuration
|
||
public class MyConfig {
|
||
|
||
static {
|
||
...
|
||
ApiConfig.getInstance().setDataNameBuilder(new CustomDataNameBuilder());
|
||
...
|
||
}
|
||
|
||
}
|
||
```
|
||
|
||
设置后，网关统一的返回结果如下：
|
||
|
||
```json
|
||
{
|
||
"result": {
|
||
...
|
||
},
|
||
"sign": "xxxxx"
|
||
}
|
||
```
|
||
|
||
此外，构造方法可指定自定义字段名称：`new CustomDataNameBuilder("data");`。
|
||
设置后，数据节点将变成`data`
|
||
|
||
```json
|
||
{
|
||
"data": {
|
||
...
|
||
},
|
||
"sign": "xxxxx"
|
||
}
|
||
```
|
||
|
||
**注**：网关设置了CustomDataNameBuilder后，SDK也要做相应的更改：`OpenConfig.dataNameBuilder = new CustomDataNameBuilder();`
|
||
|
||
## 自定义结果处理
|
||
|
||
如果想要对微服务结果做更深一步处理，步骤如下：
|
||
|
||
1. 新增一个类，继承`GatewayResultExecutor.java`，并重写`String mergeResult(T request, String serviceResult)`方法
|
||
|
||
2. 配置自定义类
|
||
|
||
```java
|
||
@Configuration
|
||
public class MyConfig {
|
||
|
||
static {
|
||
...
|
||
ApiConfig.getInstance().setGatewayResultExecutor(new MyGatewayResultExecutor());
|
||
...
|
||
}
|
||
|
||
}
|
||
```
|
||
|
||
|
||
## 不合并结果
|
||
|
||
如果不希望对结果进行合并，可在application.properties中设置`sop.api-config.merge-result=false`
|
||
|
||
|
||
这样，网关最终返回结果即为微服务端的返回结果。 |