Webpack-publicPath

你真的知道publicPath的用处吗?无论是官方文档,还是水友的解释都很难让豁然开朗,比如:

对于按需加载(on-demand-load)或加载外部资源(external resources)(如图片、文件等)来说,output.publicPath 是很重要的选项。如果指定了一个错误的值,则在加载这些资源时会收到 404 错误。
此选项指定在浏览器中所引用的「此输出目录对应的公开 URL」。相对 URL(relative URL) 会被相对于 HTML 页面(或 <base> 标签)解析。相对于服务的 URL(Server-relative URL),相对于协议的 URL(protocol-relative URL) 或绝对 URL(absolute URL) 也可是可能用到的,或者有时必须用到,例如:当将资源托管到 CDN 时。

实验是检验用法的最好途径,于是设置目录结构如下:
src
|---index.html
|---index.js
|---asssets
    |----1.jpg

  • index.html使用<script src="./dist/bundle.js"/>的方式引入打包后的脚本。
  • index.js使用require('./assets/1.jpg')的方式引入了图片
  • webpack.config.js的配置如下:
    entry:"./index.js",
    output:{
        filename:"bundle.js",
        path:path.resolve(__dirname,"dist"),
    },
    devServer:{
    },

目的是将脚本打包到一个统一的dist文件夹下。

使用webpack-dev-server重新打包并打开index.html时,报错如下:

http://localhost:8080/dist/bundle.js net::ERR_ABORTED

为什么找不到呢?

  1. webpack-dev-server使用的是内存中的打包文件,并不是webpack命令打包后的路径。(上面我没有使用webpack命令打包哦。)
  2. webpack-dev-server在不设置publicPath的情况下,将默认输出bundle.js到根目录。不信,你输入localhost:8080/bundle.js就能看到这个Js。
  3. 报错是因为,输出的bundle.js在根目录,而html却要去加载dist目录下的,所以找不到(上文:index.html使用<script src="./dist/bundle.js"/>的方式引入打包后的脚本)。

这时你需要在devServer中添加publicPath属性:

publicPath: "/dist/"

重新使用webpack-dev-server打包,并打开index.html你会发现,找到了bundle.js。但是仍旧提示找不到图片

http://localhost:8080/c3bbc15b8d6be7ec744c8a32670d7f6c.png 404 (Not Found)

所以,此时devServer.pulicPath属性的含义可以这么理解:

  1. 将你的打包文件输出到哪个路径下,该路径是在内存里(你看不到但存在),相对于加载bundle.js的index.html页面或web服务根目录的哪个路径下。(本示例就相对web服务根目录,因为是以"/"开头)
  2. 此时webpack.config.js中,output.path是可以删除的。因为这个路径是输出到硬盘上的物理路径。与webpack-dev-server完全无关。

可为什么找不到图片呢?先回味一下官方原文

对于按需加载(on-demand-load)或加载外部资源(external resources)(如图片、文件等)来说,output.publicPath 是很重要的选项。如果指定了一个错误的值,则在加载这些资源时会收到 404 错误。

也就是说:如果你require了一些资源或直接引用了网络上的资源,这些资源里包含uri属性(如css中设置img:url('./1.jpg')),就要使用就这个属性,否则会找不到文件。(如果没有使用uri资源,那么这个属性没什么用)。
说人话---这个属性就是让webpack在打包时才能根据配置动态修改uri中的相对值的;你不配置,webpack打包后的bundle.js中引用的url不对。

于是再去配置output下的publicPath,将其修改为

    output:{
        filename:"bundle.js",
        path:path.resolve(__dirname,"dist"),
        publicPath: "/dist/"
    },

重新执行webpack-dev-server,打开index.html发现一切正常!

后来尝试,不配置webserver.publicPath,而只配置output中的publicPath且修改为:

publicPath: "/dist/"

重新执行webpack-dev-server,打开index.html发现一切正常!
难道我对webserver.publicPath的理解有错?
比较了加与不加时,控制台打印出的日志才明白:

  1. 当你不配置devServer下的publicPath时,其会默认将包打到output.publicPath的路径下。
  2. 当你配置了devServer下的publicPath时,才其会将包打开你指定的路径下。

个人理解:

  1. output.path:硬盘上的路径,也就是你打算把文件打包到你的哪个目录,也就是各个牛人说的绝对路径!与发布时的路径完全无关。
  2. output.publicPath:主要用来转换url中的相对路径的。如果你引用到包含url的资源,一定要配置output.publicPath。配置了此项,webpack在打包时才能根据配置动态修改uri中的相对值。
  3. devserver.publicPath:可以理解为服务或模块的发布路径!注意:该值后面都要有"/"!本示例的index.html用了dist目录下的bundle.js,所以我们需要将模块发布到dist目录下就正确了。
    4.output.path对应的是硬盘上路径,output.publicPath对应的是你这打好的包将来放在web服务器上后,使用www.xxx.xx/xxx/xx形式访问时对应的url.本示例中因为我引用的是域名下/dist目录中的js。所以其对应的publicPath就应该为/dist/
  4. 如果你使用webstorm,千万不要在webpack打包后,使用其自带的端口为63342的默认web服务器打开index.html。这个默认的web服务器会以你的工程目录为根目录,而不像webpack-dev-server是以配置文件所在目录为根目录。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容

  • 版权声明:本文为博主原创文章,未经博主允许不得转载。 webpack介绍和使用 一、webpack介绍 1、由来 ...
    it筱竹阅读 10,933评论 0 21
  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,612评论 7 110
  • webpack 介绍 webpack 是什么 为什么引入新的打包工具 webpack 核心思想 webpack 安...
    yxsGert阅读 6,327评论 2 71
  • 效果图 shape根元素有些属性只适用于ring类型:android:innerRadius 内环的半径andro...
    C二叔阅读 357评论 0 0
  • 同理,第一层是接口名称,第二层是接口的方法。注意事项:接口还有一种表示方式: 企鹅和气候有关联,企鹅需要知道气候的...
    仁昌居士阅读 859评论 0 1