[已解决]Unity使用WebRequest过程中发生内存问题A Native Collection has not been disposed

问题背景

Unity版本:2021.3.16

在用Unity做一个文字识别的应用,方案是用UnityWebRequest把图片发送给web api,但在发送一定时间后Unity会报错。

A Native Collection has not been disposed 报错信息

(具体堆栈信息可以通过添加com.unity.entities包后开启堆栈追踪查看)

搜索试了不同的方法,后来在Unity Forum中一个帖子里找到了实际的原因和解决方案。

做了一些总结,该报错根据具体情况,可以尝试从以下几个方向解决:

报错原因1:UnityWebRequest没有释放。

解决方案:使用using把UnityWebRequest框起来,或者在使用完后调用Dispose()。

     using(UnityWebRequest www=new UnityWebRequest(webUrl))
     {
            // ....
            yield return www.SendWebRequest();
            // ....
     }

报错原因2: DownloadHandler或UploadHandler没有释放。

解决方案:设置两者随WebRequest一起释放,或者手动Dispose()。

        using(UnityWebRequest www=new UnityWebRequest(webUrl))
        {
            // ....
            yield return www.SendWebRequest();
            // ....

            www.disposeDownloadHandlerOnDispose = true;
            www.disposeUploadHandlerOnDispose = true;
        }

报错原因3:使用了自己定义的UploadHandle替换了创建WebRequest时创建的UploadHandle,而在释放时没有释放两者。

具体原因:参考UnityWebRequest.Post()方法中SetPost()的代码

        private static void SetupPost(UnityWebRequest request, string postData)
        {
            request.downloadHandler = new DownloadHandlerBuffer();
            if (!string.IsNullOrEmpty(postData))
            {
                byte[] array = null;
                string s = WWWTranscoder.DataEncode(postData, Encoding.UTF8);
                array = Encoding.UTF8.GetBytes(s);
                request.uploadHandler = new UploadHandlerRaw(array);
                request.uploadHandler.contentType = "application/x-www-form-urlencoded";
            }
        }

可以注意到使用UnityWebRequest.Post()时,会自动创建上传和下载的Handle并赋值给WebRequest的downloadHandler和uploadHandler属性

在实际使用时我们可能会替换掉WebRequest的这两个属性,同时在释放内存时只关注了替换后的downloadHandler和uploadHandler属性,导致原来的handler没有被释放,出现报错。

解决方案:在替换前先释放原有的uploadHandler/downloadHandler

        // 使用UnityWebRequest.Post()方法创建UnitywebRequest
        using (UnityWebRequest www = UnityWebRequest.Post(url, dataJson))
        {
            //设置请求的信息....            

            // 创建自己的uploadHandler,使用using语句保证自动释放
            using (var uploadHandlerRaw = new UploadHandlerRaw(bodyRaw))
            {
                // 释放使用UnityWebRequest.Post方法时创建的uploadHandler
                www.uploadHandler.Dispose();
                // 替换为自己创建的uploadHandler
                www.uploadHandler = uploadHandlerRaw;

                yield return www.SendWebRequest();
                
                // 处理请求的结果...

                // 保险起见再设置一下handler随WebRequest一起释放
                www.disposeDownloadHandlerOnDispose = true;
                www.disposeUploadHandlerOnDispose = true;
            }
        }

参考文章:A Native Collection has not been disposed, resulting in a memory leak. - Unity Forum