如何优雅地执行dubbo"单测"

时间 2019-12-23

标签如何优雅执行 dubbo 栏目 Dubbo 繁體版

原文原文链接

不少小伙伴所在的公司是基于Dubbo来构建技术栈的，平常开发中必不可少要写dubbo单测（单元测试），若是单测数据依赖已有的外部dubbo服务，通常是mock数据，若是数据比较复杂，其实mock数据也是一个不小的工做量。那有没有更好的单测方式来代替咱们完成”mock“数据功能呢，这时能够借助dubbo telnet功能，获取真实数据用在单测中使用。java

本文会先讨论如何使用基于dubbo telnet的代理工具类（DubboTelnetProxy），而后再讨论下mockito+DubboTelnetProxy如何进行多层次的单测，最后分析下如何让单测变得更加智能（好比自动注入等）。（ps：关于dubbo和mockito这里就不展开讨论了，具体能够参考对应资料~）程序员

1 Dubbo单测现状

dubbo单测其实和非dubbo单测的流程是同样的，初始化待测试类和单测上下文，打桩而后调用，最后检查返回结果。好比咱们经常使用mockito来跑单测，其简单的示例以下：bootstrap

public class DubboAppContextFilterTest extends BaseTest {
    private DubboAppContextFilter filter = new DubboAppContextFilter();

    @Before
    public void setUp() {
        cleanUpAll();
    }

    @After
    public void cleanUp() {
        cleanUpAll();
    }

    @Test
    public void testInvokeApplicationKey() {
        Invoker invoker = mock(Invoker.class);
        Invocation invocation = mock(Invocation.class);
        URL url = URL.valueOf("test://test:111/test?application=serviceA");
        when(invoker.getUrl()).thenReturn(url);

        filter.invoke(invoker, invocation);
        verify(invoker).invoke(invocation);

        String application = RpcContext.getContext().getAttachment(DubboUtils.SENTINEL_DUBBO_APPLICATION_KEY);
        assertEquals("serviceA", application);
    }
}

上面代码copy于sentinel的单元测试代码。api

2 DubboTelnetProxy

在dubbo服务机器上，咱们可使用telnet链接dubbo服务，而后执行invoke命令来手动调用dubbo接口并获取结果，DubboTelnetProxy就是将这一系列的手动操做按照dubbo telnet格式固化到代码中。在具体讨论DubboTelnetProxy以前，先看下其有哪些功能，DubboTelnetProxy特色：app

基于telnet的dubbo代理工具类，可用于本地单测中；
直接使用telnet指定ip+port进行链接，无需更多的dubbo相关配置，使用便捷；
可动态配置ip+port信息。

话很少说，先看下DubboTelnetProxy代码实现：ide

@AllArgsConstructor(access = AccessLevel.PRIVATE)
public class DubboTelnetProxy implements MethodInterceptor {

    private String ip;
    private Integer port;

    @Override
    public Object intercept(Object obj, Method method, Object[] params, MethodProxy proxy) throws Throwable {
        if ("toString".equals(method.getName())) {
            return obj.getClass().getName();
        }

        TelnetClient telnetClient = new TelnetClient();
        telnetClient.setConnectTimeout((int) TimeUnit.SECONDS.toMillis(5));
        telnetClient.connect(ip, port);
        try {
            InputStream in = telnetClient.getInputStream();
            PrintStream out = new PrintStream(telnetClient.getOutputStream());

            // 1. 发送dubbo telnet请求
            StringBuffer request = new StringBuffer("invoke ");
            request.append(method.getDeclaringClass().getTypeName()).append(".");
            request.append(method.getName()).append("(");
            request.append(StringUtils.join(Arrays.stream(params).map(JSON::toJSONString).collect(Collectors.toList()), ",")).append(")");
            out.println(request.toString());
            out.flush();

            // 2. 结果处理
            int len = 0;
            byte[] buffer = new byte[512];
            String result = "";
            while (!result.contains(StringUtils.LF) && (len = in.read(buffer)) > 0) {
                result += new String(ArrayUtils.subarray(buffer, 0, len));
            }
            result = StringUtils.substringBefore(result, StringUtils.LF);
            if (StringUtils.isBlank(result) || !result.startsWith("{")) {
                throw new RuntimeException(result);
            }

            // 3. 反序列化
            return JSON.parseObject(result, method.getGenericReturnType());
        } finally {
            telnetClient.disconnect();
        }
    }

    /**
     * mockDubboIpPortFormat：配置格式为  -Dmock.dubbo.%s=127.0.0.1:8080，%s为当前dubbo接口的名字，class.getSimpleName()
     */
    private final static String mockDubboIpPortPrefix = "mock.dubbo.";
    public final static String mockDubboIpPortFormat = mockDubboIpPortPrefix + "%s";

    /**
     * dubbo telnet建造者
     */
    public static class Builder {
        final static String DEFAULT_IP = "127.0.0.1";
        final static Integer DEFAULT_PORT = 20880;

        /**
         * 建立dubbo telnet代理
         */
        public static <T> T enhance(Class<T> clazz) {
            return enhance(clazz, null, null);
        }
        public static <T> T enhance(Class<T> clazz, String ip) {
            return enhance(clazz, ip, null);
        }
        public static <T> T enhance(Class<T> clazz, Integer port) {
            return enhance(clazz, null, port);
        }

        @SuppressWarnings("unchecked")
        public static <T> T enhance(Class<T> object, String ip, Integer port) {
            // 优先尝试从properties解析ip:port配置
            String ipPort = System.getProperties().getProperty(String.format(mockDubboIpPortFormat, object.getSimpleName()));
            if (StringUtils.isNotEmpty(ipPort)) {
                String[] array = StringUtils.split(ipPort, ",");
                ip = array[0];
                port = Integer.valueOf(array[1]);
            }

            Enhancer enhancer = new Enhancer();
            enhancer.setSuperclass(object);
            enhancer.setCallback(new DubboTelnetProxy(ObjectUtils.defaultIfNull(ip, DEFAULT_IP), ObjectUtils.defaultIfNull(port, DEFAULT_PORT)));
            return (T) enhancer.create();
        }
    }
}

DubboTelnetProxy的实现原理是使用cglib生成dubbo facade接口代理类，而后在代理类按照dubbo telnet格式拼接请求参数，最后获取返回结果并反序列化返回给应用程序。上述代码不足点是：目前每次dubbo调用都会新建telnet链接，对于单测来讲是OK的，后续若是用于本地压测或者调用频繁测试场景，考虑复用链接或者使用netty client bootstrap方式避免每次都新建链接。工具

2.1 使用示例

手动/自动指定dubbo服务IP地址：单元测试

@Test
public void test() {
  // OrderQueryService为dubbo服务的一个API接口
  System.setProperty("mock.dubbo.OrderQueryService", "127.0.0.1:20880");

  OrderQueryService orderQueryService1 = DubboTelnetProxy.Builder.enhance(OrderQueryService.class);
  OrderQueryService orderQueryService2 = DubboTelnetProxy.Builder.enhance(OrderQueryService.class, "127.0.0.1");
  OrderQueryService orderQueryService3 = DubboTelnetProxy.Builder.enhance(OrderQueryService.class, "127.0.0.1", 20880);

  OrderDTO result = orderQueryService1.query("订单号");
  System.out.println(result);
}

3 DubboTelnetProxy + mockito自动注入

平常开发中，可使用mockito进行单测，保证代码质量。在mockito中，若是想让某个DubboTelnetProxy代理类注入到待测试中，可以使用FieldUtils工具类进行属性注入。测试

使用DubboTelnetProxy + mockito示例以下：ui

@RunWith(MockitoJUnitRunner.class)
public class DemoServiceClientTest {
    @InjectMocks
    DemoServiceClient demoServiceClient;

    @Before
    public void before() throws IllegalAccessException {
        FieldUtils.writeField(demoServiceClient, "demoServiceFacade",
                DubboTelnetProxy.Builder.enhance(DemoServiceFacade.class), true);
    }

    @Test
    public void hello() throws IllegalAccessException {
        // 调用远程服务，DubboTelnetProxy方式
        demoServiceClient.hello("world");

        // 若是须要打桩，则使用Mock类
        DemoServiceFacade demoServiceFacade = Mockito.mock(DemoServiceFacade.class);
        Mockito.when(demoServiceFacade.hello("world")).thenReturn("zzz");
        FieldUtils.writeField(demoServiceClient, "demoServiceFacade", demoServiceFacade, true);
        Assert.assertEquals(demoServiceClient.hello("world"), "zzz");
    }
}

@Component
public class DemoServiceClient {
    @Resource
    private DemoServiceFacade demoServiceFacade;

    public String hello(String world) {
        return demoServiceFacade.hello(world);
    }
}

// dubbo api
public interface DemoServiceFacade {
    String hello(String world);
}

3.1 如何自动注入

要实现DubboTelnetProxy的自动注入，首先判断出来待测试类中的哪些属性须要构造DubboTelnetProxy或者对应实例，通常状况下若是属性是非本工程内的接口类型，就能够认为是dubbo api接口，进行构造DubboTelnetProxy并注入；若是属性是本工程内的接口类型，则在本工程内查找对应的实现类进行反射方式的属性注入（可以使用org.reflections包中的Reflections工具类来获取接口下全部实现类）；若是属性是普通类，则直接反射构建对象注入便可，伪代码以下：

/**
 * 默认的dubbo属性构造器，若是是非本工程内属性类型而且是接口类型，直接进行DubboTelnetProxy构建
 */
public static Function<Field, Object> DEFAULT_DUBBO_FC = field -> {
    try {
        assert Objects.nonNull(targetContext.get());
        Class fieldClass = field.getType();
        if (fieldClass.isInterface()) {
            // 本工程内的加载其实现类，非本工程内的按照DubboTelnetProxy构建
            if (!isSameProjectPath(targetContext.get().getClass(), fieldClass)) {
                return DubboTelnetProxy.Builder.enhance(fieldClass);
            } else if (fieldClass.getSimpleName().endsWith("Dao")) {
                return Mockito.mock(fieldClass);
            } else {
                String packagePath = fieldClass.getPackage().getName() + ".impl.";
                return Class.forName(packagePath + fieldClass.getSimpleName() + "Impl").newInstance();
            }
        } else if (isSameProjectPath(targetContext.get().getClass(), fieldClass)) {
            return fieldClass.newInstance();
        } else {
            // 非工程内的类直接mock掉
            return Mockito.mock(fieldClass);
        }
    } catch (Exception e) {
        System.err.println("DEFAULT_DUBBO_FC 发生异常 field=" + field);
        e.printStackTrace();
        System.exit(-1);
        return null;
    }
};

针对待注入类有多个层次，好比测试类A中属性b类型是B，B中属性c类型是C等，那么在自动注入类A的全部属性时，须要递归进行，直至全部子类型的属性都构建完毕，示例伪代码以下：

void doWithFieldsInternal(@NonNull Object target, @Nullable Function<Field, Object> fc, @Nullable Boolean recursive) {
    assert !(target instanceof Class);
    // 默认fc回调直接调用默认无参构造方法
    fc = ObjectUtils.defaultIfNull(fc, DEFAULT_FC);
    recursive = ObjectUtils.defaultIfNull(recursive, false);

    List<Object> fieldList = new ArrayList<>();
    do {
        Object finalTarget = target;
        Function<Field, Object> finalFc = fc;
        ReflectionUtils.doWithFields(finalTarget.getClass(), field -> {
            Object value = finalFc.apply(field));
            DubboReflectionUtils.setField(finalTarget, field, value);
            if (Objects.nonNull(value) && DEFAULT_FF.matches(field)) {
                fieldList.add(value);
            }
        }, filterField -> {
            // 默认只注入非基本类型而且为null的属性
            return DEFAULT_FF.matches(filterField) && DubboReflectionUtils.isNullFieldValue(finalTarget, filterField);
        });
    } while (recursive && !fieldList.isEmpty() && Objects.nonNull(target = fieldList.remove(0)));
}

3.2 如何让自动注入更易用

上述示例中的自动注入是程序会递归注入待测试类中的全部属性，但仍是须要在代码中先调用要"自动注入"的代码，为了更易用，可使用注解方式来自动注入被注解修饰的全部类或者属性，相似于在Spring中对类属性配置了@Resource以后，Spring在容器启动过程当中会自动对该属性注入对应示例，开发者无需关注。

关于如何实现mockito+DubboTelnetProxy的注解方式自动注入，笔者就不在赘述，感兴趣的小伙伴能够参考3.1中的实现思路自行实现。

说道注解，其实想实现针对某些注解执行一些特定逻辑（好比执行自动注入），能够在两种阶段对其处理，以下所示：

编译处理阶段：好比设置Java的注解处理器，通常是继承AbstractProcessor来实现特定业务逻辑，其主要的处理逻辑就是扫描、评估和处理注解的代码，以及生产 Java 文件。好比lombok中的@Setter注解就是要产生对应属性的setter方法；
容器启动阶段：这里的容器是业务程序本身定义的容器，好比Spring的IoC容器，在容器启动过程当中针对注解进行处理，首先获取注解对应的属性，而后从容器中获取属性对应的实例经过反射将其注入便可。

以上两种自动注入方式在实现都是OK的，前者在编译阶段后者在运行时，不事后者因为在运行时起做用，所以灵活性更大。

推荐阅读

欢迎小伙伴关注【TopCoder】阅读更多精彩好文。