jmeter系列一(jmeter界面相关无TestBean)

这系列文章是自己学习研究jmeter源码后的结果，这篇文章介绍的是jmeter界面以及事件响应相关的东西，写下来分享也利于回头看，

下图是jmeter源码导入neatbeans

涉及到跟gui相关的内容大体都在core里面的gui包下

涉及到的类主要有

AbstractJMeterGuiComponent

GUIFactory

GuiPackage

MainFrame

MenuFactory 动态加载类路径下继承了AbstractJmeterGuiComponent或者实现了TestBean接口的类，他们就是MainFrame中右边的Frame

实现TestBean接口的类会有个BeanInfo于之相对应，这是javabean规范，重点是用到了Introspector

gui.action包下面

Command和各种实现了Command接口的类

ActionRouter 动态加载实现了Command接口的类，通过ActionEvent的name来匹配是哪个类响应MainFrame中左边树的相关事件

gui.tree包下面

MainFrame左边的树，重点是TreeNode存了各种testelement,比如controller、sampler、preprocess、config etc.当运行测试的时候，程序就读取里面的各种testelement元素来执行测试流程

界面涉及相关流程

实例化树

MainFrame实例化的时候，会通过调用makeTree方法传入JMeterTreeModel和JMeterTreeListener构建一个JTree,初始化有两个节点

private void initTree(TestElement tp, TestElement wb) {
        // Insert the test plan node
        insertNodeInto(new JMeterTreeNode(tp, this), (JMeterTreeNode) getRoot(), 0);
        // Insert the workbench node
        insertNodeInto(new JMeterTreeNode(wb, this), (JMeterTreeNode) getRoot(), 1);
        // Let others know that the tree content has changed.
        // This should not be necessary, but without it, nodes are not shown when the user
        // uses the Close menu item
        nodeStructureChanged((JMeterTreeNode)getRoot());
    }

这是JMeterTreeModel中的方法，这个方法会被JMeterTreeModel构造方法调用

public JMeterTreeModel() {
        this(new TestPlanGui().createTestElement(),new WorkBenchGui().createTestElement());

    }

TestPlanGui和WorkBeanchGui都是继承了AbstractJMeterGuiComponent的类，这是MainFrame中右边界面元素都要继承的类
里面有通用发放，界面执行流程会调用到

tree响应鼠标右键事件弹出菜单

看JMeterTreeListener类，实现了TreeSelectionListener, MouseListener, KeyListener接口

因此响应鼠标右键的事件就是在这处理的

@Override
    public void mousePressed(MouseEvent e) {
        // Get the Main Frame.
        MainFrame mainFrame = GuiPackage.getInstance().getMainFrame();
        // Close any Main Menu that is open
        mainFrame.closeMenu();
        int selRow = tree.getRowForLocation(e.getX(), e.getY());
        if (tree.getPathForLocation(e.getX(), e.getY()) != null) {
            log.debug("mouse pressed, updating currentPath");
            currentPath = tree.getPathForLocation(e.getX(), e.getY());
        }
        if (selRow != -1) {
            // updateMainMenu(((JMeterGUIComponent)
            // getCurrentNode().getUserObject()).createPopupMenu());
            if (isRightClick(e)) {
                if (tree.getSelectionCount() < 2) {
                    tree.setSelectionPath(currentPath);
                }
                log.debug("About to display pop-up");
                displayPopUp(e);//这里
            }
        }
    }

private void displayPopUp(MouseEvent e) {
        JPopupMenu pop = getCurrentNode().createPopupMenu();
        GuiPackage.getInstance().displayPopUp(e, pop);
    }

JMeterTreeNode中的createPopupMenu方法

public JPopupMenu createPopupMenu() {
        try {
            return GuiPackage.getInstance().getGui(getTestElement()).createPopupMenu();
        } catch (Exception e) {
            log.error("Can't get popup menu for gui", e);
            return null;
        }
    }

最后shift+鼠标来到了JMeterGUIComponent接口,恩好吧,这是IDE

找一个实现了这个接口的类，AbstractControllerGui....

@Override
    public JPopupMenu createPopupMenu() {
        return MenuFactory.getDefaultControllerMenu();
    }

看MenuFactory类

有个static块，调用了静态方法initializeMenus

List<String> guiClasses = ClassFinder.findClassesThatExtend(JMeterUtils.getSearchPaths(), new Class[] {
                    JMeterGUIComponent.class, TestBean.class });
            Collections.sort(guiClasses);
            for (String name : guiClasses) {

                /*
                 * JMeterTreeNode and TestBeanGUI are special GUI classes, and
                 * aren't intended to be added to menus
                 *
                 * TODO: find a better way of checking this
                 */
                if (name.endsWith("JMeterTreeNode") // $NON-NLS-1$
                        || name.endsWith("TestBeanGUI")) {// $NON-NLS-1$
                    continue;// Don't try to instantiate these
                }

                if (elementsToSkip.contains(name)) { // No point instantiating class
                    log.info("Skipping " + name);
                    continue;
                }

                boolean hideBean = false; // Should the TestBean be hidden?

                JMeterGUIComponent item;
                try {
                    Class<?> c = Class.forName(name);
                    if (TestBean.class.isAssignableFrom(c)) {
                        TestBeanGUI tbgui = new TestBeanGUI(c);
                        hideBean = tbgui.isHidden() || (tbgui.isExpert() && !JMeterUtils.isExpertMode());
                        item = tbgui;
                    } else {
                        item = (JMeterGUIComponent) c.newInstance();
                    }
                } catch (NoClassDefFoundError e) {
                    log.warn("Missing jar? Could not create " + name + ". " + e);
                    continue;
                } catch (Throwable e) {
                    log.warn("Could not instantiate " + name, e);
                    if (e instanceof Error){
                        throw (Error) e;
                    }
                    if (e instanceof RuntimeException){
                        if (!(e instanceof HeadlessException)) { // Allow headless testing
                            throw (RuntimeException) e;
                        }
                    }
                    continue;
                }

会扫描实现了JMeterGUIComponent的接口或者实现了TestBean接口(上面提到的利用了JavaBean规范,BeanInfo哦)的类,

首先Class.forName他们

对于实现接口TestBean的类，会用TestBeanGUI进行包装(我能说这是装饰模式吗？)

然后调用getMenuCategories方法(实现了JMeterGUIComponent接口都会实现这个方法),

这个方法就是告诉当在currentNode上右键鼠标，针对于这个node会弹出的菜单即所谓的PopupMenu

if (categories == null) {
                    log.debug(name + " participates in no menus.");
                    continue;
                }
                if (categories.contains(THREADS)) {
                    threads.add(new MenuInfo(item, name));
                }
                if (categories.contains(FRAGMENTS)) {
                    fragments.add(new MenuInfo(item, name));
                }
                if (categories.contains(TIMERS)) {
                    timers.add(new MenuInfo(item, name));
                }

                if (categories.contains(POST_PROCESSORS)) {
                    postProcessors.add(new MenuInfo(item, name));
                }

                if (categories.contains(PRE_PROCESSORS)) {
                    preProcessors.add(new MenuInfo(item, name));
                }

                if (categories.contains(CONTROLLERS)) {
                    controllers.add(new MenuInfo(item, name));
                }

                if (categories.contains(SAMPLERS)) {
                    samplers.add(new MenuInfo(item, name));
                }

                if (categories.contains(NON_TEST_ELEMENTS)) {
                    nonTestElements.add(new MenuInfo(item, name));
                }

                if (categories.contains(LISTENERS)) {
                    listeners.add(new MenuInfo(item, name));
                }

                if (categories.contains(CONFIG_ELEMENTS)) {
                    configElements.add(new MenuInfo(item, name));
                }
                if (categories.contains(ASSERTIONS)) {
                    assertions.add(new MenuInfo(item, name));
                }

然后对应TestElement的gui类中的createPopUp方法就会在这里来取他们对应的菜单项目

弹出菜单项的响应鼠标单击事件

看MenuFactory中的各种makeMenus方法，makeMenuItem是最小项即创建每个弹出菜单最后一项内容

public static JMenuItem makeMenuItem(String label, String name, String actionCommand) {
        JMenuItem newMenuChoice = new JMenuItem(label);
        newMenuChoice.setName(name);
        newMenuChoice.addActionListener(ActionRouter.getInstance());
        if (actionCommand != null) {
            newMenuChoice.setActionCommand(actionCommand);
        }

        return newMenuChoice;
    }

newMenuChoice.addActionListener(ActionRouter.getInstance());

这句话设置了每个菜单项响应事件的监听器，已经actioncommand即该菜单项的command名字

定位到ActionRouter类，他是一个单例类，看他的方法populateCommandMap

List<String> listClasses = ClassFinder.findClassesThatExtend(
                    JMeterUtils.getSearchPaths(), // strPathsOrJars - pathnames or jarfiles to search for classes
                    // classNames - required parent class(es) or annotations
                    new Class[] {Class.forName("org.apache.jmeter.gui.action.Command") }, // $NON-NLS-1$
                    false, // innerClasses - should we include inner classes?
                    null, // contains - classname should contain this string
                    // Ignore the classes which are specific to the reporting tool
                    "org.apache.jmeter.report.gui", // $NON-NLS-1$ // notContains - classname should not contain this string
                    false); // annotations - true if classnames are annotations
            commands = new HashMap<String, Set<Command>>(listClasses.size());
            if (listClasses.isEmpty()) {
                log.fatalError("!!!!!Uh-oh, didn't find any action handlers!!!!!");
                throw new JMeterError("No action handlers found - check JMeterHome and libraries");
            }
            for (String strClassName : listClasses) {
                Class<?> commandClass = Class.forName(strClassName);
                Command command = (Command) commandClass.newInstance();
                for (String commandName : command.getActionNames()) {
                    Set<Command> commandObjects = commands.get(commandName);
                    if (commandObjects == null) {
                        commandObjects = new HashSet<Command>();
                        commands.put(commandName, commandObjects);
                    }
                    commandObjects.add(command);
                }
            }

搜集实现了Command接口的各种类，这些类就是响应菜单单击事件的类，他们都在org.apache.jmeter.gui.action包下，当然我们可以实现我们自己的Command，

简单的看其中一个 AboutCommand

static {
        HashSet<String> commands = new HashSet<String>();
        commands.add(ActionNames.ABOUT);
        commandSet = Collections.unmodifiableSet(commands);
    }

    /**
     * Handle the "about" action by displaying the "About Apache JMeter..."
     * dialog box. The Dialog Box is NOT modal, because those should be avoided
     * if at all possible.
     */
    @Override
    public void doAction(ActionEvent e) {
        if (e.getActionCommand().equals(ActionNames.ABOUT)) {
            this.about();
        }
    }

    /**
     * Provide the list of Action names that are available in this command.
     */
    @Override
    public Set<String> getActionNames() {
        return AboutCommand.commandSet;
    }

doAction方法处理单击事件的地方

getActionNames方法是ActionRouter用来调用的,

ActionRouter中收集Command的代码

for (String commandName : command.getActionNames()) {
                    Set<Command> commandObjects = commands.get(commandName);
                    if (commandObjects == null) {
                        commandObjects = new HashSet<Command>();
                        commands.put(commandName, commandObjects);
                    }
                    commandObjects.add(command);
                }