本地伪装

了解如何在 Dubbo3 中利用本地伪装实现服务降级

特性说明

在 Dubbo3 中有一种机制可以实现轻量级的服务降级，也就是本地伪装 1。

使用场景

本地伪装常被用于服务降级。比如某验权服务，当服务提供方全部挂掉后，假如此时服务消费方发起了一次远程调用，那么本次调用将会失败并抛出一个 RpcException 异常。

为了避免出现这种直接抛出异常的情况出现，那么客户端就可以利用本地伪装来提供 Mock 数据返回授权失败。

使用方式

开启 Mock 配置

在 Spring XML 配置文件中按以下方式配置：

  1. <dubbo:reference interface="com.foo.BarService" mock="true" />

或

  1. <dubbo:reference interface="com.foo.BarService" mock="com.foo.BarServiceMock" />

在工程中提供 Mock 实现 2：

  1. package com.foo;
  2. public class BarServiceMock implements BarService {
  3.     public String sayHello(String name) {
  4.         // 你可以伪造容错数据，此方法只在出现RpcException时被执行
  5.         return "容错数据";
  6.     }
  7. }

使用 return 关键字 Mock 返回值

使用 return 来返回一个字符串表示的对象，作为 Mock 的返回值。合法的字符串可以是：

  • empty：代表空，返回基本类型的默认值、集合类的空值、自定义实体类的空对象 3
  • null：返回 null
  • true：返回 true
  • false：返回 false
  • JSON 字符串：返回反序列化 JSON 串后所得到的对象

举个例子，如果服务的消费方经常需要 try-catch 捕获异常，如：

  1. public class DemoService {
  3.     public Offer findOffer(String offerId) {
  4.         Offer offer = null;
  5.         try {
  6.             offer = offerService.findOffer(offerId);
  7.         } catch (RpcException e) {
  8.             logger.error(e);
  9.         }
  11.         return offer;
  12.     }
  13. }

那么请考虑改为 Mock 实现，并在 Mock 实现中 return null。如果只是想简单的忽略异常，在 2.0.11 以上版本可用：

  1. <dubbo:reference interface="com.foo.BarService" mock="return null" />

使用 throw 关键字 Mock 抛出异常

使用 throw 来返回一个 Exception 对象，作为 Mock 的返回值。

当调用出错时，抛出一个默认的 RPCException:

  2. <dubbo:reference interface="com.foo.BarService" mock="throw"/>

当调用出错时，抛出指定的 Exception 4：

  2. <dubbo:reference interface="com.foo.BarService" mock="throw com.foo.MockException"/>

使用 force 和 fail 关键字来配置 Mock 的行为

force: 代表强制使用 Mock 行为，在这种情况下不会走远程调用。

fail: 与默认行为一致，只有当远程调用发生错误时才使用 Mock 行为。也就是说，配置的时候其实是可以不使用 fail 关键字的，直接使用 throw 或者 return 就可以了。

force: 和 fail: 都支持与 throw 或者 return 组合使用。

强制返回指定值：

  2. <dubbo:reference interface="com.foo.BarService" mock="force:return fake"/>

强制抛出指定异常：

  2. <dubbo:reference interface="com.foo.BarService" mock="force:throw com.foo.MockException"/>

调用失败时返回指定值：

  2. <dubbo:reference interface="com.foo.BarService" mock="fail:return fake"/>
  4. <!-- 等价于以下写法 -->
  5. <dubbo:reference interface="com.foo.BarService" mock="return fake"/>

调用失败时抛出异常

  2. <dubbo:reference interface="com.foo.BarService" mock="fail:throw com.foo.MockException"/>
  4. <!-- 等价于以下写法 -->
  5. <dubbo:reference interface="com.foo.BarService" mock="throw com.foo.MockException"/>

在方法级别配置 Mock

Mock 可以在方法级别上指定，假定 com.foo.BarService 上有好几个方法，我们可以单独为 sayHello() 方法指定 Mock 行为。

具体配置如下所示，在本例中，只要 sayHello() 被调用到时，强制返回 “fake”:

  2. <dubbo:reference id="demoService" check="false" interface="com.foo.BarService">
  3.     <dubbo:parameter key="sayHello.mock" value="force:return fake"/>
  4. </dubbo:reference>

注意事项

  1. Mock 是 Stub 的一个子集，便于服务提供方在客户端执行容错逻辑，因经常需要在出现 RpcException (比如网络失败，超时等)时进行容错，而在出现业务异常(比如登录用户名密码错误)时不需要容错，如果用 Stub，可能就需要捕获并依赖 RpcException 类，而用 Mock 就可以不依赖 RpcException，因为它的约定就是只有出现 RpcException 时才执行。 ↩︎

  2. 在 interface 旁放一个 Mock 实现，它实现 BarService 接口，并有一个无参构造函数。同时，如果没有在配置文件中显式指定 Mock 类的时候，那么需要保证 Mock 类的全限定类名是 原全限定类名+Mock 的形式，例如 com.foo.BarServiceMock，否则将会 Mock 失败。 ↩︎

  3. 如果返回值是一个实体类，那么此时返回的将会是一个属性都为默认值的空对象而不是 null。 ↩︎

  4. 自定义异常必须拥有一个入参为 String 的构造函数，该构造函数将用于接受异常信息。 ↩︎

最后修改 December 16, 2022: Fix check (#1736) (97972c1)