將HTML頁面轉化爲PDF下載是前端經常會遇到的需求,下面就列舉兩種方式進行實現。以下兩種方式默認都是在Vue項目環境下,其他框架項目自行靈活運用。
方式一:使用html2canvas和jspdf插件實現
該方式是通過html2canvas
將HTML頁面轉換成圖片,然後再通過jspdf
將圖片的base64生成爲pdf文件。實現步驟如下:
1,下載插件模塊
npm install html2canvas jspdf --save
2,定義功能實現方法
在項目工具方法存放文件夾utils中創建htmlToPdf.js
文件,代碼如下:
// 導出頁面爲PDF格式
import html2Canvas from 'html2canvas'
import JsPDF from 'jspdf'
export default{
install (Vue, options) {
Vue.prototype.getPdf = function () {
var title = this.htmlTitle
html2Canvas(document.querySelector('#pdfDom'), {
allowTaint: true
}).then(function (canvas) {
let contentWidth = canvas.width
let contentHeight = canvas.height
let pageHeight = contentWidth / 592.28 * 841.89
let leftHeight = contentHeight
let position = 0
let imgWidth = 595.28
let imgHeight = 592.28 / contentWidth * contentHeight
let pageData = canvas.toDataURL('image/jpeg', 1.0)
let PDF = new JsPDF('', 'pt', 'a4')
if (leftHeight < pageHeight) {
PDF.addImage(pageData, 'JPEG', 0, 0, imgWidth, imgHeight)
} else {
while (leftHeight > 0) {
PDF.addImage(pageData, 'JPEG', 0, position, imgWidth, imgHeight)
leftHeight -= pageHeight
position -= 841.89
if (leftHeight > 0) {
PDF.addPage()
}
}
}
PDF.save(title + '.pdf')
}
)
}
}
}
3, 全局引入實現方法
在項目主文件main.js
中引入定義好的實現方法,並註冊。
import htmlToPdf from '@/components/utils/htmlToPdf'
// 使用Vue.use()方法就會調用工具方法中的install方法
Vue.use(htmlToPdf)
4, 在相關要導出的頁面中,點擊時調用綁定在Vue原型上的getPdf方法,傳入id即可
//html
<div id="pdfDom">
<!-- 要下載的HTML頁面,頁面是由後臺返回 -->
<div v-html="pageData"></div>
</div>
<el-button type="primary" size="small" @click="getPdf('#pdfDom')">點擊下載</el-button>
//js
export default {
data () {
return {
htmlTitle: '頁面導出PDF文件名'
}
}
}
方式二:讀取後臺返回文件流,利用HTML5中a標籤的download屬性實現下載
該方法需要先請求後臺,後臺會返回一個文件流,然後解析文件流,再通過HTML5中
<a>
標籤的download
屬性實現下載功能。步驟如下:
1,發送請求,獲取到後臺返回的文件流及文件信息
- 前端發送請求獲取下載文件信息:
// 引入下載方法
import {download} from 'utils'
export default{
methods: {
async downloadFile () {
let res = await axios.get(
url: 'xxxx/xxxx',
method: 'GET',
// 設置返回數據類型,這裏一定要設置,否則下載下來的pdf會是空白,也可以是`arraybuffer`
responseType: 'blob',
params: {
id: 'xxxxxx'
}
)
// 獲取在response headers中返回的下載文件類型
let type = JSON.parse(res.headers)['content-type']
/*獲取在response headers中返回的下載文件名
因爲返回文件名是通過encodeURIComponent()函數進行了編碼,因此需要通過decodeURIComponent()函數解碼
*/
let fileName = decodeURIComponent(JSON.parse(res.headers)['file-name'])
// 調用封裝好的下載函數
download(res, type, fileName)
}
}
}
-
後臺返回的文件流格式:
文件流.png
2, 封裝下載方法 - 解析文件流,創建a標籤並設置下載相關屬性。
// utils.js
export const download = (res, type, filename) => {
// 創建blob對象,解析流數據
const blob = new Blob([res], {
// 如何後端沒返回下載文件類型,則需要手動設置:type: 'application/pdf;chartset=UTF-8' 表示下載文檔爲pdf,如果是word則設置爲msword,excel爲excel
type: type
})
const a = document.createElement('a')
// 兼容webkix瀏覽器,處理webkit瀏覽器中href自動添加blob前綴,默認在瀏覽器打開而不是下載
const URL = window.URL || window.webkitURL
// 根據解析後的blob對象創建URL 對象
const herf = URL.createObjectURL(blob)
// 下載鏈接
a.href = herf
// 下載文件名,如果後端沒有返回,可以自己寫a.download = '文件.pdf'
a.download = filename
document.body.appendChild(a)
a.click()
document.body.removeChild(a)
// 在內存中移除URL 對象
window.URL.revokeObjectURL(herf)
}
3,點擊下載按鈕,調用下載方法
<div id="pdfDom">
<!-- 要下載的頁面 -->
<div v-html="pageData"></div>
</div>
<el-button type="primary" size="small" @click="downloadFile">點擊下載</el-button>
總結
以上兩種實現方式各有優劣,方式一是純前端實現,需要引入第三方插件,可能會導致項目體積增加。方式二雖然更加簡潔,但a
標籤的download
屬性爲HTML5新增屬性,可能存在兼容性問題。如果有需要,可以根據自己情況來選擇。