.Net Core 无法修改服务集合，因为它是只读的 The service collection cannot be modified because it is read-only

在程序运行编译阶段发生的异常信息：System.InvalidOperationException:“The service collection cannot be modified because it is read-only.”。如下图：

        其实在 .NET 7 中，ServiceCollection 可以声明为只读了，这使得我们可以有效避免在构建了 ServiceProvider 之后再新增服务，导致服务注册失败。

        在新的版本中，ServiceCollection 新增了一个 MakeReadonly() 的 API，调用之后，ServiceCollection 就不能再修改了，不能再注册新的服务或者移除集合中的服务，再修改就会抛异常。

直接来看一个示例吧，示例代码如下：

var services = new ServiceCollection();
services.AddSingleton<IUserIdProvider, EnvironmentUserIdProvider>();
await using (var provider = services.BuildServiceProvider())
{
    Console.WriteLine(provider.GetRequiredService<IUserIdProvider>().GetHashCode());
}
 
Console.WriteLine(services.IsReadOnly);
 
services.MakeReadOnly();
 
Console.WriteLine(services.IsReadOnly);
 
try
{
    services.AddSingleton<IHttpRequester, HttpClientHttpRequester>();
}
catch (Exception ex)
{
    Console.WriteLine(ex);
} 

输出结果如下： 

43942917
False
True
System.InvalidOperationException: The service collection cannot be modified because it is read-only.
   at Microsoft.Extensions.DependencyInjection.ServiceCollection.ThrowReadOnlyException()
   at Microsoft.Extensions.DependencyInjection.ServiceCollection.CheckReadOnly()
   at Microsoft.Extensions.DependencyInjection.ServiceCollection.System.Collections.Generic.ICollection<Microsoft.Extensions.DependencyInjection.ServiceDescriptor>.Add(ServiceDescriptor item)
   at Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.Add(IServiceCollection collection, Type serviceType, Type implementationType, ServiceLifetime lifetime)
   at Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.AddSingleton(IServiceCollection services, Type serviceType, Type implementationType)
   at Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.AddSingleton[TService,TImplementation](IServiceCollection services)
   at Net7Sample.ServiceCollectionSample.MainTest() in C:\projects\sources\SamplesInPractice\net7Sample\Net7Sample\ServiceCollectionSample.cs:line 28 

        在新的 HostApplicationBuilder 中也借助了这个 API ，在构建 Host 的时候也会调用这个 API 来使得 ServiceCollection 中注册的服务不能再变更，可以参考：https://github.com/dotnet/runtime/pull/68051/files#diff-e55c31d683c37cca99b7a3a274beef4a3101d53b02c9ea989e4f6310094f68ec

        在我们的应用中遇到想要使 ServiceCollection 不能再修改的时候就可以考虑使用这个 API 来避免误操作从而导致意外的 BUG。

在 .Net 8.0 的示例代码如下：

 public class Program
 {
     public static void Main(string[] args)
     {
         var builder = WebApplication.CreateBuilder(args);

         // Add services to the container.

         builder.Services.AddControllers();
         // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
         builder.Services.AddEndpointsApiExplorer();
         builder.Services.AddSwaggerGen();

         var app = builder.Build();

         //查询数据库真实数据的业务逻辑层服务注册
         builder.Services.AddTransient<ICommodityService, CommodityService>();
         builder.Services.AddTransient<ICompanyInfoService, CompanyInfoService>();

         //添加DbContext
         //builder.Services.AddDbContext<AdvancedCustomerDbContext>();
         builder.Services.AddTransient<DbContext, WebApi8DbContext>();

         //支持AutoMapper
         builder.Services.AddAutoMapper(options =>
         {
             options.AddProfile<AuotoMapConfig>();

         });

         // Configure the HTTP request pipeline.
         if (app.Environment.IsDevelopment())
         {
             app.UseSwagger();
             app.UseSwaggerUI();
         }

         app.UseAuthorization();

         app.MapControllers();

         app.Run();
     }
 }

编译运行异常如下：

看红框内的代码即可明白，在 var app = builder.Build();  之后，ServiceCollection 为只读不能再修改或注入新的服务接口，避免误操作从而导致意外的 BUG，将代码修改如下：

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);

        // Add services to the container.

        builder.Services.AddControllers();
        // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
        builder.Services.AddEndpointsApiExplorer();
        builder.Services.AddSwaggerGen();

        //查询数据库真实数据的业务逻辑层服务注册
        builder.Services.AddTransient<ICommodityService, CommodityService>();
        builder.Services.AddTransient<ICompanyInfoService, CompanyInfoService>();

        //添加DbContext
        //builder.Services.AddDbContext<AdvancedCustomerDbContext>();
        builder.Services.AddTransient<DbContext, WebApi8DbContext>();

        //支持AutoMapper
        builder.Services.AddAutoMapper(options =>
        {
            options.AddProfile<AuotoMapConfig>();

        });

        var app = builder.Build();

        // Configure the HTTP request pipeline.
        if (app.Environment.IsDevelopment())
        {
            app.UseSwagger();
            app.UseSwaggerUI();
        }

        app.UseAuthorization();

        app.MapControllers();

        app.Run();
    }
}

看过后，即上面绿色的代码应放在  var app = builder.Build(); 之前执行，避免出现： System.InvalidOperationException:“The service collection cannot be modified because it is read-only.”。 异常问题。