Dubbo之Wrapper源码解析
功能概述
- 为了减少反射的调用，Dubbo会为每个服务提供者的实现生成一个Wrapper类，通过Wrapper类去调用真正的接口实现类。
功能分析
核心类Wrapper分析
主要成员变量分析
private static final Map<Class<?>, Wrapper> WRAPPER_MAP = new ConcurrentHashMap<Class<?>, Wrapper>(); //class wrapper map：类与Wrapper的缓存，当需要执行调用时，根据Class即可找到Wrapper，然后通过Wrapper调用目标对象中方法，减少反射调用
private static final String[] EMPTY_STRING_ARRAY = new String[0];
private static final String[] OBJECT_METHODS = new String[] {"getClass", "hashCode", "toString", "equals"};
private static final Wrapper OBJECT_WRAPPER = new Wrapper() {
...代码省略...
}//Object对应的封装类（匿名内部类）
主要成员方法分析
获取Wrapper封装类
public static Wrapper getWrapper(Class<?> c) { //获取Wrapper的实例（先从缓存中获取，若没有则对应创建）
while (ClassGenerator.isDynamicClass(c)) // can not wrapper on dynamic class.
{
c = c.getSuperclass(); //不能封装动态类，动态类取它的父类进行封装
}
if (c == Object.class) { //Object 返回默认的对象封装类
return OBJECT_WRAPPER;
}
return WRAPPER_MAP.computeIfAbsent(c, key -> makeWrapper(key)); //构建封装类，并设置到缓存中，key的值与c相同
}
创建封装类
private static Wrapper makeWrapper(Class<?> c) { //为指定class构建Wrapper封装类的实例
if (c.isPrimitive()) { //基本类型不能创建封装类
throw new IllegalArgumentException("Can not create wrapper for primitive type: " + c);
}
String name = c.getName(); //被封装的类的全限定名，如：org.apache.dubbo.demo.GreetingService
ClassLoader cl = ClassUtils.getClassLoader(c); //获取类加载器
// 拼接类代码对应的字符串 (对应Wrapper类中的抽象方法)
StringBuilder c1 = new StringBuilder("public void setPropertyValue(Object o, String n, Object v){ "); //构建当前类中的setPropertyValue()抽象方法
StringBuilder c2 = new StringBuilder("public Object getPropertyValue(Object o, String n){ ");
StringBuilder c3 = new StringBuilder("public Object invokeMethod(Object o, String n, Class[] p, Object[] v) throws " + InvocationTargetException.class.getName() + "{ ");
c1.append(name).append(" w; try{ w = ((").append(name).append(")$1); }catch(Throwable e){ throw new IllegalArgumentException(e); }"); //将setPropertyValue方法中的Object强制转化为具体类型，如：(org.apache.dubbo.demo.GreetingService)$1
c2.append(name).append(" w; try{ w = ((").append(name).append(")$1); }catch(Throwable e){ throw new IllegalArgumentException(e); }"); //将getPropertyValue方法中的Object强制转化为具体类型
c3.append(name).append(" w; try{ w = ((").append(name).append(")$1); }catch(Throwable e){ throw new IllegalArgumentException(e); }"); //将invokeMethod方法中的Object强制转化为具体类型
Map<String, Class<?>> pts = new HashMap<>(); // 属性名与属性类型的映射Map
Map<String, Method> ms = new LinkedHashMap<>(); // 方法对应的描述符与方法实例的映射Map
List<String> mns = new ArrayList<>(); // method names. 方法名列表
List<String> dmns = new ArrayList<>(); // declaring method names. 被封装的类或接口中，声明的方法名列表
// get all public field.
for (Field f : c.getFields()) { //处理被封装类的所有public字段
String fn = f.getName(); //获取字段名称
Class<?> ft = f.getType(); //获取字段类型，如 java.lang.String
if (Modifier.isStatic(f.getModifiers()) || Modifier.isTransient(f.getModifiers())) { //static、transient修饰的字段不处理（接口中的字段，都是public static final字段，所以不会处理，那这里处理就是对类封装时处理）
continue;
}
c1.append(" if( $2.equals(\"").append(fn).append("\") ){ w.").append(fn).append("=").append(arg(ft, "$3")).append("; return; }"); //通过setPropertyValue方法，为目标对象设置成员属性的值，如：if( $2.equals("employeeName") ){ w.employeeName=(java.lang.String)$3;
c2.append(" if( $2.equals(\"").append(fn).append("\") ){ return ($w)w.").append(fn).append("; }"); //通过getPropertyValue方法，获取目标对象的成员变量值，如：if( $2.equals("employeeName") ){ return ($w)w.employeeName; }
pts.put(fn, ft); //设置成员属性名与属性类型的关系，如Map<"employeeName,"java.lang.String">
}
Method[] methods = c.getMethods();
// get all public method.
boolean hasMethod = hasMethods(methods); //处理被封装类的所有public方法（判断是否有非Object中的方法）
if (hasMethod) { //拼接invokeMethod方法中的调用逻辑（把被封装的类或接口中的声明方法，依次拼接起来）
c3.append(" try{");
for (Method m : methods) { //对类中的方法依次封装处理（构造Wrapper中的invokeMethod方法，如org.apache.dubbo.demo.GreetingService中声明中的所有方法）
//ignore Object's method.（忽略Object对象中的方法）
if (m.getDeclaringClass() == Object.class) {
continue;
}
String mn = m.getName();
c3.append(" if( \"").append(mn).append("\".equals( $2 ) "); //$2指当前类中的invokeMethod()的第二个参数（比较方法名称）
int len = m.getParameterTypes().length;
c3.append(" && ").append(" $3.length == ").append(len);// 比较方法参数个数（需要方法名称和参数个数都相等）
boolean override = false; //判断同一个接口或类中是存在重载的方法
for (Method m2 : methods) { //按方法名，判断是否重写
if (m != m2 && m.getName().equals(m2.getName())) {
override = true;
break;
}
}
if (override) { //若有重载的方法（只按方法名称不能匹配出方法，还得按参数类型进行匹配）
if (len > 0) { //方法参数个数
for (int l = 0; l < len; l++) { //
c3.append(" && ").append(" $3[").append(l).append("].getName().equals(\"")
.append(m.getParameterTypes()[l].getName()).append("\")");
}
}
}
c3.append(" ) { "); //组装出判断条件，如：if( "hello".equals( $2 ) && $3.length == 1 && $3[0].getName().equals("org.apache.dubbo.demo.Fruit"))
if (m.getReturnType() == Void.TYPE) { //返回类型为void
c3.append(" w.").append(mn).append('(').append(args(m.getParameterTypes(), "$4")).append(");").append(" return null;");
} else { //方法有返回类型（组装方法的返回类型，如：return ($w)w.hello((org.apache.dubbo.demo.Fruit)$4[0] ）
c3.append(" return ($w)w.").append(mn).append('(').append(args(m.getParameterTypes(), "$4")).append(");");
}
c3.append(" }");
mns.add(mn); //加入到方法名列表
if (m.getDeclaringClass() == c) {
dmns.add(mn); //被封装的类或接口中声明的方法
}
ms.put(ReflectUtils.getDesc(m), m); //将方法描述符与方法实例缓存起来
}
c3.append(" } catch(Throwable e) { ");
c3.append(" throw new java.lang.reflect.InvocationTargetException(e); ");
c3.append(" }");
}
c3.append(" throw new " + NoSuchMethodException.class.getName() + "(\"Not found method \\\"\"+$2+\"\\\" in class " + c.getName() + ".\"); }"); //若没有找到方法，则抛出“未找到方法”的异常
// deal with get/set method.（处理set/get方法，非规范的方法就不会处理了）
Matcher matcher;
for (Map.Entry<String, Method> entry : ms.entrySet()) {
String md = entry.getKey(); //暴露接口中的方法描述信息，如hello(Lorg/apache/dubbo/demo/FruitEnum;)Ljava/lang/String;
Method method = entry.getValue();
if ((matcher = ReflectUtils.GETTER_METHOD_DESC_PATTERN.matcher(md)).matches()) { //判断是否匹配get方法对应的描述信息（描述信息可以确定唯一的方法）
String pn = propertyName(matcher.group(1));
c2.append(" if( $2.equals(\"").append(pn).append("\") ){ return ($w)w.").append(method.getName()).append("(); }");
pts.put(pn, method.getReturnType());
} else if ((matcher = ReflectUtils.IS_HAS_CAN_METHOD_DESC_PATTERN.matcher(md)).matches()) { //匹配is、has、can方法
String pn = propertyName(matcher.group(1));
c2.append(" if( $2.equals(\"").append(pn).append("\") ){ return ($w)w.").append(method.getName()).append("(); }");
pts.put(pn, method.getReturnType());
} else if ((matcher = ReflectUtils.SETTER_METHOD_DESC_PATTERN.matcher(md)).matches()) { //匹配set方法
Class<?> pt = method.getParameterTypes()[0];
String pn = propertyName(matcher.group(1));
c1.append(" if( $2.equals(\"").append(pn).append("\") ){ w.").append(method.getName()).append("(").append(arg(pt, "$3")).append("); return; }"); //拼接的内容如：" if( $2.equals("msg") ){ w.setMsg((java.lang.String)$3); return;"
pts.put(pn, pt); //设置属性名与属性Class的映射
}
}
c1.append(" throw new " + NoSuchPropertyException.class.getName() + "(\"Not found property \\\"\"+$2+\"\\\" field or setter method in class " + c.getName() + ".\"); }");
c2.append(" throw new " + NoSuchPropertyException.class.getName() + "(\"Not found property \\\"\"+$2+\"\\\" field or setter method in class " + c.getName() + ".\"); }");
// make class（构建Class对象）
long id = WRAPPER_CLASS_COUNTER.getAndIncrement();
ClassGenerator cc = ClassGenerator.newInstance(cl); //使用ClassGenerator类生成器来生成Wrapper的Class
cc.setClassName((Modifier.isPublic(c.getModifiers()) ? Wrapper.class.getName() : c.getName() + "$sw") + id); //org.apache.dubbo.common.bytecode.Wrapper0，判断类是否是public，然后进行类名拼接
cc.setSuperClass(Wrapper.class); //将Wrapper指定为父类，创建其封装类
cc.addDefaultConstructor(); //添加默认构造函数
cc.addField("public static String[] pns;"); // property name array.
cc.addField("public static " + Map.class.getName() + " pts;"); // property type map.
cc.addField("public static String[] mns;"); // all method name array.
cc.addField("public static String[] dmns;"); // declared method name array.
for (int i = 0, len = ms.size(); i < len; i++) {
cc.addField("public static Class[] mts" + i + ";");
}
cc.addMethod("public String[] getPropertyNames(){ return pns; }");
cc.addMethod("public boolean hasProperty(String n){ return pts.containsKey($1); }");
cc.addMethod("public Class getPropertyType(String n){ return (Class)pts.get($1); }");
cc.addMethod("public String[] getMethodNames(){ return mns; }");
cc.addMethod("public String[] getDeclaredMethodNames(){ return dmns; }");
cc.addMethod(c1.toString()); //处理setPropertyValue()方法
cc.addMethod(c2.toString()); //处理getPropertyValue()方法
cc.addMethod(c3.toString()); //处理invokeMethod()方法
try {
Class<?> wc = cc.toClass(); //将CtClass转换为Class
// setup static field.（设置静态字段值）
wc.getField("pts").set(null, pts);
wc.getField("pns").set(null, pts.keySet().toArray(new String[0]));
wc.getField("mns").set(null, mns.toArray(new String[0]));
wc.getField("dmns").set(null, dmns.toArray(new String[0]));
int ix = 0;
for (Method m : ms.values()) { //遍历方法参数列表
wc.getField("mts" + ix++).set(null, m.getParameterTypes());
}
return (Wrapper) wc.newInstance(); //使用Class对象创建实例，并强转为Wrapper类型
} catch (RuntimeException e) {
throw e;
} catch (Throwable e) {
throw new RuntimeException(e.getMessage(), e);
} finally {
cc.release();
ms.clear();
mns.clear();
dmns.clear();
}
}
关联类ClassGenerator分析
主要成员变量分析
private static final AtomicLong CLASS_NAME_COUNTER = new AtomicLong(0); //未指定类名时，默认产生类名，用到的下标
private static final String SIMPLE_NAME_TAG = "" ;
private static final Map<ClassLoader, ClassPool> POOL_MAP = new ConcurrentHashMap<ClassLoader, ClassPool>(); //ClassLoader - ClassPool（类加载器与javassist中的类池对应缓存）
private ClassPool mPool; //javassist中的类池
private CtClass mCtc; //javassist中的编译时类
private String mClassName; //动态生成的类名
private String mSuperClass; //父类对应的名称
private Set<String> mInterfaces; //存放类实现的接口列表
private List<String> mFields; //存放字段对应的代码片段，如ccp.addField("public static java.lang.reflect.Method[] methods;");
private List<String> mConstructors; //存放构造函数对应的代码片段
private List<String> mMethods; //存放方法对应的代码片段
private Map<String, Method> mCopyMethods; // 方法描述符与方法实例的映射
private Map<String, Constructor<?>> mCopyConstructors; // 方法描述符与构造实例的映射
private boolean mDefaultConstructor = false; //是否使用默认构造函数
主要成员方法分析
动态创建Class对象
public Class<?> toClass(ClassLoader loader, ProtectionDomain pd) { //创建Class对象（将当前维护的Class信息，创建Class对象）
if (mCtc != null) {
mCtc.detach(); //detach:分离， 从ClassPool中移除CtClass
}
// 基于当前类维护的数据，进行逻辑处理
long id = CLASS_NAME_COUNTER.getAndIncrement();
try {
CtClass ctcs = mSuperClass == null ? null : mPool.get(mSuperClass); // 从类池ClassPool中获取类名mSuperClass对应的CtClass
if (mClassName == null) { //若没显示设置类名时，自动生成对应的类名，如 org.apache.dubbo.common.bytecode.ClassGenerator0
mClassName = (mSuperClass == null || javassist.Modifier.isPublic(ctcs.getModifiers()) // ||都优先级大于?: 且结合性是从左到右的
? ClassGenerator.class.getName() : mSuperClass + "$sc") + id; //构建类名：取ClassGenerator名称或mSuperClass名称
}
mCtc = mPool.makeClass(mClassName); //根据类名className创建对应的CtClass对象
if (mSuperClass != null) { // 设置继承的类（java是单继承，所以只会设置一个父类）
mCtc.setSuperclass(ctcs);
}
mCtc.addInterface(mPool.get(DC.class.getName())); // add dynamic class tag. (每一个动态类都实现了DC接口)
if (mInterfaces != null) { // 设置实现的接口
for (String cl : mInterfaces) {
mCtc.addInterface(mPool.get(cl));
}
}
if (mFields != null) { // 设置字段
for (String code : mFields) {
mCtc.addField(CtField.make(code, mCtc)); // 将字段对应的字符串，转换为CtField
}
}
if (mMethods != null) { // 设置方法
for (String code : mMethods) {
if (code.charAt(0) == ':') {
mCtc.addMethod(CtNewMethod.copy(getCtMethod(mCopyMethods.get(code.substring(1))),
code.substring(1, code.indexOf('(')), mCtc, null));
} else {
mCtc.addMethod(CtNewMethod.make(code, mCtc)); // 将方法对应的字符串，转换为CtMethod
}
}
}
if (mDefaultConstructor) { // 设置默认的构造函数（无参的构造函数）
mCtc.addConstructor(CtNewConstructor.defaultConstructor(mCtc));
}
if (mConstructors != null) { // 处理构造函数
for (String code : mConstructors) {
if (code.charAt(0) == ':') {
mCtc.addConstructor(CtNewConstructor
.copy(getCtConstructor(mCopyConstructors.get(code.substring(1))), mCtc, null));
} else {
String[] sn = mCtc.getSimpleName().split("\\$+"); // inner class name include $.
mCtc.addConstructor(
CtNewConstructor.make(code.replaceFirst(SIMPLE_NAME_TAG, sn[sn.length - 1]), mCtc));
}
}
}
return mCtc.toClass(loader, pd); //使用CtClass转换到Class
} catch (RuntimeException e) {
throw e;
} catch (NotFoundException e) {
throw new RuntimeException(e.getMessage(), e);
} catch (CannotCompileException e) {
throw new RuntimeException(e.getMessage(), e);
}
}
- 代码解析：动态创建Class的流程：
- 将设置的代码字符串，如继承的类、实现的接口、设置的方法、字段等转换javassist对应的数据模型，如CtMethod、CtFiled等
- 然后按类或接口的组成进行组装，如设置继承的类、设置实现的接口、设置类中的方法和字段等
- 使用javassist的CtClass.toClass()获取到动态生成的Class（类似Mybatis的动态SQL，按字符串动态组装，最终形成SQL）
问题点答疑
-
每个暴露的接口，都有一个wrapper封装类吗？是怎么找到这个Wrapper类的？
- 解答：在服务暴露时ServiceConfig#doExportUrlsFor1Protocol会Wrapper.getWrapper(interfaceClass).getMethodNames()为暴露的接口创建Wrapper类，并对应缓存起来。消费端ReferenceConfig#init也会在启动时，创建接口对应的Wrapper类，并对应缓存起来。会转换为具体的类进行执行，避免了反射使用
-
Wrapper能够获取类的封装类吗？还是说只能获取接口的封装类？
- 解答：不管是接口还是类都可以创建其对应的封装类的
归纳总结
-
Wrapper用于“包裹”目标类，Wrapper是一个抽象类，仅可通过 getWrapper(Class) 方法创建子类。在创建Wrapper子类的过程中，子类代码生成逻辑会对getWrapper方法传入的Class对象进行解析，拿到诸如类方法，类成员变量等信息。以及生成 invokeMethod方法代码和其他一些方法代码。代码生成完毕后，通过 Javassist 生成 Class 对象，最后再通过反射创建Wrapper实例
-
ClassGenerator：Class生成器，内部对Javassist的数据模型进行抽象，对外提供使用代码片段的方式创建Class