カスタムレスポンス
概要
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フレームワークは、テキサス州オースティンのWeb＆モバイルショップによって、貢献者の皆様の助けを借りて構築されました。私たちは2012年にNode.jsプロジェクトを支援するためにSailsを作成し、オープンソース化しました。皆様のお役に立てれば幸いです！
© 2012-2024 The Sails Company。
Sailsフレームワークは、MITライセンスの下で無料かつオープンソースです。
イラストレーション：Edamame。