资讯专栏INFORMATION COLUMN

webpack学习笔记

mylxsw / 1450人阅读

摘要:配置完成后就可以使用来打包代码了。值得注意的是会删除所有无作用代码也就是说那些包裹在这些全局变量下的代码块都会被删除这样就能保证这些代码不会因发布上线而泄露。默认会从项目的根目录下引入这些文件。

命令使用
npm install webpack -g
    作为全局安装, 在任意目录使用

npm install webpack --save-dev
    作为项目依赖安装

npm init
    创建package.json

npm install webpack-dev-server --save-dev
    使用webpack-dev-server启动服务器

webpack --progress -colors
    让编译的输出内容带有进度和颜色

webpack --watch
    如果不想每次修改模块后都重新编译, 那么可以启动监听模式。
    开启监听模式后, 没有变化的模块会在编译后缓存到内存中,
    而不会每次都被重新编译, 所以监听模式的整体速度是很快的

webpack --display-error-details
    用来打印错误详情

npm install xxx-loader --save-dev
    安装多个加载器: npm install babel-core babel-preset-es2015 babel-preset-react

npm webpack --config webpack.config.js
    执行打包命令

npm start
    启动开发模式下的server

npm run start:prod
    启动生产模式的server

npm run build
    打包生产模式的代码

npm run lint: eslint
    代码检查

npm run lint:watch: eslint
    监视

npm run remove:build
    删除dist目录

npm run clean:build
    清除dist目录

// 调用webpack
webpack
    开发环境下编译

webpack -p
    产品编译及压缩

webpack --watch
    开发环境下持续的监听文件变动来进行编译

webpack -d
    引入source maps
配置文件
webpack.config.dev.js: 开发模式相关配置
webpack.config.prod.js: 生产模式相关配置
server.js: 配置本地的server(包含dev server和prod server) 将server部分分离到一个多带带到的文件配置
package.json
//webpack.config.dev.js

var webpack = require("webpack");
var path = require("path");
var config = {
    // 入口文件配置
    entry: {
        path.resolve(__dirname, "app/index.js");
    },
    // 文件输出配置
    output: {
        path: path.resolve(_dirname, "build"),
        filename: "bundle.js",
        publicPath: "/"
    },

    // 插件项
    plugins: [],

    // 加载器配置
    module: {
        loaders: [
            {
                test: /pattern/,
                loader: "xxx-loader",
                exclude: /dir/,
                query: {
                    presets: ["react"]
                }
            },
             {
                 test: /.(png|jpg)$/,
                 loader: "url-loader?limit=8192"
                 // 内联的base64的图片地址, 图片要小于8k, 直接的url的地址则不解析
             }
        ]
    },
    // 其他解决方案配置
    resolve: {
        extensions: ["", ".js", ".json"],
        alias: {}
    },
    watch: true
};

module.exports = config;
webpack.server.js

var webpack = require("webpack");
var webpackServer = require("webpack-dev-server");
var config = require("./webpack.config.dev.js");

var compiler = webpack(config);
var server = new webpackDevServer(compiler, {
    contentBase: "./app",
    historyApiFallback: true,
    hot: true,        //热启动
    inline: true, // 监控js变化
    stats: {
        color: true
    }
});

config.entry.unshift("webpack-dev-server/client?http://localhost:8080/",
    "webpack/hot/dev-server");

server.listen(8080, "localhost", function(err) {
    if(err) {
        console.log(err);
    }
    console.log("Listening at localhost:8080...");
});


"script": {
    "start": "node server.js"
}
配置详解
entry: 入口, 定义要打包的文件

output: 出口, 定义打包输出的文件;包括路径, 文件名,还可能有运行时的访问路径(publicPath)参数

module: webpack将所有的资源都看做是模块, 而模块就需要加载器;
|---- loaders: 主要定义一些loaders, 定义哪些后缀名的文件应该用哪些loader

|-------- test: 匹配文件后缀, 检测哪些文件需要此loader, 是一个正则表达式

|-------- exclude: 忽略哪些文件

|-------- query: 参数 (或直接写于loader如: loader: "url-loader?limit=8192")

|------------ presets:

resolve: 其他解决方案配置

|---- extensions: 忽略文件扩展名, require文件时可直接使用require("file"),而非带后缀如require("file.js")

|-------- alias: 模块别名定义,方便后续直接饮用别名无需多写长地址, 后续直接require(key)

plugins: 定义一些额外的插件

watch: 值为boolean, 监听文件变化
配置生产环境
开发环境:
    webpack.config.dev.js
    需要日志输出, sourcemap, 错误报告等

生产环境:
    webpack.config.prod.js
    需要做代码压缩, 对文件名进行hash处理等
区分环境

使用DefinePlugin设置环境变量, 根据设置的环境变量决定是否打包压缩及启动dev server或prod server

plugins: [
    new webpack.DefinePlugin({
        "process.evn.NODE_ENV": JSON.stringify("production")
    });
]

判断当前是否是生产环境

var isProduction = function() {
    return process.env.NODE_ENV === "production";
}


output: {
    path: path.resolve(isProduction ? "__build" : "./assets/"),
    filename: isProduction ? "[name].js" : "./assets/js/[chunkhash:8].[name].min.js",
    chunkFilename: isProduction ? "[chunkhash:8].chunk.js" : "./assets/js/[chunkhash:8].chunk.min.js",
    publicPath: isProduction ? "/__build/" : "http://cdn.site.com/"
}
代码压缩
new webpack.optimizeUglifyJsPlugin({
    compress: {
        warnings: false
    }
});
添加Hash缓存

对于没有修改的文件, 从缓存中获取文件, 对于已经修改的文件, 不要从缓存中获取

output: {
    //chunkhash 默认16位, 可自定义配置
    filename: "[chunkhash:8].bundle.js"
}
自动生成页面

文件名带上hash值后, 这个值在每次编译的时候都会发生变化,都需要在 html 文件里手动修改引用的文件名,这种重复工作很琐碎且容易出错, 这里我们可以使用 html-webpack-plugin 来帮我们自动处理这件事情, 用来简化创建服务于webpackbundle的HTML文件

解决方案: 在项目目录下建一个index.tpl.html作为钩子

    
    
    
    
        
        My APP
    
    
        

在webpack.config.dev.js和webpack.config.prod.js添加配置代码, 即可生成相应的index.html

    plugins: [
        new HtmlWebpackPlugin({
            template: "app/index.tpl.html",
            inject: "body",
            filename: index.html
        })
    ]
加载器 js处理
babel-loader: 转换JSX
babel-core: babel核心包
babel-preset-react
babel-preset-es2015


loaders:[
    {
        loaders: "xxx-loader",
        query: {
            resets:["react", "es2015"]
        }
    }
]
css处理
style-loader
css-loader
less-loader
img处理
url-loader
    可以根据自定义文件大小或者转化为 base64 格式的 dataUrl, 或者多带带作为文件, 也可以自定义对应的hash 文件名
file-loader
    默认情况下会根据图片生成对应的 MD5hash 的文件格式
image-webpack-loader
    提供压缩图片的功能

加载babel-loader需要配置query参数



loaders:[
    {
        test: /.(jpe?g|png|gif|svg)$/i,
        loaders: [
            // 当内容size小于8KB时, 会自动转成base64的方式内嵌进去, 这样可以减少一个HTTP的请求
            // 当图片大于8KB时, 则会在img/下生成压缩后的图片, 命名是[hash:8].[name].[ext]的形式
            // hash:8的意思是取图片内容hashsum值的前8位,
            // 这样做能够保证引用的是图片资源的最新修改版本, 保证浏览器端能够即时更新
            "url?limit=8192&name=img/[hash:8].[name].[ext]",

            // 图片压缩
            "image-webpack"
        ]
    }
]


loaders:[
    {
        test: /.(jpe?g|png|gif|svg)$/i,
        loaders: [
            // 生成md5 hash格式的文件名
            "file?hash=sha512&digest=hex&name=[hash].[ext]",
            // 图片压缩
            "image-webpack"
        ]
    }
]
插件

plugins: [definPlugin, bannerPlugin, uglifyJsPlugin...]
设置环境变量
var definPlugin = new webpack.DefinePlugin({
    "process.env": {
        NODE_ENV: JSON.stringify("production")
    }
    // feature flags: 在开发环境(例如日志)活内部测试环境(例如没有发布的新功能)中使用
    // __DEV__: JSON.stringify(JSON.parse(process.env.BUILD_DEV || "true")),
    // __PRERELEASE__: JSON.stringify(JSON.parse(process.env.BUILD_PRERELEASE || "false"))
});
给输出的文件头部添加注释信息
var bannerPlugin = new webpack.BannerPlugin("This is test!");
JS混淆
var uglifyJsPlugin = new webpack.optimize.UglifyJsPlugin({
    mangle: {
        // 配置以下列表, 在混淆代码时, 以下配置的变量, 不会被混淆
        except: ["$super", "$", "exports", "require"]
    }
});
压缩JS
var minChunkSizePlugin = new webpack.optimize.MinChunkSizePlugin({
    compress: {
        warnings: false
    }
});
压缩React
var definPlugin = new webpack.DefinePlugin({
    "process.env": {
        NODE_ENV: JSON.stringify("production")
    }
});
加载jQuery
new webpack.ProvidePlugin({
    $: "jquery"
});
公共模块提取
new webpack.optimize.CommonsChunkPlugin({
    name: "vendors",                     // 将公共模块提取, 生成名为`vendors`的chunk
    chunks: ["index","list","about"],     //提取哪些模块共有的部分
    minChunks: 3                         // 提取至少3个模块共有的部分
});
多带带使用link标签加载css并设置路径
new ExtractTextPlugin("css/[name].css"), // 相对于output配置中的publickPath
自动生成html文件, 模板生成的相关配置, 每个对于一个页面的配置, 有几个写几个
new HtmlWebpackPlugin({                 //根据模板插入css/js等生成最终HTML
    favicon: "./src/img/favicon.ico",     //favicon路径, 通过webpack引入同时可以生成hash值
    filename: "./view/index.html",         //生成的html存放路径, 相对于path
    template: "./src/view/index.html",     //html模板路径
    inject: "body",                     //js插入的位置, true/"head"/"body"/false
    hash: true,                         //为静态资源生成hash值
    chunks: ["vendors", "index"],        //需要引入的chunk, 不配置就会引入所有页面的资源
    minify: {                             //压缩HTML文件
        removeComments: true,             //移除HTML中的注释
        collapseWhitespace: false         //删除空白符与换行符
    }
});
new HtmlWebpackPlugin({                 //根据模板插入css/js等生成最终HTML
    favicon: "./src/img/favicon.ico",     //favicon路径, 通过webpack引入同时可以生成hash值
    filename: "./view/list.html",         //生成的html存放路径, 相对于path
    template: "./src/view/list.html",     //html模板路径
    inject: true,                         //js插入的位置, true/"head"/"body"/false
    hash: true,                         //为静态资源生成hash值
    chunks: ["vendors", "list"],        //需要引入的chunk, 不配置就会引入所有页面的资源
    minify: {                             //压缩HTML文件
        removeComments: true,             //移除HTML中的注释
        collapseWhitespace: false         //删除空白符与换行符
    }
});
其它插件
new webpack.HotModuleReplacementPlugin()     // 热加载
HotModuleReplacementPlugin()                 // 代码热替换
NoErrorsPlugin()                             // 报错但不退出webpack进程
OpenBrowserPlugin()                         // 自动打开浏览器
webpack使用 分析多个模块的公用代码提取并多带带打包
var commonsPlugin = new webpack.optimize.CommonsChunkPlugin("common.js");
module.exports = {
    entry: {
        page1: "./main1.js",
        page2: "./main2.js"
    },
    output: {
        path: "build",
        filename: "[name].js"
    },
    plugins: [
        commonsPlugin
    ]
}
文件引用忽略扩展名配置

如果你希望在require文件时省略文件的扩展名, 只需要在webpack.config.js中添加 resolve.extensions 来配置。

// webpack.config.js
module.exports = {
    entry: "./main.js",
    output: {
        filename: "bundle.js"
    },
    module: {
        loaders: [
            { test: /.coffee$/, loader: "coffee-loader" },
            {
                test: /.js$/,
                loader: "babel-loader",
                query: {
                    presets: ["es2015", "react"]
                }
            }
        ]
    },
    resolve: {
        // 现在你require文件的时候可以直接使用require("file"), 不用使用require("file.coffee")
        extensions: ["", ".js", ".json", ".coffee"]
    }
};
css样式和图片的加载

首先你需要用require()去加载你的静态资源(named as they would with node"s require()):

require("./bootstrap.css");
require("./myapp.less");

var img = document.createElement("img");
img.src = require("./glyph.png");

当你require了CSS(less或者其他)文件, webpack会在页面中插入一个内联的