自訂回應
總覽
Sails 應用程式捆綁了數個預先設定的回應，可以從動作程式碼中呼叫。這些預設回應可以處理諸如「找不到資源」（notFound 回應）和「內部伺服器錯誤」（serverError 回應）等情況。如果您的應用程式需要修改預設回應的運作方式，或完全建立新的回應，您可以透過將檔案新增至 api/responses 資料夾來完成。
注意：新的 Sails 應用程式預設不會產生
api/responses，因此如果您想要新增/自訂回應，則必須自行新增。
使用回應
作為一個快速範例，請考慮以下動作
getProfile: function(req, res) {
// Look up the currently logged-in user's record from the database.
User.findOne({ id: req.session.userId }).exec(function(err, user) {
if (err) {
res.status(500);
return res.view('500', {data: err});
}
return res.json(user);
});
}
此程式碼透過傳送 500 錯誤狀態並將錯誤資料傳送至視圖以顯示來處理資料庫錯誤。但是，此程式碼有幾個缺點，主要是
- 回應不是內容協商的：如果用戶端期望 JSON 回應，他們就會失望
- 回應洩漏了太多關於錯誤的資訊：在生產環境中，最好只將錯誤記錄到終端機
- 它不是標準化的：即使我們處理了上面的其他要點，此程式碼也特定於此動作，我們必須努力在任何地方保持完全相同的錯誤處理格式
- 它不是抽象化的：如果我們想在其他地方使用類似的方法，我們必須複製/貼上程式碼
現在，考慮這個替換方案
getProfile: function(req, res) {
// Look up the currently logged-in user's record from the database.
User.findOne({ id: req.session.userId }).exec(function(err, user) {
if (err) { return res.serverError(err); }
return res.json(user);
});
}
這種方法有很多優點
- 更簡潔
- 錯誤酬載已標準化
- 已考量生產環境與開發環境的記錄
- 錯誤代碼是一致的
- 已處理內容協商（JSON 與 HTML）
- API 調整可以在一個快速編輯中完成，以修改適當的通用回應檔案
回應方法和檔案
任何儲存在 api/responses/ 資料夾中的 .js 檔案都可以透過呼叫 res.thatFileName() 來執行。例如，api/responses/insufficientFunds.js 可以透過呼叫 res.insufficientFunds() 來執行。
存取 req、res 和 sails
請求和回應物件在自訂回應中以 this.req 和 this.res 的形式提供。這允許實際的回應函式接受任意參數。例如
return res.insufficientFunds(err, { happenedDuring: 'signup' });
而自訂回應的實作可能看起來像這樣
module.exports = function insufficientFunds(err, extraInfo){
var req = this.req;
var res = this.res;
var sails = req._sails;
var newError = new Error('Insufficient funds');
newError.raw = err;
_.extend(newError, extraInfo);
sails.log.verbose('Sent "Insufficient funds" response.');
return res.badRequest(newError);
}
內建回應
所有 Sails 應用程式都有幾個預先設定的回應，例如 res.serverError() 和 res.notFound()，即使它們在 api/responses/ 中沒有對應的檔案，也可以使用。
任何預設回應都可以透過在您的應用程式的 api/responses/ 中新增同名檔案（例如 api/responses/serverError.js）來覆寫。
您可以使用 Sails 命令列工具 作為執行此操作的捷徑。
例如
sails generate response serverError
為了在 sailsjs.com 上獲得更好的體驗，更新您的瀏覽器。
概念
以愛打造
Sails 框架是由位於德州奧斯汀的 網頁與行動商店，以及我們的貢獻者們共同打造。我們在 2012 年創建 Sails，以協助我們進行 Node.js 專案。自然地，我們將其開源。我們希望它可以讓您的生活更輕鬆一點！
© 2012-2024 The Sails Company.
Sails 框架在 MIT 許可下是免費且開源的。
插圖由 Edamame 提供。