Addressables

ttps://docs.unity3d.com/Packages/com.unity.addressables@1.11/manual/index.html

Unity Addressable Asset system | Addressables | 1.11.2

 

Getting Started

1. 유니티에서 기존 Assetbundle Browser를 대체해 만든 bundle 관리 시스템
2. package manager를 통해 설치 가능(Addressables 검색)
3. 유니티의 ProjectView 에서 Object 선택시 Inspector 창에 Addressables라는 체크항목이 생겼음을 확인
4. 메뉴의 Windows -> Asset Management -> Addressables -> Groups 를 통해 번들 관리 가능

Overview

1. 기존에는 Inspector창 아랫 부분에서 AssetBundle dropdown을 통해 설정하거나, 별도의 script를 만들어 관리
2. Inspector에서 Addressables 를 체크하면 자동으로 Group창에 노출됨
3. 해당 항목은 Addressables Group 창에서 드래그를 통해 다른 Group에 포함시키거나 제외 시킬 수 있음

prefab을 Addressables 등록 

Architecture

1. Addressables Groups 창에는 Playmode가 있는데 각각 선택시마다 내부에서 처리하는 방식이 상이
   • 각 모드에 대한 특징은 위의 document 에 기술되어 있으므로 여기서는 각 모드가 어떻게 내부에서 번들을 관리하는지 설명
   • Use Asset Database(faster)
     • catalog path : Project Folder/Library/com.unity.addressables/catalog_BuildScriptFastMode.json
     • settings path :                                        ''                               /settings_BuildScriptFastMode.json
     • 번들을 빌드하지 않고, Entry Point를 통해 직접 접근하므로 Load가 빠르다(개발단계 유리)
   • Simulate Groups(advanced)
     • catalog path : Project Folder/Library/com.unity.addressables/catalog_BuildScriptVirtualMode.json
     • settings path :                                      ''                                 /settings_BuildScriptVirtualMode.json
     • 가상의 bundle을 빌드해서 그 bundle을 통해 Asset에 접근하는 방식으로, bundle간 dependency가 제대로 되어있는지, 모바일로 빌드했을때 참조 에러가 나지 않는지 editor 환경에서 bundle 참조확인이 가능하므로, 빌드 직전 리소스 테스트 단계에 유리
   • Use Existing Build(requires built groups)
     • 스크립트를 통해 빌드를 이미 수행했다는 전제하에, 물리적으로 존재하는 bundle을 직접 참조해서 Asset에 접근하는 방식
     • 개발 중 직접 bundle을 빌드해서 확인하고자 할떄 사용 (local build test에 유리)
     • catalog와 settings 파일은 빌드시에 Project Folder/Library/com.unity.addressables/StreamingAssetCopy/aa/[BuildTarget]에 만들어지므로 참조경로도 여기에 설정되어 있음
     • 이미 있는 bundle을 이용하는 모드이기 때문에 생성과정이 없으므로 실행시 가장 빠르다
2. 각 프로젝트마다 위의 mode를 사용하지 않아야 할 떄가 있다. 가령 서버에 올라가 있는 번들을 받아서 돌리고 싶을때나, 버전 관리를 위해 json파일에 버전을 추가한다거나 할때 script를 커스터마이징 해야 하는데 이를 위해 Addressables가 번들 로드시 참조하는 값이 무엇인지, 그리고 각 파일들이 어떻게 연결되어 있는지 파악해야 함
   • 가령 한 PC 에서 bundle빌드를 돌린다고 가정
   • Addressables Group 창에서 Build -> New Build -> Default Build Script를 실행
   • Project Folder/Library/com.unity.addressables/StreamingAssetCopy/aa/[BuildTarget] 에 settings.json, catalog.json, link.xml이 생성됨
     • settings.json
       1. 이 프로젝트가 참조해야 할 catalog파일이 어디 존재하는지 명시
       2. hash파일과 remote hash 파일이 어디 존재하는지 명시
       3. 기타 Addressables 관련 환경변수가 저장되어 있음
     • catalog.json
       1. 실질적인 bundle들의 정보로서 모든 addressables의 이름, 경로, Key, Resource Type 이 정의되어 있음
       2. 해당 파일을 이용하면 이전 catalog와의 diff를 통해 자제적으로 버전관리도 가능할 수준의 detail하고 substantial한 정보
     • link.xml
       1. 본 프로젝트가 참조하고 있는 모든 라이브러리의 정보를 담고 있음
       2. editor 환경에서는 사용되지 않고, 모바일 빌드시 library포함여부에 관여
   • 결국 settings.json과 catalog.json 파일만 잘 만들어준다면, Addressables 커스터마이징을 할 수 있다는 의미

Remote Version 관리

1. Remote Path
   • 서버의 catalog.json, catalog.hash 파일과 로컬의 catalog.json 파일을 비교해서 업데이트된bundle만 서버에서 선별해 받을 수 있는 Addressables Remote 시스템
2. Firebase 를 통한 Addressables Remote
   • 문서를 만들게 된 계기가 된 항목으로서 firebase에 bundle을 업로드 한 후 RemoteLoadPath에 gs:// 로 시작하는 링크를 연결시 파일을 받아오지 못하는 문제가 발생
   • 기본적으로 Unity는 http, https로 시작하는 주소만 remote path라고 인식을 하기 때문에 기존 Addressables 에 대한 커스터마이징이 필요하게 됨
   • 해결법
     • 문제 해결을 위해선 LoadAsset을 통한 bundle요청시 gs://로 시작하는 주소를 https://주소로 변환한 다음 서버에 요청하고 그 결과를 반환해줘야 함
     • Addressables 에서는 이를 위해 AssetbundleProvider라는 함수를 제공
       1. 단 위 함수는 Addressables Group의 bundle로드시에만 동작하는 함수이기 때문에 Addressables의 주요 기능인 DownloadDependencyAsync 함수를 쓰기 위해선 별도의 방법이 필요
       2. Addressables.InternalIdTransformFunc 함수는 provideHandle.ResourceManager.TransformInternalId 함수 호출시 타도록 Unity가 제공하는 API
          • 이름에서도 알 수 있듯 개발자들이 Provider 에서 TransformId를 입맛대로 수정이 용이하도록 제공한 함수로서 v.1.75부터 제공한다
       3. 이를 이용해 서버에 존재하는 .hash, .json 로드시에도 서버에 gs protocol을 날리기 전에 동작을 가로채어 변환후 넘겨줄 수 있다.
     • 사용법(여기는 소스코드가 있다고 가정하고 설명, 소스는 github에서 확인가능)
       1. Addressables의 각 그룹을 선택한 후 Advanced Options 를 열어 Assetbundle Provider를 firebase assetbundle provider로 바꾸기
       2. Firebase 초기화가 완료되는 시점에 ResourceManager에 추가한 Provider를 등록
       3. Addressables.InternalIdTransformFunc에 콜백 함수 등록
          1. Provider를 상속받은 3개의 Class 내부의 Provide() 함수 안에서 TransformInternalId() 함수를 호출해서 gs internal id -> https internal id 로 바꿔준다
3. Firebase가 아닌 서버에서 Addressables 의 Remote System을 적용하기 위한 코드 절차
   1. 서버로 요청하는 url이 https 가 아닌지 확인
   2. 총 3개의 Provider를 만들어 상속받기
      1. hash 파일을 위한 Provider (ResourceProviderBase 상속)
      2. catalog 파일을 위한 Provider (JsonAssetProvider 상속)
      3. bundle파일을 읽기 위한 Provider (AssetBundleProvider 상속)
   3. Addressables Group의 Inspector 창에서 Advanced Options -> Assetbundle Provider 항목에서 추가한 bundle provider 로 바꿔준다
   4. 사용하는 서버의 초기화 시점에서 추가한 Provider들을 등록해준다
      1. Addressables.ResourceManager.ResourceProviders.Add()
   5. Provider 함수 내부의 Provider() 를 override 해서 internal id 를 바꾼 후 provideHandle.ResourceManager.ProvideResource() 함수를 호출하고 Complete 성공 시 provideHandle.Complete() 를 호출해서 Unity에 넘겨준다