js前端图片加载异常兜底方案


Posted in Javascript onJune 21, 2022

背景

网络环境总是多样且复杂的,一张图片可能会因为网路状况差而加载失败或加载超长时间,也可能因为权限不足或者资源不存在而加载失败,这些都会导致用户体验变差,所以我们需要一个图片加载异常的兜底方案。

<img>加载错误解决方案

内联事件

直接在img标签上使用内联事件处理图片加载失败的情况,但是这种方式代码侵入性太大,指不定就会有地方漏掉。

<img src='xxxxx' onerror="this.src = 'default.png'">

全局img添加事件

第一个方案侵入性太大,我们将入口收敛,为所有img标签统一添加error处理事件。

const imgs = document.getElementsByTagName('img')
Array.prototype.forEach.call(imgs, img =&gt; {
    img.addEventListener('error', e =&gt; {
        e.target.src = 'default.png'
    })
})

利用error事件捕获

为每个img添加事件处理函数的代价还是高了点,我们知道一般事件会经历三个阶段:

  • 捕获阶段
  • 处于目标阶段
  • 冒泡阶段

根据MDN文档中的描述:

When a resource (such as an <img> or <script>) fails to load, an error event using interface Event is fired at the element that initiated the load, and the onerror() handler on the element is invoked. These error events do not bubble up to window, but can be handled with a EventTarget.addEventListener configured with useCapture set to true.

我们可以知道img和srcipt标签的error并不会冒泡,但是会经历捕获阶段和处于目标阶段。前两个方案就是利用处于目标阶段触发事件函数,这一次我们在捕获阶段截获并触发函数,从而减少性能损耗。

document.addEventListener(
    'error',
    e => {
        let target = e.target
        const tagName = target.tagName || ''
        if (tagName.toLowerCase = 'img') {
            target.src = 'default.png'
        }
        target = null
    },
    true
)

替换src方式的最优解

上面的方案有两个缺点:

  • 如果是因为网络差导致加载失败,那么加载默认图片的时候也极大概率会失败,于是会陷入无限循环。
  • 如果是网络波动导致的加载失败,那么图片可能重试就会加载成功。

所以我们可以为每个img标签额外添加一个data-retry-times计数属性,当重试超过限制次数后就用base64图片作为默认兜底。

document.addEventListener(
    'error',
    e => {
        let target = e.target
        const tagName = target.tagName || ''
        const curTimes = Number(target.dataset.retryTimes) || 0
        if (tagName.toLowerCase() === 'img') {
            if (curTimes >= 3) {
                target.src = 'data:image/png;base64,xxxxxx'
            } else {
                target.dataset.retryTimes = curTimes + 1
                target.src = target.src
            }
        }
        target = null
    },
    true
)

CSS处理的最优解

上面方式是采用替换src的方式来展示兜底图,这种解决方式有一个缺陷:

  • 原图的资源链接无法从标签上获取(虽然可以通过加data-xxx属性的方式hack解决)。

所以还有一种更好的方式,就是利用CSS伪元素::before和::after覆盖原本元素,直接展示兜底base64图片。

CSS样式如下:

img.error {
  display: inline-block;
  transform: scale(1);
  content: '';
  color: transparent;
}
img.error::before {
  content: '';
  position: absolute;
  left: 0; top: 0;
  width: 100%; height: 100%;
  background: #f5f5f5 url(data:image/png;base64,xxxxxx) no-repeat center / 50% 50%;
}
img.error::after {
  content: attr(alt);
  position: absolute;
  left: 0; bottom: 0;
  width: 100%;
  line-height: 2;
  background-color: rgba(0,0,0,.5);
  color: white;
  font-size: 12px;
  text-align: center;
  white-space: nowrap;
  overflow: hidden;
  text-overflow: ellipsis;
}

JS代码如下:

document.addEventListener(
    'error',
    e => {
        let target = e.target
        const tagName = target.tagName || ''
        const curTimes = Number(target.dataset.retryTimes) || 0
        if (tagName.toLowerCase() === 'img') {
            if (curTimes >= 3) {
                target.classList.remove('error')
                target.classList.add('error')
            } else {
                target.dataset.retryTimes = curTimes + 1
                target.src = target.src
            }
        }
        target = null
    },
    true
)

<img>加载超时解决方案

目前大多数应用都会接入CDN来加速资源请求,但是CDN存在节点覆盖不全的问题,导致DNS查询超时,此时如果切换Domain可能就会加载成功。

嗅探切换Domain(CNAME)

我们可以使用嗅探的方式,测试CDN提供的Domain是否能够正常访问,如果不行或者超时就及时切换成可访问Domain。 其中有几个注意点:

  • 为了防止嗅探图片缓存,需要添加时间戳保持新鲜度
  • Image图片加载没有超时机制,使用setTimeout模拟超时
// 防止嗅探图片存在缓存,添加时间戳保持新鲜度
export const imgUri = `/img/xxxxx?timestamp=${Date.now()}${Math.random()}`;

export const originDomain = 'https://sf6-xxxx.xxxx.com'

// 可采用配置下发的方式
export const cdnDomains = [
  'https://sf1-xxxx.xxxx.com',
  'https://sf3-xxxx.xxxx.com',
  'https://sf9-xxxx.xxxx.com',
];

export const validateImageUrl = (url: string) => {
  return new Promise<string>((resolve, reject) => {
    const img = new Image();
    img.onload = () => {
      resolve(url);
    };
    img.onerror = (e: string | Event) => {
      reject(e);
    };
    // promise的状态不可变性,使用setTimeout模拟超时
    const timer = setTimeout(() => {
      clearTimeout(timer);
      reject(new Error('Image Load Timeout'));
    }, 10000);
    img.src = url;
  });
};

export const setCDNDomain = () => {
  const cdnLoop = () => {
    return Promise.race(
      cdnDomains.map((domain: string) => validateImageUrl(domain + imgUri)),
    ).then(url => {
      window.shouldReplaceDomain = true;
      const urlHost = url.split('/')[2];
      window.replaceDomain = urlHost;
    });
  };

  return validateImageUrl(`${originDomain}${imgUri}`)
    .then(() => {
      window.shouldReplaceDomain = false;
      window.replaceDomain = '';
    })
    .catch(() => {
      return cdnLoop();
    });
};

// 替换URL
export const replaceImgDomain = (src: string) => {
  if (src && window.shouldReplaceDomain && window.replaceDomain) {
    return src.replace(originDomain.split('/')[2], window.replaceDomain);
  }
  return src;
};

服务端下发Domain(CNAME)

该方案需要后台同学配合,由后台判断当前当前可用Domain并返回。

getUsefulDomain()
    .then(e => {
        window.imgDomain = e.data.imgDomain || ''
    })

background-image加载异常解决方案

实际应用中背景图也会加载失败,通常这些元素没有error事件,所以也就无从捕获error事件了。此时就可以利用dispatchEvent,它同样拥有捕获阶段,MDN文档上是这么介绍的:

Dispatches an Event at the specified EventTarget, (synchronously) invoking the affected EventListeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

js前端图片加载异常兜底方案

可以看到支持度也还是可以的,我们首先需要自定义一个事件并初始化这个事件,在背景图加载失败的时候触发这个自定义事件,最后在上层捕获这个事件并执行事件函数。

自定义事件

自定义事件有两种方式:

  • 使用createEvent() 和 initEvent(),但是根据MDN文档,initEvent方法已经从浏览器标准中移除,并不安全,但支持度很高。

js前端图片加载异常兜底方案

  • 使用new Event()的方式,但是支持率稍微差一点

js前端图片加载异常兜底方案

这里以第二种为例,根据MDN文档的用法创建一个自定义事件:

const event = new Event('bgImgError')

嗅探加载情况

使用前面定义的方法嗅探图片资源的情况。

validateImageUrl('xxx.png')
    .catch(e => {
        let ele = document.getElementById('bg-img')
        if (ele) {
            ele.dispatchEvent('bgImgError')
        }
        ele = null
    })

添加事件捕获

document.addEventListener(
    'bgImgError',
    e => {
        e.target.style.backgroundImage = "url(data:image/png;base64,xxxxxx)"
    },
    true
)

以上就是js前端图片加载异常兜底方案的详细内容,更多关于js前端图片加载异常方案的资料请关注三水点靠木其它相关文章!


Tags in this post...

Javascript 相关文章推荐
jQuery移动和复制dom节点实用DOM操作案例
Dec 17 Javascript
JS中的this变量的使用介绍
Oct 21 Javascript
JavaScript对内存分配及管理机制详细解析
Nov 11 Javascript
Javascript中this的用法详解
Sep 22 Javascript
JS设置网页图片vspace和hspace属性的方法
Apr 01 Javascript
JS修改iframe页面背景颜色的方法
Apr 01 Javascript
使用JavaScript刷新网页的方法
Jun 04 Javascript
jquery地址栏链接与a标签链接匹配之特效代码总结
Aug 24 Javascript
Vue2.5通过json文件读取数据的方法
Feb 27 Javascript
JavaScript实现浅拷贝与深拷贝的方法分析
Jul 05 Javascript
vue获取data数据改变前后的值方法
Nov 07 Javascript
JS JQuery获取data-*属性值方法解析
Sep 01 jQuery
JavaScript中10个Reduce常用场景技巧
Jun 21 #Javascript
js前端面试常见浏览器缓存强缓存及协商缓存实例
Jun 21 #Javascript
JavaScript前端面试组合函数
Jun 21 #Javascript
Vue2项目中对百度地图的封装使用详解
JavaScript原型链中函数和对象的理解
JS精髓原型链继承及构造函数继承问题纠正
Jun 16 #Javascript
5个实用的JavaScript新特性
Jun 16 #Javascript
You might like
一个自定义位数的php多用户计数器代码
2007/03/11 PHP
PHP 面向对象实现代码
2009/11/11 PHP
ThinkPHP利用PHPMailer实现邮件发送实现代码
2013/09/26 PHP
PHP 登录完成后如何跳转上一访问页面
2014/01/14 PHP
thinkphp3.2.2实现生成多张缩略图的方法
2014/12/19 PHP
php实现smarty模板无限极分类的方法
2015/12/07 PHP
PHP表单数据写入MySQL数据库的代码
2016/05/31 PHP
无需数据库在线投票调查php代码
2016/07/20 PHP
Yii 2.0在Grid中格式化时间方法示例
2017/06/06 PHP
php实现根据身份证获取精准年龄
2020/02/26 PHP
jQuery控制DIV层实现由大到小,由远及近动画变化效果
2015/10/09 Javascript
javascript中return,return true,return false三者的用法及区别
2015/11/17 Javascript
javascript下使用Promise封装FileReader
2016/02/19 Javascript
Bootstrap table使用方法总结
2017/05/10 Javascript
ExtJs的Ext.Ajax.request实现waitMsg等待提示效果
2017/06/14 Javascript
Node.js学习教程之HTTP/2服务器推送【译】
2017/10/31 Javascript
js保留两位小数方法总结
2018/01/31 Javascript
浅析node.js的模块加载机制
2018/05/25 Javascript
jQuery实现ajax回调函数带入参数的方法示例
2018/06/26 jQuery
如何封装了一个vue移动端下拉加载下一页数据的组件
2019/01/06 Javascript
微信小程序input抖动问题的修复方法
2021/03/03 Javascript
Pycharm无法使用已经安装Selenium的解决方法
2018/10/13 Python
解决Pandas的DataFrame输出截断和省略的问题
2019/02/08 Python
python中嵌套函数的实操步骤
2019/02/27 Python
Python应用领域和就业形势分析总结
2019/05/14 Python
Python实现把多维数组展开成DataFrame
2019/11/30 Python
基于python实现地址和经纬度转换
2020/05/19 Python
Pycharm调试程序技巧小结
2020/08/08 Python
加拿大当代时尚服饰、配饰和鞋类专业零售商和制造商:LE CHÂTEAU
2017/10/06 全球购物
澳大利亚新奇小玩意网站:Yellow Octopus
2017/12/28 全球购物
Araks官网:纽约内衣品牌
2020/10/15 全球购物
奶茶店创业计划书范文
2014/01/17 职场文书
教师考核评语
2014/04/28 职场文书
生活委员竞选稿
2015/11/21 职场文书
委托书范本格式
2019/04/18 职场文书
python爬取新闻门户网站的示例
2021/04/25 Python