Roslyn 분석기와 규칙 집합 파일

Unity 프로젝트의 Roslyn 분석기와 규칙 집합 파일을 사용하여 코드의 스타일, 품질, 기타 문제를 검사할 수 있습니다.

기존 분석기 라이브러리를 사용하여 코드를 검사하고, 자체 분석기를 작성하여 조직 내에 베스트 프랙티스나 규칙을 홍보할 수 있습니다. 이 페이지에서는 빈 Unity 프로젝트에서 Roslyn 분석기를 사용하는 방법을 설명합니다.

기존 Roslyn 분석기 라이브러리 사용

기존 Roslyn 분석기 라이브러리를 사용하려면 프로젝트 내에서 NuGet에서 ErrorProne.NET.CoreAnalyzers 라이브러리를 설치해야 합니다. 그러면 .csproj 파일이 열립니다. 프로젝트에 분석기로 포함되는 세 개의 .dll 파일은 다음과 같습니다.

  <ItemGroup>
      <Analyzer Include="packages\ErrorProne.NET.CoreAnalyzers.0.1.2\analyzers\dotnet\cs\ErrorProne.NET.Core.dll" />
      <Analyzer Include="packages\ErrorProne.NET.CoreAnalyzers.0.1.2\analyzers\dotnet\cs\ErrorProne.Net.CoreAnalyzers.dll" />
      <Analyzer Include="packages\ErrorProne.NET.CoreAnalyzers.0.1.2\analyzers\dotnet\cs\RuntimeContracts.dll" />
    </ItemGroup>

세 개의 .dll 파일을 Unity 프로젝트의 Assets 폴더(또는 Assets 폴더 내에 중첩된 폴더)로 이동합니다. 에디터에서 .dll 파일을 선택합니다. 플러그인 인스펙터의 Select platforms for plugin에서 Any Platform을 비활성화하고, Include platforms에서 Editor 및 Standalone 플랫폼을 비활성화한 후 모든 DLL에 RoslynAnalyzer라는 새 레이블을 지정합니다.

모두 올바르게 작동하는지 확인하려면 프로젝트의 Assets 폴더에 다음 코드와 함께 RethrowError.cs라는 파일을 저장합니다. 이 코드는 ErrorProne.NET이 잘못된 예외 전파와 의심스러운 예외 처리에 대한 경고를 발생시킵니다.

using System;
using UnityEngine;

public class RethrowError : MonoBehaviour
{
    void Update()
    {
        try
        {
            DoSomethingInteresting();
        }
        catch (Exception e)
        {
            Debug.Log(e.Message);
            throw e;
        }
    }

    private void DoSomethingInteresting()
    {
        throw new System.NotImplementedException();
    }
}

이렇게 하면 콘솔 창에 다음의 두 가지 경고가 표시됩니다.

Assets\RethrowError.cs(14,23): warning EPC12: Suspicious exception handling: only e.Message is observed in exception block.
Assets\RethrowError.cs(15,19): warning ERP021: Incorrect exception propagation. Use throw; instead.

규칙 집합 파일

프로젝트의 분석기에서 발생하는 다양한 경고 및 오류를 처리하는 방법에 대한 고유한 규칙을 정의하기 위해 규칙 집합 파일을 만들 수 있습니다. 커스텀 규칙 집합을 만드는 방법에 대한 자세한 내용은 커스텀 규칙 집합을 만드는 방법에 대한 Microsoft의 Visual Studio 문서를 참조하십시오.

Assets 루트 폴더에 Default.ruleset라는 이름의 규칙 집합 파일을 배치하십시오. Default.ruleset에서 정의하는 규칙은 사전 정의된 모든 어셈블리(예: Assembly-CSharp.dll)뿐만 아니라, .asmdef 파일을 사용하여 빌드된 모든 어셈블리에도 적용됩니다.

사전 정의된 어셈블리에 대한 Default.ruleset에서 규칙을 오버라이드하려면 [PredefinedAssemblyName].ruleset라는 이름의 루트 폴더에서 .ruleset 파일을 생성하십시오. 예를 들어 Assembly-CSharp.ruleset의 규칙은 Assembly-CSharp.dll의 코드에 적용됩니다. 이 .ruleset 파일만 루트 폴더 내부에서 허용됩니다.

Default.ruleset
Assembly-CSharp.ruleset
Assembly-CSharp-firstpass.ruleset
Assembly-CSharp-Editor.ruleset
Assembly-CSharp-Editor-firstpass.ruleset

워크플로: Unity에서 규칙 집합 파일 테스트

Unity에서 규칙 집합 파일을 테스트하려면 다음 단계를 따르십시오.

단계 1: 규칙 집합 파일 설정

프로젝트의 Assets 폴더에 Subfolder라는 하위 폴더를 만듭니다.
Subfolder 내에서 다음을 수행합니다.
1. 새 .asmdef 파일을 만듭니다.
2. RethrowError.cs의 복제본을 저장합니다.
다음 코드를 사용하여 Assets 내부에 Default.ruleset 파일을 생성합니다.

<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="New Rule Set" Description=" " ToolsVersion="10.0">
  <Rules AnalyzerId="ErrorProne.NET.CodeAnalyzers" RuleNamespace="ErrorProne.NET.CodeAnalyzers">
    <Rule Id="ERP021" Action="Error" />
  <Rule Id="EPC12" Action="None" />
  </Rules>
</RuleSet>

Default.ruleset 파일은 다음 규칙을 정의합니다.

의심스러운 예외 처리에 대한 경고인 ’EPC12’가 표시되지 않도록 만듭니다.
잘못된 예외 전파에 대한 경고인 ERP021을 오류로 등급을 높입니다.

단계 2: 프로젝트 다시 로드

프로젝트에 규칙 집합 파일을 추가한 후 규칙을 적용할 어셈블리에 있는 스크립트를 다시 임포트하십시오. 이렇게 하면 Unity가 새 규칙 집합 파일을 사용하여 어셈블리를 다시 컴파일합니다. 재컴파일 후 콘솔 창에는 다음과 같은 두 개의 메시지가 표시됩니다.

Assets\Subfolder\RethrowError.cs(15,19): error ERP021: Incorrect exception propagation. Use throw; instead.
Assets\RethrowError.cs(15,19): error ERP021: Incorrect exception propagation. Use throw; instead.

Unity가 Default.ruleset에 정의된 규칙을 Assets/RethrowError.cs와 Assets/Subfolder/RethrowError.cs 모두에 적용한다는 점에 유의하십시오.

단계 3: 커스텀 규칙 집합 추가

Assets/Subfolder에서 .ruleset 파일을 생성한 후 원하는 이름을 지정합니다(이 예제에서는 Hello.ruleset).

<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="New Rule Set" Description=" " ToolsVersion="10.0">
  <Rules AnalyzerId="ErrorProne.NET.CodeAnalyzers" RuleNamespace="ErrorProne.NET.CodeAnalyzers">
    <Rule Id="ERP021" Action="Info" />
    <Rule Id="EPC12" Action="Info" />
  </Rules>
</RuleSet>

새로운 Hello.ruleset 파일은 Unity가 EPC12와 ERP021을 경고나 오류로 처리하지 않고 콘솔에 출력하도록 지시합니다.

Unity가 프로젝트를 다시 컴파일하면 콘솔 창에 다음의 메시지가 표시됩니다.

Assets\Subfolder\RethrowError.cs(14,23): info EPC12: Suspicious exception handling: only e.Message is observed in exception block.
Assets\Subfolder\RethrowError.cs(15,19): info ERP021: Incorrect exception propagation. Use throw; instead.
Assets\RethrowError.cs(15,19): error ERP021: Incorrect exception propagation. Use throw; instead.

Default.ruleset의 규칙이 Assets\RethrowError.cs에 여전히 적용되지만, Assets\Subfolder\RethrowError.cs에는 더 이상 적용되지 않는데, 이는 Hello.ruleset의 규칙에 의해 오버라이드되기 때문입니다.

허용되는 모든 규칙 집합 작업 파일에 대한 자세한 내용은 코드 분석 규칙 집합 에디터 사용에 대한 Visual Studio 문서를 참조하십시오.

추가 분석기

다음은 인기 있는 다른 Roslyn 분석기 라이브러리의 Github 저장소에 대한 링크입니다.

awesome-analyzers
dotnet/roslyn-analyzers
2020.2에서 Roslyn 분석기 호환성 추가됨 NewIn20202

유닛 테스트

스크립팅 개념

매뉴얼