NuGet 如何设置图标

Updated: at 12:43,Created: at 08:55

在找 NuGet 的时候可以看到有趣的库都有有趣的图标，那么如何设置一个 NuGet 的图标？

比较推荐的方法是 通过文件 的方式设置 NuGet 的图标，设置的方法十分简单，请看文章最后

在开始之前，请在nuget官方网站下载 NuGet.exe 同时设置环境变量

环境变量设置的方法就是将 NuGet.exe 放在一个文件夹，如 C:\lindexi 然后右击计算机，属性高级环境变量，然后选择用户变量，双击 Path 添加 c:\lindexi 就可以了

如果之前已经设置了环境变量，请尝试更新一下 NuGet 请使用下面命令

nuget update -self

在 NuGet 包显示图标的原理是在 nuspec 文件存在图标或图片链接

尝试使用 dotnet 打包的方法打包一个应用

在命令行输入下面代码创建一个 web 应用

dotnet new webapi -o Lindexi

这样就创建出一个 webapi 的应用，因为 web 应用默认是不能打包，需要修改 Lindexi.csproj 文件，添加下面代码

  <PropertyGroup>
    <IsPackable>true</IsPackable>
  </PropertyGroup>

通过下面代码可以打包

dotnet pack

在 bind\debug 文件夹可以找到 Lindexi.1.0.0.nupkg 文件

通过应用商店找到NuGet工具安装就可以打开 nupkg 文件

通过 VisualStudio 的 Nuget 包管理设置本地的包为 Lindexi.1.0.0.nupkg 文件的文件夹，就可以找到这个文件

在 VisualStudio 右击一个项目，选择刚才设置的源，就可以找到这个文件

这时可以看到图标使用的是默认的图标，下面就是如何修改这个图标

通过压缩工具打开 Lindexi.1.0.0.nupkg 文件，因为 nupkg 文件是一个压缩文件，可以通过压缩工具解压，在解压之后可以看到下面的文件

通过 URL 设置图标

打开 Lindexi.nuspec 文件，在之前的 NuGet 支持的是通过 URL 的方法设置图标

可以从easyicon找到一个好看的图标

然后通过图床将图标上传到网上，在 Lindexi.nuspec 文件添加下面代码

    <iconUrl>http://image.acmx.xyz/lindexi%2F2019427172218870</iconUrl>

这里的 http://image.acmx.xyz/lindexi%2F2019427172218870 就是我上传的图标，添加在 metadata 里面，大概看起来的 Lindexi.nuspec 文件就是下面代码

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
  <metadata>
    <id>Lindexi</id>
    <version>1.0.0</version>
    <authors>Lindexi</authors>
    <owners>Lindexi</owners>
    <iconUrl>http://image.acmx.xyz/lindexi%2F2019427172218870</iconUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>Package Description</description>
    忽略一些代码
  </metadata>
</package>

将命令行跳到 Lindexi.nuspec 文件的文件夹，输入下面代码就可以重新打包

nuget pack

通过NuGet工具打开创建的 Lindexi.1.0.0.nupkg 的文件，可以看到图标

做到这个效果的另一个简单方法是在NuGet工具点击更改，在 Icon Url 修改链接

通过文件

有小伙伴说他在清真的地方，无法下载到好看的图标，同时图标使用的是外面的链接，可能下载到的不是图片，所以微软建议将图标文件放在 NuGet 包里面

编辑 Lindexi.nuspec 文件，将 iconUrl 替换为 icon 同时添加相对路径的图标

这也是比较推荐的方法，能够解决 NU5048 警告

推荐在 Directory.Build.props 文件里面使用下面添加下面代码

  <PropertyGroup>
    <PackageIcon>Icon.png</PackageIcon>
  </PropertyGroup>
  <ItemGroup>
    <None Include="$(MSBuildThisFileDirectory)logo.png" Pack="true" PackagePath="Icon.png"></None>
  </ItemGroup>

将图标文件 logo.png 放在 Directory.Build.props 文件所在的文件夹，通过 $(MSBuildThisFileDirectory) 就可以找到这个文件，然后打包放在 Icon.png 文件

在 PackageIcon 引用这个文件，需要注意的是这里的文件的大小写是需要关注的，需要让大小写相同，才能拿到相同的文件

另外，此 Icon.png 将会在项目中看到，如果期望没有在项目看到，可以加上 Visible="False" 设置不可见，代码如下

 <None Include="$(MSBuildThisFileDirectory)Logo.png" Pack="true" PackagePath="Icon.png" Visible="False"></None>

Packaging Icon within the nupkg · NuGet/Home Wiki

知识共享许可协议

原文链接: http://blog.lindexi.com/post/NuGet-%E5%A6%82%E4%BD%95%E8%AE%BE%E7%BD%AE%E5%9B%BE%E6%A0%87

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。 欢迎转载、使用、重新发布，但务必保留文章署名 林德熙 (包含链接: https://blog.lindexi.com )，不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请与我 联系。