1. 程式人生 > >原始碼分析Dubbo 泛化呼叫與泛化實現原理

原始碼分析Dubbo 泛化呼叫與泛化實現原理

   本文將重點分析Dubbo的兩個重要特性:泛化呼叫與泛化實現。
   1、泛化引用:
在這裡插入圖片描述
   通常是服務呼叫方沒有引入API包,也就不包含介面中的實體類,故服務呼叫方只能提供Map形式的資料,由服務提供者根據Map轉化成對應的實體。
   2、泛化實現
在這裡插入圖片描述
   泛化實現,是指服務提供者未引入API包,也就不包含介面用於傳輸資料的實體類,故客戶端發起呼叫前,需要將mode轉化為Map。
從上面分析,其實所謂的泛化本質上就是Map與Bean的轉換。

   3、原始碼分析客戶端用於泛化呼叫的過濾器GenericImplFilter

public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        String generic = invoker.getUrl().getParameter(Constants.GENERIC_KEY);
        if (ProtocolUtils.isGeneric(generic)                                                                                  // @1
                && !Constants.$INVOKE.equals(invocation.getMethodName())
                && invocation instanceof RpcInvocation) {
            RpcInvocation invocation2 = (RpcInvocation) invocation;
            String methodName = invocation2.getMethodName();
            Class<?>[] parameterTypes = invocation2.getParameterTypes();
            Object[] arguments = invocation2.getArguments();

            String[] types = new String[parameterTypes.length];
            for (int i = 0; i < parameterTypes.length; i++) {
                types[i] = ReflectUtils.getName(parameterTypes[i]);
            }

            Object[] args;
            if (ProtocolUtils.isBeanGenericSerialization(generic)) {
                args = new Object[arguments.length];
                for (int i = 0; i < arguments.length; i++) {
                    args[i] = JavaBeanSerializeUtil.serialize(arguments[i], JavaBeanAccessor.METHOD);
                }
            } else {
                args = PojoUtils.generalize(arguments);
            }

            invocation2.setMethodName(Constants.$INVOKE);
            invocation2.setParameterTypes(GENERIC_PARAMETER_TYPES);
            invocation2.setArguments(new Object[]{methodName, types, args});
            Result result = invoker.invoke(invocation2);

            if (!result.hasException()) {
                Object value = result.getValue();
                try {
                    Method method = invoker.getInterface().getMethod(methodName, parameterTypes);
                    if (ProtocolUtils.isBeanGenericSerialization(generic)) {
                        if (value == null) {
                            return new RpcResult(value);
                        } else if (value instanceof JavaBeanDescriptor) {
                            return new RpcResult(JavaBeanSerializeUtil.deserialize((JavaBeanDescriptor) value));
                        } else {
                            throw new RpcException(
                                    "The type of result value is " +
                                            value.getClass().getName() +
                                            " other than " +
                                            JavaBeanDescriptor.class.getName() +
                                            ", and the result is " +
                                            value);
                        }
                    } else {
                        return new RpcResult(PojoUtils.realize(value, method.getReturnType(), method.getGenericReturnType()));
                    }
                } catch (NoSuchMethodException e) {
                    throw new RpcException(e.getMessage(), e);
                }
            } else if (result.getException() instanceof GenericException) {
                GenericException exception = (GenericException) result.getException();
                try {
                    String className = exception.getExceptionClass();
                    Class<?> clazz = ReflectUtils.forName(className);
                    Throwable targetException = null;
                    Throwable lastException = null;
                    try {
                        targetException = (Throwable) clazz.newInstance();
                    } catch (Throwable e) {
                        lastException = e;
                        for (Constructor<?> constructor : clazz.getConstructors()) {
                            try {
                                targetException = (Throwable) constructor.newInstance(new Object[constructor.getParameterTypes().length]);
                                break;
                            } catch (Throwable e1) {
                                lastException = e1;
                            }
                        }
                    }
                    if (targetException != null) {
                        try {
                            Field field = Throwable.class.getDeclaredField("detailMessage");
                            if (!field.isAccessible()) {
                                field.setAccessible(true);
                            }
                            field.set(targetException, exception.getExceptionMessage());
                        } catch (Throwable e) {
                            logger.warn(e.getMessage(), e);
                        }
                        result = new RpcResult(targetException);
                    } else if (lastException != null) {
                        throw lastException;
                    }
                } catch (Throwable e) {
                    throw new RpcException("Can not deserialize exception " + exception.getExceptionClass() + ", message: " + exception.getExceptionMessage(), e);
                }
            }
            return result;
        }

        if (invocation.getMethodName().equals(Constants.$INVOKE)                             // @2
                && invocation.getArguments() != null
                && invocation.getArguments().length == 3
                && ProtocolUtils.isGeneric(generic)) {

            Object[] args = (Object[]) invocation.getArguments()[2];
            if (ProtocolUtils.isJavaGenericSerialization(generic)) {

                for (Object arg : args) {
                    if (!(byte[].class == arg.getClass())) {
                        error(byte[].class.getName(), arg.getClass().getName());
                    }
                }
            } else if (ProtocolUtils.isBeanGenericSerialization(generic)) {
                for (Object arg : args) {
                    if (!(arg instanceof JavaBeanDescriptor)) {
                        error(JavaBeanDescriptor.class.getName(), arg.getClass().getName());
                    }
                }
            }

            ((RpcInvocation) invocation).setAttachment(
                    Constants.GENERIC_KEY, invoker.getUrl().getParameter(Constants.GENERIC_KEY));
        }
        return invoker.invoke(invocation);
    }

   程式碼@1:該分支是泛化實現,如果是泛化實現,則根據generic的值進行序列化,然後呼叫$invoke方法,因為服務端實現為泛化實現,所有的服務提供者實現GenericeServer#$invoker方法,其實現方式就是將Bean轉換成Map。這些細節將在服務端GenericFilter序列中詳細講解。

   程式碼@2:泛化引用,呼叫方是直接通過GenericService#$invoke方法進行呼叫,以此來區分是泛化呼叫還是泛化引用,那不經要問,為什麼invoker.getUrl().getParameter(Constants.GENERIC_KEY)中獲取的generic引數到底是< dubbo:service/>中配置的還是< dubbo:reference/>中配置的呢?其實不難理解:

  1. dubbo:servcie未配置而dubbo:reference配置了,則代表的是消費端的,必然是泛化引用。
  2. dubbo:servcie配置而dubbo:reference未配置了,則代表的是服務端的,必然是泛化實現。
  3. 如果兩者都配置了,generic以消費端為主。消費端引數與服務端引數的合併在服務發現時,註冊中心首先會將服務提供者的URL通知消費端,然後消費端會使用當前的配置與服務提供者URL中的配置進行合併,如遇到相同引數,則消費端覆蓋服務端。

   注:這裡我就不深入去探討其實現細節,因為這部分在下文原始碼分析GenericFilter時會詳細介紹Map與Bean轉換的細節,包含是否序列化,之所以這裡沒有細說,主要是因為我先看的是GenericFilter。
   4、原始碼分析泛化引用 GenericFilter(服務提供者)

@Activate(group = Constants.PROVIDER, order = -20000)
public class GenericFilter implements Filter {
    @Override
    public Result invoke(Invoker<?> invoker, Invocation inv) throws RpcException {
        if (inv.getMethodName().equals(Constants.$INVOKE)
                && inv.getArguments() != null
                && inv.getArguments().length == 3
                && !ProtocolUtils.isGeneric(invoker.getUrl().getParameter(Constants.GENERIC_KEY))) {       // @1
            String name = ((String) inv.getArguments()[0]).trim();
            String[] types = (String[]) inv.getArguments()[1];
            Object[] args = (Object[]) inv.getArguments()[2];
            try {
                Method method = ReflectUtils.findMethodByMethodSignature(invoker.getInterface(), name, types);             // @2
                Class<?>[] params = method.getParameterTypes();
                if (args == null) {
                    args = new Object[params.length];
                }
                String generic = inv.getAttachment(Constants.GENERIC_KEY);
                if (StringUtils.isEmpty(generic)
                        || ProtocolUtils.isDefaultGenericSerialization(generic)) {                                                             // @3
                    args = PojoUtils.realize(args, params, method.getGenericParameterTypes());
                } else if (ProtocolUtils.isJavaGenericSerialization(generic)) {                                                             // @4
                    for (int i = 0; i < args.length; i++) {
                        if (byte[].class == args[i].getClass()) {
                            try {
                                UnsafeByteArrayInputStream is = new UnsafeByteArrayInputStream((byte[]) args[i]);
                                args[i] = ExtensionLoader.getExtensionLoader(Serialization.class)
                                        .getExtension(Constants.GENERIC_SERIALIZATION_NATIVE_JAVA)
                                        .deserialize(null, is).readObject();
                            } catch (Exception e) {
                                throw new RpcException("Deserialize argument [" + (i + 1) + "] failed.", e);
                            }
                        } else {
                            throw new RpcException(
                                    "Generic serialization [" +
                                            Constants.GENERIC_SERIALIZATION_NATIVE_JAVA +
                                            "] only support message type " +
                                            byte[].class +
                                            " and your message type is " +
                                            args[i].getClass());
                        }
                    }
                } else if (ProtocolUtils.isBeanGenericSerialization(generic)) {                                                 // @5
                    for (int i = 0; i < args.length; i++) {
                        if (args[i] instanceof JavaBeanDescriptor) {
                            args[i] = JavaBeanSerializeUtil.deserialize((JavaBeanDescriptor) args[i]);
                        } else {
                            throw new RpcException(
                                    "Generic serialization [" +
                                            Constants.GENERIC_SERIALIZATION_BEAN +
                                            "] only support message type " +
                                            JavaBeanDescriptor.class.getName() +
                                            " and your message type is " +
                                            args[i].getClass().getName());
                        }
                    }
                }
                Result result = invoker.invoke(new RpcInvocation(method, args, inv.getAttachments()));    // @6
                if (result.hasException()
                        && !(result.getException() instanceof GenericException)) {
                    return new RpcResult(new GenericException(result.getException()));
                }
                if (ProtocolUtils.isJavaGenericSerialization(generic)) {                                                        // @7
                    try {
                        UnsafeByteArrayOutputStream os = new UnsafeByteArrayOutputStream(512);
                        ExtensionLoader.getExtensionLoader(Serialization.class)
                                .getExtension(Constants.GENERIC_SERIALIZATION_NATIVE_JAVA)
                                .serialize(null, os).writeObject(result.getValue());
                        return new RpcResult(os.toByteArray());
                    } catch (IOException e) {
                        throw new RpcException("Serialize result failed.", e);
                    }
                } else if (ProtocolUtils.isBeanGenericSerialization(generic)) {
                    return new RpcResult(JavaBeanSerializeUtil.serialize(result.getValue(), JavaBeanAccessor.METHOD));
                } else {
                    return new RpcResult(PojoUtils.generalize(result.getValue()));
                }
            } catch (NoSuchMethodException e) {
                throw new RpcException(e.getMessage(), e);
            } catch (ClassNotFoundException e) {
                throw new RpcException(e.getMessage(), e);
            }
        }
        return invoker.invoke(inv);  
    }
}

   程式碼@1:如果方法名為$invoker,並且只有3個引數,並且服務端實現為非返回實現,則認為本次服務呼叫時客戶端泛化引用服務端,客戶端的泛化呼叫,需要將請求引數反序列化為該介面真實的pojo物件。
   程式碼@2:根據介面名(API類)、方法名、方法引數型別列表,根據反射機制獲取對應的方法。
   程式碼@3:處理普通的泛化引用呼叫,即處理<dubbo:referecnce generic=“true” …/>,只需要將引數列表Object[]反序列化為pojo即可,具體的反序列化為PojoUtils#realize,其實現原理如下:
   在JAVA的世界中,pojo通常用map來表示,也就是一個Map可以用來表示一個物件的值,那從一個Map如果序列化一個物件呢?其關鍵的要素是要在Map中保留該物件的類路徑名。例如現在有這樣一個物件:

public class Student {
	private int id;
	private String name;
	private Team team;
	//省略get set方法
}
public class Team {
	private int id;
	private String name;
	// 省略其他屬性與set get方法
}
用Map表示Student為:
{
	“class”:"somepackeage.Student",
	"id":1,
	"name":"dingw",
	"team":
	{
		"class" : "somepackage.Team",
		"id":2,
		"name":"t"
	}
}

   也就是通過class來標識該Map需要反序列化的pojo型別。
   程式碼@4:處理< dubbo:reference generic=“nativejava” /> 啟用泛化引用,並使用nativejava序列化引數,在服務端這邊通過nativejava反序列化引數成pojo物件。
   程式碼@5:處理< dubbo:reference generic=“bean” /> 啟用泛化引用,並使用javabean序列化引數,在服務端這邊通過javabean反序列化引數成pojo物件。
   程式碼@6:序列化API方法中宣告的型別,構建new RpcInvocation(method, args, inv.getAttachments())呼叫環境,繼續呼叫後續過濾器。
   程式碼@7:處理執行結果,如果是nativejava或bean,則需要對返回結果序列化,如果是generic=true,則使用PojoUtils.generalize序列化,也即將pojo序列化為Map。
   泛化呼叫與泛化引用,就介紹到這裡了。