在checkstyle中运行自定义检查需要帮助

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

Com.PuppyCrawl.Tools.CheckStyle.API.CheckStyleException：无法初始化模块TreeWalker-无法实例化“Com.CheckStyle.Checks.IllegalExceptionThrowscheck”类，也不可能将其实例化为NULL。请重新检查类名是否指定为规范名称，或阅读如何配置短名称用法http://checkstyle.sourceforge.net/config.html#packages。还请重新检查所提供的Checker的类加载器是否配置正确。在com.puppycrawl.tools.checkstyle.checker.setupchild(checker.java:460)在com.puppycrawl.tools.checkstyle.api.automaticbean.configure(automaticbean.198)在com.puppycrawl.tools.checkstyle.main.runcheckstyle(main.java:550)在com.puppycrawl.tools.checkstyle.main.runcli(main.java:465)在请重新检查类名是否指定为规范名称，或阅读如何配置短名称用法http://checkstyle.sourceforge.net/config.html#packages。还请重新检查所提供的Checker的类加载器是否配置正确。在com.puppycrawl.tools.Checkstyle.packageobjectfactor.CreateModule（packageobjectfactor.java:208)在com.puppycrawl.tools.Checkstyle.treewalker.setupchild（treewalker.java:151)在com.puppycrawl.tools.Checkstyle.api.automaticbean.configure（automaticbean.java:198)在

Answer 1

类IllegalExceptionThrowsCheck扩展检查{

首先，基类不再是check。它是abstractcheck。check不久前被删除了，而您的CLI命令说您使用的是8.10.1，所以我不知道您是如何使用不存在的基类check进行编译的。

java-jar lib/checkstyle-8.10.1-all.jar com.puppycrawl.tools.checkstyle.main-c custom_check.xml示例/test.java

我建议将项目打包到一个jar中，然后将其包含在命令行中。示例：java-classpath mycustom.jar；checkstyle-8.10.1-all.jar com.puppycrawl.tools.checkstyle.main-c config.xml check.java
http://checkstyle.sourceforge.net/cmdline.html#usage_by_classpath_update

第三，您可以将您的setter更改为：

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