テンプレートテスト

ラベル .NET Standard の投稿を表示しています。すべての投稿を表示

2020/10/08

外部 DLL を NuGet パッケージに含める方法

## 環境  - Visual Studio 2017 - .NET Core 2.2  ## 方法  ググってみるとまさにそのものが書いてある以下のページが見つかりました。  - https://blog.okazuki.jp/entry/2019/09/28/145646  しかし、これだけではいろいろはまったので、追記・補足しておきます。    ### PackagePath について    出力先となる `PackagePath` のディレクトリ名には `lib` を指定する必要があるようです。 指定しなかった場合、以下の警告が表示されました。    > warning NU5100: The assembly 'foo.dll' is not inside the 'lib' folder and hence it won't be added as a reference when the package is installed into a project. Move it into the 'lib' folder if it needs to be referenced.    さらに、`lib` だけだと以下のエラーが表示されました。    > warning NU5103: The folder 'lib/foo.dll' under 'lib' is not recognized as a valid framework name or a supported culture identifier. Rename it to a valid framework name or culture identifier.  `lib` の下にはフレームワーク名またはカルチャー名のディレクトリを指定する必要があるみたいです。  ```xml <ItemGroup>  <Content Include="foo.dll" Pack="true" PackagePath="lib\netstandard2.0" /></ItemGroup>```    また、 このフレームワーク名またはカルチャー名以下の階層が、作成した DLL と同じ階層に作られるようです。   例えば、作成した DLL が `sample.dll` だとして、外部の DLL を以下のように設定してパッケージに含めた場合、  ``` <ItemGroup>  <Content Include="foo\x64\foo.dll" Pack="true" PackagePath="lib\netstandard2.0\foo\x64" />  <Content Include="foo\x86\foo.dll" Pack="true" PackagePath="lib\netstandard2.0\foo\x86" /></ItemGroup>```  NuGet パッケージインストール後の配置は以下のようになります。  - sample.dll - foo\x64\foo.dll - foo\x86\foo.dll  ### 外部 DLL を出力ディレクトリにコピー    外部 DLL を出力ディレクトリにコピーするには、Visual Studio で該当の DLL を右クリックし、`出力ディレクトリにコピー` の項目を `新しい場合はコピーする` （または `常にコピーする`） に設定しておく必要があります。  手動で `.csproj` ファイルを修正する場合は以下を追加します。  ```xml <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>```    ### publish 時に出力先ディレクトリに外部 DLL がコピーされない    この外部 DLL を含んだ NuGet パッケージを使っているアプリケーションにおいて、`dotnet publish` コマンドを実行しても外部 DLL が出力先の `publish` ディレクトリにコピーされませんでした。  `publish` 時に出力ディレクトリに外部 DLL をコピーするためには、まずライブラリ側（NuGet パッケージにするほう）の `.csproj` ファイルに以下を追加します。    ```xml <PackageCopyToOutput>true</PackageCopyToOutput>```    しかし、これを `PackagePath` で `lib` を指定している箇所に指定しても上手くいきませんでした。  `PackagePath` を指定しなかった場合、該当のファイルはコンテンツとして追加されるようなので、そこに `PackageCopyToOutput` を設定すると上手くいきました。   具体的には以下のような感じです。  ``` <Content Include="foo\x64\foo.dll" Pack="true">  <PackageCopyToOutput>true</PackageCopyToOutput></Content><Content Include="foo\x86\foo.dll" Pack="true">  <PackageCopyToOutput>true</PackageCopyToOutput></Content>```    これが一番はまりました。  ## 最終的に作成した設定  上記を踏まえ、最終的に `.csproj` ファイルの設定は以下のようになりました。  ``` <ItemGroup>  <Content Include="foo\x64\foo.dll" Pack="true" PackagePath="lib\netstandard2.0\foo\x64" />  <Content Include="foo\x86\foo.dll" Pack="true" PackagePath="lib\netstandard2.0\foo\x86" />  <Content Include="foo\x64\foo.dll" Pack="true">    <PackageCopyToOutput>true</PackageCopyToOutput>    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>  </Content>  <Content Include="foo\x86\foo.dll" Pack="true">    <PackageCopyToOutput>true</PackageCopyToOutput>    <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>  </Content></ItemGroup>```

依存している dll が出力フォルダにコピーされない

.NET Framework .NET Standard Visual Studio

## 環境  - Visual Studio 2017 - .NET Framework 4.6.1 - .NET Standard 2.0  ## 依存関係  まず、説明の都合上以下のように定義します。  - .NET Framework で作成したアプリケーションを **A** とする - .NET Standard で作成したライブラリを **B** とする - その .NET Standard で作成されたライブラリが依存している他の dll などを **C** とする  依存関係は A -> B -> C のようになります。  このとき、A をビルドすると、出力フォルダに B の dll はコピーされるのですが、C の dll がコピーされないという状況になりました。  ## 原因と解決策  NuGet のパッケージ管理には `packages.config` 形式と、`PackageReference` 形式があるようです。  `packages.config` 形式だと今回のような現象が起こるようで、`PackageReference` 形式に移行すれば解決します。  - https://docs.microsoft.com/ja-jp/nuget/reference/migrate-packages-config-to-package-reference  尚、.NET Core で新規にプロジェクトを作成した場合は `PackageReference` 形式になるようなので、今回のような問題は発生しません。   ## 移行方法  Visual Studio で `packages.config` から `PackageReference` へマイグレーションすることができます。  ソリューションファイルを開き、プロジェクト内の `packages.config` を右クリックします。  `Migrate packages.config to PackageReference...` を選択するとマイグレーションの画面が表示されるので、OK を押すとマイグレーションが実行されます。  <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjh7WNoS0ufaeXIN8qlAXlM4h2KaQbjGROZddMRTS95w-LwbaZChtyQm_tQ0-dZtqcRvmgcQuW2zk4a7LC81_XQPrLGBSuZhWOLDGWhx6AoYxh-r8VUUOiBlSxDCgun5ggRzBwxHtt8bmQ/s1600/01.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEjh7WNoS0ufaeXIN8qlAXlM4h2KaQbjGROZddMRTS95w-LwbaZChtyQm_tQ0-dZtqcRvmgcQuW2zk4a7LC81_XQPrLGBSuZhWOLDGWhx6AoYxh-r8VUUOiBlSxDCgun5ggRzBwxHtt8bmQ/s320/01.png" width="320" height="282" data-original-width="593" data-original-height="522" /></a> `Migrate packages.config to PackageReference...` のメニューが表示されない場合は、Visual Studio の設定を見直してみてください。  NuGet のデフォルトのパッケージ管理方式が `PackageReference` になっているとマイグレーションのメニューは表示されないようなので、`packages.config` に変更してください。   <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgpECcU-ZFLEdTka_fo8bp6JBQbsvgZayQAm7-DMVVPIXpBkiS9ZxG4cRtp7TvYwZgQibQUKOU_5swewjPhHnxJ9ePo4wshW87occyeQ2z1ZlHL6dkg8hWPC3xUmXWTIpAp2xVPXbm_sAo/s1600/02.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgpECcU-ZFLEdTka_fo8bp6JBQbsvgZayQAm7-DMVVPIXpBkiS9ZxG4cRtp7TvYwZgQibQUKOU_5swewjPhHnxJ9ePo4wshW87occyeQ2z1ZlHL6dkg8hWPC3xUmXWTIpAp2xVPXbm_sAo/s320/02.png" width="320" height="187" data-original-width="744" data-original-height="434" /></a>  尚、stackoverflow では .NET Framework で作成したアプリケーションのプロジェクトファイル (.csproj) を開き、`PropertyGroup` に以下を追加すれば OK というのがありました。  ``` <RestoreProjectStyle>PackageReference</RestoreProjectStyle>```  しかし、この場合 `package.config` で管理しているパッケージが未インストールされていない状態になるので、既に `package.config` が存在する場合はマイグレーションを行ったほうが良いと思います。

テンプレートテスト

2020/10/08

外部 DLL を NuGet パッケージに含める方法

2018/08/30

依存している dll が出力フォルダにコピーされない

Translate

Popular Posts

Labels

Blog Archive