.NET - Using NuGet Packages

Using NuGet Packages in .NET

Introduction to NuGet

NuGet is the package manager for the Microsoft development platform including .NET. It enables developers to create, share, and consume reusable code packages. These packages are distributed from the public NuGet Gallery (nuget.org) or private repositories. NuGet helps manage dependencies, versioning, and package configurations in both .NET Framework and .NET Core/5/6+ projects.

Why Use NuGet in .NET Projects?

• Simplifies dependency management.
• Speeds up development by reusing libraries.
• Supports version control for packages.
• Allows for private/internal enterprise packages.
• Integrates seamlessly with Visual Studio and CLI tools.

Installing NuGet Packages in Visual Studio

Using the NuGet Package Manager GUI

The easiest way to install NuGet packages in Visual Studio is by using the Package Manager GUI.

1. Right-click the project in Solution Explorer.
2. Select Manage NuGet Packages.
3. Browse or search for a package, e.g., Newtonsoft.Json.
4. Click Install and accept the license.

Using the Package Manager Console

Install-Package Newtonsoft.Json

This command installs the specified package and its dependencies into your project.

Installing NuGet Packages via .NET CLI

For .NET Core/.NET 5+ applications, use the CLI for cross-platform compatibility.

dotnet add package Newtonsoft.Json

To see all installed packages:

dotnet list package

Understanding Package References

After installation, the NuGet package is referenced in the project file (.csproj).

<ItemGroup>
  <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
</ItemGroup>

This is different from older projects that used a separate packages.config file.

Using a NuGet Package in Code

using Newtonsoft.Json;
using System;

public class Demo
{
    public static void Main()
    {
        var person = new { Name = "John", Age = 30 };
        string json = JsonConvert.SerializeObject(person);
        Console.WriteLine(json);
    }
}

Creating Your Own NuGet Package

Step 1: Create a Class Library

dotnet new classlib -n MyAwesomeLibrary
cd MyAwesomeLibrary

Step 2: Add Metadata to .csproj

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <PackageId>MyAwesomeLibrary</PackageId>
    <Version>1.0.0</Version>
    <Authors>YourName</Authors>
    <Company>YourCompany</Company>
    <Description>A demo NuGet package</Description>
  </PropertyGroup>

</Project>

Step 3: Build and Pack the Project

dotnet pack

This generates a .nupkg file in the bin/Debug or bin/Release directory.

Publishing NuGet Packages

Step 1: Create a NuGet API Key

Visit nuget.org, log in, and generate an API Key under your account settings.

Step 2: Push Package Using CLI

dotnet nuget push bin/Debug/MyAwesomeLibrary.1.0.0.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json

Setting Up a Local or Private NuGet Feed

If you want to share packages within an organization without publishing to nuget.org:

Create a Local Feed Directory

mkdir C:\NuGetPackages
dotnet nuget add source C:\NuGetPackages -n LocalFeed

Consume a Local NuGet Package

dotnet add package MyAwesomeLibrary --source C:\NuGetPackages

NuGet Configuration Files

nuget.config

Stores configuration settings such as package sources and credentials.

<configuration>
  <packageSources>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
    <add key="LocalFeed" value="C:\NuGetPackages" />
  </packageSources>
</configuration>

Updating and Restoring NuGet Packages

Update All Packages

dotnet list package --outdated
dotnet add package [PackageName] --version x.y.z

Restore Packages

To restore packages from a solution or project file:

dotnet restore

Best Practices for NuGet Usage

• Always use specific package versions to ensure build consistency.
• Don't push sensitive data in .nupkg files.
• Document dependencies in README.md or .csproj comments.
• Use semantic versioning (MAJOR.MINOR.PATCH) for releases.
• Pin versions in CI/CD pipelines for stability.

Common Issues and Troubleshooting

Problem: Package not found

Make sure the package name and version are correct. Verify that your nuget.config file contains the proper source.

Problem: Conflicts between dependencies

Use dotnet list package and examine the dependency tree to resolve conflicts manually.

Advanced Topics

Creating a Symbol Package (.snupkg)

dotnet pack --include-symbols --include-source

Hosting Private NuGet Server with Azure Artifacts

Azure DevOps provides a private NuGet feed via Artifacts. This is ideal for internal teams.

Using GitHub Packages as a NuGet Feed

GitHub Packages supports NuGet hosting. You'll need a token and modify nuget.config with GitHub credentials.

NuGet is an essential tool in the .NET developer's toolbox. It enables scalable and maintainable project architecture by simplifying dependency management. Whether you're consuming existing packages or authoring your own, mastering NuGet will significantly boost productivity and collaboration. With support across Visual Studio, CLI, and CI/CD tools, NuGet is a cornerstone of modern .NET development.