Laravel 的资源任务编译器 Laravel Mix

简介

Laravel Mix 提供了简洁流畅的 API,让你能够为你的 Laravel 应用定义 Webpack 的编译任务。Mix 支持许多常见的 CSS 与 JavaScript 预处理器,通过简单的方法,你可以轻松的管理资源。例如:

mix.js('resources/assets/js/app.js', 'public/js')
    .sass('resources/assets/sass/app.scss', 'public/css');

如果你曾经对于使用 Webpack 及编译资源感到困惑,那么你绝对会爱上 Laravel Mix。当然,在 Laravel 应用开发中使用 Mix 并不是必须的,你也可以选择任何你喜欢的资源编译工具,或者不使用任何工具。

安装

安装 Node

在开始使用 Mix 之前,你必须先确定你的开发环境上有安装 Node.js 和 NPM。

node -v
npm -v

默认情况下, Laravel Homestead 会包含你所需的一切。当然,如果你没有使用 Vagrant,那么你可以浏览 nodejs 下载可视化的安装工具来安装最新版的 Node 和 NPM.

Laravel Mix

剩下的只需要安装 Laravel Mix!随着新安装的 Laravel, 你会发现根目录下有个名为 package.json 的文件。就如同 composer.json 文件, 只不过 package.json 文件定义的是 Node 的依赖,而不是 PHP。你可以使用以下的命令安装依赖扩展包:

npm install

如果你使用的是 Windows 系统或运行在 Windows 系统上的 VM, 你需要在运行 npm install 命令时将 --no-bin-links 开启:

npm install --no-bin-links

使用

Mix 基于 Webpack 的配置, 所以运行定义于 package.json 文件中的 NPM 脚本即可执行 Mix 的编译任务:

// 运行所有 Mix 任务...
npm run dev

// 运行所有 Mix 任务和压缩资源输出
npm run production

监控资源文件修改

npm run watch 会在你的终端里持续运行,监控资源文件是否有发生改变。在 watch 命令运行的情况下,一旦资源文件发生变化,Webpack 会自动重新编译:

npm run watch

你可能会发现,在某些环境下,当你改变了你的文件的时候而 Webpack 并没有同步更新。如果在你的系统中出现了这个问题,你可以考虑使用 watch-poll 命令:

npm run watch-poll

使用样式

项目根目录的 webpack.mix.js 文件是资源编译的入口。可以把它看作是 Webpack 的配置文件。Mix 任务可以使用链式调用的写法来定义你的资源文件该如何进行编译。

Less

less 方法可以让你将 Less 编译为 CSS。下面的命令可以把 app.less 编译为 public/css/app.css

mix.less('resources/assets/less/app.less', 'public/css');

多次调用 less 方法可以编译多个文件:

mix.less('resources/assets/less/app.less', 'public/css')
   .less('resources/assets/less/admin.less', 'public/css');

如果你想自定义编译后的 CSS 文件名, 你可以传递一个完整的路径到 less 方法的第二个参数:

mix.less('resources/assets/less/app.less', 'public/stylesheets/styles.css');

如果你需要重写 底层 Less 插件选项,你可以传递一个对象到 mix.less() 的第三个参数:

mix.less('resources/assets/less/app.less', 'public/css', {
    strictMath: true
});

Sass

sass 方法可以让你将 Sass 编译为 CSS。你可以使用此方法:

mix.sass('resources/assets/sass/app.scss', 'public/css');

同样的,如同 less 方法, 你可以将多个 Sass 文件编译为多个 CSS 文件,甚至可以自定义生成的 CSS 的输出目录:

mix.sass('resources/assets/sass/app.sass', 'public/css')
   .sass('resources/assets/sass/admin.sass', 'public/css/admin');

另外 Node-Sass 插件选项 可以通过传递第三个参数来重写:

mix.sass('resources/assets/sass/app.sass', 'public/css', {
    precision: 5
});

Stylus

类似于 Less 和 Sass,stylus 方法允许你编译 Stylus 为 CSS:

mix.stylus('resources/assets/stylus/app.styl', 'public/css');

你也可以安装其他的 Stylus 插件,例如 Rupture。首先,通过 NPM(npm install rupture) 来安装插件,然后在调用 mix.stylus() 的时候引用插件:

mix.stylus('resources/assets/stylus/app.styl', 'public/css', {
    use: [
        require('rupture')()
    ]
});

PostCSS

PostCSS,一个用来转换 CSS 的强大工具,已经包含在 Laravel Mix 中。默认, Mix 利用了流行的 Autoprefixer 插件来自动添加所需要的 CSS3 供应商前缀。不过,你也可以自由添加任何适合你应用程序的插件。首先,通过 NPM 来安装想要的插件,然后在你的 webpack.mix.js 文件中引用:

mix.sass('resources/assets/sass/app.scss', 'public/css')
   .options({
        postCss: [
            require('postcss-css-variables')()
        ]
   });

纯 CSS

如果你只是想将一些纯 CSS 样式合并成单个的文件, 你可以使用 styles 方法。

mix.styles([
    'public/css/vendor/normalize.css',
    'public/css/vendor/videojs.css'
], 'public/css/all.css');

URL 处理

由于 Laravel Mix 是建立在 Webpack 之上,所以了解一些 Webpack 概念就非常有必要。编译 CSS 的时候,Webpack 会重写和优化那些你样式表中调用 url() 的地方。 虽然可能一开始听起来觉得奇怪,不过这确实是一个强大的功能。试想一下我们编译一个包含相对路径图片的 Sass 文件:

.example {
    background: url('../images/example.png');
}

{note} url() 方法会在 URL 重写中排除绝对路径。例如 url('/images/thing.png') 或者 url('http://example.com/images/thing.png') 不会被修改。

Laravel Mix 和 Webpack 默认会找到 example.png,把它复制到你的 public/images 目录下,然后在你生成的样式表中重写 url()。这样,你编译之后的 CSS 会变成:

.example {
  background: url(/images/example.png?d41d8cd98f00b204e9800998ecf8427e);
}

与此功能相同,可能你的现在的文件夹结构已经按照你喜欢的方式来配置。如果是这种情况,你可以像这样来禁用 url() 重写:

mix.sass('resources/assets/app/app.scss', 'public/css')
   .options({
      processCssUrls: false
   });

如果在你的 webpack.mix.js 文件这样配置之后,Mix 将不再匹配 url() 或者复制 assets 到你的 public 目录。换句话来说,编译后的 CSS 跟你原来输入的看起来一样:

.example {
    background: url("../images/thing.png");
}

资源地图

source maps 默认状态下是禁用的,你可以通过在 webpack.mix.js 文件中调用 mix.sourceMaps() 方法来开启。它会带来一些编译成本,但在使用编译后的资源文件时可以更方便的在浏览器中进行调试:

mix.js('resources/assets/js/app.js', 'public/js')
   .sourceMaps();

使用脚本

Mix 也提供了一些函数来帮助你使用 JavaScript 文件,像是编译 ECMAScript 2015、模块编译、压缩、及简单的串联纯 JavaScript 文件。更棒的是,这些都不需要自定义的配置:

mix.js('resources/assets/js/app.js', 'public/js');

这一行简单的代码,支持:

  • ECMAScript 2015 语法.
  • Modules
  • 编译 .vue 文件.
  • 针对生产环境压缩代码.

Vendor Extraction

将应用程序的 JavaScript 与依赖库捆绑在一起的一个潜在缺点是,使得长期缓存更加困难。如,对应用程序代码的单独更新将强制浏览器重新下载所有依赖库,即使它们没有更改。

如果你打算频繁更新应用程序的 JavaScript,应该考虑将所有的依赖库提取到单独文件中。这样,对应用程序代码的更改不会影响 vendor.js 文件的缓存。Mix 的 extract 方法可以轻松做到:

mix.js('resources/assets/js/app.js', 'public/js')
   .extract(['vue'])

extract 方法接受你希望提取到 vendor.js 文件中的所有的依赖库或模块的数组。使用以上代码片段作为示例,Mix 将生成以下文件:

  • public/js/manifest.js: Webpack 显示运行时
  • public/js/vendor.js: 依赖库
  • public/js/app.js: 应用代码

为了避免 JavaScript 错误,请务必按正确的顺序加载这些文件:

<script src="/js/manifest.js"></script>
<script src="/js/vendor.js"></script>
<script src="/js/app.js"></script>

React

Mix 可以自动安装 Babel 插件来支持 React。你只需要替换你的 mix.js() 变成 mix.react() 即可:

mix.react('resources/assets/js/app.jsx', 'public/js');

在背后,React 会自动下载,并且自动下载适当的 babel-preset-react Babel 插件。

原生 JS

类似使用 mix.styles() 来组合多个样式表一样,你也可以使用 scripts() 方法来合并并且压缩多个 JavaScript 文件:

mix.scripts([
    'public/js/admin.js',
    'public/js/dashboard.js'
], 'public/js/all.js');

这个选项对于那些没有使用 Webpack 的历史项目非常有用。

{tip} mix.babel()mix.scripts() 有点稍微不一样。babel 方法用法和 scripts 一样;不过,这些文件会经过 Babel 编译,把所有 ES2015 的代码转换为原生 JavaScript,这样所有浏览器都能识别。

自定义 Webpack 配置

Laravel Mix 默认引用了一个预先配置的 webpack.config.js 文件,以便尽快启动和运行。有时,你可能需要手动修改此文件。例如,你可能有一个特殊的加载器或插件需要被引用,或者也许你喜欢使用 Stylus 而不是 Sass。在这种情况下,你有两个选择:

合并

Mix 提供了一个有用的 webpackConfig 方法,允许合并任何 Webpack 配置以覆盖默认配置。这是一个非常好的选择,你不需要复制和维护 webpack.config.js 文件。webpackConfig 方法接受一个对象,该对象应包含要应用的任何 Webpack 配置项

mix.webpackConfig({
    resolve: {
        modules: [
            path.resolve(__dirname, 'vendor/laravel/spark/resources/assets/js')
        ]
    }
});

复制文件与目录

copy 方法可以复制文件与目录至新位置。当 node_modules 目录中的特定资源需要复制到 public 文件夹时会很有用。

mix.copy('node_modules/foo/bar.css', 'public/css/bar.css');

版本与缓存清除

许多的开发者会在它们编译后的资源文件中加上时间戳或是唯一的 token,强迫浏览器加载全新的资源文件以取代提供的旧版本代码副本。你可以使用 version 方法让 Mix 处理它们。

version 方法为你的文件名称加上唯一的哈希值,以防止文件被缓存:

mix.js('resources/assets/js/app.js', 'public/js')
   .version();

在为文件生成版本之后,你将不知道确切的文件名。因此,你应该在你的视图 中使用 Laravel 的全局 mix PHP 辅助函数来正确加载名称被哈希后的文件。 mix 函数会自动判断被哈希的文件名称:

<link rel="stylesheet" href="{{ mix('/css/app.css') }}">

在开发中通常是不需要版本化,你可能希望仅在运行 npm run production 的时候进行版本化:

mix.js('resources/assets/js/app.js', 'public/js');

if (mix.config.inProduction) {
    mix.version();
}

Browsersync 自动加载刷新

BrowserSync 可以监控你的文件变化,并且无需手动刷新就可以把你的变化注入到浏览器中。你可以通过调用 mix.browserSync() 方法来启用这个功能支持:

mix.browserSync('my-domain.dev');

// 或者...

// https://browsersync.io/docs/options
mix.browserSync({
    proxy: 'my-domain.dev'
});

你可以通过传递一个字符串 (代理) 或者一个对象 (BrowserSync 设置) 给这个方法。接着,使用 npm run watch 命令来开启 Webpack 的开发服务器。现在,当你修改一个脚本或者 PHP 文件,看着浏览器立即刷新出来的页面来反馈你的改变。

通知

在可用的时候,Mix 会将每个包的编译是否成功以系统通知的方式反馈给你。如果你希望停用这些通知,可以通过 disableNotifications 方法实现:

mix.disableNotifications();

译者署名

用户名 头像 职能 签名
@zyxcba 翻译 考拉客 - 考拉微商店主加盟立返100元!