ObjectProgressEvent详解

一、ObjectProgressEvent定义及使用

ObjectProgressEvent继承自ProgressEvent，用于指示位于耗时操作过程中的对象的进展情况。可以用在加载大型媒体文件，上传或下载文件等场景。具体的应用场景可参考下面的代码示例：

var loader:URLLoader = new URLLoader();
loader.addEventListener(ProgressEvent.PROGRESS, onLoading);
loader.addEventListener(Event.COMPLETE, onComplete);
loader.load(new URLRequest("large_media_file.mp4"));

function onLoading(event:ProgressEvent):void {
  var progressEvent:ObjectProgressEvent = event as ObjectProgressEvent;
  trace("Loaded " + progressEvent.bytesLoaded + " bytes");
  trace("Total bytes to load: " + progressEvent.bytesTotal);
}

function onComplete(event:Event):void {
  trace("Loading has completed.");
}

在上面的代码中，我们创建了一个URLLoader对象，然后为它添加了一个ProgressEvent.PROGRESS事件监听器和一个Event.COMPLETE事件监听器。然后我们使用该URLLoader对象来加载视频文件。在onLoading函数中，我们将ProgressEvent转化为ObjectProgressEvent，以便于获取对象加载的有用信息。当视频加载完成后，我们将执行onComplete函数。

二、ObjectProgressEvent属性及方法

ObjectProgressEvent有以下有用的属性和方法：

1. currentTarget：当前正在处理事件的对象的引用。

2. bytesLoaded：已经加载的字节数。

3. bytesTotal：要加载的总字节数。

4. cancelable：指示是否可以取消事件的布尔值。

5. clone()：创建当前对象的副本。

6. ObjectProgressEvent.TYPE_PROGRESS：定义progress事件的类型字符串。

下面是一个简单的示例，演示了如何使用clone()方法创建ObjectProgressEvent的副本：

var loader:URLLoader = new URLLoader();
loader.addEventListener(ProgressEvent.PROGRESS, onLoading);
loader.load(new URLRequest("large_media_file.mp4"));

function onLoading(event:ProgressEvent):void {
  var progressEvent:ObjectProgressEvent = event as ObjectProgressEvent;
  var clonedEvent:ObjectProgressEvent = progressEvent.clone() as ObjectProgressEvent;
  trace("Cloned bytesLoaded: " + clonedEvent.bytesLoaded);
}

在上面的代码中，我们通过clone()方法创建了一个ObjectProgressEvent的副本，并且输出了副本的bytesLoaded属性。

三、ObjectProgressEvent与字节码长度

ObjectProgressEvent中的bytesLoaded和bytesTotal属性都是以字节为单位的。在AS3中，一个Unicode字符通常需要两个字节来表示，这意味着当我们在读取文本文件时，ObjectProgressEvent会返回以字节为单位的值，而不是以字符为单位的值。这可能会导致一些意外的结果。下面是一个示例，展示了如何在读取文本文件时计算已经加载的字符数：

var loader:URLLoader = new URLLoader();
loader.addEventListener(ProgressEvent.PROGRESS, onLoading);
loader.load(new URLRequest("large_text_file.txt"));

function onLoading(event:ProgressEvent):void {
  var progressEvent:ObjectProgressEvent = event as ObjectProgressEvent;
  var bytesPerChar:Number = progressEvent.bytesLoaded / progressEvent.target.data.length;
  var charsLoaded:int = progressEvent.bytesLoaded / bytesPerChar;
  var charsTotal:int = progressEvent.bytesTotal / bytesPerChar;
  trace("Loaded " + charsLoaded + " of " + charsTotal + " characters.");
}

在上面的代码中，我们通过计算已加载的字节数和目标文件的总字节数之比，计算出每个字符需要的字节数。然后，我们将已经加载的字节数除以每个字符需要的字节数，以获取已经加载的字符数，最后将总字节数除以每个字符需要的字节数，以获取文件中的字符总数。

四、ObjectProgressEvent与上传文件

在上传文件时（通常使用FileReference类），ObjectProgressEvent可以告诉我们上传进度的百分比和已经上传的字节数。下面是一个示例，演示了如何使用ObjectProgressEvent在上传过程中跟踪进度：

var uploadURL:URLRequest = new URLRequest("upload.php");
var file:FileReference = new FileReference();
file.browse();
file.addEventListener(Event.SELECT, onFileSelect);

function onFileSelect(event:Event):void {
  file.upload(uploadURL);
  file.addEventListener(ProgressEvent.PROGRESS, onUploadProgress);
  file.addEventListener(Event.COMPLETE, onUploadComplete);
}

function onUploadProgress(event:ProgressEvent):void {
  var progressEvent:ObjectProgressEvent = event as ObjectProgressEvent;
  trace("Uploaded " + progressEvent.bytesLoaded + " of " + progressEvent.bytesTotal + " bytes.");
  trace("Percentage uploaded: " + Math.round(progressEvent.bytesLoaded / progressEvent.bytesTotal) * 100 + "%");
}

function onUploadComplete(event:Event):void {
  trace("Upload has completed.");
}

在上面的代码中，我们创建了一个FileReference对象，并为其添加了一个ProgressEvent.PROGRESS事件监听器和一个Event.COMPLETE事件监听器。当文件被选择时，我们使用该FileReference对象将文件上传到服务器。在onUploadProgress函数中，我们将ProgressEvent转换为ObjectProgressEvent，以获取上传进度的有用信息。当上传完成后，我们将执行onUploadComplete函数。

五、ObjectProgressEvent与下载文件

除了上传文件之外，ObjectProgressEvent也可用于下载文件时跟踪进度。在这种情况下，我们通常使用URLLoader类。下面是一个示例，演示了如何使用ObjectProgressEvent在下载视频文件时跟踪进度：

var loader:URLLoader = new URLLoader();
loader.addEventListener(Event.COMPLETE, onComplete);
loader.addEventListener(ProgressEvent.PROGRESS, onLoading);
loader.load(new URLRequest("large_media_file.mp4"));

function onComplete(event:Event):void {
  trace("File downloaded successfully.");
}

function onLoading(event:ProgressEvent):void {
  var progressEvent:ObjectProgressEvent = event as ObjectProgressEvent;
  trace("Downloaded " + progressEvent.bytesLoaded + " of " + progressEvent.bytesTotal + " bytes.");
  trace("Percentage downloaded: " + Math.round(progressEvent.bytesLoaded / progressEvent.bytesTotal) * 100 + "%");
}

在上面的代码中，我们创建了一个URLLoader对象，并为其添加了一个ProgressEvent.PROGRESS事件监听器和一个Event.COMPLETE事件监听器。然后，我们使用该URLLoader对象下载视频文件。在onLoading函数中，我们将ProgressEvent转换为ObjectProgressEvent，以获取有用的下载信息。当下载完成后，我们将执行onComplete函数。