Упаковщики модулей JavaScript могут делать много вещей, но одна из их самых полезных функций — это возможность добавлять и использовать внешние библиотеки в вашей кодовой базе. Упаковщики модулей считывают пути импорта в вашем коде и объединяют (связывают) ваш код, специфичный для приложения, с вашим импортированным библиотечным кодом.
Начиная с версии 9 и выше, модульный API Firebase JavaScript оптимизирован для работы с функциями оптимизации сборщиков модулей, что позволяет сократить объем кода Firebase, включаемого в финальную сборку.
import { initializeApp } from 'firebase/app';
import { getAuth, onAuthStateChanged, getRedirectResult } from 'firebase/auth';
const firebaseApp = initializeApp({ /* config */ });
const auth = getAuth(firebaseApp);
onAuthStateChanged(auth, user => { /* check status */ });
/**
* getRedirectResult is unused and should not be included in the code base.
* In addition, there are many other functions within firebase/auth that are
* not imported and therefore should not be included as well.
*/
Этот процесс удаления неиспользуемого кода из библиотеки известен как tree shake. Удаление этого кода вручную заняло бы очень много времени и было бы подвержено ошибкам, но сборщики модулей могут автоматизировать это удаление.
В экосистеме JavaScript существует множество высококачественных сборщиков модулей. Это руководство посвящено использованию Firebase с webpack , Rollup и esbuild .
Начать
Для этого руководства вам необходимо установить npm в вашей среде разработки. npm используется для установки и управления зависимостями (библиотеками). Чтобы установить npm, установите Node.js , который автоматически включает npm.
Большинство разработчиков правильно настроены после установки Node.js. Однако есть общие проблемы, с которыми сталкиваются многие разработчики при настройке своей среды. Если вы столкнетесь с какими-либо ошибками, убедитесь, что в вашей среде есть npm CLI и что у вас установлены соответствующие разрешения, чтобы вам не приходилось устанавливать пакеты как администратор с помощью команды sudo .
package.json и установка Firebase
После установки npm вам нужно будет создать файл package.json в корне вашего локального проекта. Сгенерируйте этот файл с помощью следующей команды npm:
npm init
Это проведет вас через мастера, чтобы предоставить необходимую информацию. После создания файла он будет выглядеть примерно так:
{
"name": "your-package-name",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
}
}
Этот файл отвечает за множество разных вещей. Это важный файл, с которым стоит ознакомиться, если вы хотите узнать больше о связывании модулей и построении кода JavaScript в целом. Важная часть этого руководства — объект "dependencies" . Этот объект будет содержать пару ключ-значение установленной вами библиотеки и используемой ею версии.
Добавление зависимостей выполняется с помощью команды npm install или npm i .
npm i firebase
При запуске npm i firebase процесс установки обновит package.json , указав Firebase в качестве зависимости:
"dependencies": {
"firebase": "^9.0.0"
},
Ключ — это имя библиотеки, а значение — используемая версия. Значение версии является гибким и может принимать ряд значений. Это известно как семантическое версионирование или semver. Чтобы узнать больше о semver, см. руководство npm о семантическом версионировании .
Исходные и сборочные папки
Код, который вы пишете, считывается и обрабатывается сборщиком модулей, а затем выводится как новый файл или набор файлов. Важно разделить эти два типа файлов. Код, который считывают и обрабатывают сборщики модулей, называется «исходным» кодом. Файлы, которые они выводят, называются построенным или «dist» (дистрибутивным) кодом.
Распространенной схемой в базах кода является хранение исходного кода в папке с именем src , а собранного кода — в папке с именем dist .
- src
|_ index.js
|_ animations.js
|_ datalist.js
- dist
|_ bundle.js
В примере структуры файла выше, учтите, что index.js импортирует и animations.js и datalist.js . Когда модульный упаковщик обрабатывает исходный код, он создаст файл bundle.js в папке dist . bundle.js представляет собой комбинацию файлов в папке src и любых импортируемых библиотек.
Если вы используете системы управления исходным кодом, такие как Git, то при сохранении этого кода в основном репозитории папку dist обычно игнорируют.
Точки входа
У всех сборщиков модулей есть концепция точки входа. Вы можете представить свое приложение как дерево файлов. Один файл импортирует код из другого и так далее и тому подобное. Это означает, что один файл будет корнем дерева. Этот файл называется точкой входа.
Давайте вернемся к предыдущему примеру структуры файла.
- src
|_ index.js
|_ animations.js
|_ datalist.js
- dist
|_ bundle.js
// src/index.js
import { animate } from './animations';
import { createList } from './datalist';
// This is not real code, but for example purposes only
const theList = createList('users/123/tasks');
theList.addEventListener('loaded', event => {
animate(theList);
});
Файл src/index.js считается точкой входа, поскольку он начинает импорт всего необходимого кода для приложения. Этот файл точки входа используется упаковщиками модулей для начала процесса связывания.
Использование Firebase с webpack
Для приложений Firebase и webpack не требуется специальной конфигурации. В этом разделе рассматривается общая конфигурация webpack .
Первый шаг — установить webpack из npm в качестве зависимости разработки.
npm i webpack webpack-cli -D
Создайте файл в корне вашего локального проекта с именем webpack.config.js и добавьте следующий код.
const path = require('path');
module.exports = {
// The entry point file described above
entry: './src/index.js',
// The location of the build folder described above
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'bundle.js'
},
// Optional and for development only. This provides the ability to
// map the built code back to the original source format when debugging.
devtool: 'eval-source-map',
};
Затем убедитесь, что у вас установлен Firebase в качестве зависимости.
npm i firebase
Затем инициализируйте Firebase в вашей кодовой базе. Следующий код импортирует и инициализирует Firebase в файле точки входа и использует Firestore Lite для загрузки документа "city".
// src/index.js
import { initializeApp } from 'firebase/app';
import { getFirestore, doc, getDoc } from 'firebase/firestore/lite';
const firebaseApp = initializeApp({ /* config */ });
const db = getFirestore(firebaseApp);
async function loadCity(name) {
const cityDoc = doc(db, `cities/${name}`);
const snapshot = await getDoc(cityDoc);
return {
id: snapshot.id,
...snapshot.data(),
};
}
Следующий шаг — добавить скрипт npm для запуска сборки webpack. Откройте файл package.json и добавьте следующую пару ключ-значение в объект "scripts" .
"scripts": {
"build": "webpack --mode=development"
},
Чтобы запустить webpack и создать папку сборки, выполните следующую команду.
npm run build
Наконец, проверьте папку dist build. Она должна содержать файл bundle.js , который содержит ваше связанное приложение и код зависимостей.
Дополнительную информацию об оптимизации сборки Webpack для производства см. в официальной документации по настройке конфигурации «mode» .
Использование Firebase с Rollup
Для приложений Firebase и Rollup не требуется специальной конфигурации. В этом разделе рассматривается общая конфигурация Rollup.
Первым шагом является установка Rollup и плагина, используемого для сопоставления импортов с зависимостями, установленными с помощью npm.
npm i rollup @rollup/plugin-node-resolve -D
Создайте файл в корне вашего локального проекта с именем rollup.config.js и добавьте следующий код.
import { nodeResolve } from '@rollup/plugin-node-resolve';
export default {
// the entry point file described above
input: 'src/index.js',
// the output for the build folder described above
output: {
file: 'dist/bundle.js',
// Optional and for development only. This provides the ability to
// map the built code back to the original source format when debugging.
sourcemap: 'inline',
// Configure Rollup to convert your module code to a scoped function
// that "immediate invokes". See the Rollup documentation for more
// information: https://rollupjs.org/guide/en/#outputformat
format: 'iife'
},
// Add the plugin to map import paths to dependencies
// installed with npm
plugins: [nodeResolve()]
};
Затем инициализируйте Firebase в вашей кодовой базе. Следующий код импортирует и инициализирует Firebase в файле точки входа и использует Firestore Lite для загрузки документа "city".
// src/index.js
import { initializeApp } from 'firebase/app';
import { getFirestore, doc, getDoc } from 'firebase/firestore/lite';
const firebaseApp = initializeApp({ /* config */ });
const db = getFirestore(firebaseApp);
async function loadCity(name) {
const cityDoc = doc(db, `cities/${name}`);
const snapshot = await getDoc(cityDoc);
return {
id: snapshot.id,
...snapshot.data(),
};
}
Следующий шаг — добавить скрипт npm для запуска сборки rollup. Откройте файл package.json и добавьте следующую пару ключ-значение в объект "scripts" .
"scripts": {
"build": "rollup -c rollup.config.js"
},
Чтобы запустить свертывающие сборки и создать папку сборки, выполните следующую команду.
npm run build
Наконец, проверьте папку dist build. Она должна содержать файл bundle.js , который содержит ваше связанное приложение и код зависимостей.
Дополнительную информацию об оптимизации сборки Rollup для производства см. в официальной документации по плагинам для производственных сборок .
Использование Firebase с esbuild
Для приложений Firebase и esbuild не требуется специальной конфигурации. В этом разделе рассматривается общая конфигурация esbuild.
Первый шаг — установить esbuild как зависимость разработки.
npm i esbuild -D
Создайте файл в корне вашего локального проекта с именем esbuild.config.js и добавьте следующий код.
require('esbuild').build({
// the entry point file described above
entryPoints: ['src/index.js'],
// the build folder location described above
outfile: 'dist/bundle.js',
bundle: true,
// Replace with the browser versions you need to target
target: ['chrome60', 'firefox60', 'safari11', 'edge20'],
// Optional and for development only. This provides the ability to
// map the built code back to the original source format when debugging.
sourcemap: 'inline',
}).catch(() => process.exit(1))
Затем инициализируйте Firebase в вашей кодовой базе. Следующий код импортирует и инициализирует Firebase в файле точки входа и использует Firestore Lite для загрузки документа "city".
// src/index.js
import { initializeApp } from 'firebase/app';
import { getFirestore, doc, getDoc } from 'firebase/firestore/lite';
const firebaseApp = initializeApp({ /* config */ });
const db = getFirestore(firebaseApp);
async function loadCity(name) {
const cityDoc = doc(db, `cities/${name}`);
const snapshot = await getDoc(cityDoc);
return {
id: snapshot.id,
...snapshot.data(),
};
}
Следующий шаг — добавить скрипт npm для запуска esbuild. Откройте файл package.json и добавьте следующую пару ключ-значение в объект "scripts" .
"scripts": {
"build": "node ./esbuild.config.js"
},
Наконец, проверьте папку dist build. Она должна содержать файл bundle.js , который содержит ваше связанное приложение и код зависимостей.
Дополнительную информацию об оптимизации esbuild для производства см. в официальной документации по минификации и другим оптимизациям .