構(gòu)建和運(yùn)行WebGL項(xiàng)目
當(dāng)您構(gòu)建(buil)WebGL項(xiàng)目時(shí),Unity將創(chuàng)建一個(gè)包含以下文件的文件夾:
- 一個(gè)
index.html
文件,瀏覽器可以通過(guò)它來(lái)加載您的內(nèi)容。 - 一個(gè)
TemplateData
文件夾(當(dāng)使用默認(rèn)模板構(gòu)建時(shí))包含建立標(biāo)志,加載欄和其他模板資產(chǎn)。構(gòu)建模板文件夾通常用于在加載時(shí)自定義構(gòu)建的外觀。有關(guān)更多信息,請(qǐng)參閱WebGL模板上的用戶手冊(cè)頁(yè)面。 - 一個(gè)
Build
文件夾包含您生成的生成輸出文件。
Build
文件夾包含以下文件(MyProject文件名稱代表項(xiàng)目名稱)。
- 一個(gè)
UnityLoader.js
腳本, 它包含加載網(wǎng)頁(yè)中Unity內(nèi)容所需代碼 - 一個(gè)
MyProject.json
的JSON文件 它包含關(guān)于構(gòu)建的所有必要信息。當(dāng)構(gòu)建實(shí)例化時(shí),此JSON文件的URL作為Unity Loader的參數(shù)提供。 JSON文件包含所有其他構(gòu)建文件的URL,這些文件可以是絕對(duì)的或相對(duì)于JSON文件的位置。 JSON可能包含其他模塊參數(shù),例如閃屏風(fēng)格或內(nèi)存堆的初始大小。 - 一個(gè)
MyProject.asm.framework.unityweb
文件, 它包含asm.js運(yùn)行時(shí)和JavaScript插件。 - 一個(gè)
MyProject.asm.code.unityweb
文件 包含你的播放器(player)的asm.js模塊。 - 一個(gè)
MyProject.asm.memory.unityweb
文件 包含一個(gè)二進(jìn)制圖像以初始化 您的播放器(your player)的堆內(nèi)存。 - 一個(gè)
MyProject.data.unityweb
文件 包含資產(chǎn)數(shù)據(jù)和場(chǎng)景。
根據(jù)發(fā)布設(shè)置,Build文件夾中 *.unityweb
文件的內(nèi)容可能使用gzip,brotli進(jìn)行壓縮或可能未壓縮。有關(guān)更多信息,請(qǐng)參閱部署壓縮構(gòu)建的文檔(deploying compressed builds
您可以通過(guò)打開index.html文件直接在大多數(shù)瀏覽器中查看您的WebGL播放器。但是,出于安全原因,Chrome對(duì)從本地文件網(wǎng)址打開的腳本設(shè)置了限制,因此該技術(shù)在Chrome中無(wú)法使用。要解決Chrome的限制,請(qǐng)使用Unity的Build&Run命令(文件>構(gòu)建和運(yùn)行 (File > Build & Run);該文件然后暫時(shí)托管在本地Web服務(wù)器中,并從本地主機(jī)URL打開。或者,您可以使用--allow-file-access-from-files
命令行選項(xiàng)運(yùn)行Chrome,該選項(xiàng)允許它從本地文件URL加載內(nèi)容。這是PC上需要的,以允許執(zhí)行構(gòu)建。
在某些服務(wù)器上,您需要明確地創(chuàng)建 .unityweb
文件,因?yàn)榉?wù)器需要將這些文件提供給客戶端。
Build player options 建立玩家選項(xiàng)
通過(guò)Build Settings對(duì)話框訪問(wèn)WebGL選項(xiàng)。 (菜單:文件>構(gòu)建設(shè)置... (File > Build Settings...)。在對(duì)話框中,從平臺(tái)列表中選擇WebGL,然后選擇Player Settings...。
Development Build 開發(fā)構(gòu)建
當(dāng)您選中Development Build復(fù)選框時(shí),Unity會(huì)生成一個(gè)具有Profiler支持的開發(fā)版本和一個(gè)用于查看錯(cuò)誤的開發(fā)控制臺(tái)。另外,開發(fā)版本不會(huì)壓縮內(nèi)容(即內(nèi)容沒有縮小);他們以可讀的形式維護(hù)JavaScript,保留函數(shù)名稱,以便獲取有用的錯(cuò)誤堆棧跟蹤。但請(qǐng)注意,這意味著開發(fā)版本非常大,而且分發(fā)太大。
Use pre-built Engine 使用預(yù)先構(gòu)建的引擎
此選項(xiàng)僅在您選中Development Build復(fù)選框時(shí)才會(huì)顯示。使用 Build Settings 構(gòu)建設(shè)置”對(duì)話框中的 中的 Use pre-built Engine 使用預(yù)構(gòu)建引擎 選項(xiàng)可加快開發(fā)過(guò)程中的構(gòu)建迭代時(shí)間。啟用此選項(xiàng)時(shí),Unity僅重建托管代碼,然后與預(yù)生成Unity引擎動(dòng)態(tài)鏈接,因此項(xiàng)目重建速度提高了大約30-40%。請(qǐng)注意,此類構(gòu)建僅適用于開發(fā)目的,因?yàn)樗冀K會(huì)生成未劃分的引擎代碼。由于動(dòng)態(tài)鏈接開銷,這種構(gòu)建的性能比正常構(gòu)建慢。
Autoconnect Profiler
WebGL在PlayerSettings檢查器窗口中有一些其他選項(xiàng)(菜單:Edit > Project Settings > Player 編輯>項(xiàng)目設(shè)置>播放器)。
Other Settings
Strip Engine Code 剝離引擎代碼
打開Other Settings 其他設(shè)置以訪問(wèn) Strip Engine Code 剝離引擎代碼選項(xiàng)。此選項(xiàng)默認(rèn)選中以啟用WebGL代碼剝離。選中此選項(xiàng)后,Unity不包含任何您不使用的類的代碼。例如,如果您不使用任何物理組件或功能,則整個(gè)物理引擎將從您的構(gòu)建中刪除。有關(guān)更多詳細(xì)信息,請(qǐng)參閱下面的<Stripping 剝離>部分。
Publishing Settings
Memory Size
打開 Publishing Settings 發(fā)布設(shè)置 以訪問(wèn)Memory Size 內(nèi)存大小字段。在這里,您可以指定內(nèi)容應(yīng)為其堆分配多少內(nèi)存(以MB為單位)。如果此值太低,則會(huì)顯示“out of memory 內(nèi)存不足”錯(cuò)誤消息。這意味著您的加載內(nèi)容和場(chǎng)景無(wú)法放入可用內(nèi)存。但是,如果此值太高,則可能無(wú)法在某些瀏覽器或某些計(jì)算機(jī)上加載內(nèi)容,因?yàn)闉g覽器可能沒有足夠的可用內(nèi)存來(lái)分配所請(qǐng)求的堆大小。此值將寫入生成的.json文件中名為TOTAL_MEMORY
的屬性,因此如果您想在不重建項(xiàng)目的情況下嘗試此設(shè)置,則可以編輯.json文件或?qū)⒏碌?code>TOTAL_MEMORY值作為附加WebGL提供實(shí)例化參數(shù)。有關(guān)更多詳細(xì)信息,請(qǐng)參閱 WebGL memory usage WebGL內(nèi)存使用情況的用戶手冊(cè)頁(yè)。
Enable Exceptions 啟用例外
打開 Publishing Settings發(fā)布設(shè)置 以訪問(wèn) Enable Exceptions啟用例外。啟用異常允許您指定在運(yùn)行時(shí)處理意外代碼行為(通常認(rèn)為是錯(cuò)誤)的方式。它有以下選項(xiàng):
- None: 如果您不需要任何異常支持,請(qǐng)選擇此項(xiàng)。這提供了最佳的性能和最小的構(gòu)建。使用此選項(xiàng),拋出的任何異常都會(huì)導(dǎo)致您的內(nèi)容在該設(shè)置中出現(xiàn)錯(cuò)誤而停止。
- Explicitly Thrown Exceptions Only(default) 僅顯式拋出異常: 選擇此選項(xiàng)可捕獲腳本中從throw語(yǔ)句顯式指定的異常,并確保 finally最終調(diào)用塊。請(qǐng)注意,選擇此選項(xiàng)會(huì)使您的腳本生成的JavaScript代碼變得越來(lái)越慢;如果腳本是您項(xiàng)目中的主要瓶頸,這可能只是一個(gè)問(wèn)題。
-
Full Without Stacktrace 完全沒有Stacktrace: 選擇此選項(xiàng)以捕獲:
- 在腳本中通過(guò)throw語(yǔ)句顯式指定的異常(與僅在顯式拋出異常選項(xiàng)中相同)
- 空引用
- 超出界限數(shù)組訪問(wèn)
- Full With Stacktrace 完全與Stacktrace: 該選項(xiàng)與上面的選項(xiàng)類似,但它也捕獲堆棧跟蹤。 Unity會(huì)通過(guò)在代碼中嵌入對(duì)它們的檢查來(lái)生成這些異常,所以此選項(xiàng)會(huì)降低性能并增加瀏覽器內(nèi)存使用量。僅用于調(diào)試,并且始終在64位瀏覽器中進(jìn)行測(cè)試。
選擇 Publishing Settings發(fā)布設(shè)置以訪問(wèn)Data Caching數(shù)據(jù)緩存。選擇此項(xiàng)以啟用播放器數(shù)據(jù)的自動(dòng)本地緩存。此選項(xiàng)將資產(chǎn)存儲(chǔ)設(shè)置為本地緩存在瀏覽器的IndexedDB數(shù)據(jù)庫(kù)中,以便資源不必在隨后的內(nèi)容運(yùn)行中再次下載。請(qǐng)注意,不同的瀏覽器在允許IndexedDB存儲(chǔ)方面有不同的規(guī)則;瀏覽器可能會(huì)要求用戶存儲(chǔ)數(shù)據(jù)的權(quán)限,并且您的構(gòu)建可能會(huì)超出瀏覽器定義的大小限制。
Distribution size 分布大小
在發(fā)布WebGL時(shí),重要的是保持較低的 構(gòu)建(build size) 大小,以便用戶在內(nèi)容啟動(dòng)之前獲得合理的下載時(shí)間。有關(guān)減少資產(chǎn)規(guī)模的一般提示,請(qǐng)參閱 有關(guān)減少構(gòu)建文件大小的文檔 Reducing the file size of the build。
Hints and tips specific to WebGL 針對(duì)WebGL的建議和提示
- 為紋理導(dǎo)入器Texture Importer中的所有壓縮紋理指定壓縮紋理壓縮格式。
- 不要部署 開發(fā)版本(development builds);他們沒有壓縮或縮小minified,所以有更大的文件大小。
- 進(jìn)入PlayerSettings(菜單:Edit > Project Settings > Player),打開 Publishing Settings 并將 Enable Exceptions為None,如果你不需要你的構(gòu)建異常。
- 轉(zhuǎn)到PlayerSettings(菜單:Edit > Project Settings > Player),打開Other Settings并啟用Strip Engine Code以確保高效構(gòu)建。
- 使用第三方托管dll時(shí)要小心,因?yàn)樗鼈兛赡馨芏嘁蕾図?xiàng),因此會(huì)顯著增加生成的代碼大小。
如果制作發(fā)布版本(release build),Unity會(huì)根據(jù)在WebGL Player Settings > Publishing Settings窗口中選擇的Compression Format(壓縮格式) 壓縮構(gòu)建輸出文件。
有關(guān)這些選項(xiàng)的更多信息以及如何使用它們發(fā)布構(gòu)建,請(qǐng)參閱 部署壓縮構(gòu)建的文檔 Deploying compressed builds。
AssetBundles
由于您的內(nèi)容開始前需要預(yù)先下載所有的資產(chǎn)數(shù)據(jù),因此您應(yīng)該考慮將資產(chǎn)從主要數(shù)據(jù)文件中移出并存入AssetBundles中。這樣,您可以為加載速度快的內(nèi)容創(chuàng)建一個(gè)小型加載程序場(chǎng)景。然后,隨著用戶瀏覽您的內(nèi)容,它會(huì)按需動(dòng)態(tài)加載資產(chǎn)。 AssetBundles還有助于Asset data memory(資產(chǎn)數(shù)據(jù)內(nèi)存管理):您可以通過(guò)調(diào)用AssetBundle.Unload從資產(chǎn)內(nèi)存中卸載您不再需要的資產(chǎn)。
在WebGL平臺(tái)上使用AssetBundles時(shí),一些注意事項(xiàng)適用:
- 當(dāng)您在AssetBundle中使用未在主版本中使用的類類型時(shí),Unity可能會(huì)剝離構(gòu)建中的這些類的代碼。當(dāng)嘗試從AssetBundle加載資產(chǎn)時(shí),這可能會(huì)導(dǎo)致失敗。使用BuildPlayerOptions.assetBundleManifestPath來(lái)解決該問(wèn)題,或者參見下面的Stripping(剝離)部分以獲取其他選項(xiàng)。
- WebGL不支持線程,但http下載只有在完成下載后才可用。因此,Unity WebGL需要在下載完成時(shí)在主線程上解壓縮AssetBundle數(shù)據(jù),從而阻塞主線程。為避免此中斷,LZMA AssetBundle compression不適用于WebGL上的AssetBundles。 AssetBundles是使用LZ4進(jìn)行壓縮的,它可以非常有效地按需進(jìn)行解壓縮。如果您需要的壓縮尺寸小于LZ4提供的壓縮尺寸,則可以將Web服務(wù)器配置為在AssetBundles上使用gzip或Brotli壓縮(在LZ4壓縮之上)。有關(guān)如何執(zhí)行此操作的更多信息,請(qǐng)參閱部 Deploying compressed builds署壓縮構(gòu)建的文檔。
- WebGL支持使用WWW.LoadFromCacheOrDownload的AssetBundle緩存,使用瀏覽器中的IndexedDB API在用戶的計(jì)算機(jī)上實(shí)現(xiàn)緩存。請(qǐng)注意,IndexedDB對(duì)某些瀏覽器的支持可能有限,并且瀏覽器可能會(huì)要求用戶授權(quán)將數(shù)據(jù)存儲(chǔ)在磁盤上。有關(guān)更多信息,請(qǐng)參閱 WebGL browser compatibilityWebGL瀏覽器兼容性文檔。
Stripping 剝離
默認(rèn)情況下,Unity從您的版本中刪除所有未使用的代碼。您可以通過(guò)PlayerSettings檢查器窗口(菜單:Edit > Project Settings)更改此選項(xiàng):選擇Other Settings其他設(shè)置以訪問(wèn)Strip Engine Code剝離引擎代碼選項(xiàng)。最好在啟用剝離的情況下構(gòu)建。
使用代碼剝離功能時(shí),Unity會(huì)掃描您的項(xiàng)目以查找所有使用的UnityObject派生類(通過(guò)在腳本代碼中引用,或者在場(chǎng)景中的序列化數(shù)據(jù)中)。然后從構(gòu)建中刪除任何沒有使用它們的類的Unity子系統(tǒng)。這使得您的構(gòu)建代碼更少,從而導(dǎo)致下載量更少,解析代碼更少(因此代碼運(yùn)行速度更快,內(nèi)存更少)。
Issues with code stripping 代碼剝離問(wèn)題
代碼剝離可能會(huì)導(dǎo)致您的項(xiàng)目出現(xiàn)問(wèn)題,如果它剝奪了實(shí)際需要的代碼。當(dāng)您在運(yùn)行時(shí)加載包含未包含在主版本中的類并因此已從項(xiàng)目中刪除的AssetBundles時(shí),可能會(huì)出現(xiàn)這種情況。出現(xiàn)這種情況時(shí),瀏覽器的JavaScript控制臺(tái)中會(huì)顯示錯(cuò)誤消息(可能后面跟著更多錯(cuò)誤)。例如:
Could not produce class with ID XXX
要排除這些錯(cuò)誤,請(qǐng)?jiān)?a target="_blank" rel="nofollow">Class ID Reference中查找ID(例如上面的例子中的XXX),以查看它嘗試創(chuàng)建實(shí)例的哪個(gè)類。在這種情況下,您可以強(qiáng)制Unity將該類的代碼包含在構(gòu)建中,方法是將對(duì)該類的引用添加到腳本或場(chǎng)景中,或者將link.xml
文件添加到項(xiàng)目中。
下面是一個(gè)確保Collider類(因此物理模塊)被保存在項(xiàng)目中的例子。將此XML代碼添加到名為link.xml的文件中,并將該文件放入您的Assets folder
中。
<linker>
<assembly fullname="UnityEngine">
<type fullname="UnityEngine.Collider" preserve="all"/>
</assembly>
</linker>
如果您懷疑剝離導(dǎo)致構(gòu)建問(wèn)題,您還可以嘗試在測(cè)試期間禁用 trip Engine Code剝離引擎代碼選項(xiàng)。
Unity沒有提供一種方便的方式來(lái)查看構(gòu)建中包含哪些模塊和類,這將允許您優(yōu)化項(xiàng)目以良好地剝離。但是,要獲得包含的類和模塊的概述,可以在構(gòu)建完成后查看生成的文件Temp/StagingArea/Data/il2cppOutput/UnityClassRegistration.cpp。
請(qǐng)注意,Strip Engine代碼選項(xiàng)僅影響Unity引擎代碼。 IL2CPP總是從您的托管dll和腳本中剝離字節(jié)碼。當(dāng)您需要通過(guò)反射動(dòng)態(tài)引用托管類型而不是通過(guò)代碼中的靜態(tài)引用時(shí),這可能會(huì)導(dǎo)致問(wèn)題。如果您需要通過(guò)反射訪問(wèn)類型,則可能還需要設(shè)置link.xml文件以保留這些類型。有關(guān)link.xml文件的更多信息,請(qǐng)參閱iOS Build size optimization (iOS上的文檔頁(yè)面生成大小優(yōu)化)。
Moving build output files 移動(dòng)構(gòu)建輸出文件
要更改Build文件夾的位置,請(qǐng)?jiān)趇ndex.html文件中更改JSON文件的URL(UnityLoader.instantiate的第二個(gè)參數(shù))。
要更改Build文件夾內(nèi)文件的位置,請(qǐng)?jiān)贘SON文件中更改它們的URL(即dataUrl,asmCodeUrl,asmMemoryUrl和asmFrameworkUrl)。 JSON文件中的所有非絕對(duì)URL都被視為相對(duì)于JSON文件位置的URL。如果要在內(nèi)容分發(fā)網(wǎng)絡(luò)(CDN)上托管文件,則可以在外部服務(wù)器上指定這些URL,但需要確保托管服務(wù)器已啟用跨源資源共享(CORS)才能使其運(yùn)行。有關(guān)CORS的更多信息,請(qǐng)參閱WebGL networking(WebGL網(wǎng)絡(luò)上的手冊(cè)頁(yè))。
Incremental builds 增量構(gòu)建
IL2CPP為您的項(xiàng)目生成的C++代碼是逐步編譯的;也就是說(shuō),只有生成的C++代碼自上次構(gòu)建后再次編譯后發(fā)生了更改。未更改的源代碼重新使用為以前的版本生成的相同的目標(biāo)文件。用于增量C++構(gòu)建的對(duì)象文件存儲(chǔ)在Unity項(xiàng)目的Library/il2cpp_cache目錄中。
要執(zhí)行一個(gè)干凈的,從頭開始構(gòu)建生成的不使用增量編譯的C++代碼,請(qǐng)刪除Unity項(xiàng)目中的Library/il2cpp_cache目錄。請(qǐng)注意,如果Unity編輯器版本與先前的WebGL版本不同,Unity會(huì)自動(dòng)執(zhí)行干凈的從頭構(gòu)建。
Unity WebGL 中文文檔 Unity 2018.1.b
1. WebGL
2. webGL Browser Compatibility
3. Building and running a WebGL project
4. WebGL: Deploying compressed builds
5. Debugging and trouble shooting WebGL builds
6. WebGL Graphics
7. WebGL Networking
8. Using Audio In WebGL
9. WebGL performance considerations
10. WebGL: Interacting with browser scripting
11. Using WebGL Templates
12. Cursor locking and full-screen mode in WebGL
13. Input in WebGL