gulp詳細入門教程


一、gulp簡介

    1.gulp是什么?

      gulp是前端開發過程中一種基於流的代碼構建工具,是自動化項目的構建利器;它不僅能對網站資源進行優化,而且在開發過程中很多重復的任務能夠使用正確的工具自動完成;使用它,不僅可以很愉快的編寫代碼,而且大大提高我們的工作效率。

      gulp是基於Nodejs的自動任務運行器, 它能自動化地完成 javascript、coffee、sass、less、html/image、css 等文件的測試、檢查、合並、壓縮、格式化、瀏覽器自動刷新、部署文件生成,並監聽文件在改動后重復指定的這些步驟。在實現上,她借鑒了Unix操作系統的管道(pipe)思想,前一級的輸出,直接變成后一級的輸入,使得在操作上非常簡單。通過本文,我們將學習如何使用Gulp來改變開發流程,從而使開發更加快速高效。

      gulp 和 grunt 非常類似,但相比於 grunt 的頻繁 IO 操作,gulp 的流操作,能更快地更便捷地完成構建工作。

     2.核心概念:流

      ,簡單來說就是建立在面向對象基礎上的一種抽象的處理數據的工具。在流中,定義了一些處理數據的基本操作,如讀取數據,寫入數據等,程序員是對流進行所有操作的,而不用關心流的另一頭數據的真正流向。流不但可以處理文件,還可以處理動態內存、網絡數據等多種數據形式。

      而gulp正是通過流和代碼優於配置的策略來盡量簡化任務編寫的工作。這看起來有點“像jQuery”的方法,把動作串起來創建構建任務。早在Unix的初期,流就已經存在了。流在Node.js生態系統中也扮演了重要的角色,類似於*nix將幾乎所有設備抽象為文件一樣,Node將幾乎所有IO操作都抽象成了stream的操作。因此用gulp編寫任務也可看作是用Node.js編寫任務。當使用流時,gulp去除了中間文件,只將最后的輸出寫入磁盤,整個過程因此變得更快。

     3.特點    

      易於使用

        通過代碼優於配置的策略,gulp 讓簡單的任務簡單,復雜的任務可管理。

      構建快速

        利用 Node.js 流的威力,你可以快速構建項目並減少頻繁的 IO 操作。

      易於學習

        通過最少的 API,掌握 gulp 毫不費力,構建工作盡在掌握:如同一系列流管道。

      插件高質

        gulp 嚴格的插件指南確保插件如你期望的那樣簡潔高質得工作。

     4.安裝 

      首先確保你已經正確安裝了nodejs環境。然后以全局方式安裝gulp:

npm install -g gulp

      全局安裝gulp后,還需要在每個要使用gulp的項目中都單獨安裝一次。把目錄切換到你的項目文件夾中,然后在命令行中執行:

npm install gulp

      如果想在安裝的時候把gulp寫進項目package.json文件的依賴中,則可以加上--save-dev:

npm install --save-dev gulp

      這樣就完成了gulp的安裝,接下來就可以在項目中應用gulp了。

     5.gulp的使用

      1、建立gulpfile.js文件

      gulp也需要一個文件作為它的主文件,在gulp中這個文件叫做gulpfile.js。新建一個文件名為gulpfile.js的文件,然后放到你的項目目錄中。之后要做的事情就是在gulpfile.js文件中定義我們的任務了。下面是一個最簡單的gulpfile.js文件內容示例,它定義了一個默認的任務。

var gulp = require('gulp');
gulp.task('default',function(){
    console.log('hello world');
});

      此時我們的目錄結構是這樣子的:

      

      2 運行gulp任務

      要運行gulp任務,只需切換到存放gulpfile.js文件的目錄(windows平台請使用cmd或者Power Shell等工具),然后在命令行中執行gulp命令就行了,gulp后面可以加上要執行的任務名,例如gulp task1,如果沒有指定任務名,則會執行任務名為default的默認任務。

二、 gulp api

     1.工作方式

      在介紹gulp API之前,我們首先來說一下gulp.js工作方式。在gulp中,使用的是Nodejs中的stream(流),首先獲取到需要的stream,然后可以通過stream的pipe()方法把流導入到你想要的地方,比如gulp的插件中,經過插件處理后的流又可以繼續導入到其他插件中,當然也可以把流寫入到文件中。所以gulp是以stream為媒介的,它不需要頻繁的生成臨時文件,這也是我們應用gulp的一個原因。

  gulp的使用流程一般是:首先通過gulp.src()方法獲取到想要處理的文件流,然后把文件流通過pipe方法導入到gulp的插件中,最后把經過插件處理后的流再通過pipe方法導入到gulp.dest()中,gulp.dest()方法則把流中的內容寫入到文件中。例如:

var gulp = require('gulp');
gulp.src('script/jquery.js')         // 獲取流的api
    .pipe(gulp.dest('dist/foo.js')); // 寫放文件的api

     2.globs的匹配規則

      我們重點說說gulp用到的globs的匹配規則以及一些文件匹配技巧,我們將會在后面用到這些規則。

  gulp內部使用了node-glob模塊來實現其文件匹配功能。我們可以使用下面這些特殊的字符來匹配我們想要的文件:

匹配符 說明
* 匹配文件路徑中的0個或多個字符,但不會匹配路徑分隔符,除非路徑分隔符出現在末尾
** 匹配路徑中的0個或多個目錄及其子目錄,需要單獨出現,即它左右不能有其他東西了。如果出現在末尾,也能匹配文件。
? 匹配文件路徑中的一個字符(不會匹配路徑分隔符)
[...]

匹配方括號中出現的字符中的任意一個,當方括號中第一個字符為^或!時,則表示不匹配方括號中出現的其他字符中的任意一個,類似js正則表達式中的用法

!(pattern|pattern|pattern) 匹配任何與括號中給定的任一模式都不匹配的
?(pattern|pattern|pattern) 匹配括號中給定的任一模式0次或1次,類似於js正則中的(pattern|pattern|pattern)?
+(pattern|pattern|pattern) 匹配括號中給定的任一模式至少1次,類似於js正則中的(pattern|pattern|pattern)+
*(pattern|pattern|pattern) 匹配括號中給定的任一模式0次或多次,類似於js正則中的(pattern|pattern|pattern)*
@(pattern|pattern|pattern) 匹配括號中給定的任一模式1次,類似於js正則中的(pattern|pattern|pattern)

下面以例子來加深理解

* 能匹配 a.js,x.y,abc,abc/,但不能匹配a/b.js

*.* 能匹配 a.js,style.css,a.b,x.y

*/*/*.js 能匹配 a/b/c.js,x/y/z.js,不能匹配a/b.js,a/b/c/d.js

** 能匹配 abc,a/b.js,a/b/c.js,x/y/z,x/y/z/a.b,能用來匹配所有的目錄和文件

**/*.js 能匹配 foo.js,a/foo.js,a/b/foo.js,a/b/c/foo.js

a/**/z 能匹配 a/z,a/b/z,a/b/c/z,a/d/g/h/j/k/z

a/**b/z 能匹配 a/b/z,a/sb/z,但不能匹配a/x/sb/z,因為只有單**單獨出現才能匹配多級目錄

?.js 能匹配 a.js,b.js,c.js

a?? 能匹配 a.b,abc,但不能匹配ab/,因為它不會匹配路徑分隔符

[xyz].js 只能匹配 x.js,y.js,z.js,不會匹配xy.js,xyz.js等,整個中括號只代表一個字符

[^xyz].js 能匹配 a.js,b.js,c.js等,不能匹配x.js,y.js,z.js

     3.src:獲取流

      gulp.src()方法正是用來獲取流的,但要注意這個流里的內容不是原始的文件流,而是一個虛擬文件對象流(Vinyl files),這個虛擬文件對象中存儲着原始文件的路徑、文件名、內容等信息。其語法為:

gulp.src(globs[, options]);

      globs參數是文件匹配模式(類似正則表達式),用來匹配文件路徑(包括文件名),當然這里也可以直接指定某個具體的文件路徑。當有多個匹配模式時,該參數可以為一個數組;類型為String或 Array。當有多種匹配模式時可以使用數組

//使用數組的方式來匹配多種文件
gulp.src(['js/*.js','css/*.css','*.html'])

options為可選參數。以下為options的選項參數:

options.buffer

類型: Boolean 默認值: true

  如果該項被設置為 false,那么將會以 stream 方式返回 file.contents 而不是文件 buffer 的形式。這在處理一些大文件的時候將會很有用。

      注意:插件可能並不會實現對 stream 的支持。

options.read

類型: Boolean 默認值: true

如果該項被設置為 false, 那么 file.contents 會返回空值(null),也就是並不會去讀取文件。

options.base

類型: String , 設置輸出路徑以某個路徑的某個組成部分為基礎向后拼接。

如, 請想像一下在一個路徑為 client/js/somedir 的目錄中,有一個文件叫 somefile.js :

gulp.src('client/js/**/*.js') // 匹配 'client/js/somedir/somefile.js' 現在 `base` 的值為 `client/js/`
  .pipe(minify())
  .pipe(gulp.dest('build'));  // 寫入 'build/somedir/somefile.js' 將`client/js/`替換為build
 
gulp.src('client/js/**/*.js', { base: 'client' }) // base 的值為 'client'
  .pipe(minify())
  .pipe(gulp.dest('build'));  // 寫入 'build/js/somedir/somefile.js' 將`client`替換為build

     4.dest:寫文件

      gulp.dest()方法是用來寫文件的,其語法為:

gulp.dest(path[,options])

path為寫入文件的路徑;

options為一個可選的參數對象,以下為選項參數:

options.cwd

類型: String 默認值: process.cwd()

輸出目錄的 cwd 參數,只在所給的輸出目錄是相對路徑時候有效。

options.mode

類型: String 默認值: 0777

八進制權限字符,用以定義所有在輸出目錄中所創建的目錄的權限。

var gulp = require('gulp');
gulp.src('script/jquery.js')        // 獲取流
    .pipe(gulp.dest('dist/foo.js')); // 寫放文件

      下面再說說生成的文件路徑與我們給gulp.dest()方法傳入的路徑參數之間的關系。  gulp.dest(path)生成的文件路徑是我們傳入的path參數后面再加上gulp.src()中有通配符開始出現的那部分路徑。例如:

var gulp = reruire('gulp');
//有通配符開始出現的那部分路徑為 **/*.js
gulp.src('script/**/*.js')
    .pipe(gulp.dest('dist')); //最后生成的文件路徑為 dist/**/*.js
//如果 **/*.js 匹配到的文件為 jquery/jquery.js ,則生成的文件路徑為 dist/jquery/jquery.js

      用gulp.dest()把文件流寫入文件后,文件流仍然可以繼續使用。

     5.watch:監聽文件 

      gulp.watch()用來監視文件的變化,當文件發生變化后,我們可以利用它來執行相應的任務,例如文件壓縮等。其語法為

gulp.watch(glob[, opts], tasks); 

      glob 為要監視的文件匹配模式,規則和用法與gulp.src()方法中的glob相同。 opts 為一個可選的配置對象,通常不需要用到。 tasks 為文件變化后要執行的任務,為一個數組。

gulp.task('uglify',function(){
  //do something
});
gulp.task('reload',function(){
  //do something
});
gulp.watch('js/**/*.js', ['uglify','reload']);

      gulp.watch()還有另外一種使用方式:

gulp.watch(glob[, opts, cb]);

glob和opts參數與第一種用法相同;

cb參數為一個函數。每當監視的文件發生變化時,就會調用這個函數,並且會給它傳入一個對象,該對象包含了文件變化的一些信息,type屬性為變化的類型,可以是added,changed,deleted;path屬性為發生變化的文件的路徑。

gulp.watch('js/**/*.js', function(event){
    console.log(event.type); //變化類型 added為新增,deleted為刪除,changed為改變 
    console.log(event.path); //變化的文件的路徑
}); 

     6.task:定義任務

      gulp.task方法用來定義任務,其語法為:

gulp.task(name[, deps], fn)

name 為任務名;

deps 是當前定義的任務需要依賴的其他任務,為一個數組。當前定義的任務會在所有依賴的任務執行完畢后才開始執行。如果沒有依賴,則可省略這個參數;

fn 為任務函數,我們把任務要執行的代碼都寫在里面。該參數也是可選的。

當你定義一個簡單的任務時,需要傳入任務名字和執行函數兩個屬性。

gulp.task('greet', function () {
   console.log('Hello world!');
});

      執行gulp greet的結果就是在控制台上打印出“Hello world”。

  你也可以定義一個在gulp開始運行時候默認執行的任務,並將這個任務命名為“default”:

gulp.task('default', function () {
   // Your default task
});

      前面已經介紹了gulp.task的語法,但是當有多個任務時,需要知道怎么來控制任務的執行順序。

  可以通過任務依賴來實現。例如我想要執行one,two,three這三個任務,那我們就可以定義一個空的任務,然后把那三個任務當做這個空的任務的依賴就行了:

//只要執行default任務,就相當於把one,two,three這三個任務執行了
gulp.task('default',['one','two','three']);

      如果任務相互之間沒有依賴,任務就會按你書寫的順序來執行,如果有依賴的話則會先執行依賴的任務。但是如果某個任務所依賴的任務是異步的,就要注意了,gulp並不會等待那個所依賴的異步任務完成,而是會接着執行后續的任務。例如:

gulp.task('one',function(){
  //one是一個異步執行的任務
  setTimeout(function(){
    console.log('one is done')
  },5000);
});
 
//two任務雖然依賴於one任務,但並不會等到one任務中的異步操作完成后再執行
gulp.task('two',['one'],function(){
  console.log('two is done');
});

      上面的例子中我們執行two任務時,會先執行one任務,但不會去等待one任務中的異步操作完成后再執行two任務,而是緊接着執行two任務。所以two任務會在one任務中的異步操作完成之前就執行了。

  那如果我們想等待異步任務中的異步操作完成后再執行后續的任務,該怎么做呢?

  有三種方法可以實現:

  第一:在異步操作完成后執行一個回調函數來通知gulp這個異步任務已經完成,這個回調函數就是任務函數的第一個參數。

gulp.task('one', function (cb) { //cb為任務函數提供的回調,用來通知任務已經完成
    //one是一個異步執行的任務
    exec('', function (err) {
        setTimeout(function () {
            if (err) {
                return cb(err);
            }
            console.log('one is finish');
            cb();  //執行回調,表示這個異步任務已經完成
        }, 5000)
    });
});

//這時two任務會在one任務中的異步操作完成后再執行
gulp.task('two', ['one'], function () {
    console.log('two is finish');
});

      第二:定義任務時返回一個流對象。適用於任務就是操作gulp.src獲取到的流的情況。

gulp.task('one',function(cb){
  var stream = gulp.src('client/**/*.js')
      .pipe(exec()) //exec()中有某些異步操作
      .pipe(gulp.dest('build'));
    return stream;
});
 
gulp.task('two',['one'],function(){
  console.log('two is done');
});

      第三:返回一個promise對象,例如

var Q = require('q');
gulp.task('one', function() {
  var deferred = Q.defer();
 
  // 執行異步的操作
  setTimeout(function() {
    deferred.resolve();
  }, 1);
  return deferred.promise;
});
 
gulp.task('two',['one'],function(){
  console.log('two is done');
});

三、寫自己的gulp任務

     1.項目需求

      我們將創建一個自己的gulp,具體的需求是通過gulp把我們自己所編寫的JS文件合並壓縮、CSS文件進行壓縮后,並且生成新的文件。我們所需要的插件為:gulp-minify-css gulp-concat gulp-uglify gulp-rename 如下圖所示,完成后的項目目錄結構:

     2.安裝插件

      根據我們項目的需求,安裝所需要的插件,可以通過"npm install 插件名" 來安裝插件

      然后打開gulpfile.js,將我們所用到的插件引用到我們項目中,代碼如下:

var gulp = require('gulp'),
    minifycss = require('gulp-minify-css'),  //CSS壓縮
    concat = require('gulp-concat'),         // 文件合並
    uglify = require('gulp-uglify'),         //js壓縮插件
    rename = require('gulp-rename');         // 重命名

     3.編寫任務代碼

      1.壓縮css

gulp.task('minifycss', function() {
    return gulp.src('src/css/*.css')         //壓縮的文件
        .pipe(minifycss())                   //執行壓縮
        .pipe(gulp.dest('dist/css'));        //輸出文件夾
});

      2.JS 合並壓縮

gulp.task('minifyjs', function() {
    return gulp.src('src/js/*.js')
        .pipe(concat('all.js'))               //合並所有js到main.js
        .pipe(gulp.dest('dist/js'))           //輸出main.js到文件夾
        .pipe(rename({suffix: '.min'}))       //rename壓縮后的文件名
        .pipe(uglify())                       //壓縮
        .pipe(gulp.dest('dist/js'));          //輸出
});

      3.將以上兩個任務合並為一個任務

gulp.task('build', ['minifycss', 'minifyjs']);

      4.監視文件的變化,自動執行任務

// 監視文件的變化,當文件有更新時執行build任務
gulp.task('watch', function () {
    gulp.watch(['src/js/*.js', 'src/css/*.css'], ['build']);
});

      5.定義默認任務

gulp.task('default', ['build', 'watch']);

     4.執行任務

      在命令行中先轉到gulp-demo目錄下,就可以輸入gulp命令來運行本項目了,刷新gulp-demo目錄看看會出現什么結果呢。運行完成后的目錄如下圖:

      運行過程中的消息如下圖所示:

      至此,整個gulp教程結束,同時附上gulp手冊。

      手冊1    手冊2


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM