Plusb Preco 30dfd54575 First translation

Translate docs to korean

2015-06-22 14:06:06 +09:00

5 KiB

Raw Blame History

어플리케이션 패키징

어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해, 약간의 구조 변경으로 어플리케이션을 asar 아카이브로 패키징 할 수 있습니다.

`asar` 아카이브 생성

asar아카이브는 tar과 비슷한 포맷으로 모든 리소스를 하나의 파일로 만듭니다. 그리고 Electron은 압축해제 없이 임의로 모든 파일을 읽어들일 수 있습니다.

다음 몇가지 단계를 통해 어플리케이션을 asar 아카이브로 압축할 수 있습니다:

1. asar 유틸리티 설치

$ npm install -g asar

2. `asar pack` 커맨드로 앱 패키징

$ asar pack your-app app.asar

`asar` 아카이브 사용하기

Electron은 두가지의 API를 가지고 있습니다: Node.js로 부터 제공된 Node API, Chromium으로부터 제공된 Web API. 두 API 모두 asar에서 읽어들일 수 있도록 지원합니다.

Node API

fs.readFile 와 require 같은 Node API들을 지원하기 위해 Electron에선 asar 아카이브가 가상의 디렉터리 구조를 가지도록 패치했습니다. 그래서 아카이브 내부에서 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다.

예를들어, /path/to라는 경로에 example.asar라는 아카이브가 있다고 가정하면:

$ asar list /path/to/example.asar
/app.js
/file.txt
/dir/module.js
/static/index.html
/static/main.css
/static/jquery.min.js

asar 아카이브에선 다음과 같이 파일을 읽을 수 있습니다:

var fs = require('fs');
fs.readFileSync('/path/to/example.asar/file.txt');

아카이브 내의 루트 디렉터리를 리스팅합니다:

var fs = require('fs');
fs.readdirSync('/path/to/example.asar');

아카이브 안의 모듈 사용하기:

require('/path/to/example.asar/dir/module.js');

BrowserWindow 클래스를 이용해 원하는 웹 페이지도 표시할 수 있습니다:

var BrowserWindow = require('browser-window');
var win = new BrowserWindow({width: 800, height: 600});
win.loadUrl('file:///path/to/example.asar/static/index.html');

Web API

웹 페이지 내에선, 아카이브 내의 파일을 file: 프로토콜을 사용하여 요청할 수 있습니다. 이 또한 Node API와 같이 가상 디렉터리 구조를 가집니다.

예를들어, jQuery의 $.get을 사용하여 파일을 가져올 수 있습니다:

<script>
var $ = require('./jquery.min.js');
$.get('file:///path/to/example.asar/file.txt', function(data) {
  console.log(data);
});
</script>

`asar` 아카이브를 일반 파일로 취급하기

asar 아카이브의 체크섬(checksum)등을 검사하기 위해선, asar 아카이브를 파일 그대로 읽어들여야 할 필요가 있습니다. 이 작업을 하기 위해 original-fs라고 하는 빌트인 모듈을 fs 모듈 대신에 사용할 수 있습니다. 이 모듈은 asar 지원이 빠져있습니다. 즉 파일 그대로를 읽어들입니다:

var originalFs = require('original-fs');
originalFs.readFileSync('/path/to/example.asar');

Node API의 한계

asar 아카이브를 Node API가 최대한 디렉터리 구조로 작동하도록 노력해왔지만, 여전히 저수준(low-level) Node API 때문에 한계가 있습니다.

Even though we tried hard to make asar archives in the Node API work like directories as much as possible, there are still limitations due to the low-level nature of the Node API.

아카이브는 읽기 전용입니다

아카이브는 수정할 수 없으며 기본적으로는 Node API로 파일을 수정할 수 있지만, asar 아카이브에선 작동하지 않습니다.

아카이브 안의 디렉터리를 작업 경로로 설정하면 안됩니다

asar 아카이브는 디렉터리처럼 사용할 수 있도록 구현되었지만, 그것은 실제 파일시스템의 디렉터리가 아닌 가상의 디렉터리입니다. 그런 이유로 몇몇 API에서 지원하는 cwd 옵션을 asar 아카이브 안의 디렉터리 경로로 지정하면 나중에 문제가 발생할 수 있습니다.

특정 API로 인한 예외적인 압축 해제

많은 fs API가 asar 아카이브의 압축을 해제하지 않고 바로 아카이브를 읽거나 정보를 가져올 수 있으나, 몇몇 API는 시스템의 실제 파일의 경로를 기반으로 작동하므로 이 API들을 사용할 땐 Electron은 이 API가 원할하게 작동할 수 있도록 하기 위해 임시경로에 해당 파일들의 압축을 해제합니다. 이 작업은 약간의 오버헤드를 불러 일으킬 수 있습니다.

해당하는 API 함수는 다음과 같습니다:

child_process.execFile
fs.open
fs.openSync
process.dlopen - Used by require on native modules

`fs.stat`의 잘못된 스테이터스

fs.stat 로 부터 반환되는 Stats 객체와 비슷한 API들은 asar 아카이브를 타겟으로 할 경우 가상의 예측된 정보를 가집니다. 왜냐하면 아카이브의 디렉터리 경로는 실제 파일시스템에 존재하지 않기 때문입니다. 그러한 이유로 파일 크기와 파일 타입 등을 확인할 때 Stats 객체를 신뢰해선 안됩니다.

Adding unpacked files in `asar` archive

전술한 바와 같이, 몇몇 Node API는 호출 시 해당 파일을 임시폴더에 압축을 해제합니다. 따로 성능문제가 발생할 수 있습니다. 그리고 백신 소프트웨어의 잘못된 오진을 일으킬 수도 있습니다.

이 문제를 해결하려면, --unpack 옵션을 활용하여 파일을 압축이 풀려진 상태로 유지해야 합니다. 다음의 예제는 node 네이티브 모듈의 공유 라이브러리를 unpack 상태로 유지합니다:

$ asar pack app app.asar --unpack *.node

커맨드를 실행한 후, 같은 디렉터리에 app.asar 파일 외에 app.asar.unpacked 폴더가 같이 생성됩니다. 이 폴더안에 unpack 옵션에서 설정한 파일들이 압축이 풀린 상태로 포함되어 있습니다. 유저에게 어플리케이션을 배포할 때 반드시 해당 폴더도 같이 배포하여야합니다.

5 KiB Raw Blame History