SonarQube重构此方法以降低其认知复杂性

时间:2018-04-10 11:21:36

标签: java sonarqube

我有以下实用工具方法,我使用多个if语句并且遇到认知复杂性问题。我浏览了一些链接,但是我无法理解如何在不影响此方法用户的情况下更改代码。

public static boolean isWrapperValid(WrapperClass wrapper, boolean isTechnicalToken){

    String key=null;
    boolean isValidWrapper = false;

    if (wrapper != null && wrapper.length() > 7
        && wrapper.substring(0, 6).equalsIgnoreCase("XYZ"))
    {
        wrapper= wrapper.substring(7, wrapper.lastIndexOf('.')+1);
    }
    if(wrapper != null && wrapper.equalsIgnoreCase("TFR")) {
        isValidWrapper=Boolean.TRUE;
    }
    try {
         key = wrapper.getKey();
    }
    catch (Exception exception) {
        return isValidWrapper;
    }

    if(key!=null) {

        Date tokenExpiryTime = key.getExpiresAt();

        if(tokenExpiryTime!=null) {
            return isValidWrapper;
        }

        String algorithm=key.getAlgorithm();
        if(!DESIRED_ALGO.equals(algorithm)) {
            return isValidWrapper;
        }

        String value6=key.getType();
        if(!DESIRED_TYPE.equals(value6)) {
            return isValidWrapper;
        }


        if(key.getValue1()!=null && key.getValue2().size()>0 && key.getValue3()!=null && key.getValue4()!=null && key.getValue5()!=null) {
            isValidWrapper=Boolean.TRUE;
        }
    }

    return isValidWrapper;
}

请分享您的建议以重构此代码。

3 个答案:

答案 0 :(得分:4)

我不认为将许多if条件合并为一个或只是简单地执行代码清理,例如通过更改某些指令的顺序,可以解决您的问题。

您的代码与single responsibility principle不符。你应该将这个大方法重构为较小的部分。由于这个原因,它将是可测试的,更易于维护和阅读。我花了一些时间做了这个:

public static boolean isWrapperValid(WrapperClass wrapper, boolean isTechnicalToken) {

    final WrapperClass unpackedWrapper = unpackWrapper(wrapper);
    boolean wrapperValid = isUnpackedWrapperValid(unpackedWrapper);

    Key key = null;
    try {
        key = unpackedWrapper.getKey();
    } catch (final Exception exception) {
        return wrapperValid;
    }

    if (key != null) {   
        if (doesKeyMeetsBasicConditions(key)) {
            return wrapperValid;
        }
        if (doesKeyMeetsValueConditions(key)) {
            return true;
        }
    }
    return wrapperValid;
}

protected static WrapperClass unpackWrapper(final WrapperClass wrapper) {      
    if (wrapper != null && wrapper.length() > 7 && wrapper.substring(0, 6).equalsIgnoreCase("XYZ")) {
        return wrapper.substring(7, wrapper.lastIndexOf('.') + 1);
    }
    return wrapper;
}

protected static boolean isUnpackedWrapperValid(final WrapperClass wrapper) {
   return wrapper != null && wrapper.equalsIgnoreCase("TFR");
}

protected static boolean doesKeyMeetsBasicConditions(final Key key) {
    Date tokenExpiryTime = key.getExpiresAt();
    if (tokenExpiryTime != null) {
        return true;
    }

    String algorithm = key.getAlgorithm();
    if (!DESIRED_ALGO.equals(algorithm)) {
        return true;
    }

    String value6 = key.getType();
    if (!DESIRED_TYPE.equals(value6)) {
        return true;
    }
    return false;
}

protected static boolean doesKeyMeetsValueConditions(final Key key) {
    return key.getValue1() != null && key.getValue2().size() > 0
           && key.getValue3() != null && key.getValue4() != null
           && key.getValue5() != null;
}

我不知道域逻辑,因此我的一些方法有愚蠢的名称等。正如您所看到的,现在您有许多较小的方法,分支不多(if条件) - 更容易测试(静态代码不好,但您可以使用例如PowerMock来模拟它。)

答案 1 :(得分:1)

一些重写提供了简化,仍然可以改进。

public static boolean isWrapperValid(WrapperClass wrapper, boolean isTechnicalToken){
    if (wrapper != null && wrapper.length() > 7
        && wrapper.substring(0, 6).equalsIgnoreCase("XYZ"))
    {
        wrapper = wrapper.substring(7, wrapper.lastIndexOf('.')+1);
    }
    boolean isValidWrapper = wrapper != null && wrapper.equalsIgnoreCase("TFR");

    try {
        String key = wrapper.getKey();
        if (key != null && key.getExpiresAt() == null
                && DESIRED_ALGO.equals(key.getAlgorithm())
                && DESIRED_TYPE.equals(key.getType())
                && key.getValue1() != null && !key.getValue2().isEmpty()
                && key.getValue3() != null && key.getValue4() != null
                && key.getValue5() != null) {
            isValidWrapper = true;
        }
    }
    catch (Exception exception) {
        // DO NOTHING
    }
    return isValidWrapper;
}

评论之后:在这里我捕获了所有电话的任何异常。

答案 2 :(得分:0)

首先,Sonar应该给你更多的标志:重用wrapper参数通常是一种不好的做法,NPE调用wrapper.getKey因为wrapper可以为null,但无论如何,不​​是关键......

尝试通过创建本地布尔变量来减少if语句的数量(如果您的测试少于5或6次,但通常可读性较差,则可能会减少if语句。)一旦完成,你应该只有1个块来测试这些布尔变量,并且有一个return语句,就像上面的例子一样(不一定准确!):

boolean expired = tokenExpiryTime != null;
boolean desiredAlgo = DESIRED_ALGO.equals(key.getAlgorithm());
boolean desiredType = DESIRED_TYPE.equals(value6);
if (expired || !desiredAlgo || !desiredType) {
    return isValidWrapper;
}

然而,如果这种算法触发它,你的认知复杂程度似乎很低......

降低算法复杂性的另一个重要方法是将代码子块(循环,if和try-catch)转换为私有方法。在您的示例中,它可能类似于checkWrapperValidity方法,负责每个返回isValidWrapper的测试

寻找你感兴趣的贴纸↓↓↓
豫ICP备18024241号-1