DIV CSS 佈局教程網

前端先行:讓 AJAX 開發擺脫後端接口的等待
編輯:關於JavaScript     

問題出在哪裡

現代網頁應用幾乎離不開 AJAX。頁面一旦打開,資料交換就持續在後台發生。手上參與的專案就是這種形態:接口數量龐大,前後端反覆對接,往復溝通的成本遠比想像中高。

現實情況往往是:後端無法在短時間內交付全部接口,也不願意為前端聯調而專門造一批假資料。等到真正進入開發階段,欄位命名、回傳結構又常常推翻重來。於是「後端寫一個、前端接一個」成了常態,但這個看似合理的策略在執行時問題叢生——未完成的接口可能帶著 bug,前端得不停地追問、排查,甚至乾脆停下來等後端把資料格式定案。

根因分析

把責任全部推給後端並不公平。真正的癥結有兩個:

一是前端在需求尚未定型時,就已經把程式碼綁死在未成熟的接口上;二是後端並不清楚前端究竟需要哪些欄位、需要什麼樣的資料結構與錯誤碼約定。

解法:把接口契約前置

1. 需求評審階段就把接口談清楚

如果 backlog 整理得夠紮實,每個使用者操作都已經被拆解成明確的功能條目,那麼在評審會上讓前後端一起過一遍,反推所需接口其實並不困難。這是成本最低、收益最高的一步。

2. 由前端撰寫接口文件,後端協助推進

為什麼主筆人是前端?因為前端最清楚畫面要呈現什麼資料,也最清楚資料該以什麼格式送達——錯誤碼怎麼定義、成功與失敗如何區分、後續要如何渲染。

一份登入接口的文件大概長這樣:

:用戶登錄
url: ? (留給後端補充)
請求方式:POST
請求參數:email:String
         pwd:String
         checkCode:String
返回數據:
{
  code:int,  // 錯誤編碼,登錄成功為 0,其他錯誤回傳對應編碼,且無 result 項
  result:{
    id:int      // 用戶 ID
    name:string // 用戶名
    ...
  }
}

後端的角色是補齊 url,並修正欄位命名使其符合自身的開發慣例。例如把 name 改為 user。文件修改本身就是雙方對齊認知的过程,任何疑慮都可以在當下提出。定稿後各自留一份,後續所有變動都用不同顏色標註,提醒其他人注意。

:用戶登錄
url: user/login.php (補充)
請求方式:POST
請求參數:email:String
         pwd:String
         checkCode:String
返回數據:
{
  code:int,
  result:{
    id:int
    user:string // 用戶名(修改)
    ...
  }
}

3. 雙方嚴格依照文件開發

文件定稿之後,心裡就有底了:只要照著做,回傳與使用這種結構的資料必然正確。後端可以埋頭寫自己的程式,不必再被前端的反覆詢問打斷。

前端如何先跑起來

接口有了、回傳結構也有了,接下來就是搭一套能用模擬資料驅動的框架。以 jQuery 為例,最直白的寫法如下:

Common = {
  post:function(url, data, success){       // 基本的 post 請求封裝
    $.ajax({
      url:url,
      type:"post",
      data:data,
      dataType:"json",
      error:function(){
        // ajax 錯誤統一提示
      },
      success:function(data){
        if(data && data.code != 0){
          // 把 code 轉成文字提示給用戶
        }
        success && success(data);
      }
    });
  }
};

// 1:用戶登錄
function login(email, pwd, checkCode, callback){
  // 測試環境
  var data = {            // 模擬數據
    code : 0,
    result:{
      id:'123456',
      user:"lujun"
    }
  };
  callback(data);         // 直接把模擬數據餵給回調函數
  return ;
  // 對接真實資料時註釋掉以上兩行,上線前用壓縮工具移除
  // 正式環境
  Common.post("user/login.php", {email:email, pwd:pwd, checkCode:checkCode}, callback);
}

// 點擊事件驅動登錄
$('#submit').click(function(){
  var email = $('#email').val();
  var pwd = $('#pwd').val();
  var checkCode = $('#checkCode').val();
  login(email, pwd, checkCode, function(data){
    if(data && data.code == 0){
      data = data.result;
      $('#userName').text(data.user);
      // 其他後續處理 ...
    }
  });
});

用戶按下登入鈕,前端拿文件裡描述好的結構直接呼叫回調,行為與真實請求完全一致。

讓切換更優雅

如果每個功能都用上面這種「在函數裡寫死假資料」的方式,確實可以完全不依賴後端完成驗收測試。但問題在於:一旦要接真實資料,你得跑遍程式各處把測試碼註釋掉——十幾二十個地方,很容易漏。測試碼的價值因此大打折扣。

更好的做法是把測試資料獨立成一個檔案,然後在最底層覆寫 AJAX 方法:

// testData.js —— 集中存放所有測試數據
TestData = {
  "userlogin":{          // 登錄的測試數據
    code : 0,
    result:{
      id:'123456',
      user:"lujun"
    }
  }
  // ... 其他接口的模擬結構
};

// common.js —— 覆蓋 Common.post
Common.post = function(url, data, success){
  // 也可以把 url 做 MD5 當 key,省掉大量 if 判斷
  if(url == "user/login.php"){
    success(TestData["userlogin"]);
  }else if(url == "other"){
    // 其他接口
  }
};

// 1:用戶登錄
function login(email, pwd, checkCode, callback){
  Common.post("user/login.php", {email:email, pwd:pwd, checkCode:checkCode}, callback);
}

要跑模擬測試就掛上這個覆寫檔,要接真實環境就換掉它,業務邏輯一行都不用動。當然這只是一種思路,你也可以用一個全域開關(例如 debug = true / false)來決定走哪條路徑。

結語

說穿了方法並不玄妙,關鍵在於 scrum 中 backlog 的拆解與理解是否到位。團隊把這套流程跑順之後,前端不必再為後端的進度停擺,後端也不必被無休止的確認打斷。剩下值得繼續思考的課題是:當一個應用的 JS 體量膨脹到數百 KB,程式碼又該如何組織與拆分?

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