DIV CSS 佈局教程網

WebApi + Bootstrap + KnockoutJs 打造單頁面應用(SPA)實戰
編輯:關於JavaScript     

一、前言

前一篇已快速介紹過 KnockoutJs 的概念與幾個小範例。要真正感受到它的價值,還得放進專案裡跑一遍。本篇用 WebApi + Bootstrap + KnockoutJs + Asp.net MVC 組出一個單頁面(SPA)任務管理系統,這套組合也是當時多數團隊的實際選擇。

二、SPA 好在哪裡

SPA(Single Page Application)指的是只載入一個 HTML 頁面,之後所有互動都在這張頁面上由 JavaScript 動態更新完成。瀏覽器一開始載入所需的 HTML、CSS 與 JavaScript,後續操作就不再重新向伺服器索取整份頁面。

好處大致有四點:

使用者體驗接近原生 App 的速度與流暢感。

前後端關注點分離,前端負責呈現、後端負責資料與計算,邏輯不再糾纏。

減輕伺服器負擔。伺服器只需輸出資料,不必負責畫面組裝,吞吐量自然提升——Razor 那種由伺服器合成頁面再回傳的模式,壓力顯然更大。

同一套後端可服務網頁、手機、平板等多種用戶端,不必重複開發。

缺點同樣要誠實面對:

不利於 SEO,不過如果做的是管理後台,這點影響有限。

首次載入時間變長,因為所有 JS 與 CSS 會在第一次就下載完畢;可用 Asp.net MVC 的 Bundle 把檔案合併壓縮來改善。

瀏覽器原生導航不可用,前後頁功能得自行實作。手機版網頁其實早就這麼做了。

對開發者的技能要求較高,學習成本也較高。這點對工程師來說反而是常態,好在主流前端框架上手都不難。

三、實作:Asp.net MVC + WebAPI + Bootstrap + KnockoutJS

步驟一,用 VS2013 建立 Asp.net Web 應用程式專案,勾選 MVC 與 Web API。

步驟二,建立模型與倉儲。這裡以一個簡易任務管理系統為例。

任務實體類別:

public enum TaskState { Active = 1, Completed = 2 }

/// <summary>
/// 任務實體
/// </summary>
public class Task {
    public int Id { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
    public DateTime CreationTime { get; set; }
    public DateTime FinishTime { get; set; }
    public string Owner { get; set; }
    public TaskState State { get; set; }

    public Task() {
        CreationTime = DateTime.Parse(DateTime.Now.ToLongDateString());
        State = TaskState.Active;
    }
}

任務倉儲類別(此處用記憶體中的示例資料代替資料庫):

/// <summary>
/// 這裡倉儲直接使用示例數據作為演示,真實項目中需要從數據庫中動態加載
/// </summary>
public class TaskRepository {
    #region Static Filed
    private static Lazy<TaskRepository> _taskRepository = new Lazy<TaskRepository>(() => new TaskRepository());
    public static TaskRepository Current { get { return _taskRepository.Value; } }
    #endregion

    #region Fields
    private readonly List<Task> _tasks = new List<Task>() {
        new Task { Id = 1, Name = "創建一個SPA程序", Description = "SPA(single page web application),SPA的優勢就是少量帶寬,平滑體驗", Owner = "Learning hard", FinishTime = DateTime.Parse(DateTime.Now.AddDays(1).ToString(CultureInfo.InvariantCulture)) },
        new Task { Id = 2, Name = "學習KnockoutJs", Description = "KnockoutJs是一個MVVM類庫,支持雙向綁定", Owner = "Tommy Li", FinishTime = DateTime.Parse(DateTime.Now.AddDays(2).ToString(CultureInfo.InvariantCulture)) },
        new Task { Id = 3, Name = "學習AngularJS", Description = "AngularJs是MVVM框架,集MVVM和MVC與一體。", Owner = "李志", FinishTime = DateTime.Parse(DateTime.Now.AddDays(3).ToString(CultureInfo.InvariantCulture)) },
        new Task { Id = 4, Name = "學習ASP.NET MVC網站", Description = "Glimpse是一款.NET下的性能測試工具", Owner = "Tonny Li", FinishTime = DateTime.Parse(DateTime.Now.AddDays(4).ToString(CultureInfo.InvariantCulture)) },
    };
    #endregion

    #region Public Methods
    public IEnumerable<Task> GetAll() { return _tasks; }

    public Task Get(int id) { return _tasks.Find(p => p.Id == id); }

    public Task Add(Task item) {
        if (item == null) { throw new ArgumentNullException("item"); }
        item.Id = _tasks.Count + 1;
        _tasks.Add(item);
        return item;
    }

    public void Remove(int id) { _tasks.RemoveAll(p => p.Id == id); }

    public bool Update(Task item) {
        if (item == null) { throw new ArgumentNullException("item"); }
        var taskItem = Get(item.Id);
        if (taskItem == null) { return false; }
        _tasks.Remove(taskItem);
        _tasks.Add(item);
        return true;
    }
    #endregion
}

步驟三,透過 Nuget 加入 Bootstrap 與 KnockoutJs。

步驟四,實作後端資料服務,這裡由 WebAPI 負責:

/// <summary>
/// Task WebAPI,提供數據服務
/// </summary>
public class TasksController : ApiController {
    private readonly TaskRepository _taskRepository = TaskRepository.Current;

    public IEnumerable<Task> GetAll() {
        return _taskRepository.GetAll().OrderBy(a => a.Id);
    }

    public Task Get(int id) {
        var item = _taskRepository.Get(id);
        if (item == null) { throw new HttpResponseException(HttpStatusCode.NotFound); }
        return item;
    }

    [Route("api/tasks/GetByState")]
    public IEnumerable<Task> GetByState(string state) {
        IEnumerable<Task> results = new List<Task>();
        switch (state.ToLower()) {
            case "":
            case "all":
                results = _taskRepository.GetAll();
                break;
            case "active":
                results = _taskRepository.GetAll().Where(t => t.State == TaskState.Active);
                break;
            case "completed":
                results = _taskRepository.GetAll().Where(t => t.State == TaskState.Completed);
                break;
        }
        results = results.OrderBy(t => t.Id);
        return results;
    }

    [HttpPost]
    public Task Create(Task item) { return _taskRepository.Add(item); }

    [HttpPut]
    public void Put(Task item) {
        if (!_taskRepository.Update(item)) {
            throw new HttpResponseException(HttpStatusCode.NotFound);
        }
    }

    public void Delete(int id) { _taskRepository.Remove(id); }
}

步驟五,用 Bundle 打包靜態資源:

public class BundleConfig {
    public static void RegisterBundles(BundleCollection bundles) {
        bundles.Add(new ScriptBundle("~/bundles/jquery").Include(
            "~/Scripts/jquery-{version}.js"));
        bundles.Add(new ScriptBundle("~/bundles/jqueryval").Include(
            "~/Scripts/jquery.validate*"));
        bundles.Add(new ScriptBundle("~/bundles/modernizr").Include(
            "~/Scripts/modernizr-*"));
        bundles.Add(new ScriptBundle("~/bundles/bootstrap").Include(
            "~/Scripts/bootstrap.js", "~/Scripts/bootstrap-datepicker.min.js"));
        bundles.Add(new StyleBundle("~/Content/css").Include(
            "~/Content/bootstrap.css", "~/Content/bootstrap-datepicker3.min.css", "~/Content/site.css"));
        bundles.Add(new ScriptBundle("~/bundles/knockout").Include(
            "~/Scripts/knockout-{version}.js", "~/Scripts/knockout.validation.min.js", "~/Scripts/knockout.mapping-latest.js"));
        bundles.Add(new ScriptBundle("~/bundles/app").Include(
            "~/Scripts/app/app.js"));
    }
}

步驟六,調整 WebApiConfig。預設序列化會把列舉型別轉成數值,但我們希望頁面上看到 Active、Completed 這類字串,同時屬性名稱採用駝峰式命名:

public static class WebApiConfig {
    public static void Register(HttpConfiguration config) {
        config.MapHttpAttributeRoutes();
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
        config.Formatters.JsonFormatter.SerializerSettings.ContractResolver =
            new CamelCasePropertyNamesContractResolver();
        config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(
            new StringEnumConverter());
    }
}

這一步若省掉駝峰式命名,前端綁定時就得寫成 Name 而非 name,否則會出現屬性未定義的錯誤。既然 JavaScript 社群普遍使用小駝峰命名,與其讓前端配合後端,不如在序列化階段就統一,程式碼也更符合規範。

步驟七,改寫 Layout 與 Index。

 <!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Learninghard SPA Application</title>
@Styles.Render("~/Content/css")
@Scripts.Render("~/bundles/modernizr")
</head>
<body>
<div class="navbar navbar-inverse navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<p class="navbar-brand">簡單任務管理系統</p>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="/">主頁</a></li>
</ul>
</div>
</div>
</div>
<div class="container body-content" id="main">
@RenderBody()
<hr />
<footer>
<p>© @DateTime.Now.Year - Learninghard SPA Application</p>
</footer>
</div>
@Scripts.Render("~/bundles/jquery")
@Scripts.Render("~/bundles/bootstrap")
@Scripts.Render("~/bundles/knockout")
@Scripts.Render("~/bundles/app")
</body>
</html>

Index 頁面:

 @{
    ViewBag.Title = "Index";
    Layout = "~/Views/Shared/_Layout.cshtml";
}
<div id="list" data-bind="if:canCreate">
<h2>Tasks</h2>
<div class="table-responsive">
<table class="table table-striped">
<thead>
<tr>
<th>編號</th><th>名稱</th><th>描述</th><th>負責人</th>
<th>創建時間</th><th>完成時間</th><th>狀態</th><th></th>
</tr>
</thead>
<tbody data-bind="foreach:tasks">
<tr>
<td data-bind="text: id"></td>
<td><a data-bind="text: name, click: handleCreateOrUpdate"></a></td>
<td data-bind="text: description"></td>
<td data-bind="text: owner"></td>
<td data-bind="text: creationTime"></td>
<td data-bind="text: finishTime"></td>
<td data-bind="text: state"></td>
<td><a class="btn btn-xs btn-primary" data-bind="click:remove" href="javascript:void(0)">Remove</a></td>
</tr>
</tbody>
</table>
</div>
<div class="col-sm-4">
<a href="javascript:void(0)" data-bind="click: function(data, event){ setTaskList('all') }">All</a> |
<a href="javascript:void(0)" data-bind="click: function(data, event){ setTaskList('active') }">Active</a> |
<a href="javascript:void(0)" data-bind="click: function(data, event){ setTaskList('completed') }">Completed</a>
</div>
<div class="col-sm-2 col-sm-offset-6">
<a href="javascript:void(0)" data-bind="click: handleCreateOrUpdate">添加任務</a>
</div>
</div>
<div id="create" style="visibility: hidden">
<h2>添加任務</h2>
<br/>
<div class="form-horizontal">
<div class="form-group">
<label for="taskName" class="col-sm-2 control-label">名稱 *</label>
<div class="col-sm-10">
<input type="text" data-bind="value: name" class="form-control" id="taskName" name="taskName" placeholder="名稱">
</div>
</div>
<div class="form-group">
<label for="taskDesc" class="col-sm-2 control-label">描述</label>
<div class="col-sm-10">
<textarea class="form-control" data-bind="value: description" rows="3" id="taskDesc" name="taskDesc" placeholder="描述"></textarea>
</div>
</div>
<div class="form-group">
<label for="taskOwner" class="col-sm-2 control-label">負責人 *</label>
<div class="col-sm-10">
<input class="form-control" id="taskOwner" name="taskOwner" data-bind="value: owner" placeholder="負責人">
</div>
</div>
<div class="form-group">
<label for="taskFinish" class="col-sm-2 control-label">預計完成時間 *</label>
<div class="col-sm-10">
<input class="form-control datepicker" id="taskFinish" data-bind="value: finishTime" name="taskFinish">
</div>
</div>
<div class="form-group">
<label for="taskState" class="col-sm-2 control-label">狀態 *</label>
<div class="col-sm-10">
<select id="taskState" class="form-control" data-bind="value: state">
<option>Active</option>
<option>Completed</option>
</select>
</div>
</div>
<div class="form-group">
<div class="col-sm-offset-2 col-sm-10">
<button class="btn btn-primary" data-bind="click:handleSaveClick">Save</button>
<button data-bind="click: handleBackClick" class="btn btn-primary">Back</button>
</div>
</div>
</div>
</div>

步驟八,撰寫前端腳本邏輯,用 AJAX 取資料並建立 ViewModel 完成綁定:

var taskListViewModel = {
    tasks: ko.observableArray(),
    canCreate: ko.observable(true)
};

var taskModel = function () {
    this.id = 0;
    this.name = ko.observable();
    this.description = ko.observable();
    this.finishTime = ko.observable();
    this.owner = ko.observable();
    this.state = ko.observable();
    this.fromJS = function(data) {
        this.id = data.id;
        this.name(data.name);
        this.description(data.description);
        this.finishTime(data.finishTime);
        this.owner(data.owner);
        this.state(data.state);
    };
};

function getAllTasks() {
    sendAjaxRequest("GET", function (data) {
        taskListViewModel.tasks.removeAll();
        for (var i = 0; i < data.length; i++) {
            taskListViewModel.tasks.push(data[i]);
        }
    }, 'GetByState', { 'state': 'all' });
}

function setTaskList(state) {
    sendAjaxRequest("GET", function(data) {
        taskListViewModel.tasks.removeAll();
        for (var i = 0; i < data.length; i++) {
            taskListViewModel.tasks.push(data[i]);
        }
    }, 'GetByState', { 'state': state });
}

function remove(item) {
    sendAjaxRequest("DELETE", function () { getAllTasks(); }, item.id);
}

var task = new taskModel();

function handleCreateOrUpdate(item) {
    task.fromJS(item);
    initDatePicker();
    taskListViewModel.canCreate(false);
    $('#create').css('visibility', 'visible');
}

function handleBackClick() {
    taskListViewModel.canCreate(true);
    $('#create').css('visibility', 'hidden');
}

function handleSaveClick(item) {
    if (item.id == undefined) {
        sendAjaxRequest("POST", function (newItem) {
            taskListViewModel.tasks.push(newItem);
        }, null, {
            name: item.name, description: item.description,
            finishTime: item.finishTime, owner: item.owner, state: item.state
        });
    } else {
        sendAjaxRequest("PUT", function () { getAllTasks(); }, null, {
            id: item.id, name: item.name, description: item.description,
            finishTime: item.finishTime, owner: item.owner, state: item.state
        });
    }
    taskListViewModel.canCreate(true);
    $('#create').css('visibility', 'hidden');
}

function sendAjaxRequest(httpMethod, callback, url, reqData) {
    $.ajax("/api/tasks" + (url ? "/" + url : ""), {
        type: httpMethod, success: callback, data: reqData
    });
}

var initDatePicker = function() {
    $('#create .datepicker').datepicker({ autoclose: true });
};

$('.nav').on('click', 'li', function() {
    $('.nav li.active').removeClass('active');
    $(this).addClass('active');
});

$(document).ready(function () {
    getAllTasks();
    ko.applyBindings(taskListViewModel, $('#list').get(0));
    ko.applyBindings(task, $('#create').get(0));
});

做到這裡,單頁面程式就完成了。執行後可以觀察到:頁面載入之後,新增、編輯、刪除、篩選都在同一張頁面上完成,完全看不到瀏覽器轉圈的過程。

四、與 Razor 開發模式的差異

效果上的差異很明顯,但更值得談的是思維上的轉變,主要落在兩點。

第一,渲染發生在使用者的瀏覽器端,而不是伺服器端。渲染壓力被分散到各個用戶的瀏覽器,伺服器負擔因此下降。若改用 Razor,前端就得寫成:

@Model IEnumerable<KnockoutJSSPA.Models.Task>
@foreach (var item in Model) {
    <tr>
    <td>@item.Name</td>
    <td>@item.Description</td>
    </tr>
}

這些標籤都由伺服器端的 Razor 引擎渲染後才回傳,這也正是每次切換頁面都會看到轉圈的原因。

第二,綁定的資料是動態的。資料模型一變,畫面立刻反映,這要歸功於 KnockoutJs 的雙向綁定機制。

這種分工讓開發變簡單了:Web API 只負責提供資料,前端少了大量繁瑣易錯的 DOM 操作,隱性 bug 也跟著減少;而且同一個後端服務能同時供應手機、網頁與其他平台,不必重複造輪子。

五、總結

本篇示範了如何用 KnockoutJs 完成一個 SPA。實務上打造單頁面程式更常採用 AngularJS,KnockoutJs 的使用者也不少,但它本質上是個 MVVM 類庫,路由機制需要借助其他工具——這裡用的是 Asp.net MVC 的路由,也可以搭配 director.js 這類前端路由框架。相較之下,AngularJS 是 MVVM 加上 MVC 的完整框架,下一篇就來談談如何用 AngularJS 打造 SPA。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved