Webpack + Angular的组件化实践

时间 2019-11-07

原文原文链接

最近写复旦二手平台的时候开始尝试用一直推崇了好久的组件化。通过一番抉择以后选择了 webpack + angular 的组合。因此在这里分享一下具体的实践流程。javascript

Webpack

Webpack是目前比较流行的前端打包工具，它同时支持AMD、CMD两种模块写法，也原生支持npm或者bower安装的模块。它还能给css、scss、less、coffeescript、es六、图片、html以及诸如jade、ejs的模板打包。css

因此有什么卵用呢？html

简单地说就是，前端

一、原来你须要在<script>中引入angular或者其余的npm模块（有些npm模块甚至没有提供能够直接在浏览器端引用的js文件），如今只须要：java

npm install angular

而后在app.js中：node

angular = require('angular');
var app = angular.module('myApp',[]);

而后执行webpack

webpack app.js bundle.js

webpack会自动分析依赖，而后编译，这样bundle.js就是你想要的东西了。git

二、组件化的时候你要在页面中引入一大堆东西，好比这样：es6

<!--index.html-->
<script type="text/javascript" src="header.js">
<script type="text/javascript" src="tab.js">
<script type="text/javascript" src="waterfoo.js">
<link rel="stylesheet" type="text/css" href="header.css">
<link rel="stylesheet" type="text/css" href="tab.css">
<link rel="stylesheet" type="text/css" href="waterfoo.css">

固然你可能不会用如此傻的方式引入组件，但若是用了webpack以后只须要这样：github

//index-bundle.js
require('header.js');
require('header.scss');
require('tab.js');
require('tab.scss');
require('waterfoo.js');
require('waterfoo.scss');

而后在index.html中引入打包好的js便可（没错连scss都给你打包好了/w\ 它甚至还能把图片打包成base64，而后替换全部url）：

<!--index.html-->
<script type="text/javascript" src="bundle.js">

上面只是最基础的用法，因此有些人可能要吐槽这不是browserify也能干么/w\ 能够看看这篇文章[《用webpack来取代browserify》
](http://segmentfault.com/a/1190000002490637)，以及webpack还有不少酷炫的功能这里就再也不赘述。

项目实践流程

回到正题吧，复旦二手平台这个项目更像是多页面的网站而不是单页面的web应用，因此我决定尝试用node去写一个渲染层（我的感受Koajs目前还不太成熟，因此选用了Express4.0），这样后台写JAVA的同窗就只须要给我提供数据API就好了，把数据库接口化。

渲染引擎用的是jade，而angular的角色更像是一个页面的“控制器”，控制由jade生成的页面，而不是去自行加载html自行渲染（说白了就是放弃了用angular渲染页面）。

Webpack和Angular的结合

Angular自带了Module以及Directive机制，但Angular1.x版本下，我以为这些机制不太适合作这种多页面网站的组件化，并且也违背了选用jade渲染的初衷。

Angular本身有本身独特的依赖注入以及模块声明方式，看起来彷佛和Webpack是水火不容的，但事实上他们彻底能够融合。只须要多几行代码：

主文件app.js大概长这样：

var angular = require('angular');
var starkAPP = angular.module('starkAPP', [
]);
module.exports = starkAPP;

注意到咱们在这里把starkAPP做为模块的接口暴露出去，而后咱们就能够这样写controller：

//someController.js
var starkAPP = require('./app.js');
starkAPP.controller('someController', ['$scope', function($scope) {
    //...
}])

运行一下webpack someController.js bundle.js 即生成了一个可使用的bundle.js。

固然若是你有一堆controller、directive、service，最好用个main.js所有声明一下依赖：

//main.js
require('./Controller1');
require('./Controller2');
require('./Controller3');
require('./Service');
require('./Directive');

目录结构设计

这里我只放了浏览器端的文件结构，整个的项目结构能够看这里

|package.json 存放npm相关的配置

|gulpfile.js gulp的配置文件

|webpack.config.js 存放webpack相关的配置

|build 存放构建完毕的资源文件

|node_modules 不解释了= =

|src 源代码

    └── components 组件
    
         ├── angular angular组件，好比各类directive、service
    
         ├── base 须要全站引入的组件，好比reset.css
    
         └── header 头部组件
         
              ├── header.jade

             ├── header.scss
             
             └── header.js
             
     └── pages 页面定义文件
     
         └──  index 首页配置文件
         
              ├── index.js
              
              └── index.scss
              
     └── template 提供给node渲染的jade模板
     
          └── index.jade 首页模板

看文件结构绝对是云里雾里的，下面详细说明：

一、首先这是首页的模板index.jade

html(ng-app="starkAPP")
    head
        link(rel='stylesheet',href='/static/css/index.css')
        script(type='text/javascript',src='/static/js/index.bundle.js')
    body(ng-view)
        include ../components/header/header.jade

注意到咱们引入了header的jade，以及两个文件index.css和index.bundle.js

二、index.css是啥？

它是pages/index/里面的index.scss编译成的：

// pages/index/index.scss
@import '../../components/header/header';
@import '../../components/base/base';

注意到咱们在这里引入了header.scss

三、index.bundle.js是啥？

它是pages/index/里面的index.js通过webpack打包成的东西

// pages/index/index/js
require('../../components/angular/app.js');
require('../../components/header/header.js');

咱们在这里引入了angular以及header.js

总之，pages下面放的就是各个页面的组件依赖文件

好比个人首页index依赖了一个组件header，那么我须要在index.js和index.scss中声明我依赖了header.js以及header.scss

其实用webpack打包的话，只须要一个定义文件就能够同时打包js和scss，但我还不太肯定webpack打包scss这种方法是否成熟。

项目构建

自动构建工具我选择了gulp全家桶，简单地说就是读取src/pages/[page-name]下面全部的js、scss文件，把他们编译到对应的build/[page-name]下面，而且监听文件变化以便热替换。

这是个人gulpfile.js:

var gulp = require('gulp');
var sass = require('gulp-sass'),
    autoprefixer = require('gulp-autoprefixer'),
    minifycss = require('gulp-minify-css'),
    uglify = require('gulp-uglify'),
    clean = require('gulp-clean'),
    webpack = require('gulp-webpack');
var webpackConfig = require('./webpack.config');
gulp.task('default', ['clean', 'watch', 'sass:watch', 'sass', 'webpack']);

gulp.task('sass:watch', function() {
    gulp.watch('src/pages/*/*.scss', ['sass']);
    gulp.watch('src/components/*/*.scss', ['sass']);
});
gulp.task('sass', function() {
    gulp.src(['src/pages/**/*.scss'])
        .pipe(sass.sync().on('error', sass.logError))
        .pipe(minifycss())
        .pipe(gulp.dest('build/pages'));
});
gulp.task('clean', function() {
    return gulp.src(['build/pages'], {
            read: false
        })
        .pipe(clean());
});
gulp.task("webpack", function() {
    return gulp
        .src('./')
        .pipe(webpack(webpackConfig))
        //.pipe(uglify())
        .pipe(gulp.dest('./build/pages'));
});
gulp.task('watch', function() {
    gulp.watch('src/components/*/*.js', ['webpack']);
    gulp.watch('src/pages/*/*.js', ['webpack']);
});

以及简化后的webpack.config.js：

module.exports = {
    entry: {
        'index/index': './src/pages/index/index.js'
    },
    output: {
        filename: '[name].bundle.js'
    }
};

怎么写一个组件？

好比如今咱们要写一个waterfoo（瀑布流）组件

首先咱们在src/components/下面新建一个文件夹waterfoo ，而后创建

waterfoo.jade
waterfoo.scss
waterfoo.js

分别对应waterfoo组件的模板、样式、以及行为，固然waterfoo组件彻底能够依赖其余更低层级组件，只须要在相应的文件中声明依赖便可。

怎么在页面中加入组件？

好比如今咱们要把waterfoo（瀑布流）组件加到首页index中

首先在src/template/index.jade中引入模板：

include ../components/waterfoo/waterfoo.jade

而后在src/pages/index/下面的index.js、index.scss配置依赖：

//index.js
require('../../components/waterfoo/waterfoo');

//index.scss
@import '../../components/waterfoo/waterfoo';

有更优雅更傻瓜的方法吗？

固然有，将来的指望是用webpack把js和scss一块儿打包，而且把template和pages文件夹合并（具体配置express渲染路径的方法我还在探索），大概就是这样的效果：

src/pages/index/下面放着首页的配置文件：

index.jade
index-config.js
index.scss （一些非组件的样式）

index.jade是模板

html(ng-app="starkAPP")
   head
       script(type='text/javascript',src='/static/js/index.bundle.js')
   body(ng-view)
       include ../components/header/header.jade

index-config.js声明依赖的组件

require('../../components/angular/app.js');
require('../../components/header/header.js');
require('../../components/header/header.scss');
require('../../components/waterfoo/waterfoo.js');
require('../../components/waterfoo/waterfoo.scss');
require('./index.scss');

-------

最后

这个项目的源码在Github · starkwang/FDSHM，FDSHM是Fudan Secondhand Market的缩写/w\，如今还在慢慢地写组件中，争取这学期上线吧……（缺人啊QAQ）