放棄webpack,擁抱gulp

別被標題嚇到,哈哈,即使現(xiàn)在vite橫空出世,社區(qū)光芒四射,兩個字很快,但是webpack依舊寶刀未老,依然扛起前端工程化的大梁,但是今天我為啥說要擁抱gulp,因為我們常常吃一道菜,所以要換個口味,這樣才營養(yǎng)均衡。

gulp定義是:用自動化構(gòu)建工具增強你的工作流程,是一種基于任務(wù)文件流方式,你可以在前端寫一些自動化腳本,或者升級歷史傳統(tǒng)項目,解放你重復(fù)打包,壓縮,解壓之類的操作。

個人理解gulp是一種命令式編程的體驗,更注重構(gòu)建過程,所有的任務(wù)需要你自己手動創(chuàng)建,你會對構(gòu)建流程會非常清楚,這點不像webpack,webpack就是一個開箱即用的聲明式方式,webpack是一個模塊化打包工具,內(nèi)部細節(jié)隱藏非常之深,你也不需關(guān)注細節(jié),你只需要照著提供的API以及引入對應(yīng)的loader和plugin使用就行。

言歸正傳,為了飲食均衡,今天一起學(xué)習(xí)下gulp

正文開始...

搭建一個簡單的前端應(yīng)用
相比較webpack,其實gulp的項目結(jié)構(gòu)更偏向傳統(tǒng)的應(yīng)用,只是我們借助gulp工具解放我們的一些代碼壓縮、es6編譯、打包以及在傳統(tǒng)項目中都可以使用less體驗。

在gulp目錄下新建01-simple-demo

根目錄下生成默認package.json

npm init -y
然后在public目錄下新建images、css、js、index.html

文件結(jié)構(gòu),大概就這樣


然后在安裝gulp

npm i gulp --save-dev
在根目錄下新建gulpfile.js我們先在gulpfile.js中寫入一點內(nèi)容,測試一下

const defaultTask = (cb) => {
  console.log('hello gulp')
  cb();
}
exports.default = defaultTask;
然后我們在命令行執(zhí)行

npx gulp

當我們執(zhí)行npx gulp時會默認運行g(shù)ulpfile.js導(dǎo)出的default,在gulpfile.js導(dǎo)出的任務(wù)會?注冊到gulp任務(wù)中

在gulp中任務(wù)主要分兩種,一種是公開任務(wù)、另一種是私有任務(wù)

公開任務(wù)可以直接在命令執(zhí)行npx gulp xxx調(diào)用執(zhí)行,比如下面的defaultTask就是一個公開任務(wù),只要被導(dǎo)出就是一個公開任務(wù),沒有被導(dǎo)出就是一個私有任務(wù)。

...
exports.default = defaultTask;
公有任務(wù)taskJS

// gulpfile.js
const { src, dest } = require('gulp');
const pathDir = (dir) => {
  return path.resolve(__dirname, dir);
}
// todo 執(zhí)行ts任務(wù),將js目錄下的js打包到dist/js目錄下
const taskJS = () => {
  return src(pathDir('public/**/*.js'), { sourcemaps: true }).pipe(dest(pathDir('dist/js')))
}
exports.taskJS = taskJS;
然后你在命令行執(zhí)行

npx gulp taskJS


至此你會發(fā)現(xiàn)dist目錄下就有生成的js了
安裝less
npm i less gulp-less --save-dev
在css/index.less中寫入測試css的代碼

@bgcolor: yellow;
@defaultsize: 20px;
body {
  background-color: @bgcolor;
}
h1 {
  font-size: @defaultsize;
}
在gulpfile.js中寫入編譯less的任務(wù),需要gulp-less

const { src, dest } = require('gulp');
const less = require('gulp-less');
const pathDir = (dir) => {
  return path.resolve(__dirname, dir);
}
...
// todo less任務(wù)
const taskLess = () => {
  // css目錄洗的所有.less文件,dest輸出到dist/css目錄下
  return src(pathDir('public/css/*.less')).pipe(less()).pipe(dest(pathDir('dist/css')))
}
exports.taskLess = taskLess;
命令行運行npx gulp taskLess,結(jié)果如下


圖片資源
使用一個gulp-image插件對圖片進行無損壓縮處理

// gulpfile.js
const { src, dest } = require('gulp');
const image = require('gulp-image');
const path = require('path');
const pathDir = (dir) => {
  return path.resolve(__dirname, dir);
}
...
// todo 圖片資源
const taskImage = () => {
  return src(pathDir('public/images/*.*')).pipe(image()).pipe(dest(pathDir('dist/images')))
}
exports.taskImage = taskImage;

一頓操作發(fā)現(xiàn),最新版本不支持esm,所以還是降低版本版本,這里降低到6.2.1版本,這里只能使用ejs方式

然后運行npx gulp taskImage


圖片壓縮得不小
在這之前,我們分別定義了三個不同的任務(wù),gulp導(dǎo)出的任務(wù)有公開任務(wù)和私有任務(wù),多個公開任務(wù)可以串行組合使用

組合任務(wù) series
因此我可以將之前的介個任務(wù)組合在一起

// gulpfile.js
const { src, dest, series } = require('gulp');
const less = require('gulp-less');
const image = require('gulp-image');
const path = require('path');
const pathDir = (dir) => {
  return path.resolve(__dirname, dir);
}
// todo js任務(wù)
const taskJS = () => {
  return src(pathDir('public/**/*.js'), { sourcemaps: true }).pipe(dest(pathDir('dist/js')))
}
...
// series組合多個任務(wù)
const seriseTask = series(taskJS, taskLess, taskLess, taskImage)
exports.seriseTask = seriseTask;
當我在命令行npx gulp seriseTask時


已經(jīng)在dist生成對應(yīng)的文件了
編譯轉(zhuǎn)換es6
在我們index.js,很多時候是寫的es6,在gulp中我們需要一些借助一些插件gulp-babel,另外我們需要安裝另外兩個babel核心插件@babel/core,@babel/preset-env

 npm i gulp-babel @babel/core @babel/preset-env
在gulpfile.js中我們需要修改下

...
const babel = require('gulp-babel');
// todo js任務(wù)
// 用babel轉(zhuǎn)換es6語法糖
const taskJS = () => {
  return src(pathDir('public/**/*.js'), { sourcemaps: true }).pipe(babel({
    presets: ['@babel/preset-env']
  })).pipe(dest(pathDir('dist/js')))
}
當我們在js/index.js寫入一段測試代碼

js/index.js
const appDom = document.getElementById('app');
appDom.innerHTML = 'hello gulp';
const fn = () => {
  console.log('公眾號:Web技術(shù)學(xué)苑,好好學(xué)習(xí),天天向上')
}
fn();
運行npx gulp seriseTask


箭頭函數(shù)和const申明的變量就變成了es5了
通常情況下,一般打包后的dist下的css或者js都會被壓縮,在gulp中也是需要借助插件來完成

壓縮js與css
壓縮js

...
const teser = require('gulp-terser');
// todo js任務(wù)
const taskJS = () => {
  return src(pathDir('public/**/*.js'), { sourcemaps: true }).pipe(babel({
    presets: ['@babel/preset-env']
  })).pipe(teser({
    mangle: {
      toplevel: true // 混淆代碼
    }
  })).pipe(dest(pathDir('dist/js')))
}
...
壓縮css

...
const uglifycss = require('gulp-uglifycss');
// todo less任務(wù)
const taskLess = () => {
  return src(pathDir('public/css/*.less')).pipe(less()).pipe(uglifycss()).pipe(dest(pathDir('dist/css')))
}
...
在這之前我們在輸出dest時候我們都指向了一個具體的文件目錄,在src這個api中是創(chuàng)建流,從文件中讀取vunyl對象,本身也提供了一個base屬性,因此你可以像下面這樣寫

const { src, dest, series } = require('gulp');
const less = require('gulp-less');
const image = require('gulp-image');
const babel = require('gulp-babel');
const teser = require('gulp-terser');
const uglifycss = require('gulp-uglifycss');
const path = require('path');
const pathDir = (dir) => {
  return path.resolve(__dirname, dir);
}
// 設(shè)置base,當輸出文件目標dist文件時,會自動拷貝當前文件夾到目標目錄
const basePath = {
  base: './public'
};
// todo js任務(wù)
const taskJS = () => {
  return src(pathDir('public/**/*.js', basePath)).pipe(babel({
    presets: ['@babel/preset-env']
  })).pipe(teser({
    mangle: {
      toplevel: true // 混淆代碼
    }
  })).pipe(dest(pathDir('dist')))
}
// todo less任務(wù)
const taskLess = () => {
  return src(pathDir('public/css/*.less'), basePath).pipe(less()).pipe(uglifycss()).pipe(dest(pathDir('dist')))
}
// todo 圖片資源,有壓縮,并輸出到對應(yīng)的dist/images文件夾下
const taskImage = () => {
  return src(pathDir('public/images/*.*'), basePath).pipe(image()).pipe(dest(pathDir('dist')))
}
// todo html
const taskHtml = () => {
  return src(pathDir('public/index.html'), basePath).pipe(dest(pathDir('dist')))
}
const defaultTask = (cb) => {
  console.log('hello gulp')
  cb();
}

// series組合多個任務(wù)
const seriseTask = series(taskHtml, taskJS, taskLess, taskLess, taskImage)

exports.default = defaultTask;
exports.taskJS = taskJS;
exports.taskLess = taskLess;
exports.taskImage = taskImage;
exports.seriseTask = seriseTask;
將資源注入html中
在gulp中,任務(wù)之間的依賴關(guān)系需要我們自己手動寫一些執(zhí)行任務(wù)流,現(xiàn)在一些打包后的dist的文件并不會自動注入html中。

參考gulp-inject[1]

...
const inject = require('gulp-inject');
...
// 將css,js插入html中
const injectHtml = () => {
  // 目標資源
  const targetSources = src(['./dist/**/*.js', './dist/**/*.css'], { read: false });
  // 目標html
  const targetHtml = src('./dist/*.html')
  // 把目標資源插入目標html中,同時輸出到dist文件下
  const result = targetHtml.pipe(inject(targetSources)).pipe(dest('dist'));
  return result
}
// series串行組合多個任務(wù)
const seriseTask = series(taskHtml, taskJS, taskLess, taskLess, taskImage, injectHtml)

exports.seriseTask = seriseTask;
注意一個執(zhí)行順序,必須是等前面任務(wù)執(zhí)行完了,再注入,所以在series任務(wù)的最后才執(zhí)行injectHtml操作

并且在public/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>gulp</title>
    <!-- inject:css -->
    <!-- endinject -->
  </head>
  <body>
    <div id="app"></div>
    <!-- inject:js -->
    <!-- endinject -->
  </body>
</html>
當我們運行npx gulp seriseTask時


創(chuàng)建本地服務(wù)
我們需要將前面所有的js,css,html組織起來,在本地服務(wù)中使用






參考browser-sync[2]

const { src, dest, series, watch } = require('gulp');
const browserSync = require('browser-sync');
...

const taskBuild = seriseTask;
// 本地服務(wù)
const taskDevServer = () => {
  // 監(jiān)聽public所有目錄下,只要文件發(fā)生改變,就重新加載
  watch(pathDir('public'), taskBuild);
  // 創(chuàng)建服務(wù)
  const server = browserSync.create();
  // 調(diào)用init開啟端口訪問
  server.init({
    port: '8081', //設(shè)置端口
    open: true,  // 自動打開瀏覽器
    files: './dist/*', // dist文件
    server: {
      baseDir: './dist'
    }
  })
}
exports.taskDevServer = taskDevServer;
當我們運行npx gulp taskDevServer時,瀏覽器會默認打開http://localhost:8081


我們使用了一個watch監(jiān)聽public目錄下的所有文件,如果文件有變化時,會執(zhí)行taskBuild任務(wù)會在dist目錄下生成對應(yīng)的文件,然后會啟動一個本地服務(wù),打開一個8081的端口就可以訪問應(yīng)用了。

至此一個一個用gulp搭建的前端應(yīng)用終于可以了。

重新組織gulpfile
最后我們可以再重新組織一下gulpfile.js,因為多個任務(wù)寫在一個文件里貌似不太那么好維護,隨著業(yè)務(wù)迭代,會越來越多,因此,有必要將任務(wù)分解一下

在根目錄新建task,我們把所有的任務(wù)如下

common.js

// task/common.js
const path = require('path');
const pathDir = (dir) => {
  return path.join(__dirname, '../', dir);
}
const rootDir = path.resolve(__dirname, '../');
const basePath = {
  base: './public'
};
const targetDest = 'dist';
module.exports = {
  rootDir,
  pathDir,
  basePath,
  targetDest
};
injectHtml.js

// task/injectHtml.js
const { src, dest } = require('gulp');
const inject = require('gulp-inject');
const { targetDest, rootDir } = require('./common.js');
// 將css,js插入html中
const injectHtml = () => {
  // 目標資源
  const targetSources = src([`${rootDir}/${targetDest}/**/*.js`, `${rootDir}/${targetDest}/**/*.css`]);
  // 目標html
  const targetHtml = src(`${rootDir}/${targetDest}/*.html`)
  // 把目標資源插入目標html中,同時輸出到dist文件下
  const result = targetHtml.pipe(inject(targetSources, { relative: true })).pipe(dest(targetDest));
  return result
}
module.exports = injectHtml;
taskDevServer.js

const { watch } = require('gulp');
const path = require('path');
const browserSync = require('browser-sync');
const { pathDir, targetDest, rootDir } = require('./common.js');
const taskDevServer = (taskBuild) => {
  return (options = {}) => {
    const defaultOption = {
      port: '8081', //設(shè)置端口
      open: true,  // 自動打開瀏覽器
      files: `${rootDir}/${targetDest}/*`, // 當dist文件下有改動時,會自動刷新頁面
      server: {
        baseDir: `${rootDir}/${targetDest}` // 基于當前dist目錄
      },
      ...options
    }
    // 監(jiān)聽public所有目錄下,只要文件發(fā)生改變,就重新加載
    watch(pathDir('public'), taskBuild);
    const server = browserSync.create();
    server.init(defaultOption);
  }
}
module.exports = taskDevServer;
...

task/index.js

const injectHtml = require('./injectHtml.js');
const taskDevServer = require('./taskDevServer.js');
const taskHtml = require('./taskHtml.js');
const taskImage = require('./taskImage.js');
const taskJS = require('./taskJS.js');
const taskLess = require('./taskLess.js');
module.exports = {
  injectHtml,
  taskDevServer,
  taskHtml,
  taskImage,
  taskJS,
  taskLess
}
在gulpfile.js中,我們修改下

// gulpfile.js
const { series } = require('gulp');
const { injectHtml, taskDevServer, taskHtml, taskImage, taskJS, taskLess } = require('./task/index.js')

// series組合多個任務(wù)
const seriseTask = series(taskHtml, taskJS, taskLess, taskLess, taskImage, injectHtml);
// 本地服務(wù)
const devServer = taskDevServer(seriseTask);
// 啟動服務(wù)
const server = () => {
  devServer({
    port: 9000
  });
}
const taskBuild = seriseTask;
const defaultTask = (cb) => {
  console.log('hello gulp')
  cb();
}
exports.default = defaultTask;
exports.server = server;
exports.build = taskBuild;
我們在package.json中新增命令

  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "server": "gulp server",
    "build": "gulp build"
  },
npm run build

在啟動server之前,我們先執(zhí)行npm run build,然后再執(zhí)行下面命令,保證browserSync創(chuàng)建的服務(wù)文件夾存在,不然頁面打開就404錯誤

npm run server

至此gulp搭建一個簡單的應(yīng)該就已經(jīng)完全ok了

這頁面背景貌似有點黃

總結(jié)
gulpjs開發(fā)是一個任務(wù)流的開發(fā)方式,它的核心思想就是用自動化構(gòu)建工具增強你的工作流,所有的自動化工作流操作都牢牢的掌握在自己手上,你可以用gulp寫一些自動化腳本,比如,文件上傳,打包,壓縮,或者改造傳統(tǒng)的前端應(yīng)用。

用gulp寫了一個簡單的應(yīng)用,但是發(fā)現(xiàn)中途需要找好多gulp插件,gulp的生態(tài)還算可以,3w多個star,生態(tài)相對豐富,但是有些插件常年不更新,或者版本更新不支持,比如gulp-image,當你按照官方文檔使用最新的包時,不支持esm,你必須降低版本6.2.1,改用cjs才行

使用gulp的一些常用的api,比如src、dest、series,以及browser-sync實現(xiàn)本地服務(wù),更多api[3]參考官方文檔。

即使項目時間再多,也不要用gulp搭建前端應(yīng)用,因為webpack生態(tài)很強大了,看gulp的最近更新還是2年前,但是寫個自動化腳本,還算可以,畢竟gulp的理念就是用自動化構(gòu)建工具增強你工作流程,也許當你接盤傳統(tǒng)項目時,一些打包,拷貝,壓縮文件之類的,可以嘗試用用這個。

本文示例code-example[4]

參考資料
[1]
gulp-inject: https://www.npmjs.com/package/gulp-inject

[2]
browser-sync: https://browsersync.io/docs/gulp

[3]
api: https://www.gulpjs.com.cn/docs/api/src/

[4]
code-example: https://github.com/maicFir/lessonNote/tree/master/gulp/01-simple-demo

最后,看完覺得有收獲的,點個贊,在看,轉(zhuǎn)發(fā),收藏等于學(xué)會,歡迎關(guān)注Web技術(shù)學(xué)苑,好好學(xué)習(xí),天天向上!





作者:Maic

歡迎關(guān)注微信公眾號 :web技術(shù)學(xué)苑