VS 2022中Web Service场景下[DataContract]与[DataMember]等效替代咨询

失效原因说明 #

VS2022默认新建的Web服务项目（如ASP.NET Core Web API）基于.NET Core/.NET 5+，而[DataContract]/[DataMember]属于传统WCF的序列化特性，默认未引入相关依赖；如果是升级旧的.NET Framework项目，可能是引用丢失或序列化配置被重置。

两种解决方案 #

方案1：继续使用原有特性（兼容旧代码） #

如果想保留原有代码结构，只需补充依赖并配置：

• 在NuGet包管理器中安装System.Runtime.Serialization.Json（JSON序列化）或System.Runtime.Serialization.Formatters（二进制/XML序列化）
• 若为ASP.NET Core项目，需在Program.cs中配置序列化器支持该特性：

  var builder = WebApplication.CreateBuilder(args);
  
  builder.Services.AddControllers()
      // 若用XML序列化，添加XML格式化器
      .AddXmlSerializerFormatters()
      // 若用JSON序列化，配置支持DataContract
      .AddJsonOptions(options =>
      {
          options.JsonSerializerOptions.Converters.Add(new DataContractJsonConverter());
      });
  

方案2：改用.NET Core原生序列化特性（推荐） #

.NET Core默认使用System.Text.Json作为序列化器，也可选择Newtonsoft.Json（Json.NET），对应替代特性如下：

基于System.Text.Json（默认）

代码示例：
原有代码：

[DataContract]
public class User
{
    [DataMember(Name = "user_id")]
    public int Id { get; set; }

    [DataMember(IsRequired = true)]
    public string Name { get; set; }

    // 不序列化
    public string Password { get; set; }
}

替代代码：

public class User
{
    [JsonPropertyName("user_id")]
    public int Id { get; set; }

    [JsonPropertyName("name")]
    [Required]
    public string Name { get; set; }

    [JsonIgnore]
    public string Password { get; set; }
}

基于Newtonsoft.Json（Json.NET）

若项目依赖Newtonsoft.Json，可使用以下对应特性：

代码示例：

[JsonObject(MemberSerialization.OptIn)]
public class User
{
    [JsonProperty("user_id")]
    public int Id { get; set; }

    [JsonProperty("name", Required = Required.Always)]
    public string Name { get; set; }

    // 不序列化
    public string Password { get; set; }
}

内容的提问来源于stack exchange，提问作者Mohsen Azizi