WCF反序列化带XmlEnumAttribute的枚举时如何设置默认值并返回验证消息

刚好之前处理过类似的WCF枚举反序列化问题，给你两个可行的方案，都能满足你「不修改WSDL、设置默认值、不同方法返回不同验证消息」的需求：

方案一：实体类代理属性处理（精确控制） #

这个方案通过给实体类加一个字符串代理属性，替代原来的枚举属性来处理序列化/反序列化，既能设置默认值，还能记录错误信息，方便后续在服务方法里返回定制化消息。

步骤1：修改实体类 #

把原来的anim枚举属性替换成「XmlIgnore的枚举属性 + 对外暴露的字符串代理属性」，同时加一个字段存验证错误：

[XmlType(Namespace = "http://rca.ws.emitere/2010-11/")]
public enum Animal {
    [System.Xml.Serialization.XmlEnumAttribute("Cat name")]
    Cat,
    [System.Xml.Serialization.XmlEnumAttribute("Dog name")]
    Dog
}

// 你的请求实体类
public class AnimalRequest
{
    [XmlIgnore]
    public Animal anim { get; set; }

    // 这个属性和原来的枚举属性名称、命名空间完全一致，保证WSDL不变
    [XmlElement(ElementName = "anim", Form = XmlSchemaForm.Unqualified)]
    public string animString
    {
        get
        {
            // 序列化时返回XmlEnum定义的别名
            var member = typeof(Animal).GetMember(anim.ToString())[0];
            var xmlEnumAttr = member.GetCustomAttribute<XmlEnumAttribute>();
            return xmlEnumAttr?.Name ?? anim.ToString();
        }
        set
        {
            bool isMatched = false;
            // 遍历枚举所有字段，匹配XmlEnum别名或枚举名称
            foreach (var field in typeof(Animal).GetFields(BindingFlags.Public | BindingFlags.Static))
            {
                var xmlEnumAttr = field.GetCustomAttribute<XmlEnumAttribute>();
                if ((xmlEnumAttr != null && xmlEnumAttr.Name.Equals(value, StringComparison.OrdinalIgnoreCase)) 
                    || field.Name.Equals(value, StringComparison.OrdinalIgnoreCase))
                {
                    anim = (Animal)field.GetValue(null);
                    isMatched = true;
                    break;
                }
            }

            // 无匹配项时设置默认值，并记录错误
            if (!isMatched)
            {
                anim = Animal.Cat; // 这里设置你想要的默认枚举值
                _validationError = $"无效的动物类型：{value}";
            }
        }
    }

    // 存储验证错误的私有字段，加个公共方法供服务方法调用
    private string _validationError;
    public string GetValidationError() => _validationError;
}

步骤2：服务方法里返回定制化消息 #

在每个服务方法里，先检查验证错误，根据方法逻辑返回不同的提示：

public class AnimalService : IAnimalService
{
    public string GetAnimalInfo(AnimalRequest request)
    {
        var error = request.GetValidationError();
        if (!string.IsNullOrEmpty(error))
        {
            // GetAnimalInfo方法专属的验证消息
            return $"获取动物信息失败：{error}，请输入「Cat name」或「Dog name」";
        }
        // 正常业务逻辑
        return $"当前动物类型：{request.anim}";
    }

    public string UpdateAnimal(AnimalRequest request)
    {
        var error = request.GetValidationError();
        if (!string.IsNullOrEmpty(error))
        {
            // UpdateAnimal方法专属的验证消息
            return $"更新动物数据失败：检测到非法类型值「{error.Split('：')[1]}」，请核对后重试";
        }
        // 正常业务逻辑
        return "动物数据更新成功";
    }
}

关键优势 #

• 完全不影响WSDL：代理属性的ElementName和原枚举属性一致，客户端感知不到任何变化
• 错误控制精准：只有枚举不匹配时才触发默认值和错误记录，不会干扰其他类型的反序列化
• 消息定制灵活：每个服务方法可以自由定义返回的验证文本

方案二：消息检查器拦截异常（无需修改实体） #

如果不想改动实体类，可以用WCF的消息处理管道，通过IDispatchMessageInspector拦截反序列化异常，根据当前调用的服务方法返回不同的错误消息。

步骤1：实现自定义消息检查器 #

这个检查器会在返回响应前，判断是否是枚举反序列化错误，然后根据操作名称替换成定制化消息：

public class EnumValidationInspector : IDispatchMessageInspector
{
    public object AfterReceiveRequest(ref Message request, IClientChannel channel, InstanceContext instanceContext)
    {
        return null; // 这里不需要处理请求，只关注响应
    }

    public void BeforeSendReply(ref Message reply, object correlationState)
    {
        // 判断是否是反序列化导致的错误消息
        if (reply.IsFault && reply.Properties.ContainsKey(FaultMessageProperty.Name))
        {
            var faultProp = reply.Properties[FaultMessageProperty.Name] as FaultMessageProperty;
            if (faultProp?.Exception.Message.Contains("枚举值") == true)
            {
                // 获取当前调用的服务方法名称
                var operationName = OperationContext.Current.IncomingMessageHeaders.Action.Split('/').Last();
                
                // 根据方法名称返回不同的验证消息
                string customMsg = operationName switch
                {
                    "GetAnimalInfo" => "获取动物信息时遇到无效类型，请输入合法的猫/狗类型标识",
                    "UpdateAnimal" => "更新动物数据失败：不支持的类型值，请检查输入参数",
                    _ => "请求参数验证失败：无效的动物类型"
                };

                // 创建新的错误消息替换原响应
                var newFault = Message.CreateMessage(reply.Version, new FaultCode("Client"), customMsg);
                reply = newFault;
            }
        }
    }
}

步骤2：注册消息检查器到服务行为 #

创建一个服务行为类，把检查器添加到所有端点的消息处理管道：

public class EnumValidationBehavior : IServiceBehavior
{
    public void AddBindingParameters(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase, Collection<ServiceEndpoint> endpoints, BindingParameterCollection bindingParameters)
    {
    }

    public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
    {
        foreach (var channelDispatcher in serviceHostBase.ChannelDispatchers.OfType<ChannelDispatcher>())
        {
            foreach (var endpointDispatcher in channelDispatcher.Endpoints)
            {
                endpointDispatcher.DispatchRuntime.MessageInspectors.Add(new EnumValidationInspector());
            }
        }
    }

    public void Validate(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
    {
    }
}

步骤3：在服务主机中添加行为 #

启动服务时，把自定义行为注册到服务主机：

var host = new ServiceHost(typeof(AnimalService));
// 添加枚举验证行为
host.Description.Behaviors.Add(new EnumValidationBehavior());
host.Open();

注意事项 #

• 异常判断依赖错误消息的关键词（比如“枚举值”），如果WCF的异常消息语言不同，需要调整判断逻辑
• 这种方式会拦截所有枚举反序列化错误，如果有多个枚举类型，可能需要更精确的过滤逻辑

内容的提问来源于stack exchange，提问作者Jarosław Gosławski