이전 논의에서 Webpack의 Loader와 Plugin 개념을 간략히 살펴보았습니다. 핵심적인 차이점을 다시 한번 명확히 정리하고, 각자의 구현 방식에 대해 자세히 알아보겠습니다.
1. Loader와 Plugin의 구분
로더(Loader)는 특정 유형의 파일을 웹팩이 이해할 수 있는 모듈로 변환하는 역할을 합니다. 예를 들어, 자바스크립트가 아닌 파일(CSS, 이미지, 폰트 등)이나 특정 버전의 자바스크립트(TypeScript, ESNext)를 웹팩 번들에 포함될 수 있도록 처리합니다. 컴파일, 압축 등 개별 파일에 대한 변환 작업에 특화되어 있습니다.
반면 플러그인(Plugin)은 웹팩 번들링 프로세스 전반에 걸쳐 다양한 최적화, 자산 관리, 환경 변수 주입 등 복잡하고 유연한 기능을 추가합니다. 로더만으로는 해결하기 어려운 광범위한 작업들을 처리하며, 웹팩의 전체 컴파일 과정에 깊숙이 개입할 수 있습니다.
이 둘의 실행 시점은 다음과 같이 구분할 수 있습니다.
- 로더: 웹팩이 모듈을 번들링하기 전에 개별 파일을 처리합니다. 파일 단위의 전처리 단계에서 동작합니다.
- 플러그인: 웹팩의 전체 컴파일 라이프사이클에 걸쳐 다양한 지점에서 개입할 수 있습니다. 웹팩은 빌드 과정 중 여러 이벤트를 발생시키고, 플러그인은 이 이벤트를 감청하여 적절한 시점에 웹팩이 제공하는 API를 통해 출력 결과를 변경합니다.
요약하자면, 로더는 특정 파일을 다른 파일 포맷으로 '변환'하는 데 중점을 두는 반면, 플러그인은 웹팩의 '전체 빌드 과정'을 제어하고 수정하는 데 사용됩니다.
2. 로더(Loader) 작성하기
로더의 본질은 하나의 함수입니다. 이 함수는 웹팩이 전달하는 파일의 원본 내용을 인자로 받습니다. 함수 내 `this` 컨텍스트는 웹팩에 의해 채워지므로, 로더를 정의할 때는 화살표 함수 대신 일반 함수를 사용해야 합니다. `this` 객체는 현재 로더에 필요한 다양한 정보를 제공합니다.
로더 함수는 동기적으로 처리될 수도 있고, 비동기적으로 처리될 수도 있습니다. 동기 로더는 처리된 내용을 `return` 문으로 반환하며, 비동기 로더는 `this.callback` 메서드를 사용하여 결과를 전달합니다.
아래는 간단한 로더 구현 예시입니다:
module.exports = function(sourceCode) {
// `sourceCode`는 웹팩이 로더에게 전달하는 파일의 원본 내용입니다.
// 로더에 설정된 `options` 객체는 `this.query`를 통해 접근할 수 있습니다.
const loaderOptions = this.query;
console.log(`로더 옵션:`, loaderOptions);
// `this.context`는 현재 로더가 처리하는 파일의 디렉토리 경로입니다.
console.log(`처리 중인 파일의 컨텍스트: ${this.context}`);
// 여기서 원본 코드를 변환하는 로직을 수행합니다.
// 예: 특정 문자열을 다른 문자열로 변경
const transformedCode = sourceCode.replace(/original/g, 'rewritten');
// 비동기 로더의 경우 `this.callback`을 사용합니다.
// 이 메서드는 `(에러, 변환된_내용, 소스맵, AST)` 순서로 인자를 받습니다.
// 에러가 없다면 첫 번째 인자는 `null`입니다.
this.callback(null, transformedCode, null, null);
// 동기 로더의 경우 처리된 내용을 단순히 반환합니다.
// 위에서 `this.callback`을 호출했다면 이 `return` 문은 실행되지 않습니다.
// return transformedCode;
};
로더를 작성할 때는 단일 기능을 수행하도록 설계하는 것이 좋습니다. 예를 들어, Less 파일을 CSS 파일로 변환하는 과정도 `less-loader`, `css-loader`, `style-loader`와 같이 여러 로더의 체인으로 이루어져 각 로더가 한 가지 역할을 담당합니다.
3. 플러그인(Plugin) 작성하기
웹팩은 발행-구독(publish-subscribe) 모델을 기반으로 동작하며, 컴파일 과정 중 다양한 이벤트를 발생시킵니다. 플러그인은 이러한 이벤트를 감청하여 특정 단계에서 자신의 작업을 실행합니다.
웹팩 컴파일 과정에서는 두 가지 핵심 객체가 생성됩니다:
compiler객체: 웹팩 환경의 모든 설정(options, loader, plugin)을 담고 있으며, 전체 빌드 라이프사이클과 관련된 훅(hook)들을 제공합니다.compilation객체: 플러그인의 내장 이벤트 콜백 함수의 인자로 전달되며, 현재 모듈 리소스, 컴파일 생성 자원, 변경된 파일 및 추적되는 의존성 상태 정보 등 현재 컴파일 과정에 대한 상세 정보를 포함합니다. 파일 변경이 감지되면 새로운compilation객체가 생성됩니다.
자체적으로 플러그인을 구현하려면 다음 지침을 따라야 합니다:
- 플러그인은 `apply` 메서드를 포함하는 객체 또는 함수 형태여야 합니다. 이 `apply` 메서드를 통해 `compiler` 인스턴스에 접근할 수 있습니다.
- 플러그인에 전달되는 `compiler`와 `compilation` 객체는 동일한 참조를 가지므로, 직접적인 수정은 신중해야 합니다.
- 비동기 작업이 포함된 플러그인은 작업 완료 후 반드시 콜백 함수를 호출하여 웹팩에 다음 단계로 진행할 것을 알려야 합니다. 그렇지 않으면 빌드 프로세스가 중단될 수 있습니다.
플러그인 구현의 기본 템플릿은 다음과 같습니다:
class CustomBuildPlugin {
// 웹팩은 플러그인 인스턴스의 apply 메서드를 호출하며 compiler 객체를 전달합니다.
apply (compilerInstance) {
// 적절한 이벤트 훅을 찾아 플러그인 기능을 구현합니다.
// 'emit' 훅은 모든 모듈 변환 및 조립이 완료되고 파일이 출력되기 직전에 발생합니다.
compilerInstance.hooks.emit.tap('CustomBuildPlugin', buildCompilation => {
// `buildCompilation` 객체는 현재 빌드 프로세스의 컨텍스트를 제공합니다.
console.log('--- CustomBuildPlugin: emit 훅 실행 ---');
console.log('생성될 자원 개수:', Object.keys(buildCompilation.assets).length);
// 예를 들어, 모든 출력 자원 목록을 확인하고 특정 자원을 수정할 수 있습니다.
for (const assetName in buildCompilation.assets) {
console.log(` 자원 이름: ${assetName}`);
// 여기서 최종 출력 자원에 접근하거나 수정하는 로직을 구현합니다.
// 예: `buildCompilation.assets[assetName].source()` 로 내용 읽기
// `buildCompilation.assets[assetName].source = () => '새로운 내용'` 으로 내용 변경
}
});
// 다른 훅 예시: 컴파일 시작 시점
compilerInstance.hooks.compile.tap('CustomBuildPlugin', compilationParams => {
console.log('--- CustomBuildPlugin: compile 훅 실행 ---');
// 컴파일 파라미터 확인
// console.log(compilationParams);
});
}
}
emit 이벤트 훅은 원본 파일의 변환 및 조립이 모두 완료된 시점을 나타냅니다. 이 시점에는 최종적으로 출력될 자원, 코드 블록, 모듈 및 그 의존성에 접근할 수 있으며, 출력 자원의 내용을 수정하는 등의 작업이 가능합니다.