req.file()
指定されたfieldから受信したマルチパートファイルアップロードを表すSkipper Upstreamを構築して返します。
req.file(field);
使用方法
| 引数 | 型 | 詳細 | |
|---|---|---|---|
| 1 | field |
アップロードを監視するファイルパラメータの名前。例：avatar。 |
詳細
req.file()は、元のConnectボディパーサーの意見の異なるバリアントであるSkipperから来ています。Skipperを使用すると、アプリケーションロジックに大きな変更を加えることなく、高性能なストリーミングファイルアップロードを利用できます。
この簡素化に伴い、小さな注意点があります。**テキストパラメータは、リクエストボディ内でファイルの前に含める必要があります。**通常、これらのテキストパラメータには、ファイルアップロードに関する追加情報を提供する文字列メタデータが含まれています。
Sailsへのマルチパートリクエストは、すべての**ファイルパラメータ**を送信する前に、すべての**テキストパラメータ**を送信する必要があります。たとえば、Sailsと通信するウェブフロントエンドを構築している場合、フォームアップロードまたはAJAXファイルアップロードリクエストで、テキストパラメータを最初に含める必要があります。「テキストパラメータ」という用語は、アップロードに関する追加情報を提供するファイルと共に送信する可能性のあるメタデータパラメータを指します。
動作方法
Skipperは、すべてのファイルアップロードをストリームとして扱います。これにより、ユーザーは最小限のパフォーマンスへの影響とディスク容量を使用せずに、巨大なファイルをアップロードでき、TMPファイルに関連する悪質なサービス拒否攻撃からアプリケーションを保護できます。
マルチパートリクエストがサーバーにヒットすると、一時ファイルをディスクに書き込む代わりに、Skipperはアプリケーションコードを実行するのに十分な長さだけリクエストをバッファリングし、互換性のあるBLOBレシーバーに「接続」できるようにします。特定のフィールドのデータに「接続」しない場合、Upstreamは「ハイウォーターマーク」に達し、バッファがフラッシュされ、そのフィールドのそれ以降の受信バイトは無視されます。
例
コントローラーアクションまたはポリシー内
// See the Skipper README on GitHub for usage documentation for `.upload()`, including
// a complete list of options.
req.file('avatar').upload(function (err, uploadedFiles){
if (err) return res.serverError(err);
return res.json({
message: uploadedFiles.length + ' file(s) uploaded successfully!',
files: uploadedFiles
});
});
注意事項
- クライアントリクエストのテキストパラメータは、ファイルパラメータの前に送信する必要があることを忘れないでください！
req.file()は、同じフィールドを介して送信された複数のファイルをサポートしますが、その結果として、それが返すUpstreamは、実際には潜在的なバイナリストリーム（ファイル）のストリーム（バッファされたイベントエミッター）であることに注意することが重要です。具体的には、Upstreamは、「オブジェクトモード」のNode.js Readableストリームであり、各オブジェクトはそれ自体が着信マルチパートファイルアップロードストリームです。- ストリームのストリームとしてUpstreamを直接操作する方が良い場合は、
.upload()メソッドを省略し、「finish」および「error」イベントをバインドするか（または.pipe()を使用するか）代わりにできます。内部では、.upload()が行っているのは、Upstreamを指定されたレシーバーインスタンスにパイプし、Upstreamがfinishまたはerrorイベントを発行したときに指定されたコールバックを実行することだけです。
sailsjs.comでより良いエクスペリエンスを得るには、ブラウザを更新してください。
リファレンス
- アプリケーション
- ブループリントAPI
- コマンドラインインターフェース
-
設定
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
リクエスト(`req`)
- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- レスポンス(`res`)
- Waterline (ORM)
- WebSockets
リファレンス
愛情込めて作成
Sails フレームワークは、テキサス州オースティンにあるWeb & モバイル開発会社が、コントリビューターの協力を得て構築しました。Node.js プロジェクトを支援するために、2012年にSailsを作成しました。当然のことながら、オープンソース化しました。皆様の生活が少しでも楽になることを願っています！
© 2012-2024 The Sails Company。
Sails フレームワークは、MIT ライセンスに基づいて無料でオープンソースです。
イラスト提供：Edamame。