Checkstyle类检查

Question

我想用Checkstyle写一个检查，确定给定的类是否扩展了其他类，以及是否有'==‘的用法。有人能帮我理解我需要做什么吗？

这是我到目前为止所知道的：

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

public final class MyEqualsCheck
        extends Check {

    @Override
    public int[] getDefaultTokens() {
        return new int[] { TokenTypes.EQUAL, TokenTypes.NOT_EQUAL };
    }

    /**
     * Right before we visit the AST, we're allowed to do initialization and setup 
     * here.
     */
    @Override
    public void beginTree(final DetailAST aRootAST) {
    }

    /**
     * Each token that we defined above is visited here.
     */
    @Override
    public void visitToken(final DetailAST ast) {

        final DetailAST lValue = ast.getFirstChild();
        final DetailAST rValue = lValue.getNextSibling();
        //is it possible to determine if lValue and rValue implement a given interface directly or indirectly?
    }

    private DetailAST getLowestParent(final DetailAST aAST) {
        DetailAST lowestParent = aAST;
        while ((lowestParent.getParent() != null)) {
            lowestParent = lowestParent.getParent();
        }
        return lowestParent;
    }

}

Answer 1

这看起来是一个很好的开始。对于==，可以查看类StringEqualsEqualityCheck，它检查两个字符串文字之间是否使用了==。

为了便于检查，您需要验证您的类是否没有使用==。这意味着您的visitToken将只记录您是否扩展了另一个类以及是否使用了==。然后，使用finishTree实际引发错误。

有关详细的示例，请参阅EqualsHashCodeCheck，它会检查一个类，以查看您是否同时实现了equals()和hashCode()。请注意，它使用映射正确地管理同一文件中的多个类。