如何在ASP.NET Web API 2中修改XML序列化与空值输出格式？

1. 修正实体类定义 #

先统一实体类命名（你代码里同时出现Draft和TestClass，这里统一为Draft），并通过XML序列化属性控制节点顺序和空值处理：

public class Draft
{
    [XmlElement(Order = 1)]
    public int UserId { get; set; }

    [XmlElement(Order = 2)]
    public string Name { get; set; }

    [XmlElement(Order = 3)]
    public string Mobile { get; set; }

    [XmlElement(Order = 4)]
    public int Access { get; set; }

    [XmlElement(ElementName = "DateTime", Order = 5)]
    public string DateTimeString { get; set; }

    // 用于数据库映射的可空日期属性，不参与XML序列化
    [XmlIgnore]
    public DateTime? Date { get; set; }
}

2. 修正数据读取逻辑 #

调整数据库读取代码，正确处理空值并给序列化用的字符串属性赋值：

public List<Draft> Get()
{
    List<Draft> list = new List<Draft>();
    string mainconn = ConfigurationManager.ConnectionStrings["Myconnection"].ConnectionString;
    
    using (SqlConnection sqlconn = new SqlConnection(mainconn))
    {
        string sqlquery = "Select UserID, Name, Mobile, Access, Date From tblTest";
        SqlCommand sqlcomm = new SqlCommand(sqlquery, sqlconn);
        sqlconn.Open();
        
        using (SqlDataReader er = sqlcomm.ExecuteReader())
        {
            while (er.Read())
            {
                var draft = new Draft();
                
                draft.UserId = Convert.ToInt32(er.GetValue(0));
                draft.Name = er.IsDBNull(1) ? string.Empty : er.GetString(1);
                draft.Mobile = er.IsDBNull(2) ? string.Empty : er.GetString(2);
                draft.Access = er.IsDBNull(3) ? 0 : Convert.ToInt32(er.GetValue(3));
                
                // 处理日期空值，转为"null"字符串
                if (!er.IsDBNull(4))
                {
                    draft.Date = Convert.ToDateTime(er.GetValue(4));
                    draft.DateTimeString = draft.Date.Value.ToString("yyyy-MM-ddTHH:mm:ss");
                }
                else
                {
                    draft.DateTimeString = "null";
                }
                
                list.Add(draft);
            }
        }
    }
    
    return list;
}

注意：

• 使用using语句自动释放数据库连接和DataReader，避免资源泄漏
• 用er.IsDBNull(index)判断空值，比直接取值更高效
• 字符串类型空值时赋值string.Empty，确保XML输出空标签而非缺失标签

3. 配置Web API使用XmlSerializer #

ASP.NET Web API默认用DataContractSerializer，切换为XmlSerializer以实现自定义格式。在App_Start/WebApiConfig.cs中添加配置：

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // 其他路由/过滤器配置...
        
        // 替换默认序列化器为XmlSerializer
        config.Formatters.XmlFormatter.UseXmlSerializer = true;
        
        // 配置空值处理：确保空字符串输出空标签
        config.Formatters.XmlFormatter.XmlSerializerSettings = new XmlSerializerSettings
        {
            NullValueHandling = NullValueHandling.Include
        };
    }
}

4. 最终效果验证 #

调整后XML响应会完全符合你的期望：

• 节点顺序按照UserId→Name→Mobile→Access→DateTime排列
• 空的Mobile输出<Mobile></Mobile>
• 空日期输出<DateTime>null</DateTime>

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