Compiling from Rust to WebAssembly

You’re reading the English version of this content since no translation exists yet for this locale. Help us translate this article!

여러분이 Rust 코드를 가지고 있다면 WebAssembly로 컴파일 할 수 있습니다. 이 튜토리얼은 Rust 프로젝트를 컴파일하여 기존 웹 애플리케이션에서 사용하기 위해 알아야 할 모든 것을 설명합니다.

Rust and WebAssembly use cases

Rust와 WebAssembly를 위한 두가지 주요 use-case가 있습니다.

  • 어플리케이션 전체를 만드는것 - Rust기반 Web app 만들기
  • 어플리케이션의 일부를 만드는것 - Rust를 기존에 존재하는 JavaScript frontend에서 사용하는것

당분간, Rust 팀은 후자의 경우에 초점을 맞출 것입니다.그래서 여기서는 두번째 내용에 대해 다루겠습니다. 첫번째 use-case는 yew와 같은 프로젝트를 한번 확인해보세요.

이 튜토리얼에서는 Rust의 npm 패키지를 빌드하는 도구인 wasm-pack을 사용하여 npm 패키지를 빌드합니다. 이 패키지에는 WebAssembly 및 JavaScript 코드만 포함되므로 패키지 사용자는 Rust를 설치할 필요가 없습니다. 심지어 WebAssembly에서 작성된 것임을 알지 못할 수도 있습니다.

Rust 환경 설치

환경을 설치하기 위해 필요한 모든 단계를 수행해 봅시다.

Rust 설치

Install Rust와 다음 설명에 따라 Rust를 설치합니다. "rustup"이라는 툴을 설치할건데 다양한 버전의 Rust를 관리할 수 있게 해줍니다. 기본적으로 최신 배포버전의 Rust가 설치됩니다. Rustup은 Rust 컴파일러인 rustc Rust의 표준 라이브러리 인 rust-std, Rust의 패키지 메니저 cargorust-docs 등 유용한 문서를 설치합니다.

Note: 설치를 완료한 뒤 cargo의 bin 디렉토리가 시스템의 PATH에 등록되어 있어야 함에 주의하십시오. 보통은 자동으로 등록되지만, 터미널을 재시작해야 할 수도 있습니다.

wasm-pack

패키지를 빌드하기 위해, wasm-pack이라는 추가적인 툴이 필요합니다. 이것을 통해 코드를 WebAssembly로 컴파일하고, npm에 적합한 패키징을 생성할 수 있습니다. 설치를 하려면 터미널에 다음 명령을 입력합니다.

$ cargo install wasm-pack

Node.js 설치와 npm 계정 생성

이 튜토리얼에서 우리는 npm 패키지를 생성할 것이므로 Node.js와 npm이 설치되어 있어야 합니다. 추가적으로, 우리는 npm에 패키지를 배포할 것이며 npm 계정 역시 필요합니다. 이것들은 모두 무료입니다. 당신은 기술적으로는 패키지를 배포할 필요가 없지만, 패키지를 사용하는 것이 더 쉬우므로 이 튜토리얼에서 수행한다고 가정합니다.

Node.js와 npm을 설치하려면 Get npm! 페이지를 열고 안내를 따라하시면 됩니다. 버전을 선택할 때, 원하는 것을 선택하면 됩니다. 이 튜토리얼은 버전과는 무관합니다.

npm 계정을 만드려면 npm 가입 페이지 에서 양식을 작성하시면 됩니다.

그 다음은, 명령줄에서 npm adduser 명령을 실행합니다.

$ npm adduser
Username: yournpmusername
Password:
Email: (this IS public) you@example.com

계정명과 패스워드, 그리고 이메일을 입력하세요. 제대로 작동했다면, 다음 출력을 볼 수 있습니다.

Logged in as yournpmusername on https://registry.npmjs.org/.

만약 제대로 되지 않았다면, 문제 해결을 위해 npm에 문의를 해보세요.

WebAssembly npm 패키지 빌드하기

설치가 다 되었으므로, Rust의 새 패키지를 만듭시다. 개인 프로젝트를 담는 디렉터리로 이동한 뒤, 다음 명령어를 입력합니다.

$ cargo new --lib hello-wasm
     Created library `hello-wasm` project

이 명령어는 hello-wasm으로 이름지어진 하위 디렉터리에 새 라이브러리를 생성합니다.

+-- Cargo.toml
+-- src
    +-- lib.rs

첫번째로, Cargo.toml은 빌드를 위해 설정하는 파일입니다. Bundler에서 Gemfile이나 npm에서 package.json을 써보셨다면 꽤 익숙할 것입니다. Cargo는 이것들과 비슷한 방식으로 작동합니다.

다음은, Cargo가 src/lib.rs에 다음 Rust 코드를 생성했을 것입니다.

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}

우리는 이 테스트 코드를 사용하지 않을 것이므로, 삭제해도 좋습니다.

Rust로 무언가를 써보기

src/lib.rs에 다음 코드를 적어봅시다.

extern crate wasm_bindgen;

use wasm_bindgen::prelude::*;

#[wasm_bindgen]
extern {
    pub fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet(name: &str) {
    alert(&format!("Hello, {}!", name));
}

이것은 우리의 Rust project의 내용으로, 세가지 주요 부분이 있습니다. 그들에 대해 차례대로 얘기해봅시다. 여기서는 고수준의 설명을 제공하고 일부 세부 사항에 대해서 설명합니다. Rust 언어에 대해 좀 더 배우고 싶으시면 The Rust Programming Language 에서 확인하시면 됩니다.

Rust와 JavaScript간의 통신을 위한 wasm-bindgen 사용

첫 부분은 다음과 같습니다.

extern crate wasm_bindgen;

use wasm_bindgen::prelude::*;

첫 줄은 Rust에게 wasm_bindgen이라는 라이브러리를 사용할 것임을 알립니다. Rust에서 라이브러리는 크레이트(crate)라고 불리며, 외부 크레이트를 불러오려면 extern 키워드를 사용해야 합니다.

알 것 같나요? Cargo(화물) 는 배에 crate(상자) 들을 실어 나릅니다.

세번째 줄의 use 키워드는 라이브러리로부터 코드를 불러옵니다. 이 경우, 우리는 wasm_bindgen::prelude 모듈 내에 있는 모든 것을 불러오게 됩니다. 다음 섹션에서 이것들의 기능에 대해 다룰 것입니다.

다음 섹션으로 넘어가기 전에 wasm-bindgen에 대해 좀 더 얘기해야 합니다.

wasm-pack은 다른 도구인 wasm-bindgen을 사용해 JavaScript와 Rust의 타입들 사이에 다리를 제공합니다. 이는 JavaScript가 문자열을 통해 Rust의 API를 호출하거나, JavaScript의 예외를 포착하기 위해 Rust의 함수를 호출할 수 있습니다.

우리는 패키지에서 wasm-bindgen의 기능을 사용할 것입니다. 실은, 그것들은 다음 섹션에 있습니다.

Rust에서 JavaScript의 외부함수 호출

다음 부분은 이렇게 되어있을 것입니다.

#[wasm_bindgen]
extern {
    pub fn alert(s: &str);
}

#[ ] 안에 있는 것을 속성이라고 부르는데, 이것은 다음에 오는 구문을 수정합니다. 이 경우에, 그 구문은 extern이며, Rust에게 외부에 정의된 함수를 호출할 것임을 알립니다. 이 속성의 경우, "wasm-bindgen은 이 함수들을 어떻게 찾을 것인지 알고 있다"고 알리는 것입니다.

세번째 줄의 함수 시그니처는 Rust로 작성되어있습니다. alert 함수는 문자열 타입의 s 하나를 인자로서 받는다는 의미입니다.

짐작하셨듯이, 이것은 JavaScript에 의해 제공되는 alert 함수입니다. 다음 섹션에서 이 함수를 호출할 것입니다.

JavaScript 함수를 호출하고 싶을 때면 언제든지 이들을 파일에 추가할 수 있으며, `wasm-bindgen`이 당신을 위해 그 모든 것을 설정할 것입니다. 아직 모든 것이 지원되지는 않지만, 우리는 노력하고 있습니다. 빠진 것이 있다면, 버그를 제출해주십시오. 

JavaScript가 호출할 수 있는 Rust 함수 작성

마지막 부분은 여기 있습니다.

#[wasm_bindgen]
pub fn greet(name: &str) {
    alert(&format!("Hello, {}!", name));
}

#[wasm_bindgen] 속성이 한번 더 나왔습니다. 이번엔 extern 구문이 수정되는 대신, fn 구문이 수정됩니다. 이것은 Rust 함수를 JavaScript에 의해 호출될 수 있도록 함을 의미하며, extern 과는 반대 기능이 됩니다. 이것은 우리가 필요로 하는 기능이 아니라, 우리가 세상에 제공하는 기능이 될 것입니다.

이 함수의 이름은 greet이며, (&str 이라고 쓰여진) 문자열 타입의 name 하나를 인자로 갖습니다. 이것은 우리가 위에 있는 extern 블록에서 요구한 alert 함수를 호출하여, 문자열을 연결하는 format! 매크로를 전달합니다.

format!매크로는 이 경우에 서식 문자열과 변수를 두개의 인자로 받습니다. 서식 문자열은 "Hello, {}!" 입니다. 이것은 두번째 인자의 변수를 표시할 {}를 담고 있습니다. 변수의 경우 함수의 인자로 전달받은 name을 전달하므로, 우리가 greet("Steve")를 호출하였다면 매크로는 "Hello, Steve!"를 반환할 것입니다.

이것은 alert()에 인자로 전달되므로, 이 함수를 호출한다면 우리는 브라우저의 경고창에서 "Hello, Steve!"를 볼 수 있을 것입니다.

라이브러리가 모두 작성되었으므로, 빌드를 해봅시다.

작성된 코드를 WebAssembly로 컴파일

컴파일이 올바르게 되려면, 먼저 Cargo.toml에서 설정을 해줘야 합니다. 파일을 열면, 다음과 같은 내용이 있을 것입니다.

[package]
name = "hello-wasm"
version = "0.1.0"
authors = ["Your Name <you@example.com>"]
description = "A sample project with wasm-pack"
license = "MIT/Apache-2.0"
repository = "https://github.com/yourgithubusername/hello-wasm"

[lib]
crate-type = ["cdylib"]

[dependencies]
wasm-bindgen = "0.2"

리포지토리 이름을 작성하고, author 필드를 git이 사용하는 것과 같게 설정해주세요.

추가해야 할 커다란 부분은 아래에 있습니다. [lib] 섹션은 패키지를 cdylib 형식으로 빌드할 것이라고 Rust에게 알리는데, 이 튜토리얼에선 그 의미가 무엇인지 다루지 않을 것입니다. 자세한 설명은 Cargo 와 Rust Linkage 문서를 참조하십시오.

마지막의 [dependencies] 섹션에서, Cargo에게 어떤 버전의 wasm-bindgen에 의존하고 있는지 알립니다. 이 경우, 버전 0.2.z는 어떤 것이든 사용할 수 있지만, 0.3.0이상부터는 사용하지 않습니다.

패키지 빌드하기

모든 셋팅이 끝났으므로, 패키지를 빌드합시다. 터미널에 다음을 입력합니다.

$ wasm-pack build --scope mynpmusername

이 명령어를 입력하면 많은 일이 일어납니다. (그리고 특히 wasm-pack을 처음 실행했을 때 처럼 많은 시간이 걸립니다.) 이에 대한 자세한 사항을 알고 싶으면, Mozilla Hacks의 블로그 포스트를 확인해보세요. 간단히 요약하자면, wasm-pack build는:

  1. Rust 코드를 WebAssembly로 컴파일 합니다.
  2. 그 WebAssembly 위에서 wasm-bindgen을 실행하여, WebAssembly를 npm이 이해할 수 있는 모듈로 감싸는 JavaScript 파일을 생성합니다.
  3. pkg 디렉터리를 만들고 JavaScript 파일과 WebAssembly 코드를 그 안으로 옮깁니다.
  4. Cargo.toml을 읽고 동등한 package.json을 생성합니다.
  5. README.md가 있다면 패키지로 복사합니다.

빌드가 끝났다면, pkg 디렉터리에 npm 패키지가 생성될 것입니다.

코드 사이즈에 대한 오류

생성된 WebAssembly 코드의 크기를 확인해보면, 몇백 킬로바이트가 될 것입니다. 우리는 Rust에게 코드의 크기를 최적화하라고 지시하지 않았으며, 만약 그렇게 지시한다면 크기가 많이 줄어들 것입니다. 이것은 이 튜토리얼에서 다루는 내용을 벗어나지만, 자세한 내용을 보려면 Shrinking .wasm Size에 대한 Rust WebAssembly Working Group의 문서를 참조하십시오.

npm에 패키지 배포

npm에 우리의 새 패키지를 배포해봅시다.

$ cd pkg
$ npm publish --access=public

우리는 이제 Rust로 쓰여졌으나, WebAssembly로 컴파일된 npm 패키지를 갖고 있습니다. 이것은 JavaScript에 쓰일 수 있도록 준비되었으며, 다른 사용자들은 Rust를 설치할 필요가 없습니다. 왜냐하면 패키지에는 WebAssembly 코드만 포함되어있으며, Rust 소스는 없기 때문입니다.

Using the package on the web

우리의 새 패키지를 사용하는 웹사이트를 빌드해봅시다. 많은 사람들이 여러가지 번들러 도구를 사용해 npm패키지를 사용하는데, 이 튜토리얼에선 이들 중 하나인 webpack을 사용할 것입니다. 이것은 조금 복잡하고, 현실적인 사용 사례를 보여줄 것입니다.

pkg 와 hello-wasm 디렉터리를 빠져나가서, 다음처럼 site라는 이름의 새 디렉터리를 만들고 진입합니다.

$ cd ../..
$ mkdir site
$ cd site

package.json 이라는 이름의 새 파일을 만들어, 다음 코드를 작성합니다.

{
  "scripts": {
    "serve": "webpack-dev-server"
  },
  "dependencies": {
    "@mynpmusername/hello-wasm": "^0.1.0"
  },
  "devDependencies": {
    "webpack": "^4.25.1",
    "webpack-cli": "^3.1.2",
    "webpack-dev-server": "^3.1.10"
  }
}

dependencies 섹션에서 @ 뒤에 실제 npm 계정명을 넣어주세요.

그 다음은 Webpack을 설정해야 합니다. webpack.config.js 파일을 만든 뒤, 다음 코드를 작성합니다.

const path = require('path');
module.exports = {
  entry: "./index.js",
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "index.js",
  },
  mode: "development"
};

그리고 HTML 파일도 필요합니다. index.html을 만들고, 다음 내용을 작성합니다.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <title>hello-wasm example</title>
  </head>
  <body>
    <script src="./index.js"></script>
  </body>
</html>

마지막으로, HTML에서 참조되는 index.js를 만들어 다음 내용을 작성합니다.

const js = import("./node_modules/@yournpmusername/hello-wasm/hello_wasm.js");
js.then(js => {
  js.greet("WebAssembly");
});

npm 계정명을 한번 더 입력해야 합니다.

이것은 node_modules 폴더에 있는 새 모듈을 불러옵니다. 이것은 모범 사례로 여겨지진 않지만, 데모이므로 지금은 괜찮습니다. 모듈이 로드되었면, 모듈로부터 greet 함수를 호출하여 "WebAssembly" 를 문자열로서 전달합니다. 여기엔 특별한 것이 없지만, Rust 코드를 호출한 방법에 주목해주세요. JavaScript 코드가 알 수 있는 한, 이것은 그저 정상적인 모듈일 뿐입니다.

파일들을 모두 만들었으니, 한번 보도록 합시다.

$ npm install
$ npm run serve

이것은 간단한 웹 서버를 시작합니다. http://localhost:8080을 열면 화면에 Hello, WebAssembly! 라고 쓰여진 alert box가 나타납니다. 우리는 성공적으로 JavaScript로부터 Rust를, Rust로부터 JavaScript를 호출하였습니다.

결론

이것이 튜토리얼의 끝입니다. 우리는 당신이 이것이 쓸모있다는 것을 알게 되었길 기대합니다.

여기에 많은 흥미로운 작업이 진행되고 있습니다. 이것을 좀 더 낫게 만들고 싶다면, the Rust Webassembly Working Group을 확인해보세요.