AngularJS 內建的表單驗證能力其實很強,只是要從自訂 directive 裡存取它需要一點技巧。本文示範如何透過 require: 'form' 取得表單控制器,並讀取它的 $pristine、$dirty、$valid 等狀態。
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>表單驗證</title>
</head>
<script src="js/jquery.js"></script>
<script src="js/angular.min.js"></script>
<body ng-app="app">
<div ng-controller="TestCtrl">
<div ng-form test>
<input ng-model="a" type="email" />
<button ng-click="do()">查看</button>
</div>
</div>
<script>
app = angular.module("app", []);
app.directive('test', function() {
// form 表單的指令都有一個默認的控制器作為第四個參數
var link = function($scope, $element, $attrs, $ctrl) {
$scope.do = function() {
//$ctrl.$setDirty();
console.log($ctrl.$pristine); // form 是否沒被動過
console.log($ctrl.$dirty); // form 是否被動過
console.log($ctrl.$valid); // form 是否通過檢驗
console.log($ctrl.$invalid); // form 是否有錯誤
console.log($ctrl.$error); // form 中有錯誤的字段
}
}
return {
compile: function() { return link },
require: 'form',
restrict: 'A'
}
});
app.controller('TestCtrl', function($scope){
// 如果沒有 controller,這個東西還不會初始化
});
</script>
</body>
</html>
directive 的 link 函式第四個參數,就是由 require 指定要注入的控制器。寫 require: 'form' 時,Angular 會把該表單對應的 FormController 實例傳進來。如果表單是巢狀的,也可以用 '?form'(找不到時給 null 而不報錯)或 '^form'(往父層找)。
注意範例中 ng-form 加了自訂屬性 test,這是因為 directive 必須掛在 form 元素上,才能 require 到那個 form 的控制器。掛在外面的 div 是拿不到的。
$pristine:表單從未被使用者修改過(與 $dirty 互斥)。$dirty:使用者動過表單了。這常用來決定「離開頁面前是否要跳確認」。範例中被註解的 $ctrl.$setDirty() 就是主動把狀態標記為已修改。$valid/$invalid:整體驗證是否通過,互為反義。通常拿來控制提交按鈕的 ng-disabled。$error:一個物件,key 是錯誤名稱(如 email、required、minlength),value 是符合該錯誤條件的欄位清單。想知道「哪個欄位格式錯了」就查這個。範例註解提到「如果沒有 controller,這東西還不會初始化」。這是因為 Angular 的表單相關狀態是掛在 $scope 上的,而 ng-form 需要一個明確的 scope 環境來註冊這些屬性。實務上就算沒有業務邏輯,也建議留一個空的 controller 作為錨點。
如果只是想讀表單狀態,其實不必寫自訂 directive。在 template 裡直接用 myForm.$valid 就能取用,因為 Angular 會自動把表單發布到當前 scope:
<form name="myForm" novalidate> <input ng-model="a" type="email" required /> <span ng-show="myForm.$error.email">Email 格式錯誤</span> <button ng-disabled="myForm.$invalid">送出</button> </form>
自訂 directive 的價值在於「需要在程式邏輯中讀取表單狀態」的場合,例如送出前統一檢查、或根據 dirty 狀態決定是否提示。純展示用途用插值就好。