NuGet 패키지 제작 - Native와 Managed DLL을 분리하는 방법
지난번에 만든 NuGet 패키지를,
SOIL(Simple OpenGL Image Library) - Native DLL 및 .NET DLL 제공
; https://www.sysnet.pe.kr/2/0/11768
Visual Studio 2015에서 참조하는 경우 다음과 같은 오류가 발생합니다.
Failed to add reference to 'SoilProxy32'
배경 설명을 하면, 해당 Package는 Managed와 Native 모듈을 모두 가지고 있습니다. 그리고 패키징 방식이 lib 폴더 밑에 모두 집어넣는 형식으로 되어 있습니다. 그러니까 다음과 같이 폴더 구조를 잡고,
Root
│ SoilNET.nuspec
│
└───lib
├───net40
│ Soil.NetFX4.dll
│ Soil.NetFX4.pdb
│ SoilProxy32.dll
│ SoilProxy32.pdb
│ SoilProxy64.dll
│ SoilProxy64.pdb
│
└───netstandard2.0
Soil.NetCore.deps.json
Soil.NetCore.dll
Soil.NetCore.pdb
SoilProxy32.dll
SoilProxy32.pdb
SoilProxy64.dll
SoilProxy64.pdb
SoilNET.nuspec의 내용을 이렇게 채운 후,
<?xml version="1.0"?>
<package >
<metadata>
<id>SoilDotnet</id>
<title>soil 1.16 for .NET Framework</title>
<version>1.0.1</version>
<authors>kevin13</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>soil 1.16 for .NET Framework 4.x and .NET Standard</description>
<!--iconUrl>if you send it to me, I'll use it.</iconUrl-->
<tags>opengl soil v150 vs2017 managed</tags>
<projectUrl>https://github.com/stjeong/SoilNET</projectUrl>
<dependencies>
<group targetFramework=".NETFramework4.0" />
<group targetFramework=".NETStandard2.0" />
</dependencies>
</metadata>
</package>
nuget 명령어를 다음과 같이 실행하면 패키징이 되는 것입니다.
nuget pack SoilNET.nuspec -OutputDirectory ..\nuget_package
이렇게 패키징한 파일을 Visual Studio 2017에서 참조 추가하면 아무런 문제가 없습니다. 반면, Visual Studio 2015에서는 Native 모듈인 SoilProxy32.dll를 참조할 수 없다는 오류가 뜨는 것입니다.
이유는 간단합니다. 2015 버전에서는 폴더에 있는 DLL 파일이라면 무조건 .NET DLL로 가정하고 참조 추가를 해버리는데 SoilProxy32.dll이 Native이기 때문에 참조 추가에 실패해 그런 오류가 발생하는 것입니다. (2017의 경우에는 똑똑하게 ^^ 해당 DLL의 유형에 따라 참조 추가 유무를 결정하므로 문제가 없습니다.)
이 문제를 해결하려면, 2015로 하여금 Native DLL은 참조 추가를 하지 않고 단지 Output Directory에 복사만 하도록 지정해야 합니다. 이렇게 하려면 참조 대상인 DLL과 그렇지 않은 파일을 폴더로 구분해 나누고 nuspec에 참조할 수 있는 DLL을 다음과 같이 직접 지정해야 합니다.
<?xml version="1.0"?>
<package >
<metadata>
<id>SoilDotnet</id>
<title>soil 1.16 for .NET Framework</title>
<version>1.0.3</version>
<authors>kevin13</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>soil 1.16 for .NET Framework 4.x and .NET Standard</description>
<!--iconUrl>if you send it to me, I'll use it.</iconUrl-->
<tags>opengl soil v150 vs2017 managed</tags>
<projectUrl>https://github.com/stjeong/SoilNET</projectUrl>
<dependencies>
<group targetFramework=".NETFramework4.0" />
<group targetFramework=".NETStandard2.0" />
</dependencies>
<references>
<group targetFramework="net40">
<reference file="Soil.NetFX4.dll" />
</group>
<group targetFramework="netcoreapp">
<reference file="Soil.NetCore.dll" />
</group>
</references>
</metadata>
</package>
그리고 Native DLL은 별도의 폴더로 구분해 넣어두는데 그래서 패키지의 소스 트리 구조가 다음과 같이 바뀝니다.
Root
│ SoilNET.nuspec
│
├───build
│ SoilDotnet.targets
│
└───lib
├───net40
│ Soil.NetFX4.dll
│ Soil.NetFX4.pdb
│
├───netstandard2.0
│ Soil.NetCore.deps.json
│ Soil.NetCore.dll
│ Soil.NetCore.pdb
│
└───runtimes
SoilProxy32.dll
SoilProxy32.pdb
SoilProxy64.dll
SoilProxy64.pdb
여기까지만 하면, Visual Studio 2015는 현재의 프로젝트 유형에 따라 Soil.NetFX4.dll 또는 Soil.NetCore.dll을 참조 추가하게 됩니다. 문제는 runtimes 밑에 있는 파일들이 아무런 역할도 하지 못한다는 점입니다. 즉, 참조한 Managed DLL과 같은 폴더에 놓이도록 출력이 되어야 하는데 저렇게 한 상태에서는 SoilProxy32.dll, SoilProxy64.dll이 누락됩니다.
물론, 해당 파일들을 net40 폴더나 netstandard2.0에 포함시켜도 되지만 그렇게 하면 Visual Studio 2015에서는 DLL이기 때문에 참조를 하려고 해 다시 동일한 오류가 발생합니다.
이 문제를 해결하기 위해, 빌드 시에 MSBuild로 하여금 NuGet 패키지를 위한 build target 파일을 처리하도록 지정할 수 있습니다. 바로 그 파일이 위의 트리 구조에서 "build" 폴더에 있는 SoilDotnet.targets 파일입니다. 파일의 내용을 보면 이해가 되실 것입니다. ^^
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<Content Include="$(MSBuildThisFileDirectory)..\lib\runtimes\SoilProxy64.dll">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
<Link>SoilProxy64.dll</Link>
</Content>
<Content Include="$(MSBuildThisFileDirectory)..\lib\runtimes\SoilProxy32.dll">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
<Link>SoilProxy32.dll</Link>
</Content>
</ItemGroup>
</Project>
위와 같이 targets 파일을 만들어 패키지에 포함시키면, 이것을 참조한 프로젝트를 빌드시 저 동작을 포함하는 것입니다. 따라서 자연스럽게 Native DLL이 빌드 디렉터리에 복사가 되어 결국 "Failed to add reference to 'SoilProxy32'" 문제가 해결되는 것입니다. 덕분에 이번 기회에 ^^ NuGet 패키징을 좀 더 알게 되었습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]