Azure DevOps Service Hook消息类型定义及反序列化类查询

获取强类型类定义的方法 #

• 从Azure DevOps Work Item结构映射：Service Hook推送的任务更新消息结构，和Azure DevOps REST API返回的Work Item/Work Item Update结构完全一致。核心类的字段可以直接对应，比如WorkItemUpdate包含id、revision、fields、url，还有外层的eventType、resource等节点，你可以根据API返回的结构手动定义类。
• Visual Studio自动生成类：先捕获一条消息，手动截取掉开头的Data Contract前缀（从第一个{到最后一个}的内容就是纯JSON），复制这段JSON到Visual Studio，新建类文件后右键选择「粘贴特殊」→「粘贴JSON为类」，就能自动生成匹配的强类型类。
• 用DataContractJsonSerializer直接处理带前缀的消息：不需要手动截前缀，直接用WCF的DataContractJsonSerializer反序列化。给类加上[DataContract]特性，字段加上[DataMember]特性，示例代码：

  [DataContract]
  public class DevOpsWorkItemHookMessage
  {
      [DataMember]
      public string eventType { get; set; }
      [DataMember]
      public WorkItemUpdate resource { get; set; }
      // 按需添加其他顶层字段，比如messageId、createdDate等
  }
  
  [DataContract]
  public class WorkItemUpdate
  {
      [DataMember]
      public int id { get; set; }
      [DataMember]
      public int revision { get; set; }
      [DataMember]
      public Dictionary<string, object> fields { get; set; }
      [DataMember]
      public string url { get; set; }
  }
  

  用这个序列化器读取整个消息流，就能自动解析带前缀的内容。

注意事项 #

• 不同事件类型（创建、修改、删除任务）的消息结构有细微差别，要根据实际触发的事件调整类定义。
• 验证JSON结构：先把截取后的纯JSON放到JSON校验工具里确认格式，再生成或调整类，确保字段名和JSON键完全匹配（Data Contract默认区分大小写）。

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