Пользовательские правила в Checkstyle для гарантии того, что Logger объявлен как статический атрибут класса Final - PullRequest
Новая
       15

Пользовательские правила в Checkstyle для гарантии того, что Logger объявлен как статический атрибут класса Final

0 голосов
/ 25 января 2012

Я написал вышеупомянутое правило и при попытке запустить его из командной строки я получаю одно и то же сообщение, а именно: Невозможно создать Checker: невозможно инициализировать модуль TreeWalker - Невозможно создать экземпляр LoggerAttrCheck

Я разложил свои чеки до одного в «Шашке» и одного в «Treewalker», неукоснительно скопировал записи, предложенные в руководстве, и без радости. У всех были похожие проблемы с пользовательскими правилами. Я WinXP, Java 1.6 (Eclipse), папка checkstyle-5.1 находится в пути. Я могу предоставить код, но это пахнет экологической проблемой.

Код выглядит следующим образом: 

package com.mystuff.checkstyle.hecks;

import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;

/**
 * 
 * 
 * This package provides the custom checks that were required outside 
 * of the standard checks provided
 * 
 */
public class LoggerAttrCheck extends Check
{
   /**
    *  
    * 
    * The Logger must be declared as a static final class attribute
    * 
    */
    @Override
    public int[] getDefaultTokens()
    {
        return new int[] { TokenTypes.VARIABLE_DEF};
    }

    @Override
    public void visitToken(DetailAST aAST)
    {
        if(aAST.getType()==TokenTypes.VARIABLE_DEF)
          visitVariableDef(aAST);

    }
    /**
     * Checks type of given variable.
     * @param aAST variable to check.
     */
    private void visitVariableDef(DetailAST aAST)
    {
        checkVariableDefn(aAST);
    }

    /**
     * 
     * Checks variable to see if its a Logger and static final
     *      * @param aAST node to check.
     */
    private void checkVariableDefn(DetailAST aAST)
    {
        final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE);
        final FullIdent ident = CheckUtils.createFullType(type);

        if ((ident.getText().equals("Logger"))) 
        {
              if((!aAST.branchContains(TokenTypes.FINAL))||(!aAST.branchContainsTokenTypes.LITERAL_STATIC)))
          {
          log(type.getLineNo(), type.getColumnNo(),
                    "Logger not defined as static final class attribute", type.getText());
          }    
        }
    }
}

Это создает com.stuff.checkstyle.checks.jar, поэтому checkstyle_packages.xml выглядит так: 

<?xml version="1.0" encoding="UTF-8"?>

    <!DOCTYPE checkstyle-packages PUBLIC
    "-//Puppy Crawl//DTD Package Names 1.3//EN"
    "http://www.puppycrawl.com/dtds/packages_1_3.dtd">

<checkstyle-packages>
    <package name="com.mystuff.checkstyle.checks"/>
</checkstyle-packages>

Все идеи с благодарностью приняты!

1 Ответ

0 голосов
/ 23 декабря 2012

Как выглядит ваш файл конфигурации checkstyle?Похоже, что ваш checkstyle_packages.xml игнорируется.Я обнаружил, что не могу добавить свой пакет в пакеты checkstyle, и поэтому объявил свою проверку с полным именем пакета: 

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

<module name="Checker">
  <module name="TreeWalker">
    <!-- Blundell specific checks -->
    <module name="com.blundell.checks.AntiHungarian" />
  </module>
</module>

Обратите внимание, что имя класса java для проверки - AntiHungarianCheck, но выобъявлять это просто как анти-венгерский

Взятый из моего пользовательского примера checkstyle здесь:

http://blog.blundell -apps.com / create-your-own-checkstyle-check /

и исходный код здесь:

https://github.com/blundell/CreateYourOwnCheckStyleCheck

...