ASP.NET 5 API中返回Server实体IP与Port字段的问题求助

问题根因 #

你的 Ip 和 Port 属性使用了 private set 私有 setter，ASP.NET 5 默认使用的 System.Text.Json 序列化器默认不会序列化带有私有 setter 的属性，因此接口返回时会丢失这两个字段的值。

可选解决方案 #

方案1：给私有 setter 属性加序列化标记（对现有代码改动最小） #

在 Server 实体类中引入 System.Text.Json.Serialization 命名空间，给带私有 setter 的属性添加 [JsonInclude] 标记即可，保留属性私有赋值权限的同时允许序列化读取值：

using System.Text.Json.Serialization;

public class Server
{
    [JsonInclude]
    public Guid ServerId { get; private set; }
    public string Name { get; set; }
    [JsonInclude]
    public string Ip { get; private set; }
    [JsonInclude]
    public int Port { get; private set; }
}

方案2：全局配置序列化规则允许序列化私有成员 #

如果需要全局生效所有类似的私有 setter 属性，可以在 Program.cs 中配置 JSON 序列化选项：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 允许序列化私有成员
        options.JsonSerializerOptions.IncludeFields = true;
        // .NET 7及以上版本可以直接使用该配置
        // options.JsonSerializerOptions.IncludePrivateMembers = true;
    });

// 其余服务注册、中间件配置省略

方案3：使用DTO传输对象（生产级规范方案） #

建议不要直接返回数据库实体给前端，单独定义返回用的DTO类，所有属性设为公共可访问，再通过手动映射或AutoMapper把实体值赋值给DTO返回，可完全隔离内部实体结构和对外接口结构：

1. 定义返回用的ServerDTO

public class ServerDTO
{
    public Guid ServerId { get; set; }
    public string Name { get; set; }
    public string Ip { get; set; }
    public int Port { get; set; }
}

2. 修改Controller返回逻辑，以GetServer接口为例：

[HttpGet("{id}")]
public async Task<ActionResult<ServerDTO>> GetServer(Guid id)
{
    var server = await _context.Servers.FindAsync(id);
    if (server == null)
    {
        return NotFound();
    }
    // 手动映射实体到DTO
    return new ServerDTO
    {
        ServerId = server.ServerId,
        Name = server.Name,
        Ip = server.Ip,
        Port = server.Port
    };
}

额外注意点 #

如果 Ip 和 Port 需要在创建Server时由客户端传入，当前的private set会导致Post接口无法绑定客户端传递的这两个值，你可以给Server类添加构造函数接收参数赋值：

public class Server
{
    public Server(Guid serverId, string ip, int port)
    {
        ServerId = serverId;
        Ip = ip;
        Port = port;
    }
    // 其余属性定义省略
}

如果不需要客户端传入，也请确保业务代码执行时确实给这两个字段赋值且成功写入了数据库。

内容的提问来源于stack exchange，提问作者Matheus Reis