如何降低声纳可接受的代码的圈复杂度

Question

此功能在声纳中无法正常工作

Answer 1

Sonar 的圈复杂度度量的一种简化思考方式是“我必须推理多少逻辑分支和循环才能理解这个函数？”您可以采取以下几种方法：

1. 拆分您的功能。如果该函数正在执行多项操作，请尝试将每项内容拆分为自己的函数
2. 减少代码中的分支。通常情况下，if/else 语句可以改为条件赋值。

圈复杂度甚至没有涵盖您的代码中难以遵循的其他一些内容：

1. 您经常复制段代码，而不是将内容存储在临时变量中。复制代码不仅使阅读代码的人有更多工作要做，而且还意味着您正在强迫程序做这些额外的工作。
2. 因为您始终使用var，所以阅读您的代码的人必须查看您的整个函数，以了解是否将在不同点重新分配变量。当某些事情不会改变时使用 const 可以让我们知道我们是否不必再担心这个问题。
3. 您的某些 if 语句条件很复杂。尝试将它们重构为更易读的临时变量。

这是我降低圈复杂度和代码可读性的尝试：

function validateSignInForm(signinErrorMessage) {
  let bFinalSubmit = true;

  if (!validateFields()) {
    bFinalSubmit = false;
  }

  const errMainError = (typeof signinErrorMessage === 'undefined')
    ? configuration.messages.signinIncomplete;
    : signinErrorMessage;
  if (errMainError === configuration.messages.notFound) {
    trp.fai.common.log(errMainError);
    bFinalSubmit = false;
  }

  const errMsg = $('#signin-mainerr-message');
  const errContainer = $('#signin-ui-notification-container-mainerr');
  if (!bFinalSubmit) {
    errMsg.html(errMainError);
    errContainer.show();
  } else {
    errMsg.html('');
    errContainer.hide();
  }

  return bFinalSubmit;
}

function validateFields() {
  let canSubmit = true;

  configuration.required.signin.forEach(field => {
    const fieldName = field.name;
    const fieldValue = $.trim(field.value);
    const fieldElement = $('#' + fieldName);
    const fieldLabel = fieldElement
      .closest('li')
      .find('label')

    if (
      (fieldValue === '' || (fieldName === 'username' && fieldValue === 'Your email address')) 
      && $('#' + field.id).is(':visible')
    ) {
      fieldElement.addClass('ui-red-border');
      fieldLabel.addClass('ui-red-text');
      canSubmit = false;
    } else {
      fieldElement.removeClass('ui-red-border');
      fieldLabel.removeClass('ui-red-text');
      $('#' + fieldName + 'Field').removeClass('registerFieldError');

      if (configuration.required.signin[i].onchange) {
        configuration.required.signin[i].onchange();
      }
    }
  });

  return canSubmit;
}