LaravelでS3のファイル操作をする方法まとめ

SAGA.TXT > 学習メモ > Laravel > LaravelでS3のファイル操作をする方法まとめ

LaravelでS3のファイル操作をする方法まとめ

2019-01-30

ご縁がありまして、LaravelからS3を使う機会が多くなってきたので、今のうちにまとめておきます。

AWS側の設定(IAMやバケット作成)、Laravelと接続するまでは、以下の記事などを参考にします。

超簡単！LaravelでS3を利用する手順

S3バケットへのアクセス

Storageファサードを使って、設定済みのディスクへの操作ができます。

use Storage;

class HogeController extends Controller
{
    public function saveImg(Request $request)
    {
        $disk = Storage::disk('s3'); // config/filesystems.phpのs3を選択
    }
}

use Storage;

class HogeController extends Controller

{

public function saveImg(Request $request)

{

$disk = Storage::disk('s3'); // config/filesystems.phpのs3を選択

}

ファイルのアップロード

// ファイル保存
$disk->put(【①アップロード先パス】, 【②ファイル】, 【③ファイルパーミッション】);

1 2	// ファイル保存 $disk->put(【①アップロード先パス】, 【②ファイル】, 【③ファイルパーミッション】);

①アップロード先のパスを指定：バケットのrootディレクトリからの相対パス

②アップロード対象のファイルデータ

③ファイルパーミッション：第三引数で、ファイル視認性をpublicかprivateのどちらかで宣言できます。

// laravelサーバーのファイルをアップロードする場合
$disk->put($upload_path, file_get_contents($tmp_url), 'public');

// ブラウザからPOSTされたファイルをアップロードする場合
$disk->put($upload_path, $request->file('upfile'), 'public');

// laravelサーバーのファイルをアップロードする場合

$disk->put($upload_path, file_get_contents($tmp_url), 'public');

// ブラウザからPOSTされたファイルをアップロードする場合

$disk->put($upload_path, $request->file('upfile'), 'public');

ファイルのURL（フルパス）を取得

$disk->url(【バケットのrootディレクトリからの相対パス】);

1	$disk->url(【バケットのrootディレクトリからの相対パス】);

https://xxxx.s3.ap-northeast-1.amazonaws.com/upload_file/500.jpg

のような、URLが取得できます。

ファイルのURL（フルパス）を取得

$disk->url(【バケットのrootディレクトリからの相対パス】);

1	$disk->url(【バケットのrootディレクトリからの相対パス】);

https://xxxx.s3.ap-northeast-1.amazonaws.com/upload_file/500.jpg

のような、URLが生成されます。

フロント側へ渡し、画像などを表示する際などに使用します。

ディレクトリ内のすべてのファイルを一覧で取得する

$disk->files(【バケットのrootディレクトリからの相対パス】);

1	$disk->files(【バケットのrootディレクトリからの相対パス】);

array:6 [
  0 => "upload/0625.JPG"
  1 => "upload/0626.JPG"
  2 => "upload/3480.jpg"
  3 => "upload/3481.jpg"
  4 => "upload/5006.jpg"
  5 => "upload/5007.jpg"
]

array:6 [

0 => "upload/0625.JPG"

1 => "upload/0626.JPG"

2 => "upload/3480.jpg"

3 => "upload/3481.jpg"

4 => "upload/5006.jpg"

5 => "upload/5007.jpg"

]

のような、rootからのパスで取得されるので注意です。

全てのディレクトリを一覧で取得する場合は、以下のようにします。

$disk->directories(【バケットのrootディレクトリからの相対パス】);

1	$disk->directories(【バケットのrootディレクトリからの相対パス】);

その他のファイル操作

// ファイル削除
$disk->delete(【バケットのrootディレクトリからの相対パス】);
//　ファイルコピー
$disk->copy($old_path, $new_path);
//　ファイル移動（名前の変更）
$disk->move($old_path, $new_path);
// ファイルの視認性を変更
$disk->setVisibility($file_path, 'public');

// ファイル削除

$disk->delete(【バケットのrootディレクトリからの相対パス】);

//　ファイルコピー

$disk->copy($old_path, $new_path);

//　ファイル移動（名前の変更）

$disk->move($old_path, $new_path);

// ファイルの視認性を変更

$disk->setVisibility($file_path, 'public');

ファイルのダウンロード

ファイルダウンロードリングを作る際は、aタグにdownload属性をつけると可能ですが、href先がクロスドメインだと、ブラウザによってはdownload属性で指定したファイル名が無視されたり、場合によってはdownload属性が無効化されます。

その場合は、Larave側でダウンロード処理を記載します。

 public function downloadFile(Request $request)
 {
    $disk = Storage::disk('s3');
    // １．ファイルの名前をURIや、リクエストなどで渡す
    $file_name = $request->input('file_name')
　　　　　　　　// ２．アップロードしたいディレクトリのパス
    $s3_dir_pash = 'upload/';
　　　　　　　　// １と２をあわせて、アップロード先パスを指定
    $s3_file_pash = $s3_dir_pash.$file_name; //'upload/5007.jpg'
    // ダウンロードする際のファイル名を、Content-Dispositionで指定
    $headers = [
        'Content-Type' => 'application/pdf',
        'Content-Disposition' => 'attachment; filename="' . $file_name . '"'
    ];

     return \Response::make($disk->get($s3_file_pash), 200, $headers);
　　　　 //$disk->download($s3_file_pash, $file_name, $headers);
     //↑の書き方でも良いが、日本語のファイル名でダウロードすると、The filename fallback must only contain ASCII characters.になってしまう。
 }

public function downloadFile(Request $request)

{

$disk = Storage::disk('s3');

// １．ファイルの名前をURIや、リクエストなどで渡す

$file_name = $request->input('file_name')

　　　　　　　　// ２．アップロードしたいディレクトリのパス

$s3_dir_pash = 'upload/';

　　　　　　　　// １と２をあわせて、アップロード先パスを指定

$s3_file_pash = $s3_dir_pash.$file_name; //'upload/5007.jpg'

// ダウンロードする際のファイル名を、Content-Dispositionで指定

$headers = [

'Content-Type' => 'application/pdf',

'Content-Disposition' => 'attachment; filename="' . $file_name . '"'

];

return \Response::make($disk->get($s3_file_pash), 200, $headers);

　　　　 //$disk->download($s3_file_pash, $file_name, $headers);

//↑の書き方でも良いが、日本語のファイル名でダウロードすると、The filename fallback must only contain ASCII characters.になってしまう。

}

————————

この記事がお役に立てたら、是非シェアをお願いします^^

SAGA.TXT

LaravelでS3のファイル操作をする方法まとめ

S3バケットへのアクセス

ファイルのアップロード

ファイルのURL（フルパス）を取得

ファイルのURL（フルパス）を取得

ディレクトリ内のすべてのファイルを一覧で取得する

その他のファイル操作

ファイルのダウンロード

■さがっと

最近の投稿

アーカイブ