服务器之家：专注于服务器技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|JAVA教程|ASP教程|

服务器之家 - 编程语言 - ASP.NET教程 - .net webapi接收xml格式数据的3种情况小结

.net webapi接收xml格式数据的3种情况小结

2020-06-08 15:09野菊花 ASP.NET教程

这篇文章主要给大家总结介绍了关于.net webapi接收xml格式数据的3种情况，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧

前言

ASP.NET Web API是​​一个框架，可以很容易构建达成了广泛的HTTP服务客户端，包括浏览器和移动设备。是构建RESTful应用程序的理想平台的.NET框架。

本文主要给大家介绍了关于.net webapi接收xml格式数据的相关内容，下面话不多说了，来一起看看详细的介绍吧

webapi 接收 xml 的三种方法

前段时间接到一个任务写一个小接口，要接收java端返回过来的短信xml数据。

刚拿到项目，我的第一想法是对方会以什么形式发送xml格式的数据给我呢，设想三种情况。

我一开始拿到手上的是一串xml格式字符串。如下

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<?xml version="1.0" encoding="utf-8"?>
<returnForm>
 <type>2</type>
 <count>1</count>
 <list>
 <pushSmsForm>
  <eprId>0</eprId>
  <mobile>13560739262</mobile>
  <msgId>30217002</msgId>
  <content> <![CDATA[回复内容]]> </content>
  <userId>id</userId>
  <extNum>扩展号</extNum>
  <recvNum/>
 </pushSmsForm>
 <pushSmsForm>
  <eprId>0</eprId>
  <mobile>13560739261</mobile>
  <msgId>30217001</msgId>
  <content> <![CDATA[回复内容]]> </content>
  <userId>id</userId>
  <extNum>扩展号</extNum>
  <recvNum/>
 </pushSmsForm>
 </list>
</returnForm>

思路

这个xml的基本知识我就不一一介绍了，简单说一下<![CDATA[ ]]>标志，里面的内容是没有限制的(除了< 和 >)。继续讲思路，文档中只说了是post方法，所以我想到了三种可能：

  1. 对方通过form表单提交了一个xml文件，我需要用文件流（filestream）读取文件，并进行转化为实体类
  2. 对方通过post了一个字符串过来，我接收字符串并转化为实体类。
  3. 对方直接在请求里添加了xml字符串（text/xml）

先构建两个xml反序列化的帮助类

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/// <summary>
/// 反序列化
/// </summary>
/// <param name="type">类型</param>
/// <param name="xml">XML字符串</param>
/// <returns></returns>
public static object Deserialize(Type type, string xml)
{
 using (StringReader sr = new StringReader(xml))
 {
  XmlSerializer xmldes = new XmlSerializer(type);
  return xmldes.Deserialize(sr);
 }
}
 
/// <summary>
/// 反序列化
/// </summary>
/// <param name="type"></param>
/// <param name="xml"></param>
/// <returns></returns>
 
public static object Deserialize(Type type, Stream stream)
{
 XmlSerializer xmldes = new XmlSerializer(type);
 return xmldes.Deserialize(stream);
}

利用visual studio自带的功能xml生成类（编辑-->选择性粘贴-->paste xml as classes）

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
[System.SerializableAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)]
public partial class returnFormPushSmsForm
{
 private int eprIdField;
 private string mobileField;
 private string msgIdField;
 private string contentField;
 private string userIdField;
 private string extNumField;
 private string recvNumField;
 
 /// <remarks/>
 public int eprId
 {
  get
  {
   return this.eprIdField;
  }
  set
  {
   this.eprIdField = value;
  }
 }
 
 
 
 /// <remarks/>
 public string mobile
 {
  get
  {
   return this.mobileField;
  }
  set
  {
   this.mobileField = value;
  }
 }
 
 
 
 /// <remarks/>
 public string msgId
 {
  get
  {
   return this.msgIdField;
  }
  set
  {
   this.msgIdField = value;
  }
 }
 
 
 
 /// <remarks/>
 public string content
 {
  get
  {
   return this.contentField;
  }
  set
  {
   this.contentField = value;
  }
 }
 
 /// <remarks/>
 public string userId
 {
  get
  {
   return this.userIdField;
  }
  set
  {
   this.userIdField = value;
  }
 }
 
 /// <remarks/>
 public string extNum
 {
  get
  {
   return this.extNumField;
  }
  set
  {
   this.extNumField = value;
  }
 }
 
 /// <remarks/>
 public string recvNum
 {
  get
  {
   return this.recvNumField;
  }
  set
  {
   this.recvNumField = value;
  }
 }
}

生成类之后注意一下数据类型需要根据需求做一些修改

接下来就开始写第一个接口，最简单的直接接收字符串

?
1
2
3
4
5
6
7
8
9
10
11
12
13
  [HttpPost, Route("get/context")]
  public int getContext(context_ context)
  {
   bool result = false;
   //短信数据
   returnForm context_data =
XmlSerializeUtil.Deserialize(typeof(returnForm), context.context) as returnForm;
   if (context_data != null && context_data.count > 0)
   {
    result = UpdateDB(context_data);
   }
   return result ? 100 : 500;
  }

这里我定义了一个类context_，调用之前写的方法反序列化实体类，再写入数据库

第二个接口时接收请求中的xml（text/xml）

?
1
2
3
4
5
6
7
8
9
10
11
12
13
  [HttpPost, Route("get/context")]
  public int getContext(context_ context)
  {
   bool result = false;
   //短信数据
   returnForm context_data = XmlSerializeUtil.Deserialize(typeof(returnForm),
HttpContext.Current.Request.InputStream) as returnForm;
   if (context_data != null && context_data.count > 0)
   {
    result = UpdateDB(context_data);
   }
   return result ? 100 : 500;
  }

这里读取了请求中的内容，HttpContext.Current.Request.InputStream

第三种是读取文件

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
  [HttpPost, Route("get/context")]
  public int getContext(context_ context)
  {
   bool result = false;
   HttpFileCollection files = HttpContext.Current.Request.Files;
   foreach (string key in files.AllKeys)
   {
    HttpPostedFile file1 = files[key];
    file1.InputStream.ToString();
    returnForm context_data =
XmlSerializeUtil.Deserialize(typeof(returnForm), file1.InputStream) as returnForm;
    if (context_data != null && context_data.count > 0)
    {
     result = UpdateDB(context_data);
    }
   }
   return result ? 100 : 500;
  }

遍历文件内容，获取数据

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对服务器之家的支持。

原文链接：http://www.cnblogs.com/Jackyye/p/10374507.html

  • XML
  • .NET
  • 接收
  • WebAPI

    • 延伸 · 阅读

    精彩推荐
    最近更新
    编辑推荐
    阅读排行
    热门标签
    MacAddress 　 循环顺序播放 　 编译不通过 　 connectionStrings 　 Linkbutton 　 App.config 　 逆变 　 System.IO 　 XSLT 　 XmlSerializer 　 表头 　 MD.DLL 　 wsdl.exe 　 RowUpdating 　 层次结构数据 　 BitmapImage 　 图片删除 　 Delegate 　 内部原理 　 自动跳转页面 　 UdpClient 　 子对象 　 STAThread 　 循环处理数据 　 Lumisoft.NET 　 CommandField 　 ASPX文件怎么打开 　 aspx文件 　 aspx是什么文件 　 aspx是什么格式 　
    © 2019-2020 服务器之家 版权所有 www.zzvips.com 关于我们联系我们版权申明网站地图