tech

Vue.js로 크롬 확장 프로그램 만들기 강의 - 1부

제가 최근 우연히 크롬 확장 프로그램을 개발했는데, 이게 생각보다 꽤 괜찮은 시장이라는 걸 알게 되었습니다.

크롬 확장 프로그램은 이미 여러분들에게 익숙한 웹 기술로 쉽게 개발할 수 있고, ReactVue같은 SPA 방식의 프레임워크에 매우매우 잘 어울립니다. 심지어 최초 한 번만 5달러를 지불하면, 평생 무료로 앱 배포가 가능합니다.

때문에 이 강의를 계기로 더욱 많은 사람들이 확장 프로그램을 만들었으면 좋겠다는 취지로 이 강의를 만들게 되었습니다.

저는 이 강의에서 등장하는 모든 기술들을 최대한 기초부터 다룰 예정입니다. 이 강의를 끝까지 잘 따라하신다면 이제 막 웹 개발을 시작하시는 분들에게 굉장히 많은 도움이 될겁니다.

하지만 여기서 다루는 Vue나 Webpack 같은 도구들이 완전 초보자용은 아니라서 많이 어려울 수 있습니다만, 최대한 쉽게 설명해보도록 하겠습니다.

아 그리고 현재는 리눅스 명령어로만 강의를 진행하므로, WindowsOS 사용자 분들은 bash 커맨드를 입력할 수 있는 환경을 구성해주세요.

프로젝트 기획하기

본격적으로 코드를 작성하기에 앞서, 어떤 확장 프로그램을 만들지 기획을 먼저 해보도록 하겠습니다.

만들고 싶은 앱을 정한 뒤에, 필요한 내용들을 하나씩 배워나가는 게 가장 학습 효과가 좋기 때문입니다. 뭐든지 목표가 있어야 열심히 하게 되니까요.

그래서 뭘 만들어볼지 이것저것 고민을 많이 했는데, 가상화폐 시세 보는 앱을 만들어볼까합니다.

이유는 간단합니다. 무료로 데이터를 제공해주는 API가 있기 때문이죠. 공부할 땐 이게 최고입니다.

사전 준비

프로젝트를 구성하기 전에, 몇 가지 프로그램들을 여러분의 컴퓨터에 설치해야합니다.

  1. Node.js가 설치되어 있어야 합니다. 현재 Long Term Support (LTS)인 14 버전 이상을 권장드립니다. Node.js를 정상적으로 설치하게 되면, 터미널에서 node 명령어와 npm 명령어를 사용할 수 있게 됩니다.

  2. 코드를 더욱 쉽게 작성하기 위한 코드 에디터가 필요합니다. 저는 VSCode를 사용합니다.

  3. 확장 프로그램을 테스트 할 브라우저가 필요합니다. 저는 이 강의에서 Chrome 브라우저를 사용하겠습니다.

프로젝트 구성하기

설치가 잘 되셨다면 프로젝트를 생성하고 싶은 곳에 폴더를 생성해줍시다. 저는 vue-extension으로 하겠습니다.

Terminal 응용 프로그램을 켜서 아래 명령어를 입력해주세요.

bash
$ mkdir vue-extension
$ cd vue-extension
$ npm init -y

참고로 각 줄 맨 앞에 $ 기호는 실제로 입력하는 글자는 아닙니다. 그냥 해당 명령어가 bash 커맨드라는 걸 표기하기 위해 붙입니다.

위 명령어들을 처음 보시더라도 당황하지 마세요. 설명해드리겠습니다.

  • mkdir [폴더명]: [폴더명]으로 폴더 생성
  • cd [폴더명]: [폴더명]으로 디렉토리 이동
  • npm: Node.js를 설치하면 자동으로 설치되는 노드 패키지 매니저입니다. 일단은 몰라도 됩니다.

위 명령어들 모두 현재 디렉토리를 기준으로 작동하게 됩니다. 참고하세요.

여기서 가장 마지막 npm init은 Node 프로젝트를 현재 디렉토리에 만들겠다는 뜻인데, 명령어를 입력해보면 몇 가지를 귀찮게 계속 물어보게 됩니다. 하지만 -y를 같이 넣어주면 그 질문들을 모두 yes로 하겠다는 뜻입니다.

이렇게 구성하면 여러분들의 폴더 구조는 이렇습니다.

|- vue-extension/
|-- package.json

일단 package.json에 대해 알아보기 전에, 우리에게 UI를 보여줄 HTML 파일을 먼저 만들어보겠습니다. 시작부터 뭐라도 눈에 보여야 더 재밌거든요.

첫 화면 만들기

bash
$ touch index.html

touch는 현재 디렉토리에 [파일명]으로 파일을 생성하겠다는 뜻입니다.

자, 그러면 우리의 첫 화면을 보여줄 html 파일을 생성했습니다. 파일명을 index로 짓는 건, 우리 프로젝트 폴더를 배포할 때 컴퓨터가 index.html 이라는 파일을 가장 먼저 찾기 때문입니다.

그럼 바로 html 코드를 작성하겠습니다.

index.html
<!DOCTYPE html>
<html lang="ko">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />

    <title>
      Vue extension
    </title>
  </head>

  <body>
    <div>
      <h1>Hello, world!</h1>
    </div>
  </body>
</html>

html 별 거 없습니다. <>으로 열어주면, </> 으로 닫는다, 이것만 기억하세요.

아무튼 이 파일을 찾아서 실행시켜주면, 현재 사용하고 있는 기본 브라우저가 자동으로 이 html 파일을 읽어 화면에 보여주게 됩니다.

방금 작성한 HTML 파일의 head 안에 title 부분은 페이지의 제목이 됩니다. 보통 브라우저는 해당 페이지의 제목을 위 사진처럼 탭에 표시해줍니다.

그리고 이 제목은 구글이나 네이버 등 검색 엔진이 검색 결과를 보여줄 때 가장 높은 점수를 주는 항목입니다. 알아두세요.

manifest.json

우리가 만들고 싶은 건 확장 프로그램입니다. 웹사이트가 아닙니다.

확장 프로그램을 만들기 위해선 프로젝트에 manifest.json 이라는 파일이 있어야 합니다. 크롬, 웨일, 엣지 등 크로미움 기반 브라우저라면 모두 이 파일 하나로 확장 프로그램을 실행시킬 수 있습니다.

json 파일은 {} 안에 원하는 값들을 넣어주는 단순 데이터를 저장하는 포맷입니다. 예시를 보시죠.

{
  "key1": "value1",
  "key2": {
    "key2-1": "value2-1",
    "key2-2": "value2-2"
    // ...
  }
}

왼쪽에는 키를, 오른쪽엔 값을 넣으면 됩니다.

이후 어떤 값을 찾으려고 할 때, 왼쪽에 있는 key를 이용해 원하는 value를 찾게 됩니다. json 파일은 이게 다입니다. 너무 쉽죠?

현재 아주 많은 곳에서 쓰이고, 데이터를 저장하는 아주 중요한 포맷이니 기억해두세요.

json에 대해 간략히 배웠으니, 아까 배운 touch를 이용해 파일을 만들어봅시다.

bash
touch manifest.json

물론 폴더에 마우스 우클릭해서 파일을 만들어 줄 수도 있지만, 검은 화면에 리눅스 명령어를 입력하는 것에 익숙해져보세요. 나중에 큰 도움이 됩니다.

아무튼 확장 프로그램을 구성하겠다는 설정 파일인 이 manifest.json 파일은, 버전이라는 게 있습니다.

현재 최신 버전은 3이고, 이 버전으로 작성된 확장 프로그램은 올해 1월부터 크롬 웹스토어에 정식 등록이 가능합니다.

지금 당장 자신이 만들 프로그램이 크롬 웹스토어에만 올라갈 예정이라면, 버전 3으로 작성해도 됩니다.

하지만 웨일 등 다른 브라우저의 자체 스토어에도 올릴 예정이라면, 버전 2로 작성해야합니다.

이유는 manifest version 3 (MV3)Chrome 88 버전 이상에서만 동작하기 때문입니다. 최신 버전의 웨일은 현재 88 버전 아래이기 때문에 MV3로 작성한 확장 프로그램은 인식하지 못합니다.

Manifest V3 is available beginning with Chrome 88, and the Chrome Web Store begins accepting MV3 extensions in January 2021.

MV2로 작성한다고 해서 크롬 웹스토어에 올리지 못하는 건 아닙니다. 하지만 언제까지 MV2 앱 제출을 허용해줄지 모르기 때문에, 자신의 프로젝트 상황에 맞게 버전을 선택하세요.

어쨌든 바로 manifest.json을 작성해보도록 하겠습니다.

manifest.json
{
  "name": "Vue extension",
  "description": "My extension app made by Vue.js",
  "version": "0.0.1",
  "manifest_version": 3,
  "action": {
    "default_popup": "index.html"
  }
}

namedescription 부분은 이후 앱 배포시 웹 스토어에 노출, 검색되는 가장 중요한 항목이므로, 앱을 잘 소개하는 문구로 작성하세요.

action.default_popup 은 확장 프로그램을 눌렀을 때, 기본적으로 뜨게 될 팝업 창입니다. 우리는 아까 만들었던 index.html 파일을 지정하면 됩니다.

자, 여기까지 하면 끝입니다. 이제 우리 프로젝트가 확장 프로그램으로써 역할을 하는 겁니다. 별 거 없죠?

테스트를 위해 브라우저에 chrome://extensions를 복사, 붙여넣기 해서 확장 프로그램 관리 페이지로 이동합니다.

여기서 오른쪽 상단 개발자 모드를 활성화 하면 3개의 버튼이 생깁니다.

여기에 압축해제된 확장 프로그램을 로드합니다. 버튼을 눌러 우리 프로젝트인 vue-extension을 선택해주세요.

그럼 테스트 가능한 상태가 되며, 확장 프로그램을 눌러보면 우리가 작성한 index.html 페이지가 보입니다.

다만 확장 프로그램은 브라우저에 띄우는 것과는 달리, 브라우저 위에 작게 뜨는 형태라 큰 사이즈로 보이진 않습니다.

직접 설정하더라도, 최대로 설정 가능한 폭은 width: 800px, 높이는 height: 600px 입니다. 그 이상의 크기는 무시됩니다.

1부 마무리

여기까지 웹 페이지를 구성하는 html, 데이터를 저장하는 포맷인 json과 크롬 확장 프로그램을 구성하는 설정 파일인 manifest.json 대해 아주 간략하게 배웠습니다.