在日常項目開發中,圖片上傳是一個十分常見的場景。而現在的各種UI框架都提供了自己的上傳組件,網上第三方的上傳組件也多如牛毛。可能你早已習慣了直接使用這些現成的組件,然而對於其具體的實現,卻並未深入解析。本文將通過簡單的代碼,爲你解析圖片上傳的各個知識點。
樣式自定義
既然是上傳,肯定需要使用到<input type="file">
標籤了。然而,默認的input
到標籤樣式不僅單一,且在各個瀏覽器下的表現也不相同,所以通常需要對input
進行樣式自定義。但<input>
標籤對於樣式的修改並不十分友好。解決方法很多,最常用的是將<input type="file">
標籤隱藏,然後通過一個<label>
標籤進行關聯,然後直接修改<label>
標籤的樣式來實現。代碼如下:
<input type="file" id="uploadImg">
<label for="uploadImg">點擊上傳</label>
圖片校驗
在上傳之前,一般會對文件進行各種校驗,例如文件類型,大小,格式,尺寸等。
其中文件類型,可通過設置<input>
標籤的accept
來指定文件類型。但accept
屬性並不能完全禁止用戶上傳指定類型之外的文件。故可以通過上傳文件的各個屬性進行校驗攔截。校驗前,我們需要通過change
事件的事件對象來獲取到上傳的文件:
event.target.files
可以獲取到上傳文件列表。列表中對象包含如下信息:
{
lastModified: 1524153515000
lastModifiedDate: Thu Apr 19 2018 23:58:35 GMT+0800 (中國標準時間) {}
name: "589adfbfe821c.jpg"
size: 1357444
type: "image/jpeg"
webkitRelativePath: ""
}
從該對象中,我們可以獲取到文件大小,文件類型,文件名等信息,從而可以在上傳之前對這些信息進行校驗,從而攔截掉不合法的文件。
然而,從file
對象中,我們並不能獲取圖片的尺寸信息。而在我們的業務中,很多場景都需要限制上傳圖片的尺寸爲某一個固定值,或者是某一個比例。以減少後期顯示時的適配問題。要實現對上傳圖片尺寸對校驗,我們需要使用到FileReader和Image。
FileReader
對象允許Web應用程序異步讀取存儲在用戶計算機上的文件。
Image()
函數將會創建一個新的HTMLImageElement實例。它的功能等價於document.createElement('img')
。
這裏,我們需要用到fileReader
的readAsDataURL()
方法來讀取上傳文件信息,通過onload
處理事件來獲取讀取到的文件信息。如下:
const reader = new FileReader();
reader.readAsDataURL(file);
reader.onload = e => {
console.log(e.target.result)
}
代碼中,file爲我們之前獲取到的文件列表files
中的文件對象。e.target.result
爲讀取到到文件內容。
之後通過new Image()
函數創建一個新的HTMLImageElement實例,並將該實例的src
賦值爲fileReader
讀取到到文件內容。即可得到一個該文件的HTMLImageElement實例,通過該實例,我們便可以讀取到該圖片的尺寸信息。具體代碼如下:
const image = new Image();
image.src = e.target.result;
image.onload = () => {
console.log(image.width, image.height);
}
圖片上傳預覽
在之前的開發中,圖片上傳顯示通常會採用先將文件上傳,預覽圖片直接展示上傳到服務器中到圖片來實現,但這樣無法達到上傳前預覽該圖片的目的,且會造成許多垃圾圖片的上傳。
通過前面對於獲取圖片尺寸研究。相信你能很快想到一種更加優雅的圖片預覽方案,既然我們已經獲取到了該文件的HTMLImageElement實例,那麼我們直接將該實例append
到頁面的容器Dom中不久行了。或者直接將獲取到的文件設置到已存在的image
標籤的src
屬性中。圖片上傳預覽就是這麼簡單。
圖片上傳與上傳進度展示
圖片的上傳,我們可以直接通過form
標籤搭配表單的submit()
方法來實現圖片的上傳。然而,這樣我們就無法在上傳前進行上傳文件的校驗與攔截。同時需要用戶主動觸發提交操作。要想讓我們之前做的上傳前的攔截工作不白做,我們需要去在合適的時候,主動觸發文件的上傳操作。
這裏,需要使用到FormData對象,來將入參對象數據轉爲表單數據。
FormData
對象用以將數據編譯成鍵值對,以便用XMLHttpRequest來發送數據。其主要用於發送表單數據,但亦可用於發送帶鍵數據(keyed data
),而獨立於表單使用。如果表單enctype
屬性設爲multipart/form-data
,則會使用表單的submit()方法來發送數據,從而,發送數據具有同樣形式。
首先我們創建一個formData
對象,然後通過append()
方法來添加字段。如下:
const formData = new FormData();
formData.append("file", file);
注意,formData
雖然爲一個對象,但通過console.log
卻無法打印出其具體的值,只會得到FormData {}
。
接下來創建一個XMLHttpRequest
對象,用來發送ajax請求。並且通過該XMLHttpRequest
對象的upload.onprogress
方法,可以實時獲取到上傳信息,並進一步獲取到上傳的進度。具體代碼如下:
const client = new XMLHttpRequest()
client.open("POST", uploadUrl)
client.upload.onprogress = function(e) {
if (e.lengthComputable) {
let total = e.total;
let loaded = e.loaded;
let percentage = parseFloat(loaded / total).toFixed(2);
}
}
client.send(formData)
上面代碼中,uploadUrl
爲上傳的URL。通過upload.onprogress
的事件對象,可以獲取到當前進度已上傳的文件大小以及完整文件大小,通過這兩個大小參數,可以很容易計算出已上傳文件的比例,之後是顯示上傳進度條、還是展示進度數據,就可以隨意操作了。
拖拽上傳
除了傳統的點擊選擇上傳文件外,拖拽文件上傳也是一個十分常見的場景。要使用拖拽上傳,就需要使用H5的拖放方法drop
和 drag
方法。除了這兩個主要的方法外,還有拖放的不同階段觸發的多個方法,常用的拖拽方法如下:
- ondragstart 事件:當拖拽元素開始被拖拽的時候觸發的事件(作用對象爲被拖曳元素)
- ondrag:在元素拖動期間不停的觸發該事件,與
touchmove
事件類似。(作用對象爲被拖曳元素) - ondragend 事件:當拖拽完成後觸發的事件(作用對象爲被拖曳元素)
- ondragenter 事件:當拖曳元素進入目標元素的時候觸發的事件(作用對象爲目標元素)
- ondragover 事件:拖拽元素在目標元素上移動的時候觸發的事件(作用對象爲目標元素)
- ondragleave 事件:拖拽元素在目標元素上移動的時候觸發的事件(作用對象爲目標元素)
- ondrop 事件:被拖拽的元素在目標元素上同時鼠標放開觸發的事件(作用對象爲目標元素)
拖拽的各個事件類似與touch
事件的各個階段。然而需要注意的是,拖拽的各個事件,有着自己的作用對象,作用對象分爲‘被拖拽元素’和‘目標元素’。被拖拽元素 爲拖拽的那個Dom元素,主要使用在頁面內Dom拖拽移動的場景。目標元素爲接收被拖拽元素的元素區域。當被拖拽元素進入到該區域,便會觸發目標對象的一系列事件。
在圖片拖拽上傳這個業務場景中,被拖拽元素爲頁面外部的圖片文件,故此處僅用到目標元素的各個事件。我們可以通過這些事件來修改目標區域樣式等。核心的兩個事件爲ondragover
和ondrop
事件。可能你覺得我只需要在鬆開鼠標時獲取拖拽的文件就行,因此只需要使用ondrop
事件就行了?但是,由於瀏覽器的默認行爲,ondrop
事件並不會被觸發。因此,需要使用e.preventDefault();
來阻止掉 ondropover
的瀏覽器默認事件,從而保證ondrop
事件的觸發。通過ondrop
事件的事件對象,我們可以獲取到跟event.target.files
相同的文件列表,獲取方法爲event.dataTransfer.files
;然而,當你這麼寫完之後,進行拖拽之後,你會發現瀏覽器自動跳轉到了該圖片的預覽頁。這也是由於瀏覽器的默認行爲導致,因此也需要使用e.preventDefault();
來阻止掉瀏覽器的默認行爲。這樣,便可以進行後續的文件校驗操作來。
具體實現代碼如下:
<label for="uploadImg"
onDragOver={e => {
e.preventDefault();
}}
onDrop={e => {
if (e.dataTransfer) {
e.preventDefault();
const file = e.dataTransfer.files[0];
...
}
}}
</label>
至此,圖片上傳的常用知識點以梳理完畢,歡迎補充。