從零開始建立 angularjs-gulp-es5 項目

源碼地址：https://github.com/silence717/angular-gulp-seed

建立一個空文件夾名字任意，此項目爲angular-gulp-seed

mkdir angular-gulp-seed

初始化工程

npm init

建立項目基本目錄結構以下：

+src
    +app            // 業務模塊
        -app.js    // 應用入口
        +demo   // 業務模塊目錄，全部子模塊均遵循此目錄
            - module.js      // 模塊聲明文件
            - controller.js  // vm層
            - index.html     // 主入口模板
            - router.js      // 模塊路由文件
            - style.css      // 模塊樣式
        +home
    +assets            // 靜態資源目錄
        -images
        -css
    +common            // 公共服務
    +components    // 公共組件
    +scripts         // gulp腳本
        - gulp.build.js   // build任務
        - gulp.common.js  // dev,build公共任務
        - gulp.config.js  // 基礎配置
        - gulp.dev.js     // dev任務
    index.html  // 主頁面

package.json

正式開始coding

gulp配置部分

1. 安裝gulp

npm install  gulp -D

2. 新建gulpfile文件，安裝browser-sync包，配置第一個任務

var browserSync = require('browser-sync');
gulp.task('browserSync', function () {
    browserSync({
        server: {
            baseDir: './',
            index: 'src/index.html'
        }
    });
});
gulp.task('default', ['browserSync']);
// 執行gulp命令，瀏覽器啓動，能夠看到大體頁面結構

更多browser-sync的信息：http://www.browsersync.cn/。

3. 爲了動態插入新加的js和css文件,且添加的文件有必定順序，安裝gulp系列包。

npm install gulp-watch gulp-inject gulp-order -D

4. 新建一個gulp.config.js文件,配置一些基本文件路徑和順序

module.exports = function () {

    var src = './src/';
    var build = './dist/';

    var config = {
        src: src,
        build: build,
        index: src + 'index.html',
        css: [src + '**/*.css'],
        appJs: [src + 'app/**/*.js'],
        commonJs: [src + 'common/**/*.js'],
        componentJs: [src + 'components/**/*.js'],
        jsOrder: [
            '**/app.js',    // 項目主入口
            '**/app.*.js',  // 主入口相應配置
            '**/module.js', // 模塊聲明
            '**/router.js', // 模塊路由
            '**/index.js',  // 組件、resource入口
            '**/*.js'       // 其餘
        ],
        cssOrder: [
            '**/app.css',       // 項目主模塊
            '**/*.module.css',  // 業務子模塊
            '**/*.css'          // 其餘
        ]
    }
    return config;
}();

5. 使用gulp-inject動態插入css和js

• js任務編寫

var config = require('./gulp.conf.js');
gulp.task('inject', function() {

    var js = gulp.src(config.js, {read: false}).pipe(order(config.jsOrder));
    var css = gulp.src(config.css, {read: false}).pipe(order(config.cssOrder));

    return gulp
        .src(config.index)
        .pipe(inject(js, {addPrefix: '../src', relative: true}))
        .pipe(inject(css, {addPrefix: '../src', relative: true}))
        .pipe(gulp.dest(config.src))
        .pipe(browserSync.reload({stream: true}));
});

• 頁面添加inject標識

<!-- css -- >
<!-- inject:css -->
<!-- endinject -->

<!-- js -- >
<!-- inject:js -->
<!-- endinject -->

• 添加到default任務中

gulp.task('default', ['inject', 'browserSync']);

• 執行gulp命令，可看到如圖頁面效果,同時index.html頁面內容發生變化

<!-- inject:css -->
<link rel="stylesheet" href="../src/assets/css/app.css">
<!-- endinject -->

<!-- inject:js -->
<script src="../src/app/app.js"></script>
<!-- endinject -->

6. 開發過程當中會不斷添加新的css和js文件，爲了優化開發體驗，引入gulp-watch包添加watch任務，當js和css文件發生變化的時候，去執行inject任務

var watch = require('gulp-watch');
gulp.task('watch', function() {
    watch('src/**/*.js', function() {
        gulp.run('inject');
    });
    watch('src/**/*.css', function() {
        gulp.run('inject');
    });
});
gulp.task('default', ['inject', 'browserSync', 'watch']);

編寫業務代碼

1. 安裝angular相關包

npm install  angular angular-ui-router --save

2. 因爲代碼量過大，不貼出具體參見src/spp下面代碼實現

• src/index.html

• src/app.js 項目主入口

• src/app.router.js 項目路由配置

mock數據服務

爲了前端保持獨立，使用express搭建一個mock服務，而後咱們就能愉快的開始開發了。

1. 首先安裝依賴包：

npm install express body-parser json-server http-proxy-middleware -D

2. 建立server.js，內容以下：

var jsonServer = require('json-server');
var server = jsonServer.create();
var middlewares = jsonServer.defaults();
var bodyParser = require('body-parser');
var mockRouter = require('./mock/index');

// 添加默認的中間件 logger, static, cors and no-cache
server.use(middlewares);

// 解析 body
server.use(bodyParser.json());
server.use(bodyParser.urlencoded({
    extended: false
}));

server.use(mockRouter);

server.listen(4000, function() {
    console.log('God bless me no bug, http://localhost:4000');
});

3. mock文件夾下建立index.js,內容以下：

var fs = require('fs');
var express = require ('express');
var router = express.Router();

fs.readdirSync('mock').forEach(function(route) {
    if (route.indexOf('index') === -1) {
        require('./' + route)(router);
    }
});

module.exports = router;

4. 引入angular-resource.js，使用$resource服務

npm install angular-resource --save

在common/resource/建立一個utils,具體文件爲resourceUtils，爲全部請求添加統一前綴

(function() {
    angular
        .module('app.resource')
        .factory('resourceUtils', resourceUtils)
        .factory('webResource', webResource);

    resourceUtils.$inject = ['$resource'];

    function resourceUtils($resource) {
        return function(apiPrefix) {
            return function(url, params, actions) {
                return $resource(apiPrefix + url, params, actions);
            };
        };
    }

    webResource.$inject = ['resourceUtils'];
    function webResource(resourceUtils) {
        // 其中***爲後端服務的統一前綴
        return resourceUtils('/***/'); 
    }

})();

關於$resource服務的使用，請參考這篇文章。https://silence717.github.io/2016/09/28/creating-crud-app-minutes-angulars-resource/

5. 在gulpfile.js中統一配置代理，而且修改browserSync任務：

// 引入http-proxy-middleware
var proxyMiddleware = require('http-proxy-middleware');

// 配置代理路徑,是否爲本地mock
var isLocal = true;
var target = '';

if (isLocal) {
    target = 'http://localhost:4000';
} else {
    // API address
}
// browserSync任務添加代理
gulp.task('browserSync', function() {
    var middleware = proxyMiddleware(['/***/'], {target: target, changeOrigin: true});
    browserSync({
        server: {
            baseDir: './',
            index: 'src/index.html',
            middleware: middleware
        }
    });
});

6. 你可能須要添加一些公共的interceptor去處理後端返回的數據或者請求出錯的統一處理。具體參見[https://docs.angularjs.org/api/ng/service/$http](https://docs.angularjs.org/api/ng/service/$http).

至此已經能夠在本地愉快的開發了。

配置gulp編譯任務

開發完成之後代碼須要build上線，繼續建立一些task。

1. 安裝相關依賴包

npm install gulp-angular-templatecache gulp-minify-css gulp-if gulp-useref gulp-uglify gulp-replace -D

2. 配置build任務，具體在scripts/gulp.build.js文件中.

3. 頁面html遇到build的地方配置

...
 <!-- build:css css/app.css -->
 <!-- endbuild -->
 
 <!-- build:js js/common.js -->
 <!-- endbuild -->
 ...

我將gulp的任務所有獨立出去管理，這樣使得gulpfile.js更加清晰

var gulp = require('gulp');
var del = require('del');
var runSequence = require('run-sequence');
var config = require('./scripts/gulp.conf.js');
var buildTask = require('./scripts/gulp.build.js');
var devTask = require('./scripts/gulp.dev.js');
var commonTask = require('./scripts/gulp.common.js');

// 動態添加css和js到index.html
gulp.task('inject', function() {
    commonTask.inject();
});
// 添加監放任務
gulp.task('watch', function() {
    devTask.watch();
});
// 使用browerSync啓動瀏覽器
gulp.task('browserSync', function() {
    devTask.browserSync();
});
// 清除dist文件
gulp.task('clean', function() {
    del(config.build);
});
// 打包組件模板
gulp.task('build:components-templates', function() {
    buildTask.componentsTemplate();
});
// 打包業務模板
gulp.task('build:app-templates', function () {
    buildTask.appTemplate();
});
// build index文件
gulp.task('build', ['build:components-templates', 'build:app-templates'], function() {
    buildTask.buildIndex();
});
// 本地開發
gulp.task('default', ['inject', 'browserSync', 'watch']);
// 線上環境打包
gulp.task('dist', ['clean'], function() {
    runSequence('inject', 'build');
});

在package.json中配置腳本

"scripts": {
    "start": "concurrently \"gulp\" \"node server.js\""
  }

• 執行npm start便可本地啓動項目

• 上線合併代碼的時候執行gulp dist命令便可

拖延症晚期，終於寫完了。有時間會加入eslint校驗,添加md5，添加sass等等。。。須要作的還有不少，看心情吧！