C# - 하나의 resource 파일을 여러 프로그램에서 (AOT 시에도) 사용하는 방법
닷넷 응용 프로그램에는, 비주얼 스튜디오의 경우 간편하게 "resx" 파일을 통해 다양한 유형의 리소스를 임베딩해서 관리할 수 있습니다.
예를 들어 볼까요? ^^ 간단하게 콘솔 프로그램을 하나 만들고 "Resources File" 유형의 파일을 하나 추가합니다. 기본 이름인 경우 "Resource1.resx" 파일이 추가되는데요, 해당 파일을 비주얼 스튜디오에서 열어 "Add Resource"를 이용해 "test_file.zip" 압축 파일을 추가해 봅니다.
자, 그럼 당연히 해당 ConsoleApp1에서는 Assembly를 이용해 스스로의 리소스에 접근하는 것이 가능합니다.
using System.Reflection;
using System.Resources;
namespace ConsoleApp2;
internal class Program
{
static void Main(string[] args)
{
Assembly asm = Assembly.GetExecutingAssembly();
string resName = asm.GetName().Name + ".Resource1";
ResourceManager rm = new ResourceManager(resName, asm);
Console.WriteLine(rm); // 출력 결과: System.Resources.ResourceManager
var result = rm.GetObject("test_file") as byte[];
Console.WriteLine(result.Length); // 출력 결과: 175
}
}
이제 추가로 ConsoleApp2 프로젝트를 하나 만들고, 위의 ConsoleApp1에 포함된 리소스를 접근하고 싶다면 이번에도 Assembly.LoadFile 등의 명령어를 이용해 Assembly 인스턴스를 만들어 접근하는 것이 가능합니다.
string currentDirectory = System.AppContext.BaseDirectory.TrimEnd(Path.PathSeparator);
string filePath = Path.Combine(currentDirectory, "ConsoleApp1.dll");
Assembly asm = Assembly.LoadFile(filePath);
string resName = "ConsoleApp1.Resource1";
ResourceManager rm = new ResourceManager(resName, asm);
Console.WriteLine(rm);
var result = rm.GetObject("test_file") as byte[];
Console.WriteLine(result.Length);
별로 어렵지 않죠? ^^
그런데 AOT 빌드를 생각하면 어떨까요? 이 경우, Assembly.LoadFile은 AOT 빌드 시 경고가 발생하고,
warning IL2026: Using member 'System.Reflection.Assembly.LoadFile(String)' which has 'RequiresUnreferencedCodeAttribute' can break functionality when trimming application code. Types and members the loaded assembly depends on might be removed
실행 시 다음과 같은 예외가 발생합니다.
Unhandled Exception: System.PlatformNotSupportedException: Operation is not supported on this platform.
at Internal.Reflection.Execution.AssemblyBinderImplementation.Bind(String, AssemblyBindResult&, Exception&) + 0x34
at System.Reflection.Runtime.Assemblies.RuntimeAssemblyInfo.GetRuntimeAssemblyFromPath(String) + 0x4c
at System.Runtime.Loader.AssemblyLoadContext.LoadFromAssemblyPath(String) + 0x6d
at System.Reflection.Assembly.LoadFile(String) + 0x12c
at ConsoleApp2.Program.Main(String[] args) + 0x45
at ConsoleApp2!<BaseAddress>+0x14ccc0
Load, LoadFrom, ReflectionOnlyLoad, UnsafeLoadFrom의 모든 메서드들이 저 오류가 발생하는데, 그러니까, 일단 동적으로 어셈블리를 로드하는 것은 AOT 환경일 경우 포기해야 합니다.
다행히도, 관점을 바꿔보면 우회 해결할 수 있는 여지가 있습니다.
위의 상황에서 개발자가 원하는 것은, (내부에 구현된 타입이 아닌) 해당 어셈블리의 리소스입니다. 따라서, 어셈블리 내에 임베딩시키지 말고 별도의 "리소스 DLL"로 분리하는 것입니다.
Create resource files for .NET apps
; https://learn.microsoft.com/en-us/dotnet/core/extensions/create-resource-files
방법은 매우 쉽습니다. 이미 ConsoleApp1 프로젝트에 resx 확장자로 포함한 파일(예: Resource1.resx)을 resgen.exe를 이용해서 빌드만 다시 해주면 됩니다.
c:\temp\ConsoleApp1\ConsoleApp1> resgen Resource1.resx
Read in 1 resources from "Resource1.resx"
Writing resource file... Done.
// 1) msbuild 과정 중에 진행이 되도록 csproj에 Task로 지정할 수 있습니다.
// 2) resx 파일이 있으면 결국 프로젝트에 임베딩되기 때문에
// 별도의 Remove 설정을 해야 2중으로 리소스가 들어가는 것을 방지할 수 있습니다.
그럼, Resource1.resources 파일이 생성되는데요, 별도로 분리된 이 파일을 ConsoleApp1.exe와 ConsoleApp2.exe 모두에 함께 배포하면 됩니다. 그리고 이렇게 분리된 리소스를
ResourceManager.CreateFileBasedResourceManager 메서드를 이용해 다음과 같이 사용할 수 있습니다.
string currentDirectory = System.AppContext.BaseDirectory.TrimEnd(Path.PathSeparator);
ResourceManager rm = ResourceManager.CreateFileBasedResourceManager("Resource1", currentDirectory, null);
Console.WriteLine($"{rm}");
var zipFile = rm.GetObject("test_file", CultureInfo.InvariantCulture) as byte[];
Console.WriteLine($"{zipFile?.Length}");
위의 코드는 ConsoleApp1, ConsoleApp2 모두에서 잘 동작합니다. 따라서 임베딩하지 않은 리소스, 즉 외부 파일로 분리된 리소스를 Assembly.Load 대신 가져올 수 있어 AOT 빌드에서도 무난하게 사용할 수 있습니다. ^^
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]