概要
こちら記事では、NodeJSでローカルでS3アップロードとダウンロードの基本的な方法を書かせていただきます。
内容として５つあります
1.環境
2.前提
3.初期設定
4.アップロード
5.ダウンロード
6.最後
7.参考
1.環境
- Nodejs v21.6.0
- MacOS
2.前提
- デモ用のS3 バッケットが作成済み
- ローカルに認証情報ファイル設定ずみ （まだ設定しない場合はこちらをご参考してください）
- プロフィルにせめてS3アクセス権を付与
- デモ用画像を準備
3.初期設定
作業のフォルダを作成
desktop/mkdir demo-s3-upload-download
cd demo-s3-upload-download
npm init
// いくつかの質問が出てくるが、そのままにしても大丈夫
必要なライブラリをダウンロード
-
@aws-sdk/client-s3 : S3に操作のツールが整いておく
-
dotenv： 環境変数を取るため
npm i @aws-sdk/client-s3 dotenv
AWSの認証情報を取って環境ファイルに保存
.env を作成
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_REGION=
重要な情報なので、Gitにアップロードしたら.gitignore に.env を登録するのが必須
/node_modules/
.env
AWS認証情報を取って、.env に該当する情報を入れる
メモ:[trungadmin] こちらはAWSブロフィルである。貴方のローカルには色んなブロフォルがあるかもしれません。それで、プロファイルを注意してください。
cat ~/.aws/credentials
結果は下のように
[default]
aws_access_key_id =
aws_secret_access_key =
[trungadmin]
aws_access_key_id =
aws_secret_access_key =
4.アップロード
demo-download-upload-file-s3.js という作業ファイルを作成
作業フォルダのツリー
｜
｜ーdemo-download-upload-file-s3.js
｜ーfor-demo.png
｜。。。。
// 作業ファイル
const {
S3Client,
GetObjectCommand,
PutObjectCommand,
} = require("@aws-sdk/client-s3"); // AWSのS3用ライブラリ
const fs = require("fs"); // ファイルを読み込むのため
require("dotenv").config();
// S3 バッケット名
const DEMO_BUCKET = "demo-pre-resize-image";
// 認証の設定
//こちらの仕方はベストプラクティスではない
const S3 = new S3Client({
region: process.env.AWS_REGION,
credentials: {
accessKeyId: process.env.AWS_ACCESS_KEY_ID,
secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
},
});
// ローカルのファイルを読み込んでS3にアップロードします
// *srcPath: ローカルに保存しているファイルのパス
// *fileName: S3でファイル名を決める
// *バッケット名
const uploadLocalFileToS3 = async (srcPath, fileName, bucketName) => {
//ストリームを開ける
const readStream = fs.createReadStream(srcPath);
try {
const command = new PutObjectCommand({
Bucket: bucketName,
Key: fileName,
Body: readStream,
});
await S3.send(command);
} catch (error) {
console.log(error);
} finally {
//ストリームを閉める
readStream.close();
}
};
uploadLocalFileToS3('./for-demo.png','test1.png',DEMO_BUCKET)
テストを行う
node demo-download-upload-file-s3.js
S3で結果をチェック
5.ダウンロード
引き続き書く
// S3に保存してるファイルをダウンロード
// *desPath: ローカルに保存する予定のファイルのパス
// *fileName: S3でファイル名
// *バッケット名
const downloadFileFromS3ToLocal = async (desPath, fileName, bucketName) => {
try {
const command = new GetObjectCommand({
Bucket: bucketName,
Key: fileName,
});
const response = await S3.send(command);
response.Body.pipe(fs.createWriteStream(desPath))
.on("error", (error) => {
throw error;
})
.on("close", () => {
console.log("completed");
});
} catch (error) {
console.log("error", error);
}
};
downloadFileFromS3ToLocal("./downloaded/image_s3.png", "test1.png", DEMO_BUCKET);
テストを行う
node demo-download-upload-file-s3.js
ローカルはこんな感じ
6.最後
皆さんは大体S3へファイルのアップロード・ダウンロード処理を把握できると思います。こちら処理は小さい段階の経過です。経過は例えばファイルにウィルスがあるかチェックするやファイルを圧縮するです
次は同じテーマを書くつもりです。
最後まで読んで頂いて有り難うございます。
役に立つを感じしたらハートやコメントやを残ってください
7.参考