V3215. Unity Engine. Passing a method name as a string literal into the 'StartCoroutine' is unreliable.

Анализатор обнаружил, что в качестве аргумента для методов Invoke, InvokeRepeating, CancelInvoke, StartCoroutine или StopCoroutine класса UnityEngine.MonoBehaviour передан строковый литерал, что ненадёжно. Если по какой-то причине переданный строковый литерал перестанет соответствовать методу (в частности, если метод поменяет название или станет недоступен), то вызов будет проигнорирован без оповещения об этом.

Рассмотрим пример:

public class CoroutineAndInvoke : MonoBehaviour
{
  void Start()
  {
    Invoke("CreateEnemyMethod", 1f);
    StartCoroutine("DangerCheckCoroutine");
  }

  private void CreateEnemyMethod()
  {
    ....
  }

  private IEnumerator DangerCheckCoroutine()
  {
    ....
  }
}

В данном случае методы Invoke и StartCoroutine вызываются со строковыми литералами, которые соответствуют существующим методам CreateEnemyMethod и DangerCheckCoroutine. Скрипт отработает корректно, но надёжность нарушена, и анализатор выдаст предупреждение 3-го уровня.

Для того чтобы сохранить надёжность при вызове этих методов, стоит использовать nameof для получения имени метода, а для StartCoroutine прямой вызов корутины.

Пример кода с сохранением надёжности:

public class CoroutineAndInvoke : MonoBehaviour
{
  void Start()
  {
    Invoke(nameof(CreateEnemyMethod), 1f);
    StartCoroutine(DangerCheckCoroutine());
  }
  ....
}

При данном подходе не выйдет передать в качестве аргумента несуществующий метод. Ещё один плюс использования nameof и прямого вызова коруины — возможность переименовывать методы в процессе рефакторинга. При этом изменения будут автоматически отражены в аргументах методов Invoke и StartCoroutine.

Рассмотрим пример, где строковые литералы не соответствуют методам:

public class CoroutineAndInvoke : MonoBehaviour
{
  void Start()
  {
    Invoke("CreateEnemy", 1f);
    StartCoroutine("DangerCheck");
  }

  private void CreateEnemyMethod()
  {
    ....
  }

  private IEnumerator DangerCheckCoroutine()
  {
    ....
  }
}

В таком случае методы Invoke и StartCoroutine будут проигнорированы, так как не будут найдены методы, соответствующие переданным строковым литералам. Анализатор выдаст предупреждение 1-го уровня. Такая ошибка может произойти, например, из-за опечатки при написании названия метода в аргументе или при переименовании метода.

Данная диагностика классифицируется как:

CWE-1106