기술 자료

Unity 엔진

Unity 엔진

Roslyn 분석기 및 소스 제너레이터용 추가 파일

Roslyn 분석기 또는 소스 제너레이터에서 사용할 추가 텍스트 파일을 정의합니다.
읽는 시간 2분최근 업데이트: 9일 전

Roslyn 분석기나 소스 제너레이터를 사용할 프로젝트에 추가 파일을 추가할 수 있습니다. Unity 에디터는 .additionalfile 확장자가 있고
Assets
폴더 또는 그 하위 폴더 중 하나에 있는 경우 Roslyn 분석기의 추가 파일로 파일을 인식합니다.

추가 파일 명명

컴파일 파이프라인에 전달되려면 파일의 이름을 형식
Filename.[Analyzer Name].additionalfile
에 따라 지정해야 합니다.
[Analyzer Name]
컴포넌트가 없는 파일은 임포트되지만 컴파일 파이프라인에 전달되지 않습니다.
[Analyzer Name]
컴포넌트는 대소문자를 구분하며 분석기 이름과 추가 파일 타겟과 일치해야 합니다.
Filename
구성 요소에는 마침표(
.
) 문자가 포함되어서는 안 됩니다.

추가 파일 필터링

컴파일된 각 어셈블리는 해당 어셈블리 정의에 대해 실행 중인 분석기에 따라 추가 파일 목록을 수신하고,
[Analyzer Name]
에 의해 필터링됩니다. 예를 들어 다음 어셈블리와 분석기가 있는 프로젝트를 생각해 보겠습니다.
  • Assembly1은
    Analyzer1
    라는 이름의 분석기를 사용합니다.
  • Assembly2는
    Analyzer2
    라는 이름의 분석기를 사용합니다.
  • Assembly3는
    Analyzer1
    및
    Analyzer2
    를 모두 사용합니다.
프로젝트에
FileA.Analyzer1.additionalfile
,
FileB.Analyzer2.additionalfile
,
FileC.additionalfile
,
FileD.Analyzer3.additionalfile
라는 이름의 추가 파일이 4개 포함된 경우 Unity는 해당 어셈블리와 함께 다음과 같은 추가 파일 목록을 전달합니다.
  • 어셈블리 1:
    FileA.Analyzer1.additionalfile
  • 어셈블리 2:
    FileB.Analyzer2.additionalfile
  • 어셈블리 3:
    FileA.Analyzer1.additionalfile
    ,
    FileB.Analyzer2.additionalfile
FileC
에는
[Analyzer Name]
컴포넌트가 없고
FileD
는 프로젝트에 없는 분석기를 참조하므로 Unity는 컴파일 파이프라인에 아무것도 전달하지 않습니다.

코드에서 사용 가능한 추가 파일 검색

분석기는 분석기 컨텍스트에서 컴파일된 어셈블리에 포함된 추가 파일의 전체 목록을 가져올 수 있습니다. 이 목록에는 어셈블리에 포함된 모든 추가 파일이 포함되며, 현재 분석기 이름과 일치하는 파일만 포함되지 않습니다. 다음 예시는 이를 보여 줍니다.
using System.IO;using System.Linq;using Microsoft.CodeAnalysis;using Microsoft.CodeAnalysis.CSharp.Syntax;namespace SourceGeneratorTest1;[제너레이터]public class SG2 : ISourceGenerator{ public void Execute(GeneratorExecutionContext context) { var pathOfFileWithTypeName = context.AdditionalFiles.FirstOrDefault(file => file.Path.Contains("GenerateType.SourceGenerator.Test.2.additionalfile")); if (pathOfFileWithTypeName == null) { // no additional file found, do not generate a type. 반환; } var @namespace = context.Compilation.SyntaxTrees.First().GetRoot().DescendantNodes().OfType<NamespaceDeclarationSyntax>().FirstOrDefault()?.Name?.ToString() ?? "NoNamespace"; // an additional file has been passed; read the type name from the file. string generatedTypeName = File.ReadAllText(pathOfFileWithTypeName.Path); context.AddSource( "SG2.generated.cs", : namespace {{@namespace}} { public partial class {{generatedTypeName}} { } } """); } public void Initialize(GeneratorInitializationContext context) { }}
참고
이 예제는 분석기 컨텍스트를 사용하여 추가 파일을 확인하는 것을 시연하는 데에만 사용됩니다. 프로덕션용 소스 제너레이터는 오류를 처리하고 올바른 기능과 성능을 보장하기 위해 더욱 포괄적인 코드를 필요로 합니다.
이전의 필터링 예제에서,
Analyzer1
및
Analyzer2
은 둘 중 하나의 이름을 따서 이름이 지정된 Assembly3에 대한 추가 파일을 가져올 수 있습니다. 각 분석기는 추가 파일에 사용할 수 있는 데이터가 있는지 확인합니다.
또한 에디터 코드에서 ScriptCompilerOptions.RoslynAdditionalFilePaths 프로퍼티를 사용하여 특정 어셈블리에 포함된 추가 파일 목록을 검색할 수 있습니다.

추가 리소스