一、理论了解
-
1、UnityWebRequest替换了原来旧的www方式，虽然其还可以继续使用。
新特性：支持大文件断点续传 -
2、构成要点
UnityWebRequest由三个元素组成：
1 UpLoadHandler处理数据将数据上传到服务器的对象；
2 DownLoadHandler从服务器下载数据的对象；
3 UnityWebRequest负责与HTTP通信并管理上面两个对象。还处理 HTTP 流量控制。此对象是定义自定义标头和 URL 的位置，也是存储错误和重定向信息的位置。
- 3、常用方法
- SendWebRequest()
开始与远程服务器通信。在调用此方法之后，有必要的话UnityWebRequest将执行DNS解析，将HTTP请求发送到目标URL的远程服务器并处理服务器的响应。 - Get(url)
创建一个HTTP为传入URL的UnityWebRequest对象 - Post（url)
向Web服务器发送表单信息 - Put(url)
将数据上传到Web服务器 - Abort()
直接结束联网 - Head()
创建一个为传输HTTP头请求的UnityWebRequest对象 - GetResponseHeader()
返回一个字典，内容为在最新的HTTP响应中收到的所有响应头
- SendWebRequest()
二、使用案例
UnityWebRequest这类里有很多静态方法和UnityWebRequest构造函数，因此调用方式就是这两种。
1、静态类方式
- Get
using System.Collections;
using System.Collections.Generic;
using System.IO;
using UnityEngine.UI;
using UnityEngine;
using UnityEngine.EventSystems;
using UnityEngine.Networking;
using System;
public class AAA : MonoBehaviour
{
void Start()
{
StartCoroutine("GetDataB", "Test.txt");
}
#region 创建persistentDataPath文件夹
IEnumerator GetDataB(string fileName)
{
//1.url地址
string fromPath = Application.streamingAssetsPath + "/" + fileName;
//2.创建一个UnityWebRequest类 method属性为Get
UnityWebRequest request = UnityWebRequest.Get(fromPath);
//3.等待响应时间，超过5秒结束
request.timeout = 5;
//4.发送请求信息
yield return request.SendWebRequest();
//5.判断是否下载完成
if (request.isDone)
{
//6.判断是否下载错误
if (request.isHttpError || request.isNetworkError)
Debug.Log(request.error);
else
Debug.Log(request.downloadHandler.text);
}
}
#endregion
}
- Post
using System.Collections;
using UnityEngine;
using UnityEngine.Networking;
/// <summary>
/// 网络请求测试
/// </summary>
public class ChinarWebRequest : MonoBehaviour
{
void Start()
{
StartCoroutine(Post());
}
/// <summary>
/// 开启一个协程，发送请求
/// </summary>
/// <returns></returns>
IEnumerator Post()
{
WWWForm form = new WWWForm();
//键值对
form.AddField("key", "value");
form.AddField("name", "Chinar");
//请求链接，并将form对象发送到远程服务器
UnityWebRequest webRequest = UnityWebRequest.Post("http://www.baidu.com", form);
yield return webRequest.SendWebRequest();
if (webRequest.isHttpError || webRequest.isNetworkError)
{
Debug.Log(webRequest.error);
}
else
{
Debug.Log("发送成功");
}
}
}
- Put
using System.Collections;
using UnityEngine;
using UnityEngine.Networking;
/// <summary>
/// 网络请求测试
/// </summary>
public class ChinarWebRequest : MonoBehaviour
{
void Start()
{
StartCoroutine(Upload());
}
/// <summary>
/// 开启协程
/// </summary>
/// <returns></returns>
IEnumerator Upload()
{
byte[] myData = System.Text.Encoding.UTF8.GetBytes("Chinar的测试数据");
using (UnityWebRequest uwr = UnityWebRequest.Put("http://www.baidu.com", myData))
{
yield return uwr.SendWebRequest();
if (uwr.isNetworkError || uwr.isHttpError)
{
Debug.Log(uwr.error);
}
else
{
Debug.Log("上传成功!");
}
}
}
}
2、构造创建UnityWebRequest方式
using System.Collections;
using System.Collections.Generic;
using System.IO;
using UnityEngine.UI;
using UnityEngine;
using UnityEngine.EventSystems;
using UnityEngine.Networking;
using System;
public class AAA : MonoBehaviour
{
void Start()
{
StartCoroutine("GetDataB", "Test.txt");
}
#region 创建persistentDataPath文件夹
IEnumerator GetDataB(string fileName)
{
string fromPath = Application.streamingAssetsPath + "/" + fileName;
Uri uri = new Uri(fromPath);
//UnityWebRequest request = UnityWebRequest.Get(fromPath);
UnityWebRequest request =new UnityWebRequest(uri); //使用构造
request.timeout = 5;//等待响应时间，超过5秒结束
/*使用构造没有DownloadHandler和UploadHandler，所以要创建赋值，这里只用到了下载，所以可以不用创建UploadHandler
* 下面罗列了三种不同类型的DownloadHandler
1.DownloadHandlerBuffer 读取文件存储
2.DownloadHandlerTexture 读取图片
3.DownloadHandlerFile 下载文件到本地
*/
DownloadHandlerBuffer Download = new DownloadHandlerBuffer();
request.downloadHandler = Download;
yield return request.SendWebRequest();
if (request.isDone)
{
if (request.isHttpError || request.isNetworkError)
Debug.Log(request.error);
else
Debug.Log(request.downloadHandler.text);
}
}
#endregion
}
3、一些别的用途
- 利用Head方法获取文件内容长度
IEnumerator SendRequest()
{
UnityWebRequest uwr = UnityWebRequest.Head("www.baidu.com"); //创建UnityWebRequest对象
yield return uwr.SendWebRequest(); //等待返回请求的信息
if (uwr.isHttpError || uwr.isNetworkError) //如果其 请求失败，或是 网络错误
{
Debug.Log(uwr.error); //打印错误原因
}
else //请求成功
{
long totalLength = long.Parse(uwr.GetResponseHeader("Content-Length")); //首先拿到文件的全部长度
Debug.Log($"totalLength:{totalLength}" );//打印文件长度
}
}
- 断点续传案例
using System;
using System.Collections;
using System.IO;
using UnityEngine;
using UnityEngine.Networking;
using UnityEngine.UI;
public class ChinarBreakpointRenewal : MonoBehaviour
{
private bool _isStop; //是否暂停
public Slider ProgressBar; //进度条
public Text SliderValue; //滑动条值
public Button startBtn; //开始按钮
public Button pauseBtn; //暂停按钮
string Url = "https://downsc.chinaz.net/Files/DownLoad/sound1/201808/10447.wav";
/// <summary>
/// 初始化UI界面及给按钮绑定方法
/// </summary>
void Start()
{
//初始化进度条和文本框
ProgressBar.value = 0;
SliderValue.text = "0.0%";
//开始、暂停按钮事件监听
startBtn.onClick.AddListener(OnClickStartDownload);
pauseBtn.onClick.AddListener(OnClickStop);
}
//开始下载按钮监听事件
public void OnClickStartDownload()
{
//开启协程 *注意真机上要用Application.persistentDataPath路径*
StartCoroutine(DownloadFile(Url, Application.streamingAssetsPath + "/MP4/test.mp4", CallBack));
}
/// <summary>
/// 协程：下载文件
/// </summary>
/// <param name="url">请求的Web地址</param>
/// <param name="filePath">文件保存路径</param>
/// <param name="callBack">下载完成的回调函数</param>
/// <returns></returns>
IEnumerator DownloadFile(string url, string filePath, Action callBack)
{
UnityWebRequest huwr = UnityWebRequest.Head(url); //使用Head方法可以获取到文件的全部长度
yield return huwr.SendWebRequest();//发送信息请求
//判断请求或系统是否出错
if (huwr.isNetworkError || huwr.isHttpError)
{
Debug.Log(huwr.error); //出现错误 输出错误信息
}
else
{
long totalLength = long.Parse(huwr.GetResponseHeader("Content-Length")); //首先拿到文件的全部长度
string dirPath = Path.GetDirectoryName(filePath);//获取文件的上一级目录
if (!Directory.Exists(dirPath)) //判断路径是否存在
{
Directory.CreateDirectory(dirPath);//不存在创建
}
/*作用：创建一个文件流，指定路径为filePath,模式为打开或创建，访问为写入
* 使用using(){}方法原因： 当同一个cs引用了不同的命名空间，但这些命名控件都包括了一个相同名字的类型的时候,可以使用using关键字来创建别名，这样会使代码更简洁。注意：并不是说两个名字重复，给其中一个用了别名，另外一个就不需要用别名了，如果两个都要使用，则两个都需要用using来定义别名的
* using(类){} 括号中的类必须是继承了IDisposable接口才能使用否则报错
* 这里没有出现不同命名空间出现相同名字的类属性可以不用using(){}
*/
using (FileStream fs = new FileStream(filePath, FileMode.OpenOrCreate, FileAccess.Write))
{
long nowFileLength = fs.Length; //当前文件长度,断点前已经下载的文件长度。
Debug.Log(fs.Length);
//判断当前文件是否小于要下载文件的长度，即文件是否下载完成
if (nowFileLength < totalLength)
{
Debug.Log("还没下载完成");
/*使用Seek方法 可以随机读写文件
* Seek() ----------有两个参数 第一参数规定文件指针以字节为单位移动的距离。第二个参数规定开始计算的位置
* 第二个参数SeekOrigin 有三个值：Begin Current End
* fs.Seek(8,SeekOrigin.Begin);表示 将文件指针从开头位置移动到文件的第8个字节
* fs.Seek(8,SeekOrigin.Current);表示 将文件指针从当前位置移动到文件的第8个字节
* fs.Seek(8,SeekOrigin.End);表示 将文件指针从最后位置移动到文件的第8个字节
*/
fs.Seek(nowFileLength, SeekOrigin.Begin); //从开头位置，移动到当前已下载的子节位置
UnityWebRequest uwr = UnityWebRequest.Get(url); //创建UnityWebRequest对象，将Url传入
uwr.SetRequestHeader("Range", "bytes=" + nowFileLength + "-" + totalLength);//修改请求头从n-m之间
uwr.SendWebRequest(); //开始请求
if (uwr.isNetworkError || uwr.isHttpError) //如果出错
{
Debug.Log(uwr.error); //输出 错误信息
}
else
{
long index = 0; //从该索引处继续下载
while (nowFileLength < totalLength) //只要下载没有完成，一直执行此循环
{
if (_isStop) break;//如果停止跳出循环
yield return null;
byte[] data = uwr.downloadHandler.data;
if (data != null)
{
long length = data.Length - index;
fs.Write(data, (int)index, (int)length); //写入文件
index += length;
nowFileLength += length;
ProgressBar.value = (float)nowFileLength / totalLength;
SliderValue.text = Math.Floor((float)nowFileLength / totalLength * 100) + "%";
if (nowFileLength >= totalLength) //如果下载完成了
{
ProgressBar.value = 1; //改变Slider的值
SliderValue.text = 100 + "%";
/*这句话的作用是：如果callBack方法不为空则执行Invoke
* 注意：
* 1.这里的Invoke可不是Unity的Invoke延迟调用的用法，参考文章：https://blog.csdn.net/liujiejieliu1234/article/details/45312141 从文章中我们可以看到，C#中的Invoke是为了防止winform中子主线程刚开始创建对象时，子线程与主线程并发修改主线程尚未创建的对象属性。
* 因为unity这里只有主线程没有用到子线程可以直接写callBack();
*/
callBack?.Invoke();
break;
}
}
}
}
}
}
}
}
/// <summary>
/// 下载完成后的回调函数
/// </summary>
void CallBack()
{
Debug.Log("下载完成");
}
/// <summary>
/// 暂停下载
/// </summary>
public void OnClickStop()
{
if (_isStop)
{
pauseBtn.GetComponentInChildren<Text>().text = "暂停下载";
Debug.Log("继续下载");
_isStop = !_isStop;
OnClickStartDownload();
}
else
{
pauseBtn.GetComponentInChildren<Text>().text = "继续下载";
Debug.Log("暂停下载");
_isStop = !_isStop;
}
}
}
4、常用属性
- timeout - int类型 - 等待时间(秒)超过此数值是 UnityWebReqest的尝试连接将终止
- isHttpError - bool类型 - HTTP响应出现出现错误
- isNetworkError- bool类型 - 系统出现错误
- error - bool类型 - 描述 UnityWebRequest对象在处理HTTP请求或响应时遇到的任何系统错误
- downloadProgress - float类型 - 表示从服务器下载数据的进度
- uploadProgress - float类型 - 表示从服务器上传数据的进度
- isDone - bool类型 - 是否完成与远程服务器的通信
- SendWebRequest -UnityWebRequestAsyncOperation类型 - 发送信息访问
转载自：https://blog.csdn.net/qq_42345116/article/details/123413736
网友评论