本文改寫自 Dr. Tom Trenka 的文章(原文日期 2013 年 8 月 6 日)。Tom 是 Dojo 框架最早的貢獻者之一,也是我在 SitePen 的良師益友。他總能跳出框架思考,用不按牌理出牌卻穩健可靠的方式解決邊角問題,這篇文章就是很好的例子。
做一個「讓使用者上傳圖片」的表單向來不難:一個 form、一個 type="file" 的輸入框,表單加上 enctype="multipart/form-data",送出即可。
但如果需要在上傳前先處理圖片呢?比如必須縮小尺寸,或是只允許 png、jpg 等特定格式,傳統表單就無能為力了。
答案是 Canvas。
canvas 是 HTML5 新增的 DOM 元素,讓我們能直接用 JavaScript 在頁面上繪圖,並讀寫圖片的像素資料。SVG 屬於向量 API,VML 也走向量路線,而 canvas 更接近光柵 API——想像 Illustrator 與 Photoshop 的差別即可。針對「縮放 + 轉格式」這兩件事,canvas 綽綽有餘。
先設定一個需求:不論原圖多高,輸出高度都不超過 100 像素。
// 最大高度
var MAX_HEIGHT = 100;
function render(src){
var image = new Image();
image.onload = function(){
var canvas = document.getElementById("myCanvas");
// 超標就等比縮放
if (image.height > MAX_HEIGHT) {
image.width *= MAX_HEIGHT / image.height;
image.height = MAX_HEIGHT;
}
// context 像是管理員,canvas 像是房子
var ctx = canvas.getContext("2d");
ctx.clearRect(0, 0, canvas.width, canvas.height);
// 重設 canvas 尺寸,避免殘留舊畫面
canvas.width = image.width;
canvas.height = image.height;
ctx.drawImage(image, 0, 0, image.width, image.height);
// 注意:image 並未加入 DOM
};
// 必須先綁定事件,再設定 src,否則會有非同步的問題
image.src = src;
}
畫到 canvas 之後,用 canvas.toDataURL() 就能取得 Base64 編碼的資料。要留意返回的結果開頭會帶一段 data:image/png;base64,,共 22 個無用字元,需要在客戶端或伺服器端過濾掉。至於 URL 長度,原則上只要瀏覽器支援就沒有上限,1024 的限制是老一輩 IE 才有的問題。
從 file 輸入框能拿到的只有路徑,而基於安全理由,瀏覽器不允許拿這個路徑去載入圖片——否則惡意網站就能靠拼湊路徑探測本機資訊。
HTML5 的 File API 提供了正解。它在不破壞沙盒機制的前提下開放讀取使用者檔案:沙盒確保惡意網站無法把病毒寫進你的磁碟,更不可能執行。我們要用的主角是 FileReader。
// 載入圖片檔案
function loadImage(src){
// 過濾非圖片類型
if (!src.type.match(/image.*/)) {
if (window.console) {
console.log("選擇的檔案不是圖片: ", src.type);
} else {
window.confirm("只能選擇圖片檔案");
}
return;
}
var reader = new FileReader();
reader.onload = function(e){
render(e.target.result); // 呼叫前面的 render
};
reader.readAsDataURL(src);
}
總不能叫使用者手打檔案路徑——大多數人根本不是開發者。改用 Drag and Drop 體驗好得多:在 DOM 元素上綁定事件,使用者把檔案拖進來放開滑鼠,我們就拿到 File 物件了。
function init(){
var target = document.getElementById("drop-target");
// 必須阻止 dragover 的預設行為,否則 drop 不會觸發
target.addEventListener("dragover", function(e){ e.preventDefault(); }, true);
target.addEventListener("drop", function(e){
e.preventDefault();
loadImage(e.dataTransfer.files[0]);
}, true);
// 允許使用者自訂最大高度
var setheight = document.getElementById("setheight");
var maxheight = document.getElementById("maxheight");
setheight.addEventListener("click", function(e){
var value = maxheight.value;
if (/^\d+$/.test(value)) {
MAX_HEIGHT = parseInt(value, 10);
}
e.preventDefault();
}, true);
document.getElementById("btnsend").addEventListener("click", function(e){
sendImage();
}, true);
}
把 canvas 的內容轉成 Data URL,用 Ajax POST 出去即可。這種做法不必處理 multipart/form-data,伺服器端只要一支普通的 POST 處理程式就行。以下用 jQuery 示範:
function sendImage(){
var canvas = document.getElementById("myCanvas");
var dataurl = canvas.toDataURL("image/png");
// 為安全起見對 URI 編碼,開頭會變成 data%3Aimage%2Fpng%3Bbase64%2C
var imagedata = encodeURIComponent(dataurl);
// 請求位址可以放在 hidden 欄位裡
var url = $("input[name='action']").val();
var data = {
imagename: "myImage.png",
imagedata: imagedata
};
jQuery.ajax({
url: url,
data: data,
type: "POST",
dataType: "json",
complete: function(xhr, result) {
var $tip = $("#tip2");
if (!xhr) { $tip.text('網路連線失敗!'); return false; }
var text = xhr.responseText;
if (!text) { $tip.text('網路錯誤!'); return false; }
var json = JSON.parse(text); // 用 JSON.parse 取代 eval,更安全
$tip.text(json.message);
}
});
}
伺服器端(以 JSP 為例)要做的就是:把開頭那段前綴切掉、做 URL 解碼、Base64 解碼,然後寫檔。
<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%@ page import="java.io.*" %>
<%@ page import="java.net.URLDecoder" %>
<%@ page import="java.util.Base64" %>
<%
response.setContentType("application/json;charset=UTF-8");
String photoPath = "D:/blog/upload/photo/";
File photoPathFile = new File(photoPath);
String imageName = request.getParameter("imagename");
String imageData = request.getParameter("imagedata");
int success = 0;
String message = "";
if (null == imageData || imageData.length() < 100) {
message = "上傳失敗,資料太短或不存在";
} else {
// 去掉 "data:image/png;base64," 前綴
imageData = imageData.substring(30);
imageData = URLDecoder.decode(imageData, "UTF-8");
byte[] data = Base64.getDecoder().decode(imageData);
if (null == imageName || imageName.length() < 1) {
imageName = System.currentTimeMillis() + ".png";
}
FileOutputStream out = new FileOutputStream(new File(photoPathFile, imageName));
out.write(data);
out.flush();
out.close();
success = 1;
message = "上傳成功,解析後檔案大小:" + data.length + " 位元組";
}
%>
{
"message": "<%=message %>",
"success": <%=success %>
}
原範例使用 sun.misc.BASE64Decoder 與 eval(),兩者都該避免:前者是 JDK 內部類別,新版 Java 已移除,請改用 java.util.Base64;後者則應換成 JSON.parse()。此外,伺服器端務必驗證檔名與副檔名,避免路徑穿越攻擊,並限制上傳大小——使用者傳來的是 Base64 字串,實際流量比原檔更大。上傳目錄也不要放在 Web 可執行路徑下。