React 번들링과 웹팩

HanSungUk·2022년 7월 26일

React TIL

React

목록 보기

10/13

React 번들링과 웹팩

현재 코드스테이츠 강의를 통해 프론트엔드를 학습하고 있습니다.
본 포스트는 해당 강의에 대한 내용 정리를 목적으로 합니다.

학습목표

1. 번들링

번들링은 여러 제품이나 코드, 프로그램을 묶어서 패키지로 제공하는 행위를 의미합니다.
프론트엔드 개발에게 번들은 사용자에게 웹 애플리케이션을 제공하기 위한 파일 묶음입니다.

2. Webpack

Webpack이란 여러 개의 파일을 하나의 파일로 합쳐주는 모듈 번들러를 의미합니다. 모듈 번들러란 HTML, CSS, JavaScript 등의 자원을 전부 각각의 모듈로 보고 이를 조합해 하나의 묶음으로 번들링(빌드)하는 도구입니다.

모듈 번들러
모듈 번들러는 복잡성에 대응하기 위해 하나의 시작점(Ex. React App의 index.js 등)으로부터 의존성을 가지는 모듈을 모두 추적하여 하나의 결과물을 만들어냅니다.
빌드와 번들링
빌드는 개발이 완료된 앱을 배포하기 위해 하나의 폴더(directory)로 구성하여 준비하는 작업을 말합니다.
React앱을 기준으로 npm run build를 실행하면 React build 작업이 진행되고, index.html 파일에 압축되어 배포에 최적화된 상태를 제공합니다.

번들링은 말 그대로 묶음의 개념입니다. 파일을 묶는 작업 그 자체를 말하며 파일은 의존적 관계에 있는 파일들(import, export)그 자체 혹은 내부적으로 포함되어 있는 모듈을 의미합니다.
즉, 모듈 간의 의존성 관계를 파악해 그룹화 하는 작업이라고 볼 수 있습니다.
Webpack의 필요성
웹 애플리케이션의 빠른 로딩 속도와 높은 성능을 위해서입니다. 일반적으로 유저는 하나의 웹사이트에 접근하는 순간부터 3초 이내에 웹페이지가 뜨지 않으면 높은 이탈률을 보입니다.
또한 웹팩을 통해 같은 타입의 파일들을 묶어서 요청 및 응답을 받으면 네트워크 코스트가 획기적으로 줄어듭니다.

3. Webpack의 핵심 컨셉

다음은 webpack의 config 파일 예시입니다.

module.exports = {
  target: ["web", "es5"],
  entry: "./src/script.js",
  output: {
    path: path.resolve(__dirname, "docs"),
    filename: "app.bundle.js",
    clean: true
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [MiniCssExtractPlugin.loader, "css-loader"],
        exclude: /node_modules/,
      },
    ],
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: path.resolve(__dirname, "src", "index.html"),
    }),
    new MiniCssExtractPlugin(),
  ],
  optimization: {
    minimizer: [
      new CssMinimizerPlugin(),
    ]
  }
};

3-1 튜토리얼 1

디렉토리 생성 및 npm init

cd ~/Desktop
mkdir fe-sprint-webpack-tutorial
cd fe-sprint-webpack-tutorial

npm init -y

npm init -y로 만든 package.json

{
  "name": "fe-sprint-webpack-tutorial",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": ""
}

index.js 파일 생성

// src/index.js
const _ = require('./underbar.js')

const shout = (...sentences) => console.log(...sentences);

const loremIpsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis egestas feugiat elit, ac tincidunt neque vestibulum at. Mauris a eros sit amet urna efficitur tempus."

const shoutOnce = _.once(shout);

shoutOnce(loremIpsum);

3.underbar.js 파일 생성

// src/underbar.js
const _ = {
  once(func) {
    // 아래 변수들은 아래 선언/리턴되는 함수 안에서 참조됩니다.
    // 리턴되는 함수의 scope 내에 존재하므로, 리턴되는 함수를 언제 실행해도 이 변수들에 접근할 수 있습니다.
    let result;
    let alreadyCalled = false;

    return function (...args) {
      // TIP: arguments 키워드 혹은, spread operator를 사용하세요.
      if (!alreadyCalled) {
        alreadyCalled = true;
        result = func(...args);
      }
      return result;
    };
  },
};

module.exports = _; // 다른 파일에서 사용할 수 있게 export

웹팩 설치하기
이제 위에 만든 결과물을 웹팩을 이용해서 하나로 합칩니다.
웹팩을 사용하기 위해서는 npm으로 webpack, webpack-cli를 설치해야 합니다.
webpack은 이 프로젝트를 번들링하기 위한 라이브러리이지만 여기서는 실제 프로젝트에 사용하지 않기 때문에 devDependency 옵션을 설정하고 설치합니다.

npm install -D webpack webpack-cli

웹팩 config 파일 작성
webpack 설정 파일인 webpack.config.js파일에 entry와 output 정보를 아래와 같이 적을 수 있습니다.

// webpack.config.js
const path = require('path');

module.exports = {
  target:["web", "es5"],
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'), // './dist'의 절대 경로를 리턴합니다.
    filename: 'app.bundle.js',
  },
};

Target
Webpack은 다양한 환경과 target을 컴파일 합니다. target의 기본값은 web입니다. 적용하지 않으면 이 기본값으로 적용됩니다. esX를 넣으면 ECMAScript 버전으로 컴파일할 수 있습니다.

module.exports = {
  target:["web", "es5"],
};

해당 config 파일에서는 es5를 배열 안에 넣었습니다. 따라서 이 config 파일은 브라우저와 동일한 환경에서 사용하기 위해 컴파일할 것이며, 작성된 코드를 es5 버전으로 컴파일 하겠다고 지정한 것임을 알 수 있습니다. Browser Compatibility와 연관된 속성으로 볼 수 있습니다.

Entry
webpack에서의 entry는 프론트엔드 개발자가 작성한 코드의 "시작점"이라는 의미입니다.
React에서도 index.js에서 HTML 엘리먼트 하나에 React 코드를 적용하는 것부터 시작합니다.

//기본 값
module.exports = {
	...
  entry: "./src/index.js",
};

//지정 값
module.exports = {
	...
  entry: "./src/script.js",
};

Entry 속성은 Entry point라고도 하며, webpack이 내부의 디펜던시 그래프를 생성하기 위해 사용해야 하는 모듈입니다. webpack은 이 Entry point를 기반으로 직간접적으로 의존하는 다른 모듈과 라이브러리를 찾을 수 있습니다.
기본 값은 ./src/index.js이지만 webpack 설정에서 위와 같은 방식으로 entry 속성을 설정하여 여러 entry point를 지정할 수 있습니다.

output
Output 속성은 생성된 번들을 내보낼 위치와 이 파일의 이름을 지정하는 방법을 webpack에 알려주는 역할을 합니다.

const path = require('path');

module.exports = {
	...
  output: {
    path: path.resolve(__dirname, "dist"), // 절대 경로로 설정을 해야 합니다. 
    filename: "app.bundle.js",
    clean: true
  },
};

기본 출력 파일의 경우에는 ./dist/app.bundle.js로 생성된 기타 파일의 경우에는 ./dist 폴더로 설정됩니다. 위의 예제에서는 output.filename과 output.path속성을 사용하여 webpack에 번들의 이름과 내보낼 위치를 알려주고 있ㅅ브니다. path 속성을 사용할 때는 path 모듈을 사용해야 합니다.

번들링하기

npx webpack

webpack은 사용자가 프론트엔드 웹 애플리케이션을 빠르게 전달받을 수 있도록 코드를 최소화(minify)합니다.

npm run build 설정하기

{
  "name": "fe-sprint-webpack-tutorial",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
		"build": "webpack", // here
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "devDependencies": {
    "webpack": "^5.73.0",
    "webpack-cli": "^4.10.0"
  }
}

webpack의 주요 컨셉 #1

entry, output, bundle에 대해서 정리하면 다음과 같습니다.
entry경로 파일에서 필요한 모든 것을
bundler인 webpack을 통해 번들링됩니다.
번들링의 결과물이 output 경로로 산출됩니다.

3-2 튜토리얼 2

이번 튜토리얼에서는 CSS까지 함께 작업하려고 합니다.
먼저 src/index.html 파일을 아래와 같이 작성합니다.

<!DOCTYPE html>
<html lang="en">
<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>Shout Lorem Ipsum</title>
</head>
<body>
  <div id="app"></div>
  <script src="index.js"></script>
</body>
</html>

src/index.html을 실행하면 아무것도 뜨지 않고 ReferenceError가 발생합니다.
이유는 require 문법은 Node.js문법으로 브라우저에서 지원하지 않기 때문입니다.
webpack은 Node.js에서만 작동할 법한 코드를 모든 브라우저에서 잘 작동할 수 있도록 번들링해줄 수 있습니다.

또한 webpack은 JavaScript와 CSS를 함께 배포해야할 때, 좀 더 쉽게 배포할 수 있게 로더(loader)를 제공합니다.

/* src/style.css */
* {
  box-sizing: border-box;
  border: 0;
  padding: 0;
  margin: 0;
}

main {
  display: flex;
  justify-content: center;
  align-items: center;
  flex-direction: column;
}

div.shout {
  padding: 12px;
  margin: 4px;
  border-radius: 8px;
  border: 0.5px solid gray;
}

Node.js도 그 자체만으로는 CSS를 읽을 수 없어서 문법 에러가 발생합니다.

// src/index.js
const _ = require('./underbar.js');
require('./style.css');

const shout = (...sentences) => console.log(...sentences);
const shoutToHTML = (...sentences) => {
  const app = document.querySelector('#app');
  app.append(...sentences.map(sentence => {
    const shoutHere = document.createElement('div');
    shoutHere.className = 'shout';
    shoutHere.textContent = sentence;
    return shoutHere;
  }))
  return;
};

const loremIpsum = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis egestas feugiat elit, ac tincidunt neque vestibulum at. Mauris a eros sit amet urna efficitur tempus."

const shoutOnce = _.once(shout);
const shoutToHTMLOnce = _.once(shoutToHTML);

shoutOnce(loremIpsum);

이 파일들을 다루기 위해서는 적절한 로더가 필요합니다.
이번 튜토리얼에서는 style-loader와 css-loader를 사용합니다.
css-loader는 CSS를 JS파일 내로 불러올 수 있고, style-loader는 불러온 CSS를 style 요소 내에 담아줍니다.

npm으로 두 로더를 설치하고, webpack.config.js를 조정합니다.

npm i -D css-loader style-loader

// webpack.config.js
const path = require("path");

module.exports = {
  entry: "./src/index.js",
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "app.bundle.js",
  },
  module: {
    rules: [
      {
				// 파일명이 .css로 끝나는 모든 파일에 적용
        test: /\.css$/,
				// 배열 마지막 요소부터 오른쪽에서 왼쪽 순으로 적용
				// 먼저 css-loader가 적용되고, styled-loader가 적용되어야 한다.
				// 순서 주의!
        use: ["style-loader", "css-loader"],
				// loader가 node_modules 안의 있는 내용도 처리하기 때문에
				// node_modules는 제외해야 합니다
        exclude: /node_modules/,
      },
    ],
  },
};

이후 npm run build 명령을 통해 번들링이 잘 되었는지 확인합니다.

loader
webpack은 기본적으로 JavaScript와 JSON 파일만 이해합니다. 그러나 loader를 사용하명 webpack이 다른 유형의 파일을 처리하거나, 그들을 유효한 모듈로 변환해 애플리케이션에 사용하거나 디펜던시 그래프에 추가할 수 있습니다.

module.exports = {
	...
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [MiniCssExtractPlugin.loader, "css-loader"],
        exclude: /node_modules/,
      },
    ],
  },
};

상위 수준에서 loader는 webpack 설정에 몇가지 속성을 가집니다.
test : 변환이 필요한 파일들을 식별하기 위한 속성
use : 변환을 수행하는데 사용되는 로더를 가리키는 속성
exclude : 바벨로 컴파일하지 않을 파일이나 폴더를 지정.(반대로 include속성을 이용해 반드시 컴파일해야 할 파일이나 폴더 지정 가능)
여기서 test와 use속성은 필수 속성입니다.

webpack의 주요 컨셉 #2

loader는 JavaScript, JSON이 아닌 파일을 불러오는 역할을 합니다.

3-3 튜토리얼 3

이번에는 HTML도 번들에 포함하는 작업을 하고자 합니다.
html-webpack-plugin을 설치합니다.

npm i -D html-webpack-plugin

설치 후 webpack.config.js 파일에 해당 플러그인을 적용합니다.

const path = require("path");
const HtmlWebpackPlugin = require('html-webpack-plugin')

module.exports = {
  entry: "./src/index.js",
  output: {
    path: path.resolve(__dirname, "dist"),
    filename: "app.bundle.js",
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: ["style-loader", "css-loader"],
        exclude: /node_modules/,
      },
    ],
  },
  plugins: [new HtmlWebpackPlugin({
    template: path.resolve(__dirname, "src", "index.html")
  })]
};

npm run build로 번들링 한 후 dist/index.html의 코드는 다음과 같습니다.

<!doctype html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <title>Shout Lorem Ipsum Once</title>
  <script defer="defer" src="app.bundle.js"></script>
</head>

<body>
  <main>
    <h1>Shout Lorem Ipsum Once</h1>
    <div id="app"></div>
  </main>
</body>

</html>

plugins
plugins를 사용하면 번들을 최적화하거나 에셋을 관리하고, 또는 환경변수 주입 등의 광범위한 작업을 수행할 수 있게 됩니다.

const webpack = require('webpack');
const HtmlWebpackPlugin = require("html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");

module.exports = {
  ...
  plugins: [
    new HtmlWebpackPlugin({
      template: path.resolve(__dirname, "src", "index.html"),
    }),
    new MiniCssExtractPlugin(),
  ],
};

플러그인을 사용하기 위해서는 require()를 통해 플러그인을 먼저 요청해야 합니다. 그리고 plugins 배열에 사용하고자 하는 플러그인을 추가해야 합니다. 대부분의 플러그인은 사용자가 옵션을 통해 지정할 수 있습니다. 다른 목적으로 플러그인을 여러 번 사용하도록 설정할 수 있기 때문에 new 연산자를 사용해 호출하여 플러그인의 인스턴스를 만들어줘야 합니다.

위의 예제에서 html-webpack-plugin은 생성된 모든 번들을 자동으로 삽입하여 애플리케이션용 HTML 파일을 생성해줍니다. mini-css-extract-plugin은 CSS를 별도의 파일로 추출해 CSS를 포함하는 JS 파일 당 CSS 파일을 작성해주게끔 지원합니다.

webpack의 주요 컨셉 #3

플러그인은 번들링 과정 중에 개발자가 원하는 작업을 할 수 있도록 도와줍니다.
그 중 html-webpack-plugin은 번들링 과정 중 html 파일을 자신이 원하는 형태로 가공하여 번들에 포함할 수 있게 돕습니다.

optimization
webpack은 버전 4부터 선택한 항목에 따라 최적화를 실행합니다.

module.exports = {
  ...
  optimization: {
    minimizer: [
      new CssMinimizerPlugin(),
    ]
  }
};

최적화하기 위해 다양한 옵션이 지원되는데, 대표적으로 minimize와 minimizer입니다.

minimize: TerserPlugin또는 optimization.minimize에 명시된 plugins로 bundle 파일을 최소화시키는 작업 여부를 결정합니다.
minimizer: default minimizer을 커스텀된 TerserPlugin인스턴스를 제공해서 재정의할 수 있습니다.

위 예제에서는 mini-css-extract-plugin에 관련된 번들을 최소화하도록 지시하고 있습니다.

HanSungUk

이전 포스트

React 상태관리 Redux

다음 포스트

React 번들링과 웹팩

React

React 번들링과 웹팩

현재 코드스테이츠 강의를 통해 프론트엔드를 학습하고 있습니다.
본 포스트는 해당 강의에 대한 내용 정리를 목적으로 합니다.

학습목표

1. 번들링

2. Webpack

3. Webpack의 핵심 컨셉

3-1 튜토리얼 1

webpack의 주요 컨셉 #1

3-2 튜토리얼 2

webpack의 주요 컨셉 #2

3-3 튜토리얼 3

webpack의 주요 컨셉 #3

React 상태관리 Redux

React Custom Hooks (1)

0개의 댓글

React 번들링과 웹팩

React

React 번들링과 웹팩

현재 코드스테이츠 강의를 통해 프론트엔드를 학습하고 있습니다.본 포스트는 해당 강의에 대한 내용 정리를 목적으로 합니다.

학습목표

1. 번들링

2. Webpack

3. Webpack의 핵심 컨셉

3-1 튜토리얼 1

webpack의 주요 컨셉 #1

3-2 튜토리얼 2

webpack의 주요 컨셉 #2

3-3 튜토리얼 3

webpack의 주요 컨셉 #3

React 상태관리 Redux

React Custom Hooks (1)

0개의 댓글

현재 코드스테이츠 강의를 통해 프론트엔드를 학습하고 있습니다.
본 포스트는 해당 강의에 대한 내용 정리를 목적으로 합니다.