C# 12 - Experimental 특성 지원
오늘(KST 2023-11-15) .NET 8과 함께 C# 12가 최종 공개되었습니다. 그래서 관련 문서를 봤더니, Experimental 특성에 대한 내용이 추가되었습니다. ^^;
Experimental attribute
; https://learn.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-12#experimental-attribute
Experimental 특성은 말 그대로 실험적으로 추가하는 기능임을 명시적으로 알리는 목적을 가집니다. 예를 들어, 아래와 같이 MyType을 Experimental로 지정하면,
using System.Diagnostics.CodeAnalysis;
namespace ConsoleApp2
{
internal class Program
{
static void Main(string[] args)
{
Console.WriteLine("Hello, World!");
MyType pg = new MyType(); // 컴파일 오류 - error MYID01: 'MyType' is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
pg.ToString();
}
}
}
[Experimental("MYID01")]
public class MyType
{
}
빌드 시 MyType을 사용하는 코드에 (특성과 함께 전달한 식별자 값에 해당하는) "MYID01"로 컴파일 오류가 발생합니다. 만약, 컴파일 오류에서 지적하는 내용을 감수하고라도 쓰고자 한다면 해당 식별자를 이용해
pragma 구문으로 오류 처리를 제어할 수 있습니다.
// 소스 코드 내에 지정 (경고가 아닌 에러여도 "warning"으로 제어)
#pragma warning disable MYID01
MyType pg = new MyType();
#pragma warning restore MYID01
또는, 프로젝트 전역적으로 허용하기 위해 csproj에 이렇게 명시할 수 있습니다. (비주얼 스튜디오의 프로젝트 설정 창에서도 "Build" / "Errors and Warnings" / "Suppress specific warnings"로도 지정할 수 있습니다.)
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<NoWarn>MYID01</NoWarn>
</PropertyGroup>
</Project>
대개의 경우, 이것은 "라이브러리"를 제공하는 개발자가 쓸만합니다. 즉, 실험적으로 포함하는 코드를 추가했다면 사용자로 하여금 이를 인지하게 만들고 "스스로 원하는 경우에 한해" 사용하게끔 안전장치를 두는 것입니다.
재미있게도, 마이크로소프트 직원이 작성한 C# 12 소개 글에 보면,
Announcing C# 12
; https://devblogs.microsoft.com/dotnet/announcing-csharp-12/
바로 C# 12 스스로의 기능으로 예정했던
Interceptor가 "experimental feature"이기 때문에 향후 구현이 바뀌거나 삭제될 수 있다고 하면서, 만약 여러분의 프로젝트에서 Interceptor를 사용한다면 ExperimentalAttribute 특성을 지정하라고 권유하고 있습니다.
Interceptors are an experimental feature, available in preview mode with C# 12. The feature may be subject to breaking changes or removal in a future release. Therefore, it is not recommended for production or released applications. If you use interceptors, mark your library with the ExperimentalAttribute.
참고로, 이것은 C# 12 컴파일러의 기능이기 때문에 .NET 7 이하의 프로젝트에서 (BCL에 없기 때문에) 임의로 특성만 정의해 사용하는 것도 가능합니다.
// .NET 7 이하의 프로젝트여도 C# 12 컴파일러로 빌드한다면 MyType을 사용하는 코드에 컴파일 에러 발생
[Experimental("MYID01")]
public class MyType
{
}
#if !NET8_0_OR_GREATER
namespace System.Diagnostics.CodeAnalysis
{
[AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Module | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Enum | AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Interface | AttributeTargets.Delegate, Inherited = false)]
public sealed class ExperimentalAttribute(string diagnosticId) : Attribute
{
public string DiagnosticId { get; } = diagnosticId;
public string? UrlFormat { get; set; }
}
}
#endif
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]