Question

我想在java程序samples/Test.java上运行在checkstyle中实现的简单自定义检查。我发现了以下错误。

com.puppycrawl.tools.checkstyle.api.CheckstyleException: cannot initialize module TreeWalker - Unable to instantiate 'com.checkstyle.checks.IllegalExceptionThrowsCheck' class, it is also not possible to instantiate it as null.

对不起，即使错误有意义，我也无法在修复错误方面取得任何进展。我在帖子的末尾发布了完整的错误。以下是自定义检查的实现。 IllegalExceptionThrowsCheck.java

package com.checkstyle.checks;

import java.util.Arrays;
import java.util.List;

import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

public final class IllegalExceptionThrowsCheck extends Check {

    List<String> illegalExceptionThrows;

    /** {@inheritDoc} */
    public int[] getDefaultTokens() {
       return new int[] { TokenTypes.LITERAL_THROWS };
    }

    /** {@inheritDoc} */
    public int[] getRequiredTokens() {
       return getDefaultTokens();
    }

    /** {@inheritDoc} */
   public void visitToken(DetailAST aDetailAST) {
      DetailAST identDetailAST = aDetailAST.findFirstToken(TokenTypes.IDENT);
      if (identDetailAST == null) {
         return;
      }
      if (illegalExceptionThrows.contains(identDetailAST.getText())) {
           log(aDetailAST, "Illegal Throws Clause  -> "
                + identDetailAST.getText());
      }
  }

  public void setIllegalExceptionThrows(String illegalExceptionThrowsStr) {
      this.illegalExceptionThrows =   Arrays.asList(illegalExceptionThrowsStr
            .split(","));
   }
}

checkstyle配置是 custom-checkstyle.xml

   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN" "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
   <module name="Checker">
       <property name="severity" value="error" />
       <module name="TreeWalker">
        <property name="severity" value="error" />
        <module name="com.checkstyle.checks.IllegalExceptionThrowsCheck">
            <property name="severity" value="error" />
            <property name="illegalExceptionThrows" value="Exception" />
        </module>
       </module>
   </module>

包结构是

Project
 |
 |->src
 |   |
 |   |->com
 |      |
 |      |->checkstyle
 |            |
 |            |-> checks
 |                  |
 |                  |-> IllegalExceptionThrowsCheck.java
 |
 |
 |-> lib
 |   |
 |   |->checkstyle-8.10.1-all.jar
 |
 |
 |-> Samples
       |
       | -> Test.java

我运行以执行java程序检查的命令是

java -jar lib/checkstyle-8.10.1-all.jar com.puppycrawl.tools.checkstyle.Main -c custom_check.xml samples/Test.java

任何评论都会有很大帮助。

附录

完整的错误日志

com.puppycrawl.tools.checkstyle.api.CheckstyleException：无法初始化模块TreeWalker - 无法实例化'com.checkstyle.checks.IllegalExceptionThrowsCheck'类，也无法将其实例化为null。请重新检查类名是否已指定为规范名称，或阅读如何配置短名称用法http://checkstyle.sourceforge.net/config.html#Packages。还请重新检查提供的ClassLoader是否正确配置为Checker。在com.puppycrawl.tools.checkstyle.Checker.setupChild（Checker.java:460）在com.puppycrawl.tools.checkstyle.api.AutomaticBean.configure（AutomaticBean.java:198）在com.puppycrawl.tools.checkstyle.Main.runCheckstyle（Main.java:550）在com.puppycrawl.tools.checkstyle.Main.runCli（Main.java:465）在com.puppycrawl.tools.checkstyle.Main.main（Main.java:219）引起：com.puppycrawl.tools.checkstyle.api.CheckstyleException：无法实例化'com.checkstyle.checks.IllegalExceptionThrowsCheck'类，也无法将其实例化为null。请重新检查类名是否已指定为规范名称，或阅读如何配置短名称用法http://checkstyle.sourceforge.net/config.html#Packages。还请重新检查提供的ClassLoader是否正确配置为Checker。在com.puppycrawl.tools.checkstyle.PackageObjectFactory.createModule（PackageObjectFactory.java:208）在com.puppycrawl.tools.checkstyle.TreeWalker.setupChild（TreeWalker.java:151）在com.puppycrawl.tools.checkstyle.api.AutomaticBean.configure（AutomaticBean.java:198）在com.puppycrawl.tools.checkstyle.Checker.setupChild（Checker.java:455） ......还有4个 Checkstyle以1个错误结束。

Answer 1

class IllegalExceptionThrowsCheck extends Check {

首先，基类不再是Check。它是AbstractCheck。前一段时间删除了Check，并且CLI命令说您正在使用8.10.1，所以我不知道如何检查是否使用不存在的基类进行编译{{1} }。

java -jar lib / checkstyle-8.10.1-all.jar com.puppycrawl.tools.checkstyle.Main -c custom_check.xml samples / Test.java

其次，由于你在这个命令行中没有提到你的项目/ jar，checkstyle永远不会找到你的类。您只告诉JVM Check而不是您的项目及其类文件。

我建议将项目打包到jar中，然后将其包含在命令行中。示例：checkstyle-8.10.1-all.jar
http://checkstyle.sourceforge.net/cmdline.html#Usage_by_Classpath_update

第三，您可以将您的二传手改为：

java -classpath MyCustom.jar;checkstyle-8.10.1-all.jar com.puppycrawl.tools.checkstyle.Main -c config.xml Check.java

在checkstyle

1 个答案: