AngularJS的Filter用法詳解

上一篇講了自定義Directive，本篇是要講到AngularJS的Filter。

 

Filter簡介

Filter是用來格式化數據用的。

Filter的基本原型（ '|' 類似於Linux中的管道模式）：

{{ expression | filter }}

Filter可以被鏈式使用（即連續使用多個filter）：

{{ expression | filter1 | filter2 | ... }}

Filter也可以指定多個參數：

{{ expression | filter:argument1:argument2:... }}

 

AngularJS內建的Filter

AngularJS內建了一些常用的Filter，我們一一來看一下。

currencyFilter（currency）：

用途：格式化貨幣

方法原型：

function(amount, currencySymbol, fractionSize)

 用法：

{{ 12 | currency}}  <!--將12格式化為貨幣，默認單位符號為 '$', 小數默認2位-->

{{ 12.45 | currency:'￥'}} <!--將12.45格式化為貨幣，使用自定義單位符號為 '￥', 小數默認2位-->

{{ 12.45 | currency:'CHY￥':1}} <!--將12.45格式化為貨幣，使用自定義單位符號為 'CHY￥', 小數指定1位, 會執行四舍五入操作 -->

{{ 12.55 | currency:undefined:0}} <!--將12.55格式化為貨幣， 不改變單位符號， 小數部分將四舍五入 -->

 

dateFilter（date）：

用途：格式化日期

方法原型：

function(date, format, timezone)

用法：

<!--使用ISO標准日期格式 -->
{{ '2015-05-20T03:56:16.887Z' | date:"MM/dd/yyyy @ h:mma"}}

<!--使用13位（單位：毫秒）時間戳 -->
{{ 1432075948123 | date:"MM/dd/yyyy @ h:mma"}}

<!--指定timezone為UTC -->
{{ 1432075948123 | date:"MM/dd/yyyy @ h:mma":"UTC"}}

 

filterFilter（filter）：

用途：過濾數組

方法原型：

function(array, expression, comparator)

用法1（參數expression使用String）：

<div ng-init="myArr = [{name:'Tom', age:20}, {name:'Tom Senior', age:50}, {name:'May', age:21}, {name:'Jack', age:20}, {name:'Alice', age:22}]">
    <!-- 參數expression使用String，將全文搜索關鍵字 'a' -->
    <div ng-repeat="u in myArr | filter:'a' ">
        <p>Name:{{u.name}}</p>
        <p>Age:{{u.age}}</p>
        <br />
    </div>
</div>

用法2（參數expression使用function）：

// 先在Controller中定義function: myFilter
$scope.myFilter = function (item) {
    return item.age === 20;
};

<div ng-repeat="u in myArr | filter:myFilter ">
    <p>Name:{{u.name}}</p>
    <p>Age:{{u.age}}</p>
    <br />
</div>

用法3（參數expression使用object）：

<div ng-init="myArr = [{name:'Tom', age:20}, {name:'Tom Senior', age:50}, {name:'May', age:21}, {name:'Jack', age:20}, {name:'Alice', age:22}]">
    <div ng-repeat="u in myArr | filter:{age: 21} ">
        <p>Name:{{u.name}}</p>
        <p>Age:{{u.age}}</p>
        <br />
    </div>
</div>

用法4（指定comparator為true或false）：

<div ng-init="myArr = [{name:'Tom', age:20}, {name:'Tom Senior', age:50}, {name:'May', age:21}, {name:'Jack', age:20}, {name:'Alice', age:22}]">
    Name:<input ng-model="yourName" />
    <!-- 指定comparator為false或者undefined，即為默認值可不傳，將以大小寫不敏感的方式匹配任意內容 -->
    <!-- 可以試試把下面代碼的comparator為true，true即大小寫及內容均需完全匹配 -->
    <div ng-repeat="u in myArr | filter:{name:yourName}:false ">
        <p>Name:{{u.name}}</p>
        <p>Age:{{u.age}}</p>
        <br />
    </div>
</div>

用法5（指定comparator為function）：

// 先在Controller中定義function:myComparator, 此function將能匹配大小寫不敏感的內容，但與comparator為false的情況不同的是，comparator必須匹配全文
$scope.myComparator = function (expected, actual) {
    return angular.equals(expected.toLowerCase(), actual.toLowerCase());
}

<div ng-init="myArr = [{name:'Tom', age:20}, {name:'Tom Senior', age:50}, {name:'May', age:21}, {name:'Jack', age:20}, {name:'Alice', age:22}]">
    Name:<input ng-model="yourName" />
    <div ng-repeat="u in myArr | filter:{name:yourName}:myComparator ">
        <p>Name:{{u.name}}</p>
        <p>Age:{{u.age}}</p>
        <br />
    </div>
</div>

 

jsonFilter（json）：

 方法原型：

function(object, spacing)

用法（將對象格式化成標准的JSON格式）：

{{ {name:'Jack', age: 21} | json}}

 

limitToFilter（limitTo）：

 方法原型：

function(input, limit)

用法（選取前N個記錄）：

<div ng-init="myArr = [{name:'Tom', age:20}, {name:'Tom Senior', age:50}, {name:'May', age:21}, {name:'Jack', age:20}, {name:'Alice', age:22}]">
    <div ng-repeat="u in myArr | limitTo:2">
        <p>Name:{{u.name}}
        <p>Age:{{u.age}}
    </div>
</div>

 

lowercaseFilter（lowercase）/uppercaseFilter（uppercase）：

 方法原型：

function(string)

用法：

China has joined the {{ "wto" | uppercase }}.
We all need {{ "MONEY" | lowercase }}.

 

numberFilter（number）:

方法原型：

function(number, fractionSize)

用法：

{{ "3456789" | number}}
<br />
{{ true | number}}
<br />
{{ 12345678 | number:1}}

 

orderByFilter（orderBy）：

方法原型：

function(array, sortPredicate, reverseOrder)

用法：

<div ng-init="myArr = [{name:'Tom', age:20, deposit: 300}, {name:'Tom', age:22, deposit: 200}, {name:'Tom Senior', age:50, deposit: 200}, {name:'May', age:21, deposit: 300}, {name:'Jack', age:20, deposit:100}, {name:'Alice', age:22, deposit: 150}]">
    <!--deposit前面的'-'表示deposit這列倒敘排序，默認為順序排序
    參數reverseOrder：true表示結果集倒敘顯示-->
    <div ng-repeat="u in myArr | orderBy:['name','-deposit']:true">
        <p>Name:{{u.name}}</p>
        <p>Deposit:{{u.deposit}}</p>
        <p>Age:{{u.age}}</p>
        <br />
    </div>
</div>

 

自定義Filter

和Directive一樣，如果內建的Filter不能滿足你的需求，你當然可以定義一個專屬於你自己的Filter。我們來做一個自己的Filter：capitalize_as_you_want，該Filter會使你輸入的字符串中的首字母、指定index位置字母以及指定的字母全部大寫。

方法原型：

function (input, capitalize_index, specified_char)

完整的示例代碼：

<!DOCTYPE>
<html>
<head>
    <script src="/Scripts/angular.js"></script>
    <script type="text/javascript">
        (function () {
            var app = angular.module('ngCustomFilterTest', []);

            app.filter('capitalize_as_you_want', function () {
                return function (input, capitalize_index, specified_char) {
                    input = input || '';
                    var output = '';

                    var customCapIndex = capitalize_index || -1;

                    var specifiedChar = specified_char || '';

                    for (var i = 0; i < input.length; i++) {
                        // 首字母肯定是大寫的， 指定的index的字母也大寫
                        if (i === 0 || i === customCapIndex) {
                            output += input[i].toUpperCase();
                        }
                        else {
                            // 指定的字母也大寫
                            if (specified_char != '' && input[i] === specified_char) {
                                output += input[i].toUpperCase();
                            }
                            else {
                                output += input[i];
                            }
                        }
                    }

                    return output;
                };
            });

        })();
    </script>
</head>
<body ng-app="ngCustomFilterTest">
    <input ng-model="yourinput" type="text">
    <br />
    Result: {{ yourinput | capitalize_as_you_want:3:'b' }}
</body>
</html>

 

好了，本篇講了AngularJS中的Filter，看完這篇后，我們可以利用好Filter非常方便的使數據能按我們的要求進行展示，從而使頁面變得更生動。

 

參考資料

AngularJS官方文檔：https://docs.angularjs.org/guide/filter

CodeSchool快速入門視頻：http://campus.codeschool.com/courses/shaping-up-with-angular-js/intro

Fun with AngularJS filter: http://sarahbranon.com/post/69604997957/fun-with-angularjs-filters-part-1-the-filter