Resolving System.Net.Http Version Conflicts in ASP.NET MVC4 Web API Deployment

Problem Background and Phenomenon Analysis

During the deployment of ASP.NET MVC4 Web API projects, developers frequently encounter System.Net.Http assembly version mismatch errors. Typical error messages display: "Could not load file or assembly 'System.Net.Http, Version=2.0.0.0' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference." This error typically occurs when there's inconsistency between local development environments and server deployment environments.

Root Cause Investigation

The core of this issue lies in the complexity of .NET framework versions and NuGet package dependencies. The System.Net.Http assembly exists in multiple versions across different .NET framework releases:

• Version 1.0.0.0 is typically used in .NET Framework 4.0
• Version 2.0.0.0 was introduced in .NET Framework 4.5
• ASP.NET Web API Beta packages have specific dependencies on System.Net.Http.Formatting

When projects are developed locally using .NET 4.5 but deployed to server environments that only support .NET 4.0, version mismatches occur. Even if local assemblies show version 1.0.0.0, project references may still point to 2.0.0.0, causing runtime binding failures.

Solution Implementation Steps

Based on best practices, resolving this issue requires systematic configuration adjustments:

1. Project Framework Version Adjustment

First, change the project target framework from .NET 4.5 to .NET 4.0. This can be accomplished through Visual Studio's project properties panel:

1. Right-click the project and select "Properties"
2. Find "Target Framework" in the "Application" tab
3. Select ".NET Framework 4.0" from the dropdown menu
4. Save changes and rebuild the project

2. NuGet Package Management

After changing the framework version, reinstall Web API-related packages:

PM> Uninstall-Package Microsoft.AspNet.WebApi
PM> Install-Package Microsoft.AspNet.WebApi -Version 4.0.30506.0

This step ensures the NuGet package manager downloads correct version dependencies compatible with .NET 4.0.

3. Assembly Reference Configuration

A crucial step is modifying reference settings in the project file (.csproj) to ensure all assemblies load from the Bin directory:

<Reference Include="System.Net.Http">
  <HintPath>..\packages\Microsoft.Net.Http.2.0.20710.0\lib\net40\System.Net.Http.dll</HintPath>
  <Private>True</Private>
</Reference>

Applying the <Private>True</Private> setting to all relevant references prevents runtime loading of older versions from the Global Assembly Cache (GAC).

4. Runtime Binding Redirection (Supplementary Solution)

If issues persist after the above steps, add binding redirection to web.config:

<runtime>
  <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
    <dependentAssembly>
      <assemblyIdentity name="System.Net.Http" 
                        publicKeyToken="b03f5f7f11d50a3a" 
                        culture="neutral"/>
      <bindingRedirect oldVersion="0.0.0.0-2.0.0.0" 
                       newVersion="1.0.0.0"/>
    </dependentAssembly>
  </assemblyBinding>
</runtime>

This configuration redirects all requests for System.Net.Http to version 1.0.0.0, resolving version mismatch issues.

Deployment Verification and Testing

After completing the above configurations, conduct the following verifications:

1. Test deployment packages locally using IIS Express
2. Check version consistency of all assemblies in the Bin directory
3. Monitor assembly loading processes using Fusion Log Viewer
4. Perform staging tests before production deployment

Best Practices Summary

To avoid similar deployment issues, follow these development standards:

• Clearly define target deployment environment .NET framework versions during project initiation
• Use NuGet package manager to uniformly manage all dependencies
• Set <Private>True</Private> for all references in .csproj files
• Regularly clean and update NuGet package caches
• Establish standardized deployment checklists

Through systematic configuration management and version control, compatibility issues during cross-environment deployment of ASP.NET MVC4 Web API projects can be significantly reduced. Such problems are not limited to System.Net.Http but may also occur with other shared assemblies, making comprehensive deployment processes essential.