DIV CSS 佈局教程網

用 Node.js 消滅重複程式碼:前後端共用一份副檔名驗證邏輯
編輯:關於JavaScript     

做 Web 開發的人大概都有過這樣的經驗:同一條規則,前端寫一遍,後端又得再寫一遍。檔案上傳的副檔名白名單,就是最典型的例子。

同一件事,為什麼要做兩次

前端驗證是為了體驗。使用者選好檔案、按下上傳之前,頁面先幫他把關一次,格式不對就立刻攔下來,省得等檔案傳完才發現白忙一場。

function is_filetype(filename, types) {
  types = types.split(',');
  var pattern = '\.(';
  for (var i = 0; i < types.length; i++) {
    if (0 != i) { pattern += '|'; }
    pattern += types[i].trim();
  }
  pattern += ')$';
  return new RegExp(pattern, 'i').test(filename);
}

// 此處省略 N 行
if (!is_filetype($('#uploadfile').val(), 'doc,pdf,txt,wps,odf,md,png,gif,jpg')) {
  can_submit = false;          // 不允許上傳
  $('#uploadfile').val('');
  alert('只允許上傳: ' + constant.RESUME_FILETYPES);
}

但前端永遠不可信。使用者可以禁用 JavaScript、可以直接改 DOM、也可以繞過你的頁面用 curl 打你的介面。所以後端非得再驗一次不可。當年後端是 Python,於是又寫了一份等價的邏輯:

import re

def is_filetype(filename, types):
    types = types.split(',')
    pattern = '\.(' + '|'.join([t.strip() for t in types]) + ')$'
    return re.search(pattern, filename, re.I) != None

# web request handler
# 此處省略 N 行

重複的根因只有兩個:前端不可信,以及前後端語言不同。而代價也是實實在在的:

  • 想多支援一個 docx,JavaScript 和 Python 兩邊都得改,漏一邊就是 bug。
  • 為了確保兩份邏輯始終一致,測試也得寫兩套,單元測試的維護成本直接翻倍。

Node.js 時代:一份程式碼,兩端執行

Node.js 讓 JavaScript 走出瀏覽器,DRY(Don't Repeat Yourself)在這個場景裡終於有了漂亮的解法。關鍵在於寫出「兩棲」的模組——在瀏覽器裡掛到全域,在 Node 裡走 exports。

// constant.js
(function (exports) {
  exports.RESUME_FILETYPES = 'doc,docx,pdf,txt,wps,odf,md,png,gif,jpg';
})(
  (function () {
    if (typeof exports === 'undefined') {
      window.constant = {};
      return window.constant;
    } else {
      return exports;
    }
  })()
);
// util.js
(function (exports) {

  /**
   * 移除字串兩端的空白字元
   * @return {String}
   */
  String.prototype.trim = function () {
    return this.replace(/(^\s*)|(\s*$)/g, "");
  };

  /**
   * 判斷是否為指定類型的檔案
   * @param {String} filename
   * @param {String} types 多個類型以逗號分隔,如 doc,docx,txt
   * @return {Boolean}
   */
  var is_filetype = exports.is_filetype = function (filename, types) {
    types = types.split(',');
    var pattern = '\.(';
    for (var i = 0; i < types.length; i++) {
      if (0 != i) { pattern += '|'; }
      pattern += types[i].trim();
    }
    pattern += ')$';
    return new RegExp(pattern, 'i').test(filename);
  };

})(
  (function () {
    if (typeof exports === 'undefined') {
      window.util = {};
      return window.util;
    } else {
      return exports;
    }
  })()
);

前端只要照常引入這兩個檔案:

<script src="/js/util.js"></script>
<script src="/js/constant.js"></script>

// 此處省略 N 行
if (!util.is_filetype($('#uploadfile').val(), constant.RESUME_FILETYPES)) {
  can_submit = false;
  $('#uploadfile').val('');
  alert('只允許上傳: ' + constant.RESUME_FILETYPES);
}

後端則用 require 直接拿走同一份實作:

var util = require('./public/js/util.js'),
    constant = require('./public/js/constant.js');

app.post('/resume/upload/:job_id', function (req, res, next) {
  req.form.complete(function (err, fields, files) {
    if (!util.is_filetype(filepath, constant.RESUME_FILETYPES)) {
      // 前端已經攔過一關,能走到這裡的基本都是惡意上傳
      res.send('檔案格式錯誤: ' + filepath +
               ' , 請上傳' + constant.RESUME_FILETYPES + '格式的檔案');
      return;
    }
    // save file ...
  });
});

白名單只維護一處,前後端行為天然一致,測試也只需要一套。這種模式除了常數定義,還很適合放字串處理、格式化、校驗這類通用工具函式——凡是「兩端都需要、且必須保持同樣規則」的邏輯,都值得抽到共用模組裡。

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