ABP微服务架构中网关层NullReferenceException问题解析与HTTP配置优化

ABP微服务架构中网关层NullReferenceException问题解析与HTTP配置优化

一、网关层System.NullReferenceException问题解析

1.1 问题现象与原因分析

在ABP微服务架构开发过程中，网关层启动后调用微服务接口时出现以下异常：

System.NullReferenceException: Object reference not set to an instance of an object.

异常堆栈指向网关层控制器中的某一行代码，通常是在调用微服务接口的位置。进一步分析发现，该异常是由于网关层控制器中依赖的服务接口实例为null导致的。

1.2 关键代码场景

public class ProdcutController : AbpController, IProductService
{
    public IProductService ProductService { get; set; } // 属性注入，实例为null
    
    [HttpGet]
    public async Task<PagedResultDto<ProductDto>> GetListAsync(
        [FromQuery] PagedAndSortedResultRequestDto pagedAndSortedResultRequestDto)
    {
        return await ProductService.GetListAsync(pagedAndSortedResultRequestDto); // 此处引发异常
    }
}

1.3 为什么注释app.UseConfiguredEndpoints()可以解决问题

在ABP框架中，app.UseConfiguredEndpoints(); 方法用于注册和启用应用程序的路由系统，包括控制器路由的注册和依赖注入容器的初始化。当注释掉该方法后：

1. 路由系统未启用：网关层的控制器不会被注册到路由系统中，请求不再由网关层的控制器处理
2. Ocelot直接代理请求：请求被Ocelot直接捕获并转发到微服务，绕过了网关层的控制器
3. 依赖注入问题被绕过：由于网关层控制器不再处理请求，依赖注入失败导致的空引用异常不再触发

// 原启动配置
app.UseConfiguredEndpoints(); // 启用路由系统，会触发控制器依赖注入检查
app.UseOcelot().Wait(); // 启用Ocelot代理

// 修改后配置（注释掉UseConfiguredEndpoints）
// app.UseConfiguredEndpoints(); // 注释掉，不启用网关层路由系统
app.UseOcelot().Wait(); // Ocelot直接处理所有请求

1.4 本质原因与隐患

这种解决方案本质上是绕过了问题而非解决了问题，存在以下隐患：

1. 网关层的自定义控制器功能失效
2. 网关层的中间件和过滤器不再对请求生效
3. 无法利用ABP框架的依赖注入和控制器特性

正确的解决方案应该是修复依赖注入配置，而不是绕过路由系统。

二、ABP微服务架构中HTTPS转HTTP配置指南

2.1 为什么需要将HTTPS改为HTTP

在开发环境中，HTTPS配置可能会遇到以下问题：

1. 证书配置复杂，需要信任开发证书
2. 本地调试时HTTPS可能引发连接问题
3. 微服务间通信使用HTTP更便捷

2.2 网关层Ocelot配置修改

2.2.1 修改Ocelot配置文件

找到网关层的ocelot.json配置文件，将所有DownstreamScheme从https改为http，并调整端口：

{
  "Routes": [
    {
      "UpstreamPathTemplate": "/api/productservice/{everything}",
      "DownstreamPathTemplate": "/api/productservice/{everything}",
      "DownstreamScheme": "http", // 关键修改：从https改为http
      "DownstreamHostAndPorts": [
        {
          "Host": "localhost",
          "Port": 50383 // 改为HTTP端口，与微服务的HTTP端口一致
        }
      ],
      // 其他配置保持不变...
    }
  ],
  "GlobalConfiguration": {
    "BaseUrl": "http://localhost:44376" // 改为http
  }
}

2.2.2 修改网关层启动配置

在网关层的Program.cs或Startup.cs中，修改Kestrel配置为HTTP：

builder.WebHost.UseKestrel(options =>
{
    options.ListenAnyIP(44376, listenOptions =>
    {
        listenOptions.UseHttp(); // 关键修改：使用HTTP
    });
});

2.3 微服务层配置修改

2.3.1 修改微服务launchSettings.json

找到微服务的Properties/launchSettings.json，修改端口为HTTP：

{
  "iisSettings": {
    "iisExpress": {
      "applicationUrl": "http://localhost:50383", // 改为http
      "sslPort": 0 // 移除HTTPS端口配置
    }
  },
  "profiles": {
    "ProductService": {
      "commandName": "Project",
      "launchBrowser": true,
      "applicationUrl": "http://localhost:50383", // 改为http
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

2.3.2 修改微服务Kestrel配置

在微服务的Program.cs中，修改Kestrel配置为HTTP：

builder.WebHost.UseKestrel(options =>
{
    options.ListenAnyIP(50383, listenOptions =>
    {
        listenOptions.UseHttp(); // 关键修改：使用HTTP
    });
});

2.3.3 修改微服务appsettings.json

将微服务的appsettings.json中的SelfUrl改为HTTP：

{
  "App": {
    "SelfUrl": "http://localhost:50383", // 改为http
    "ClientUrl": "http://localhost:4200",
    "CorsOrigins": "http://*.ProductService.com,http://localhost:4200"
  },
  // 其他配置保持不变...
}

2.4 认证与授权配置调整

如果使用了认证授权服务，需要修改相关配置为HTTP：

// 网关层appsettings.json
{
  "AuthServer": {
    "Authority": "http://localhost:50399", // 改为http和认证服务的HTTP端口
    "RequireHttpsMetadata": false,
    "SwaggerClientId": "WebSite_Gateway_Swagger"
  },
  // 其他配置保持不变...
}

2.5 验证HTTP配置

1. 启动微服务，确认控制台输出为HTTP端口：

Now listening on: http://localhost:50383
Application started.

2. 使用Postman测试微服务接口：

http://localhost:50383/api/productservice/product

3. 测试网关转发：

http://localhost:44376/api/productservice/product

三、网关层依赖注入问题的正确解决方案

虽然注释app.UseConfiguredEndpoints();可以暂时解决空引用异常，但这不是正确的解决方案。正确的做法是修复依赖注入配置：

3.1 使用构造函数注入

public class ProductController : AbpController
{
    private readonly IProductService _productService;
    
    // 构造函数注入确保服务实例被正确初始化
    public ProductController(IProductService productService)
    {
        _productService = productService;
    }
    
    [HttpGet]
    public async Task<PagedResultDto<ProductDto>> GetListAsync(
        [FromQuery] PagedAndSortedResultRequestDto pagedAndSortedResultRequestDto)
    {
        return await _productService.GetListAsync(pagedAndSortedResultRequestDto);
    }
}

3.2 注册服务到依赖注入容器

在网关层模块中注册远程服务代理：

public override void ConfigureServices(ServiceConfigurationContext context)
{
    // 注册远程服务代理
    context.Services.AddProxy<ProductService.Contracts.IProductService>(
        remoteServiceName: "ProductService",
        proxyUrl: "http://localhost:50383"
    );
}

3.3 启用路由系统

恢复app.UseConfiguredEndpoints();并确保其在Ocelot之前调用：

app.UseRouting();
app.UseConfiguredEndpoints(); // 启用路由系统
app.UseOcelot().Wait(); // 启用Ocelot代理

四、总结与最佳实践

4.1 问题解决思路总结

1. System.NullReferenceException在网关层通常是由于依赖注入失败导致的，注释app.UseConfiguredEndpoints();只是绕过了问题，而非解决问题
2. 将HTTPS改为HTTP可以简化开发环境的配置，但生产环境应使用HTTPS保证安全
3. 正确的解决方案是修复依赖注入配置，使用构造函数注入并正确注册服务

4.2 开发环境最佳实践

1. 依赖注入：始终使用构造函数注入，避免属性注入
2. 路由配置：正确配置网关层和微服务的路由，确保请求正确转发
3. HTTPS/HTTP：开发环境可使用HTTP简化配置，生产环境必须使用HTTPS
4. 日志记录：启用详细日志，便于问题排查
5. 异常处理：添加全局异常处理，避免应用崩溃

仅供参考