dubbo设置mock返回统一的自定义对象

Mock

在 dubbo 中，Mock 只有拦截到 RpcException 时才会启用，属于异常容错方式的一种。

问题描述

在开发微服务应用中，我的所有的 Rpc 接口都有一个统一的封装：ApiResponse。如果某个微服务未启动或者出现故障的时候，其他服务调用这个服务的接口时，就会抛异常，我希望设置为不抛异常，而是同样返回一个 ApiResponse。

处理方式

在配置文件中，添加如下配置：
dubbo.consumer.mock=return {“code”:300,”message”:”fail”}
将 mock 设置为 return+ 空格 + 对象的 json 字符串即可

分析

在 com.alibaba.dubbo.rpc.cluster.support.wrapper.MockClusterInvoker 中，有以下一段代码，如果设置了 mock，则会根据设置的 mock 来执行不同的操作：

 @Override
    public Result invoke(Invocation invocation) throws RpcException {
        Result result = null;

        String value = directory.getUrl().getMethodParameter(invocation.getMethodName(), Constants.MOCK_KEY, Boolean.FALSE.toString()).trim();
        if (value.length() == 0 || value.equalsIgnoreCase("false")) {
            //no mock
            result = this.invoker.invoke(invocation);
        } else if (value.startsWith("force")) {if (logger.isWarnEnabled()) {logger.info("force-mock:" + invocation.getMethodName() + "force-mock enabled , url :" + directory.getUrl());
            }
            //force:direct mock
            result = doMockInvoke(invocation, null);
        } else {
            //fail-mock
            try {result = this.invoker.invoke(invocation);
            } catch (RpcException e) {if (e.isBiz()) {throw e;} else {if (logger.isWarnEnabled()) {logger.warn("fail-mock:" + invocation.getMethodName() + "fail-mock enabled , url :" + directory.getUrl(), e);
                    }
                    result = doMockInvoke(invocation, e);
                }
            }
        }
        return result;
    }

对设置的 mock 的处理是在 com.alibaba.dubbo.rpc.support.MockInvoker.invoke(Invocation invocation) 中，如果设置的 mock 是以 return 开始的，则会调用下面的方法：

public static Object parseMockValue(String mock, Type[] returnTypes) throws Exception {
        Object value = null;
        if ("empty".equals(mock)) {value = ReflectUtils.getEmptyObject(returnTypes != null && returnTypes.length > 0 ? (Class<?>) returnTypes[0] : null);
        } else if ("null".equals(mock)) {value = null;} else if ("true".equals(mock)) {value = true;} else if ("false".equals(mock)) {value = false;} else if (mock.length() >= 2 && (mock.startsWith("\"") && mock.endsWith("\"")
                || mock.startsWith("\'") && mock.endsWith("\'"))) {value = mock.subSequence(1, mock.length() - 1);
        } else if (returnTypes != null && returnTypes.length > 0 && returnTypes[0] == String.class) {value = mock;} else if (StringUtils.isNumeric(mock)) {value = JSON.parse(mock);
        } else if (mock.startsWith("{")) {value = JSON.parseObject(mock, Map.class);
        } else if (mock.startsWith("[")) {value = JSON.parseObject(mock, List.class);
        } else {value = mock;}
        if (returnTypes != null && returnTypes.length > 0) {value = PojoUtils.realize(value, (Class<?>) returnTypes[0], returnTypes.length > 1 ? returnTypes[1] : null);
        }
        return value;
    }

   从解析代码中，我们可以看出，我们只需要 mock 设置为需要返回的对象的 json 字符串，dubbo 会先把字符串转换为 Map，在将 Map 转换为接口的返回类型的对象。