跳到主要内容html2canvas 核心使用场景与实战技巧详解 | 极客日志JavaScript大前端
html2canvas 核心使用场景与实战技巧详解
html2canvas 库实现 DOM 转图片功能,适用于证书生成、长列表截图及跨域处理等场景。文章详解基础用法、Vue/React 集成、滚动区域捕获及性能优化方案。重点解决图片模糊、跨域空白及渲染时机问题,提供批量截图与 Blob 上传实践,帮助开发者高效完成前端截图需求。
随缘6 浏览 html2canvas 核心使用场景与实战技巧详解
html2canvas 是前端常用的 DOM 转图片库,核心原理是将页面 DOM 节点渲染为 Canvas,再转为 Base64 或 Blob 格式。这里整理了 9 个高频实战场景,涵盖代码示例、参数调优及常见坑点,覆盖日常开发需求。
一、基础使用:将指定 DOM 转为 Base64 图片
适用于简单场景(如生成证书、截图分享),无需复杂配置。
1. 安装与引入
npm install html2canvas --save
import html2canvas from 'html2canvas';
2. 核心代码
<div id="targetDom">
<h2>基础截图示例</h2>
<p>这是要转为图片的内容</p>
</div>
<img id="previewImg" />
document.querySelector('#btn').addEventListener('click', async () => {
const targetDom = document.getElementById('targetDom');
canvas = (targetDom, {
: ,
: ,
: ,
:
});
base64Img = canvas.(, );
.(). = base64Img;
link = .();
link. = base64Img;
link. = ;
link.();
});
const
await
html2canvas
scale
2
useCORS
true
logging
false
backgroundColor
null
const
toDataURL
'image/jpeg'
1.0
document
getElementById
'previewImg'
src
const
document
createElement
'a'
href
download
'基础截图.jpg'
click
二、进阶场景:处理跨域图片
当 DOM 中包含网络图片(如 https://xxx.com/xxx.jpg),易出现'图片空白'问题,需配置跨域参数。
关键配置
- 前端配置:
useCORS: true + allowTaint: true(允许跨域图片污染 Canvas);
- 后端配置:图片服务器需返回
Access-Control-Allow-Origin: *(或当前域名),否则跨域图片仍会空白。
完整代码
const canvas = await html2canvas(targetDom, {
scale: 2,
useCORS: true,
allowTaint: true,
logging: false,
onclone: (clonedDoc) => {
const imgs = clonedDoc.querySelectorAll('img');
imgs.forEach(img => {
if (img.src.includes('跨域域名')) {
img.src = img.src.replace('跨域域名', '同源代理域名');
}
});
}
});
三、复杂场景:固定宽高 + 滚动内容截图
适用于'长列表截图'(如表格、聊天记录),需固定截图宽高,同时包含滚动区域的所有内容。
核心思路
- 先保存目标 DOM 的原始样式(
overflow/height);
- 临时修改为
overflow: visible + 自适应高度(确保所有内容展开);
- 截图完成后恢复原始样式。
完整代码
async function captureScrollContent() {
const targetDom = document.getElementById('targetDom');
const originalStyle = {
overflow: targetDom.style.overflow,
height: targetDom.style.height
};
try {
targetDom.style.overflow = 'visible';
targetDom.style.height = 'auto';
const canvas = await html2canvas(targetDom, {
scale: 2,
useCORS: true,
logging: false,
windowWidth: targetDom.offsetWidth,
windowHeight: targetDom.offsetHeight
});
const base64Img = canvas.toDataURL('image/png', 1.0);
const link = document.createElement('a');
link.href = base64Img;
link.download = '长列表截图.png';
link.click();
} finally {
targetDom.style.overflow = originalStyle.overflow;
targetDom.style.height = originalStyle.height;
}
}
四、Vue 项目:组件内 DOM 截图(含响应式数据)
Vue 中需注意'DOM 渲染时机'——确保数据更新后(如接口请求完成)再截图,避免内容空白。
核心注意点
- 用
this.$nextTick() 确保 DOM 已更新;
- 若用
v-for 渲染列表,需等待列表渲染完成后再截图。
完整代码(Vue 3 示例)
<template>
<div>
<!-- 目标 DOM:包含响应式数据 -->
<div ref="certDom" class="cert-container">
<h2>{{ userName }} 的证书</h2>
<p>项目:{{ projectName }}</p>
<p>时间:{{ date }}</p>
</div>
<button @click="generateCert">生成证书</button>
<img :src="previewImg" alt="证书预览" />
</div>
</template>
<script setup>
import { ref, nextTick } from 'vue';
import html2canvas from 'html2canvas';
// 响应式数据
const userName = ref('');
const projectName = ref('');
const date = ref('2025-01-01');
const previewImg = ref('');
const certDom = ref(null); // 目标 DOM 引用
// 接口请求:获取用户数据
const fetchUserInfo = async () => {
const res = await fetch('/api/user');
const data = await res.json();
userName.value = data.userName;
projectName.value = data.projectName;
};
// 生成证书(截图)
const generateCert = async () => {
// 1. 先获取数据,确保 DOM 已更新
await fetchUserInfo();
// 2. 等待 Vue DOM 渲染完成
await nextTick();
// 3. 截图(certDom.value 是目标 DOM)
const canvas = await html2canvas(certDom.value, {
scale: 2,
useCORS: true,
backgroundColor: '#fff'
});
// 4. 预览并下载
previewImg.value = canvas.toDataURL('image/jpeg', 1.0);
const link = document.createElement('a');
link.href = previewImg.value;
link.download = `${userName.value}的证书.jpg`;
link.click();
};
</script>
<style scoped>
.cert-container {
width: 500px;
height: 700px;
background: url('@/assets/cert-bg.jpg') no-repeat center;
background-size: 100% 100%;
padding: 50px;
box-sizing: border-box;
}
</style>
五、React 项目:函数组件截图(含 Hooks)
React 中需用 useRef 获取 DOM 节点,用 useEffect 处理异步渲染时机。
完整代码(React 18 示例)
import { useRef, useState } from 'react';
import html2canvas from 'html2canvas';
const ScreenshotComponent = () => {
const targetRef = useRef(null);
const [previewImg, setPreviewImg] = useState('');
const captureDom = async () => {
if (!targetRef.current) return;
const canvas = await html2canvas(targetRef.current, {
scale: 2,
useCORS: true,
logging: false
});
const base64 = canvas.toDataURL('image/png', 1.0);
setPreviewImg(base64);
const link = document.createElement('a');
link.href = base64;
link.download = 'react 截图.png';
link.click();
};
return (
<div style={{ padding: 20 }}>
{/* 目标 DOM:用 ref 绑定 */}
<div ref={targetRef} style={{ width: 400, height: 300, background: '#e8f4f8', padding: 20 }}>
<h3>React 截图示例</h3>
<p>当前时间:{new Date().toLocaleString()}</p>
</div>
<button onClick={captureDom} style={{ margin: 20 }}>生成截图</button>
{previewImg && <img src={previewImg} alt="预览" style={{ maxWidth: '100%' }} />}
</div>
);
};
export default ScreenshotComponent;
六、特殊场景:隐藏 DOM 截图(不显示在页面)
适用于'后台生成图片'(如生成后直接下载,无需在页面显示 DOM),需临时将 DOM 渲染到页面外。
核心思路
- 目标 DOM 初始样式设为
position: absolute; left: -9999px; top: -9999px;(隐藏在视口外);
- 截图完成后可删除该 DOM(可选)。
完整代码
<div id="hiddenDom">
<h2>隐藏 DOM 生成的图片</h2>
<p>用户:张三</p>
<p>等级:VIP</p>
</div>
<button id="generateBtn">生成隐藏图片</button>
document.getElementById('generateBtn').addEventListener('click', async () => {
const hiddenDom = document.getElementById('hiddenDom');
const canvas = await html2canvas(hiddenDom, {
scale: 2,
useCORS: true,
logging: false
});
const base64 = canvas.toDataURL('image/jpeg', 1.0);
const link = document.createElement('a');
link.href = base64;
link.download = '隐藏 DOM 图片.jpg';
link.click();
});
七、性能优化:批量截图 + 避免重复渲染
当需要批量生成图片(如多条数据生成证书),需控制截图顺序,避免同时渲染导致浏览器卡顿。
核心思路
- 用
async/await 按顺序截图(一条完成后再截下一条);
- 截图前判断是否已生成,避免重复操作。
完整代码
const certList = [
{ id: 1, userName: '张三', project: '前端开发' },
{ id: 2, userName: '李四', project: '后端开发' },
{ id: 3, userName: '王五', project: 'UI 设计' }
];
async function batchCapture() {
for (const cert of certList) {
const tempDom = document.createElement('div');
tempDom.style.width = '500px';
tempDom.style.height = '700px';
tempDom.style.background = '#fff';
tempDom.style.padding = '50px';
tempDom.style.position = 'absolute';
tempDom.style.left = '-9999px';
tempDom.innerHTML = `
<h2>${cert.userName} 的证书</h2>
<p>项目:${cert.project}</p>
<p>日期:2025-01-01</p>
`;
document.body.appendChild(tempDom);
try {
const canvas = await html2canvas(tempDom, {
scale: 2,
useCORS: true,
logging: false
});
const base64 = canvas.toDataURL('image/jpeg', 1.0);
const link = document.createElement('a');
link.href = base64;
link.download = `${cert.userName}的证书.jpg`;
link.click();
} finally {
document.body.removeChild(tempDom);
await new Promise(resolve => setTimeout(resolve, 500));
}
}
}
batchCapture();
八、问题解决:常见报错与优化方案
1. 图片模糊
- 原因:Canvas 默认缩放为 1,屏幕 DPI 过高(如 Retina 屏)导致模糊;
- 解决:设置
scale: 2 或 scale: window.devicePixelRatio(自适应屏幕 DPI)。
const canvas = await html2canvas(targetDom, {
scale: window.devicePixelRatio,
useCORS: true
});
2. 跨域图片空白
- 原因:图片服务器未配置 CORS,或未开启
useCORS: true;
- 解决:
- 后端添加
Access-Control-Allow-Origin 响应头;
- 前端配置
useCORS: true + allowTaint: true;
- 备选方案:用同源代理服务器转发图片(如 Nginx 代理)。
3. DOM 内容未完全渲染(如接口数据空白)
- 原因:截图时机过早,DOM 尚未更新(如接口请求未完成);
- 解决:
- Vue:用
this.$nextTick() 等待 DOM 渲染;
- React:用
useEffect 或 await 等待数据加载;
- 原生 JS:在接口
then 回调中执行截图。
4. 大 DOM 截图卡顿
- 原因:DOM 节点过多(如长列表、复杂表格),渲染耗时;
- 解决:
- 简化 DOM(移除截图无关的节点,如隐藏按钮、多余注释);
- 分批截图(避免一次性渲染大量节点);
- 关闭日志:
logging: false(减少控制台输出耗时)。
九、高级场景:Canvas 转 Blob 上传服务器
当需要将生成的图片上传到后端(而非本地下载),需将 Canvas 转为 Blob 格式(比 Base64 更节省带宽)。
完整代码
async function captureAndUpload() {
const targetDom = document.getElementById('targetDom');
const canvas = await html2canvas(targetDom, {
scale: 2,
useCORS: true,
logging: false
});
canvas.toBlob(async (blob) => {
const formData = new FormData();
formData.append('image', blob, '上传图片.jpg');
formData.append('userId', '123');
try {
const res = await fetch('/api/upload-image', {
method: 'POST',
body: formData
});
const data = await res.json();
if (data.success) {
alert('图片上传成功!');
console.log('图片地址:', data.imageUrl);
}
} catch (err) {
console.error('上传失败:', err);
}
}, 'image/jpeg', 0.8);
}
相关免费在线工具
- Keycode 信息
查找任何按下的键的javascript键代码、代码、位置和修饰符。 在线工具,Keycode 信息在线工具,online
- Escape 与 Native 编解码
JavaScript 字符串转义/反转义;Java 风格 \uXXXX(Native2Ascii)编码与解码。 在线工具,Escape 与 Native 编解码在线工具,online
- JavaScript / HTML 格式化
使用 Prettier 在浏览器内格式化 JavaScript 或 HTML 片段。 在线工具,JavaScript / HTML 格式化在线工具,online
- JavaScript 压缩与混淆
Terser 压缩、变量名混淆,或 javascript-obfuscator 高强度混淆(体积会增大)。 在线工具,JavaScript 压缩与混淆在线工具,online
- Base64 字符串编码/解码
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具,Base64 字符串编码/解码在线工具,online
- Base64 文件转换器
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具,Base64 文件转换器在线工具,online