devbox
weixin_40725706
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Unity C# 之 使用 HttpWebRequest 基础知识/HttpWebRequest 进行异步Post 网络访问/数据流形式获取数据(Task/async/await)的代码简单实现_unitywebrequest 异步

作者：weixin_40725706 | 2024-06-23 02:16:41

赞

踩

unitywebrequest 异步

Unity C# 之 使用 HttpWebRequest 基础知识/HttpWebRequest 进行异步Post 网络访问/数据流形式获取数据(Task/async/await)的代码简单实现

目录

Unity C# 之 使用 HttpWebRequest 基础知识/HttpWebRequest 进行异步Post 网络访问/数据流形式获取数据(Task/async/await)的代码简单实现

一、简单介绍

二、实现原理

三、注意事项

四、效果预览

五、关键代码

附录 ： HttpWebRequest 的一些基础知识

1、HttpWebRequest 常用属性

2、HttpWebRequest  中的 ContentType

3、HttpWebRequest 一般使用示例

4、HttpWebRequest  json 文本 Post 请求示例

5、 HttpWebRequest   multipart/form-data 文件上传示例

一、简单介绍

Unity 在开发中，网络访问：

  • 可以使用 UnityWebRequest 访问，不过好似只能用协程的方式，并且访问只能在主线程中；
  • 所以这里使用 C# 中的 HttpWebRequest，进行网络访问，而且 HttpWebRequest，允许在子线程中访问，在一些情况下可以大大减少主线程的网络访问压力； 

这里使用 HttpWebRequest ，进行 Post 访问，并且Task 结合 async （await） 的进行异步访问，最后使用 Stream 流式的形式获取数据，在这里做一个简单的记录，以便后期使用的时候参考。

二、实现原理

1、HttpWebRequest 创建 post 的请求

2、GetRequestStreamAsync 发起 异步请求

3、GetResponseAsync 和 GetResponseStream 异步获取响应数据流

4、因为使用到异步，所以 async Task<string> 返回异步获取的流数据

三、注意事项

1、获取更新的流数据打印是，注意 每次更新下 buffer ，不然输出打印的结果可能不是预期的

  1.     // 循环获取流式数据
  2.     while ((bytesRead = await reader.ReadAsync(buffer, 0, buffer.Length)) > 0)
  3.     {
  4.          sb.Append(buffer, 0, bytesRead);
  5.          Console.WriteLine(buffer);
  6.          buffer = new char[1024];
  7.      }

四、效果预览

五、关键代码

  1. using System;
  2. using System.Net;
  3. using System.Text;
  4.  
  5. namespace TestHttpWebRequestPostStream
  6. {
  7.     internal class Program
  8.     {
  9.         static string m_Authorization = "Your_Authorization";
  10.         static int TIMEOUT_TIME = 10000; // 超时时间
  11.  
  12.         static async Task Main(string[] args)
  13.         {
  14.             string url = "Your_STREAM_URL";
  15.             string postData = "Your_POST_DATA";
  16.             
  17.             string content = await PostRequestStreamToStringAsync(url, postData);
  18.  
  19.             Console.WriteLine("Response content:");
  20.             Console.WriteLine(content);
  21.         }
  22.  
  23.         static async Task<string> PostRequestStreamToStringAsync(string url, string postData)
  24.         {
  25.             try
  26.             {
  27.                 HttpWebRequest request = WebRequest.Create(url) as HttpWebRequest;
  28.  
  29.                 request.ReadWriteTimeout = TIMEOUT_TIME;
  30.                 request.Timeout = TIMEOUT_TIME;
  31.                 request.Method = "POST";
  32.                 request.ContentType = "application/json"; // 根据需要设定
  33.                 request.Headers.Add("user-token", "xxxxxxxx");    // 根据需要设定
  34.                 request.Headers.Add("xxxx-authorization", m_Authorization); // 根据需要设定
  35.  
  36.                 //流式发起请求
  37.                 using (Stream requestStream = await request.GetRequestStreamAsync())
  38.                 {
  39.                     byte[] dataBytes = Encoding.UTF8.GetBytes(postData);
  40.                     await requestStream.WriteAsync(dataBytes, 0, dataBytes.Length);
  41.                 }
  42.  
  43.                 // 流式获取数据响应
  44.                 using (HttpWebResponse response = (HttpWebResponse)await request.GetResponseAsync())
  45.                 using (Stream responseStream = response.GetResponseStream())
  46.                 using (StreamReader reader = new StreamReader(responseStream))
  47.                 {
  48.                     StringBuilder sb = new StringBuilder();
  49.                     char[] buffer = new char[1024];
  50.                     int bytesRead;
  51.  
  52.                     // 循环获取流式数据
  53.                     while ((bytesRead = await reader.ReadAsync(buffer, 0, buffer.Length)) > 0)
  54.                     {
  55.                         sb.Append(buffer, 0, bytesRead);
  56.                         Console.WriteLine(buffer);
  57.                         buffer = new char[1024];
  58.                     }
  59.  
  60.                     return sb.ToString();
  61.                 }
  62.             }
  63.             catch (Exception e)
  64.             {
  65.  
  66.                 return e.Message;
  67.             }
  68.             
  69.         }
  70.     }
  71. }

附录 ： HttpWebRequest 的一些基础知识

1、HttpWebRequest 常用属性

  • AllowAutoRedirect：获取或设置一个值，该值指示请求是否应跟随重定向响应。
  • CookieContainer：获取或设置与此请求关联的cookie。
  • Credentials：获取或设置请求的身份验证信息。
  • KeepAlive：获取或设置一个值，该值指示是否与 Internet 资源建立持久性连接。
  • MaximumAutomaticRedirections：获取或设置请求将跟随的重定向的最大数目。
  • Proxy：获取或设置请求的代理信息。
  • SendChunked：获取或设置一个值，该值指示是否将数据分段发送到 Internet 资源。
  • Timeout：获取或设置请求的超时值。
  • UserAgent：获取或设置 User-agent HTTP 标头的值
  • ContentType：Http内容类型
  • Headers：指定组成 HTTP 标头的名称/值对的集合。
     

2、HttpWebRequest  中的 ContentType

  • 普通文本: “text/plain”
  • JSON字符串: “application/json”
  • 数据流类型(文件流): “application/octet-stream”
  • 表单数据(键值对): “application/x-www-form-urlencoded”
  • 多分部数据: “multipart/form-data”
     

3、HttpWebRequest 一般使用示例

  1. //创建HttpWeb请求
  2. HttpWebRequest request = (HttpWebRequest)WebRequest.Create (url);
  3. //创建HttpWeb相应
  4. HttpWebResponse response = (HttpWebResponse)request.GetResponse ();
  5.  
  6. Console.WriteLine ("Content length is {0}", response.ContentLength);
  7. Console.WriteLine ("Content type is {0}", response.ContentType);
  8.  
  9. //获取response的流
  10. Stream receiveStream = response.GetResponseStream ();
  11.  
  12. //使用streamReader读取流数据
  13. StreamReader readStream = new StreamReader (receiveStream, Encoding.UTF8);
  14.  
  15. Console.WriteLine ("Response stream received.");
  16. Console.WriteLine (readStream.ReadToEnd ());
  17. response.Close ();
  18. readStream.Close ();

4、HttpWebRequest  json 文本 Post 请求示例

使用application/json作为请求头，用来告诉服务端消息主体是序列化的JSON字符串。

  1. /*
  2. *  url:POST请求地址
  3. *  postData:json格式的请求报文,例如：{"key1":"value1","key2":"value2"}
  4. */
  5. public static string PostUrl(string url, string postData)
  6. {
  7.     HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url);
  8.     req.Method = "POST";
  9.     req.TimeOut = "800";//设置请求超时时间，单位为毫秒
  10.     req.ContentType = "application/json";
  11.     byte[] data = Encoding.UTF8.GetBytes(postData);
  12.     req.ContentLength = data.Length;
  13.  
  14.     using (Stream reqStream = req.GetRequestStream())
  15.     {
  16.         reqStream.Write(data, 0, data.Length);
  17.         reqStream.Close();
  18.     }
  19.  
  20.     HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
  21.     Stream stream = resp.GetResponseStream();
  22.  
  23.     //获取响应内容
  24.     string result = "";
  25.     using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
  26.     {
  27.         result = reader.ReadToEnd();
  28.     }
  29.     return result;
  30. }

5、 HttpWebRequest   multipart/form-data 文件上传示例

使用multipart/form-data作为请求头，用来告诉服务器消息主体是 多发文件 格式

multipart/form-data格式使用一长串字符作为boundtry封装线对字段进行分割。这也很符合multipart多个部分的语义，包含了多个部分集，每一部分都包含了一个content-desposition头，其值为form-data,以及一个name属性，其值为表单的字段名，文件输入框还可以使用filename参数指定文件名。content-type非必须属性，其值会根据文件类型进行变化，默认值是text/plain。multipart的每一个part上方是边界线，最后一个part的下方添加一个边界线。

  1. /// <summary>
  2. /// 上传文件请求
  3. /// </summary>
  4. /// <param name="url">Url</param>
  5. /// <param name="filePath">文件路径</param>
  6. /// <param name="formDatas">表单数据（字典格式）</param>
  7. /// <param name="callback">上传回调</param>
  8. public static void UploadRequest(string url, string filePath, Dictionary<string,string> formDatas, Action<string> callback)
  9. {
  10.     // 时间戳，用做boundary
  11.     string timeStamp = DateTime.Now.Ticks.ToString("x");
  12.  
  13.     //根据uri创建HttpWebRequest对象
  14.     HttpWebRequest httpReq = (HttpWebRequest) WebRequest.Create(new Uri(url));
  15.     httpReq.Method = "POST";
  16.     httpReq.AllowWriteStreamBuffering = false; //对发送的数据不使用缓存
  17.     httpReq.Timeout = 300000; //设置获得响应的超时时间（300秒）
  18.     httpReq.ContentType = "multipart/form-data; boundary=" + timeStamp;
  19.  
  20.     //读取file文件
  21.     FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read);
  22.     BinaryReader binaryReader = new BinaryReader(fileStream);
  23.     
  24.     //表单信息
  25.     string boundary = "--" + timeStamp;
  26.     string form = "";
  27.     string formFormat = boundary + "\r\nContent-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}\r\n";
  28.     string formEnd = boundary + "\r\nContent-Disposition: form-data; name=\"{0}\"; filename=\"{1}\";\r\nContent-Type:application/octet-stream\r\n\r\n";
  29.     foreach (var pair in formDatas)
  30.     {
  31.         form += string.Format(formFormat, pair.Key, pair.Value);
  32.     }
  33.     form += string.Format(formEnd,"file", Path.GetFileName(filePath));
  34.     byte[] postHeaderBytes = Encoding.UTF8.GetBytes(form);
  35.  
  36.     //结束边界
  37.     byte[] boundaryBytes = Encoding.ASCII.GetBytes("\r\n--" + timeStamp + "--\r\n");
  38.     long length = fileStream.Length + postHeaderBytes.Length + boundaryBytes.Length;
  39.     httpReq.ContentLength = length; //请求内容长度
  40.  
  41.     try
  42.     {
  43.         //每次上传4k
  44.         int bufferLength = 4096;
  45.         byte[] buffer = new byte[bufferLength];
  46.  
  47.         //已上传的字节数
  48.         long offset = 0;
  49.         int size = binaryReader.Read(buffer, 0, bufferLength);
  50.         Stream postStream = httpReq.GetRequestStream();
  51.  
  52.         //发送请求头部消息
  53.         postStream.Write(postHeaderBytes, 0, postHeaderBytes.Length);
  54.  
  55.         while (size > 0)
  56.         {
  57.             postStream.Write(buffer, 0, size);
  58.             offset += size;
  59.             size = binaryReader.Read(buffer, 0, bufferLength);
  60.         }
  61.  
  62.         //添加尾部边界
  63.         postStream.Write(boundaryBytes, 0, boundaryBytes.Length);
  64.         postStream.Close();
  65.  
  66.         //获取服务器端的响应
  67.         using (HttpWebResponse response = (HttpWebResponse) httpReq.GetResponse())
  68.         {
  69.             Stream receiveStream = response.GetResponseStream();
  70.             StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
  71.             string returnValue = readStream.ReadToEnd();
  72.             Debug.Log("upload result:"+returnValue);
  73.             callback?.Invoke(returnValue);
  74.             
  75.             response.Close();
  76.             readStream.Close();
  77.         }
  78.     }
  79.     catch (Exception ex)
  80.     {
  81.         Debug.Log("文件传输异常： " + ex.Message);
  82.     }
  83.     finally
  84.     {
  85.         fileStream.Close();
  86.         binaryReader.Close();
  87.     }
  88. }

Unity 上的简单的异步封装使用

1、HttpWebRequest 异步 Post 获取数据

  1. using System;
  2. using System.IO;
  3. using System.Net;
  4. using System.Text;
  5. using System.Threading.Tasks;
  6. using UnityEngine;
  7.  
  8. public class GptNormalWrapper : Singleton<GptNormalWrapper>, IGptHttpWebRequestWrapper
  9. {
  10.     const string GPT_URL = "Your_URL";
  11.     const string AUTHORIZATION = "Your_AUTHORIZATION";
  12.     const string USER_TOKEN = "123456";
  13.     const int TIMEOUT_TIME = 10000; // 超时时间
  14.  
  15.     public string GptUrl => GPT_URL;
  16.  
  17.     public async Task<string> PostRequestToStringAsync(string postData) {
  18.  
  19.         return await PostRequestToStringAsync(GptUrl, postData);
  20.     }
  21.  
  22.     public async Task<string> PostRequestToStringAsync(string url, string postData)
  23.     {
  24.         try
  25.         {
  26.  
  27.             HttpWebRequest request = WebRequest.Create(url) as HttpWebRequest;
  28.  
  29.             request.ReadWriteTimeout = TIMEOUT_TIME;
  30.             request.Timeout = TIMEOUT_TIME;
  31.             request.Method = "POST";
  32.             request.ContentType = "application/json";
  33.             request.Headers.Add("user-token", USER_TOKEN);
  34.             request.Headers.Add("xxx-authorization", AUTHORIZATION);
  35.  
  36.             Debug.Log("[GptNormalWrapper] PostRequestToStringAsync msg = " + postData);
  37.  
  38.             byte[] jsonBytes = Encoding.UTF8.GetBytes(postData);
  39.             request.ContentLength = jsonBytes.Length;
  40.             Stream strStream = request.GetRequestStream();
  41.             strStream.Write(jsonBytes, 0, jsonBytes.Length);
  42.             strStream.Close();
  43.  
  44.             HttpWebResponse respone = (HttpWebResponse)await request.GetResponseAsync();
  45.             Stream ns = respone.GetResponseStream();
  46.             string responseContent = new StreamReader(ns, Encoding.UTF8).ReadToEnd();
  47.  
  48.             Debug.Log("[GptNormalWrapper] PostRequestToStringAsync 消息返回:" + responseContent);
  49.             MessageBack textback = JsonUtility.FromJson<MessageBack>(responseContent);
  50.             Debug.Log($"[GptNormalWrapper] PostRequestToStringAsync answer content {textback.data.choices[0].message.content} ");
  51.             return new(textback.data.choices[0].message.content);
  52.  
  53.         }
  54.         catch (Exception e)
  55.         {
  56.             Debug.LogError("[GptNormalWrapper] PostRequestToStringAsync error:" + e);
  57.         }
  58.  
  59.         return new(GptChatCommonStringDefine.GPT_REQUEST_SERVER_FAILED);
  60.     }
  61. }

2、HttpWebRequest 异步 Post 流式的获取数据

  1.  
  2. using System.Net;
  3. using System.Threading.Tasks;
  4. using System.Text;
  5. using System.IO;
  6. using UnityEngine;
  7. using System;
  8.  
  9.  
  10. public class GptStreamWrapper : Singleton<GptStreamWrapper>, IGptHttpWebRequestWrapper
  11. {
  12.     const string GPT_URL = "Your_URL";
  13.     const string AUTHORIZATION = "Your_AUTHORIZATION";
  14.     const string USER_TOKEN = "123456";
  15.     const int TIMEOUT_TIME = 10000; // 超时时间
  16.  
  17.     public string GptUrl { get; } = GPT_URL;
  18.  
  19.     public async Task<string> PostRequestToStringAsync(string postData) {
  20.         return await PostRequestToStringAsync(GptUrl, postData);
  21.     }
  22.  
  23.     public async Task<string> PostRequestToStringAsync(string url, string postData)
  24.     {
  25.         try
  26.         {
  27.             HttpWebRequest request = WebRequest.Create(url) as HttpWebRequest;
  28.  
  29.             request.ReadWriteTimeout = TIMEOUT_TIME;
  30.             request.Timeout = TIMEOUT_TIME;
  31.             request.Method = "POST";
  32.             request.ContentType = "application/json";
  33.             request.Headers.Add("user-token", USER_TOKEN);
  34.             request.Headers.Add("xxx-authorization", AUTHORIZATION);
  35.  
  36.             //流式发起请求
  37.             using (Stream requestStream = await request.GetRequestStreamAsync())
  38.             {
  39.                 Debug.Log("[GptStreamWrapper] PostRequestStreamToStringAsync postData : " + postData);
  40.                 byte[] dataBytes = Encoding.UTF8.GetBytes(postData);
  41.                 await requestStream.WriteAsync(dataBytes, 0, dataBytes.Length);
  42.             }
  43.  
  44.             // 流式获取数据响应
  45.             using (HttpWebResponse response = (HttpWebResponse)await request.GetResponseAsync())
  46.             using (Stream responseStream = response.GetResponseStream())
  47.             using (StreamReader reader = new StreamReader(responseStream))
  48.             {
  49.                 StringBuilder sb = new StringBuilder();
  50.                 char[] buffer = new char[1024];
  51.                 int bytesRead;
  52.  
  53.                 // 循环获取流式数据
  54.                 while ((bytesRead = await reader.ReadAsync(buffer, 0, buffer.Length)) > 0)
  55.                 {
  56.                     sb.Append(buffer, 0, bytesRead);
  57.                     Debug.Log("[GptStreamWrapper] PostRequestStreamToStringAsync getting steam data : " + buffer);
  58.                     buffer = new char[1024];
  59.                 }
  60.  
  61.                 Debug.Log("[GptStreamWrapper] PostRequestStreamToStringAsync whole stream data : " + sb.ToString());
  62.                 return sb.ToString();
  63.             }
  64.         }
  65.         catch (Exception e)
  66.         {
  67.             Debug.Log("[GptStreamWrapper] PostRequestStreamToStringAsync Exception Message data : " + e.Message);
  68.             return new(GptChatCommonStringDefine.GPT_REQUEST_SERVER_FAILED);
  69.         }
  70.  
  71.     }
  72. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/weixin_40725706/article/detail/748410
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号