DolphinScheduler源码分析之EntityTestUtils类

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.dolphinscheduler.common.task;

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.*;

/**
 * entity test utils
 * //该类是一个工具类，可以对传入的任何其他类进行检测，会依次调用类中的所有方法，用了反射机制。
 */
public class EntityTestUtils {
    //初始化一个用来存储测试用的类型和对应的数值map数组
    private static final Map<String, Object> OBJECT_MAP = new HashMap<>();
    //遇到这些方法直接跳过，不测试。
    private static final String SKIP_METHOD = "getClass,notify,notifyAll,wait,equals,hashCode,clone";
    String
    static {
        //初始化参数数组
        OBJECT_MAP.put("java.lang.Long", 1L);
        OBJECT_MAP.put("java.lang.String", "test");
        OBJECT_MAP.put("java.lang.Integer", 1);
        OBJECT_MAP.put("int", 1);
        OBJECT_MAP.put("long", 1L);
        OBJECT_MAP.put("java.util.Date", new Date());
        OBJECT_MAP.put("char", '1');
        OBJECT_MAP.put("java.util.Map", new HashMap());
        OBJECT_MAP.put("boolean", true);
    }
    //传入要测试的类，可以看到，入参是一个Class类型的数组，代表可以同时测试多个类
    public static void run(List<Class> classList)
            throws IllegalAccessException, InvocationTargetException, InstantiationException {
        //一个个来，先取出第一个要测试的Class，比如是String.class
        for (Class temp : classList) {
            Object tempInstance = new Object();
            //获取要测试的类中所有的构造方法，不管是有参构造方法还是无参构造方法，比如String.class中的String()构造方法和String(String original) 等等
            Constructor[] constructors = temp.getConstructors();
            //遍历所有的构造方法
            for (Constructor constructor : constructors) {
                //获取构造方法的参数类型，如果是无参构造方法，就会进入下面的if，如果是有参构造方法，就会进入下面的else去。
                final Class<?>[] parameterTypes = constructor.getParameterTypes();
                //无参构造方法，会进入这里的if
                if (parameterTypes.length == 0) {
                    //用反射的机制，直接调用了这个无参构造方法，相当于完成了测试
                    tempInstance = constructor.newInstance();
                } else {
                    //objects中存储的是参数的值，如果构造方法需要传入第一个是int，第二个是String，那么这个objects其实就是传入了（1，‘1’）这两个值
                    Object[] objects = new Object[parameterTypes.length];
                    //这里就是往objects中塞数据
                    for (int i = 0; i < parameterTypes.length; i++) {
                        objects[i] = OBJECT_MAP.get(parameterTypes[i].getName());
                    }
                    //用反射的机制，直接调用了这个有参数的构造方法，相当于完成了测试
                    tempInstance = constructor.newInstance(objects);
                }
            }
            //这里是对类中的普通方法（除了构造方法外的所有其他方法）做测试
            Method[] methods = temp.getMethods();
            //遍历所有的普通方法
            for (final Method method : methods) {
                //如果是需要跳过不进行测试的方法，那么就直接跳过
                if (SKIP_METHOD.contains(method.getName())) {
                    break;
                }
                //同样也是获取到参数的类型
                final Class<?>[] parameterTypes = method.getParameterTypes();
                //如果是有参方法，进入if，无参方法进入else
                if (parameterTypes.length != 0) {
                    //objects中存储的是参数的值，如果构造方法需要传入第一个是int，第二个是String，那么这个objects其实就是传入了（1，‘1’）这两个值
                    Object[] objects = new Object[parameterTypes.length];
                    //这里就是往objects中塞数据
                    for (int i = 0; i < parameterTypes.length; i++) {
                        objects[i] = OBJECT_MAP.get(parameterTypes[i].getName());
                    }
                    //用反射的机制，直接调用了这个有参数的方法，相当于完成了测试
                    method.invoke(tempInstance, objects);
                } else {
                    //用反射的机制，直接调用了这个无参的方法，相当于完成了测试
                    method.invoke(tempInstance);
                }
            }
        }
    }
}

 以下是DolphinScheduler源码中对这个类进行使用的方式，可以参考：

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.dolphinscheduler.common.task;

import org.apache.dolphinscheduler.common.task.sqoop.SqoopParameters;
import org.apache.dolphinscheduler.common.task.sqoop.sources.SourceHdfsParameter;
import org.apache.dolphinscheduler.common.task.sqoop.sources.SourceHiveParameter;
import org.apache.dolphinscheduler.common.task.sqoop.sources.SourceMysqlParameter;
import org.apache.dolphinscheduler.common.task.sqoop.targets.TargetHdfsParameter;
import org.apache.dolphinscheduler.common.task.sqoop.targets.TargetHiveParameter;
import org.apache.dolphinscheduler.common.task.sqoop.targets.TargetMysqlParameter;
import org.junit.Assert;
import org.junit.Test;
import java.util.ArrayList;
import java.util.List;

/**
 * sqoop parameter entity test
 */
public class SqoopParameterEntityTest {

    @Test
    public void testEntity(){
        try {
            List<Class> classList = new ArrayList<>();
            classList.add(SourceMysqlParameter.class);
            classList.add(SourceHiveParameter.class);
            classList.add(SourceHdfsParameter.class);
            classList.add(SqoopParameters.class);
            classList.add(TargetMysqlParameter.class);
            classList.add(TargetHiveParameter.class);
            classList.add(TargetHdfsParameter.class);
            EntityTestUtils.run(classList);
        } catch (Exception e) {
            Assert.fail(e.getMessage());
        }
    }
}

爱词霸

 

 

划词翻译

自动发声

自动添加生词本

爱词霸

 

 

划词翻译

自动发声

自动添加生词本

爱词霸

 

 

划词翻译

自动发声

自动添加生词本