지난여름에는 SONAR라는 상업용 WebGL 게임의 기술 리드로 일했습니다. 이 프로젝트는 완료하는 데 약 3개월이 걸렸으며 JavaScript로 완전히 처음부터 진행했습니다. SONAR를 개발하는 동안 Google은 테스트되지 않은 새로운 HTML5 환경에서 여러 문제에 대한 혁신적인 솔루션을 찾아야 했습니다. 특히 플레이어가 게임을 시작할 때 70MB 이상의 게임 데이터를 다운로드하고 캐시하는 방법을 묻는 간단한 문제에 대한 해결책이 필요했습니다.
다른 플랫폼에는 이 문제에 대한 즉시 사용 가능한 솔루션이 있습니다. 대부분의 콘솔 및 PC 게임은 로컬 CD/DVD 또는 하드 드라이브에서 리소스를 로드합니다. Flash는 게임이 포함된 SWF 파일의 일부로 모든 리소스를 패키징할 수 있으며 Java는 JAR 파일로 동일한 작업을 할 수 있습니다. Steam이나 App Store와 같은 디지털 배포 플랫폼은 플레이어가 게임을 시작하기 전에 모든 리소스가 다운로드되고 설치되도록 합니다.
HTML5는 이러한 메커니즘을 제공하지 않지만 자체 게임 리소스 다운로드 시스템을 빌드하는 데 필요한 모든 도구를 제공합니다. 자체 시스템을 구축하면 필요한 모든 제어 기능과 유연성을 확보하고 요구사항에 정확히 부합하는 시스템을 구축할 수 있습니다.
검색
리소스 캐싱이 전혀 없던 시절에는 간단한 체인 리소스 로더가 있었습니다. 이 시스템을 사용하면 상대 경로로 개별 리소스를 요청할 수 있었고, 이는 더 많은 리소스를 요청할 수 있다는 의미였습니다. 로딩 화면에는 로드해야 하는 데이터의 양을 측정하는 간단한 진행률 표시기가 표시되었으며, 리소스 로더 대기열이 비어 있어야 다음 화면으로 전환되었습니다.
이 시스템의 설계를 통해 패키지 리소스와 로컬 HTTP 서버를 통해 제공되는 느슨한 (패키지되지 않은) 리소스 간에 쉽게 전환할 수 있었으며, 이는 게임 코드와 데이터를 모두 빠르게 반복할 수 있도록 하는 데 매우 중요한 역할을 했습니다.
다음 코드는 오류 처리와 더 고급 XHR/이미지 로드 코드를 삭제하여 가독성을 유지한 연결된 리소스 로더의 기본 설계를 보여줍니다.
function ResourceLoader() {
this.pending = 0;
this.baseurl = './';
this.oncomplete = function() {};
}
ResourceLoader.prototype.request = function(path, callback) {
var xhr = new XmlHttpRequest();
xhr.open('GET', this.baseurl + path);
var self = this;
xhr.onreadystatechange = function() {
if (xhr.readyState == 4 && xhr.status == 200) {
callback(path, xhr.response, self);
if (--self.pending == 0) {
self.oncomplete();
}
}
};
xhr.send();
};
이 인터페이스의 사용은 매우 간단하지만 상당히 유연합니다. 초기 게임 코드는 초기 게임 레벨과 게임 객체를 설명하는 일부 데이터 파일을 요청할 수 있습니다. 예를 들어 간단한 JSON 파일일 수 있습니다. 이러한 파일에 사용되는 콜백은 데이터를 검사하고 종속 항목에 대한 추가 요청 (연결된 요청)을 할 수 있습니다. 게임 객체 정의 파일에 모델과 재질이 나열될 수 있으며, 재질 콜백에서 텍스처 이미지를 요청할 수 있습니다.
기본 ResourceLoader 인스턴스에 연결된 oncomplete 콜백은 모든 리소스가 로드된 후에만 호출됩니다. 게임 로딩 화면은 다음 화면으로 전환되기 전에 해당 콜백이 호출될 때까지 기다리면 됩니다.
물론 이 인터페이스로 훨씬 더 많은 작업을 할 수 있습니다. 독자를 위한 연습으로, 조사해 볼 만한 몇 가지 추가 기능은 진행률/백분율 지원 추가, 이미지 로드 추가 (이미지 유형 사용), JSON 파일 자동 파싱 추가, 오류 처리입니다.
이 도움말에서 가장 중요한 기능은 요청하는 파일의 소스를 쉽게 전환할 수 있는 baseurl 필드입니다. URL에서 ?uselocal 유형의 쿼리 매개변수를 허용하도록 핵심 엔진을 설정하여 매개변수가 설정되지 않은 경우 캐시 시스템을 사용하는 동시에 게임의 기본 HTML 문서를 제공한 동일한 로컬 웹 서버 (예: python -m SimpleHTTPServer)에서 제공하는 URL의 리소스를 요청할 수 있습니다.
패키징 리소스
리소스의 연결된 로딩의 한 가지 문제는 모든 데이터의 전체 바이트 수를 가져올 방법이 없다는 것입니다. 이로 인해 다운로드에 대한 간단하고 안정적인 진행률 대화상자를 만들 수 없습니다. 모든 콘텐츠를 다운로드하고 캐시해야 하므로 큰 게임의 경우 시간이 꽤 오래 걸릴 수 있습니다. 따라서 플레이어에게 멋진 진행 상황 대화상자를 제공하는 것이 매우 중요합니다.
이 문제를 가장 쉽게 해결하는 방법 (다른 유용한 이점도 있음)은 모든 리소스 파일을 단일 번들로 패키징하는 것입니다. 그러면 단일 XHR 호출로 다운로드할 수 있으며, 이를 통해 멋진 진행률 표시줄을 표시하는 데 필요한 진행률 이벤트를 얻을 수 있습니다.
맞춤 번들 파일 형식을 빌드하는 것은 그리 어렵지 않으며 몇 가지 문제를 해결할 수도 있지만 번들 형식을 만드는 도구를 만들어야 합니다. 대안은 도구가 이미 있는 기존 보관 파일 형식을 사용한 다음 브라우저에서 실행할 디코더를 작성하는 것입니다. HTTP는 gzip 또는 deflate 알고리즘을 사용하여 데이터를 압축할 수 있으므로 압축된 보관 파일 형식이 필요하지 않습니다. 이러한 이유로 TAR 파일 형식을 선택했습니다.
TAR은 비교적 간단한 형식입니다. 모든 레코드 (파일)에는 512바이트 헤더가 있으며, 그 뒤에 512바이트로 패딩된 파일 콘텐츠가 있습니다. 헤더에는 목적에 맞는 관련 필드나 흥미로운 필드가 몇 개만 있으며, 주로 파일 유형과 이름이 헤더 내의 고정된 위치에 저장됩니다.
TAR 형식의 헤더 필드는 헤더 블록의 고정된 위치에 고정된 크기로 저장됩니다. 예를 들어 파일의 마지막 수정 타임스탬프는 헤더 시작부터 136바이트에 저장되며 길이는 12바이트입니다. 모든 숫자 필드는 ASCII 형식으로 저장된 8진수로 인코딩됩니다. 필드를 파싱하기 위해 배열 버퍼에서 필드를 추출하고 숫자 필드의 경우 원하는 8진수 베이스를 나타내는 두 번째 매개변수를 전달하여 parseInt()를 호출합니다.
가장 중요한 필드 중 하나는 type 필드입니다. 레코드에 포함된 파일의 유형을 나타내는 한 자리 8진수입니다. 여기서는 일반 파일 ('0')과 디렉터리 ('5')라는 두 가지 레코드 유형만 고려합니다. 임의의 TAR 파일을 다루는 경우 심볼릭 링크 ('2')와 하드 링크 ('1')도 고려할 수 있습니다.
각 헤더 뒤에는 헤더로 설명된 파일의 콘텐츠가 바로 이어집니다 (디렉터리와 같이 자체 콘텐츠가 없는 파일 유형 제외). 파일 콘텐츠 다음에는 모든 헤더가 512바이트 경계에서 시작되도록 패딩이 추가됩니다. 따라서 TAR 파일의 파일 레코드 전체 길이를 계산하려면 먼저 파일의 헤더를 읽어야 합니다. 그런 다음 헤더에서 추출한 파일 콘텐츠의 길이에 헤더 길이 (512바이트)를 더합니다. 마지막으로 오프셋이 512바이트에 정렬되도록 필요한 패딩 바이트를 추가합니다. 이는 파일 길이를 512로 나누고, 숫자의 상한을 취한 다음 512를 곱하여 쉽게 수행할 수 있습니다.
// Read a string out of an array buffer with a maximum string length of 'len'.
// state is an object containing two fields: the array buffer in 'buffer' and
// the current input index in 'index'.
function readString (state, len) {
var str = '';
// We read out the characters one by one from the array buffer view.
// this actually is a lot faster than it looks, at least on Chrome.
for (var i = state.index, e = state.index + len; i != e; ++i) {
var c = state.buffer[i];
if (c == 0) { // at NUL byte, there's no more string
break;
}
str += String.fromCharCode(c);
}
state.index += len;
return str;
}
// Read the next file header out of a tar file stored in an array buffer.
// state is an object containing two fields: the array buffer in 'buffer' and
// the current input index in 'index'.
function readTarHeader (state) {
// The offset of the file this header describes is always 512 bytes from
// the start of the header
var offset = state.index + 512;
// The header is made up of several fields at fixed offsets within the
// 512 byte block allocated for the header. fields have a fixed length.
// all numeric fields are stored as octal numbers encoded as ASCII
// strings.
var name = readString(state, 100);
var mode = parseInt(readString(state, 8), 8);
var uid = parseInt(readString(state, 8), 8);
var gid = parseInt(readString(state, 8), 8);
var size = parseInt(readString(state, 12), 8);
var modified = parseInt(readString(state, 12), 8);
var crc = parseInt(readString(state, 8), 8);
var type = parseInt(readString(state, 1), 8);
var link = readString(state, 100);
// The header is followed by the file contents, then followed
// by padding to ensure that the next header is on a 512-byte
// boundary. advanced the input state index to the next
// header.
state.index = offset + Math.ceil(size / 512) * 512;
// Return the descriptor with the relevant fields we care about
return {
name : name,
size : size,
type : type,
offset : offset
};
};
기존 TAR 리더를 찾아봤는데 몇 개를 찾았지만 다른 종속 항목이 없거나 기존 코드베이스에 쉽게 맞지 않았습니다. 그래서 직접 작성하기로 했습니다. 또한 로딩을 최대한 최적화하고 디코더가 보관 파일 내에서 바이너리 데이터와 문자열 데이터를 모두 쉽게 처리할 수 있도록 했습니다.
해결해야 했던 첫 번째 문제 중 하나는 XHR 요청에서 데이터를 실제로 로드하는 방법이었습니다. 원래는 '바이너리 문자열' 접근 방식으로 시작했습니다. 아쉽게도 바이너리 문자열을 ArrayBuffer와 같이 더 쉽게 사용할 수 있는 바이너리 형식으로 변환하는 것은 간단하지 않으며 이러한 변환이 특히 빠른 것도 아닙니다. Image 객체로 변환하는 것도 마찬가지로 고통스럽습니다.
XHR 요청에서 직접 ArrayBuffer로 TAR 파일을 로드하고 ArrayBuffer에서 문자열로 청크를 변환하는 작은 편의 함수를 추가하기로 했습니다. 현재 내 코드는 기본 ANSI/8비트 문자만 처리하지만 브라우저에서 더 편리한 변환 API를 사용할 수 있게 되면 이 문제를 해결할 수 있습니다.
이 코드는 ArrayBuffer를 간단히 스캔하여 레코드 헤더를 파싱합니다. 레코드 헤더에는 모든 관련 TAR 헤더 필드 (및 관련성이 없는 필드 몇 개)와 ArrayBuffer 내 파일 데이터의 위치 및 크기가 포함됩니다. 코드는 선택적으로 데이터를 ArrayBuffer 뷰로 추출하여 반환된 레코드 헤더 목록에 저장할 수도 있습니다.
이 코드는 https://github.com/subsonicllc/TarReader.js에서 친근하고 허용적인 오픈소스 라이선스에 따라 자유롭게 사용할 수 있습니다.
FileSystem API
실제로 파일 콘텐츠를 저장하고 나중에 액세스하기 위해 FileSystem API를 사용했습니다. 이 API는 비교적 새 API이지만 훌륭한 HTML5 Rocks FileSystem 도움말을 비롯한 몇 가지 유용한 문서가 이미 있습니다.
FileSystem API에는 주의사항이 있습니다. 한 가지 이유는 이벤트 기반 인터페이스이기 때문입니다. 이로 인해 API가 비차단되어 UI에는 좋지만 사용하기가 어렵습니다. WebWorker에서 FileSystem API를 사용하면 이 문제를 완화할 수 있지만, 전체 다운로드 및 압축 해제 시스템을 WebWorker로 분할해야 합니다. 이 방법이 가장 좋을 수도 있지만 시간 제약 (WorkWorkers에 아직 익숙하지 않음)으로 인해 이 방법을 사용하지 않았으므로 API의 비동기 이벤트 기반 특성을 처리해야 했습니다.
Google의 요구사항은 주로 디렉터리 구조에 파일을 쓰는 데 중점을 둡니다. 이를 위해서는 각 파일에 대해 일련의 단계를 거쳐야 합니다. 먼저 파일 경로를 가져와 목록으로 변환해야 합니다. 이는 항상 URL과 같은 슬래시인 경로 구분자 문자로 경로 문자열을 분할하면 쉽게 할 수 있습니다. 그런 다음 결과 목록에서 마지막 요소를 제외한 각 요소를 반복하여 로컬 파일 시스템에 디렉터리를 재귀적으로 생성해야 합니다 (필요한 경우). 그런 다음 파일을 만들고 FileWriter을 만든 후 파일 콘텐츠를 작성할 수 있습니다.
두 번째로 고려해야 할 중요한 사항은 FileSystem API의 PERSISTENT 저장소의 파일 크기 제한입니다. 사용자가 게임을 플레이하는 도중에 강제 종료된 파일을 로드하려고 하기 직전 등 언제든지 임시 저장소가 삭제될 수 있으므로 영구 저장소가 필요했습니다.
Chrome 웹 스토어를 타겟팅하는 앱의 경우 애플리케이션의 매니페스트 파일에서 unlimitedStorage 권한을 사용할 때 저장소 제한이 없습니다. 하지만 일반 웹 앱은 실험용 할당량 요청 인터페이스를 사용하여 공간을 요청할 수 있습니다.
function allocateStorage(space_in_bytes, success, error) {
webkitStorageInfo.requestQuota(
webkitStorageInfo.PERSISTENT,
space_in_bytes,
function() {
webkitRequestFileSystem(PERSISTENT, space_in_bytes, success, error);
},
error
);
}