資料驗證是企業級 Web 應用中最具挑戰性的環節之一。常見的困境是:驗證規則屬於伺服器端知識,卻得散落在 JavaScript 模組裡,於是每一段客戶端驗證程式碼都混進了伺服器端的片段,日後規則一改,客戶端就得跟著翻修。
本文示範一個更乾淨的做法:由伺服器端產生 JSON 形式的「字串化」後設資料,快取在用戶端,再以普通 JavaScript 物件的方式存取。這套方法同時能優雅處理多值與多組屬性。
每個應用程式都是為了解決某個領域的問題,而每個領域都有自己的一套約束規則。把規則套用到資料上,就成了驗證。
傳統做法是用大量 if-else 組合,判斷條件與提示訊息都硬編碼在函式中,或是透過伺服器端語法(例如 JSP 標籤)插入。後者看似方便,卻有兩個后遗症:一是所有伺服器端片段都會被求值並送到用戶端,你無法控制實際送出多少;二是規則一旦調整,客戶端驗證函式就得跟著改。
改用 JSON 快取後,伺服器端可以決定要產生哪些後設資料,客戶端只需讀取物件屬性,兩邊徹底分離。
JSON 用特定的字串形式表示 JavaScript 物件。把這樣的字串指派給變數後,該變數就成為一個真正的物件。例如有一個 policy 物件,具有計畫名稱、描述、年期三個屬性:
var policy = {
"Plan": { "Full Life Cover" },
"Description": { "The best life insurance plan" },
"Term": { "20 years" }
};
把這段程式碼放進 HTML 頁面,接著寫:
alert(policy.Plan);
在任何支援 JavaScript 的瀏覽器中開啟,都會看到對應的提示。
假設有一個 person 物件,每個人可以擁有一台或多台車輛,每台車有品牌名稱、註冊碼、CC 三個屬性。表單必須允許使用者連續新增多台車,且每個屬性都有各自的驗證規則:
當使用者輸入 40CC 時,程式必須提示超出有效範圍:
if (cc < <%= minCC %> || cc > <%= maxCC %>) {
alert(<%= ResourceList.vehicleCCRangeMsg %>);
}
ResourceList 是伺服器端類別,負責存放國際化訊息。這種寫法的問題很明顯:伺服器端程式碼被散進每一個客戶端驗證函式;一旦後設資料或訊息的組織方式調整,所有引用它的客戶端腳本都得跟著改。
如果判斷式與提示訊息都改成讀取同一個 JavaScript 物件,情況就單純多了:
if (cc < vehicleValidationsMetadata.CC.minCC ||
cc > vehicleValidationsMetadata.CC.maxCC) {
alert(vehicleValidationsMetadata.CC.RangeMessage);
}
JavaScript 裡不再出現任何伺服器端語法,伺服器端調整儲存方式也不影響客戶端。
只能由伺服器端負責。典型的產生流程是:
最終的車輛後設資料物件長這樣:
var vehicleValidationsMetadata = {
"BrandName": {
"CanContainDigits": { false },
"MaxWords": { 2 },
"FormatMessage": { "品牌名稱不可包含數字。" },
"WordLimitMessage": { "品牌名稱不可超過兩個單字" }
},
"RegistrationNumber": {
"CanContainAlphabets": { false },
"CanContainDigits": { true },
"FormatMessage": { "註冊碼只能包含數字。" }
},
"CC": {
"minCC": { 50 },
"maxCC": { 5000 },
"FormatMessage": { "CC 只能為數字" },
"RangeMessage": { "CC 必須介於 50 與 5000 之間" }
}
};
伺服器端只需產生中間部分,最外層的宣告則依使用者語系決定訊息內容。若日後要擴充,更好的做法是把車輛後設資料包進 person 後設資料裡,不必再開一個全域變數。
function validateVehicleData() {
var brandName = /* 從表單欄位取得品牌名稱 */;
var registrationNumber = /* 取得註冊碼 */;
var CC = /* 取得 CC */;
var brandNameTokens = brandName.split(' ');
if (brandNameTokens.length > vehicleValidationsMetadata.BrandName.MaxWords) {
alert(vehicleValidationsMetadata.BrandName.WordLimitMessage);
}
// 其餘規則同理
if ((!vehicleValidationsMetadata.RegistrationNumber.CanContainAlphabets) &&
isNaN(parseInt(registrationNumber))) {
alert(vehicleValidationsMetadata.RegistrationNumber.FormatMessage);
}
var ccNum = parseInt(CC);
if (ccNum < vehicleValidationsMetadata.CC.minCC ||
ccNum > vehicleValidationsMetadata.CC.maxCC) {
alert(vehicleValidationsMetadata.CC.RangeMessage);
}
}
整段程式碼不再混雜伺服器語法,後端調整儲存方式時客戶端不必重寫,維護成本大幅下降。
有些應用要求使用者為同一屬性輸入多筆資料,例如為每一台車各填一次。此時面臨一個現實問題:輸入欄位是同一組,第二台車的資料就必須先把第一台的存起來。
有兩條路:
第一種做法每輸入一台就得等伺服器回應,互動體驗很差;第二種回應時間近乎為零,使用者可以連續輸入而不必等待。
至於用戶端怎麼存,也有兩種選擇:
按下「新增車輛」時,更新用戶端快取物件:
function addVehicleData() {
var brand = /* 取得品牌 */;
var regNo = /* 取得註冊碼 */;
var cc = /* 取得 cc */;
vehicleData[vehicleData.length] = {};
vehicleData[vehicleData.length].brandName = brand;
// 其餘兩個屬性同理
}
其中 vehicleData 在頁面載入時初始化為空陣列(或含先前輸入的資料)。存好之後再呼叫另一支函式清空欄位,讓使用者接著填下一台。
若要求最少或最多輸入幾筆,同樣可以寫進 JSON:
var vehicleValidationsMetadata = {
"MIN_OCC": { 0 },
"MAX_OCC": { 10 },
"MAX_OCC_MSG": { "最多只能新增十台車輛" },
"MIN_OCC_MSG": { "請至少新增一台車輛" }
// 其餘規則不變
};
function addVehicleData() {
if (vehicleData.length == vehicleValidationsMetadata.MAX_OCC - 1) {
alert(vehicleValidationsMetadata.MAX_OCC_MSG);
return;
}
// 其餘邏輯不變
}
頁面提交時的函式則負責檢查最少出現次數。
這套做法最大的好處是:新增資料時畫面完全不必刷新。提供這種「靜態畫面」體驗原本正是 Ajax 的主要目標,而搭配 JSON 快取,你就能在不引入完整框架的前提下達到同樣效果——所有操作都在用戶端完成,回應時間自然最短。
最後按下儲存時,用 JSON.stringify() 把物件轉為字串寫入隱藏欄位送出;伺服器端則需具備解析 JSON 的能力,才能還原成原生物件進行處理與保存。