Unity中的HTTP编程

Unity中的HTTP通信主要依赖的是Unity自带的UnityWebRequest类(虽然也有一些第三方插件,但一般使用这个就足够了)。
HTTP是请求-响应模型,所以通信的过程主要分为请求部分和响应部分。

官方文档:https://docs.unity3d.com/cn/current/Manual/UnityWebRequest.html

HTTP请求(REQUEST)

客户端发送一个HTTP请求到服务器的请求消息包括以下格式:

请求行(request line)、请求头部(header)、空行和请求数据四个部分组成。

HTTP

HTTP请求方法

请求实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
using System.Collections;
using UnityEngine;
using UnityEngine.Networking;

public class UnityPageRequest : MonoBehaviour
{
// Start is called before the first frame update
IEnumerator Start()
{
var url = "https://www.baidu.com";
var www = UnityWebRequest.Get(url);
yield return www.SendWebRequest();

if (www.isHttpError || www.isNetworkError)
{
Debug.Log(www.error);
}
else
{
Debug.Log(www.downloadHandler.text);
}
}
}

本例中我们使用了UnityWebRequest.Get(url)来获取对应的信息。
这里的Get方法对应了HTTP方法中的GET。

HTTP方法

根据HTTP标准,HTTP请求可以使用多种请求方法。
HTTP1.0定义了三种请求方法: GET, POST 和 HEAD方法。
HTTP1.1新增了五种请求方法:OPTIONS, PUT, DELETE, TRACE 和 CONNECT 方法。

  • GET 请求指定的页面信息,并返回实体主体。
  • POST 向指定资源提交数据进行处理请求(例如提交表单或者上传文件)。数据被包含在请求体中。POST请求可能会导致新的资源的建立和/或已有资源的修改。
  • HEAD 类似于get请求,只不过返回的响应中没有具体的内容,用于获取报头
  • PUT 从客户端向服务器传送的数据取代指定的文档的内容。
  • DELETE 请求服务器删除指定的页面。
  • CONNECT HTTP/1.1协议中预留给能够将连接改为管道方式的代理服务器。
  • OPTIONS 允许客户端查看服务器的性能。
  • TRACE 回显服务器收到的请求,主要用于测试或诊断。

通常我们用的比较多的是GET和POST方法。GET一般用来获取信息,POST一般用来向服务器上传信息,比如表单、文件等。

Unity中对应的HTTP方法

UnityWebRequest类中封装了几种HTTP方法的高级操作:

  • GET对应UnityWebRequest.Get
  • POST对应UnityWebRequest.Post
  • HEAD对应UnityWebRequest.Head
  • PUT对应UnityWebRequest.Put
  • DELETE对应UnityWebRequest.Delete

此外,还能使用底层的API来手动创建UnityWebRequest。

URL

上面的几行代码请求了https://www.baidu.com这一URL对应的资源,返回的数据是一个html文件的文本内容。

URL它是一个资源地址,就本例来说:

  1. 协议部分:该URL的协议部分为“https:”,这代表网页使用的是HTTPS协议,S代表Secure,安全的,是一种加密传输的HTTP协议,在”https”后面的“//”为分隔符。
  2. 域名部分:该URL的域名部分为“www.baidu.com”。一个URL中,也可以使用IP地址作为域名使用
  3. 端口部分:端口不是一个URL必须的部分,如果省略,将采用默认端口80。本例中就省略了端口号。
  4. 虚拟目录部分:从域名后的第一个“/”开始到最后一个“/”为止,是虚拟目录部分。虚拟目录也不是一个URL必须的部分。本例中的虚拟目录是根目录“/”
  5. 文件名部分:文件名部分也不是一个URL必须的部分,可以在服务端配置和开发。

如果你不参与服务端开发的话,一般只需要知道URL地址是什么就可以了。

HTTP HEADERS(头部)

请求头部经常用来设置请求的一些属性参数。

比如我们想告诉服务器给我们返回json格式的数据,通常要设置:

1
Content-type:application/json

在Unity中需要这么设置:

1
www.SetRequestHeader("Content-Type", "application/json");

请求数据

有些请求方法如POST和PUT还可以携带请求数据,通常用于上传文件。

在Unity中,请求数据通常以这种方式添加,例如上传一张图片:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
IEnumerator UploadTexture()
{
var tex = new Texture2D(1,1);
tex.ReadPixels(new Rect(0, 0, Screen.width, Screen.height), 0, 0);
tex.Apply();
// tex.Apply() 对性能影响较大,故等待一帧再执行
yield return null;
var bytes = tex.EncodeToPNG();
var form = new WWWForm();
form.AddBinaryData("screenshot", bytes);
var www = UnityWebRequest.Post("server url", form);
yield return www.SendWebRequest();
// ...
}

HTTP响应(RESPONSE)

Http请求的结果都是字节流。

那么为什么我们能看到在浏览器上有的能呈现文字,还有图片、视频呢?

这是因为响应结果中都有Content-Type报头,浏览器会根据报头来解析接收到的数据,显示为不同的内容。

HTTP状态码

HTTP响应的第一行会显示使用的协议以及状态码。

状态码

状态码的定义

状态代码有三位数字组成,第一个数字定义了响应的类别,共分五种类别:

  • 1xx:指示信息–表示请求已接收,继续处理
  • 2xx:成功–表示请求已被成功接收、理解、接受
  • 3xx:重定向–要完成请求必须进行更进一步的操作
  • 4xx:客户端错误–请求有语法错误或请求无法实现
  • 5xx:服务器端错误–服务器未能实现合法的请求

常见状态码

  • 200 OK //客户端请求成功
  • 301 Moved Permanently//重定向(当前页面已过时,跳转到新的页面)
  • 400 Bad Request //客户端请求有语法错误,不能被服务器所理解
  • 401 Unauthorized //请求未经授权,这个状态代码必须和WWW-Authenticate报头域一起使用
  • 403 Forbidden //服务器收到请求,但是拒绝提供服务
  • 404 Not Found //请求资源不存在,eg:输入了错误的URL
  • 500 Internal Server Error //服务器发生不可预期的错误
  • 502 Bad Gateway//服务器从上游服务器收到一个无效的响应(访问量过大,不能提供服务的就会收到)
  • 503 Server Unavailable //服务器当前不能处理客户端的请求,一段时间后可能恢复正常

在Unity中可以使用如下代码获取状态码:

1
Debug.Log(www.responseCode);

这个状态码也决定了www.isHttpError的返回值

1
isHttpError = reponseCode >= 400;

UNITY中的HTTP响应

但是在Unity中,UnityWebRequest并没有自动帮我们处理这个过程,我们需要手动来处理。

通常我们使用:

1
2
var text = www.downloadHandler.text; // 文本信息,使用UTF8编码解析
var bytes = www.downloadHandler.data; // 字节数组

注意www.downloadHandler.text实际上是自动使用UTF8编码解析了字节数组,如果发送的数据不是采用UTF8编码,需要获取字节数组自行解析。

另外在Unity中,Unity结合游戏开发中的常见需求,也加入了请求图片、音频请求的接口。

请求图片:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
IEnumerator RequestTexture()
{
var url = "https://www.baidu.com/img/bd_logo1.png";
var www = UnityWebRequestTexture.GetTexture(url);
yield return www.SendWebRequest();
Debug.Log("status code:" + www.responseCode);
if (www.isHttpError || www.isNetworkError)
{
Debug.Log(www.error);
}
else
{
var tex = DownloadHandlerTexture.GetContent(www);
}
}

请求音频:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
IEnumerator RequestMedia()
{
var url = "https://www.xxx.com/music.ogg";
var www = UnityWebRequestMultimedia.GetAudioClip(url, AudioType.OGGVORBIS);
yield return www.SendWebRequest();
Debug.Log("status code:" + www.responseCode);
if (www.isHttpError || www.isNetworkError)
{
Debug.Log(www.error);
}
else
{
var audio = DownloadHandlerAudioClip.GetContent(www);
}
}

请求视频

目前Unity的VideoPlayer中支持直接从file或http协议直接播放视频,如果你想将这个视频下载到本地,可以使用UnityWebRequest.Get方法获取到所有字节再将字节保存到本地。

请求Assetbundle

1
2
3
4
5
6
7
8
9
10
11
IEnumerator InstantiateObject(string assetBundleName)
{
string uri = "file:///" + Application.dataPath + "/AssetBundles/" + assetBundleName;
UnityWebRequest request = UnityWebRequestAssetBundle.GetAssetBundle(uri, 0);
yield return request.SendWebRequest();
AssetBundle bundle = DownloadHandlerAssetBundle.GetContent(request);
GameObject cube = bundle.LoadAsset<GameObject>("Cube");
GameObject sprite = bundle.LoadAsset<GameObject>("Sprite");
Instantiate(cube);
Instantiate(sprite);
}

总结

  • Unity有一个旧的Web请求API是WWW,但是对HTTP请求不完善。
  • 建议使用新的UnityWebRequest类拥有更好的性能和更完善的HTTP请求。
- (UNITY中的HTTP网络通信)[https://www.freesion.com/article/29501003340/]