Completely master the use of AWS S3 in Laravel

This article brings you relevant knowledge about using AWS S3 in Laravel. AWS S3 provides us with a place to store server files. Storing files in the cloud does not take up much space. disk space, I hope it helps everyone.

#AWS S3 provides us with a place to store server files. The benefits of doing this are:

• Backup/Redundancy - S3 and similar products have built-in backup and redundancy

• Extension- In modern servers (such as serverless or containerized environments as well as traditional load balancing environments), saving files outside the server becomes a necessity

• Disk Usage - Doesn't require much disk space when storing files in the cloud

• Features- S3 (and other clouds) have Some great features like versioning of files, lifecycle rules for deleting old files (or storing them cheaper), deletion protection and more

Now with S3 (even in a single server setup) can save you headaches in the long run. Here's what you should know!

Configuration

Configuring S3 requires the following:

• In Laravel - usually via .env, but possibly also in config/filesystem.php In

• Your AWS Account

Laravel Config

If you check your config/ filesystem.php file, you will find that there is already an S3 option. It's already set as an environment variable in the .env file!

Unless you need to customize this, you can leave it alone and just set it in the .env file:

#（可选）将默认文件系统驱动设置为 S3
FILESYSTEM_DRIVER=sqs
# 添加基于 S3 的文件驱动所需的参数
AWS_ACCESS_KEY_ID=xxxzzz
AWS_SECRET_ACCESS_KEY=xxxyyy
AWS_DEFAULT_REGION=us-east-2
AWS_BUCKET=my-awesome-bucket
AWS_USE_PATH_STYLE_ENDPOINT=false

The config/filesystem.php file contains the following options:

return [
    'disks' => [
        // 'local' 和 'public' 省略...
        's3' => [
            'driver' => 's3',
            'key' => env('AWS_ACCESS_KEY_ID'),
            'secret' => env('AWS_SECRET_ACCESS_KEY'),
            'region' => env('AWS_DEFAULT_REGION'),
            'bucket' => env('AWS_BUCKET'),
            'url' => env('AWS_URL'),
            'endpoint' => env('AWS_ENDPOINT'),
            'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
        ],
    ],
];

Some options we don't use in the .env file. For example, you can set the AWS_URL, which is useful for using other file storage clouds with S3-compatible APIs, such as CloudFlare's R2 or Digital Ocean's Spaces.

AWS Configuration

In AWS, you need to do two things:

• Create a bucket in the S3 service

• Create an IAM user to obtain the Key and Secret Key, then attach a policy to the user to allow access to the S3 API.

As with anything in AWS, creating a bucket in S3 requires looking at a lot of configuration options and wondering if you need any of them. For most use cases, you don't need to!

Go to the S3 console, create a bucket name (it must be globally unique, not just unique to your AWS account), select the region you are operating in, and leave all defaults (including marking "Block public access settings" area).

Some of these options are ones you might want to use, but you can select them later.

After creating the bucket, we need permission to perform operations on it. Let's say we create a bucket called my-awesome-bucket.

We can create an IAM user, select "Programmatic Access", but don't attach any policies or set anything else. Make sure to record the secret access keys as they will only be displayed once.

I created a video showing the process of creating a bucket and setting up IAM permissions here: www.youtube.com/watch?v=FLIp6BLtwj...

Visit## The #Access Key and Secret Access Key should be placed in your .env file.

Next, click on IAM Users and add an inline policy. Edit it using the JSON editor and add the following (from the Flysystem documentation):

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Stmt1420044805001",
            "Effect": "Allow",
            "Action": [
                "s3:ListBuckets",
                "s3:GetObject",
                "s3:GetObjectAcl",
                "s3:PutObject",
                "s3:PutObjectAcl",
                "s3:ReplicateObject",
                "s3:DeleteObject"
            ],
            "Resource": [
                "arn:aws:s3:::my-awesome-bucket",
                "arn:aws:s3:::my-awesome-bucket/*"
            ]
        }
    ]
}

This allows us to perform the required S3 API operations on our new bucket.

Laravel Usage

In Laravel, you can use file storage like this:

# 如果您将 S3 设置为默认值：
$contents = Storage::get('path/to/file.ext');
Storage::put('path/to/file.ext', 'some-content');
# 如果您没有将 S3 作为默认设置：
$contents = Storage::disk('s3')->get('path/to/file.ext');
Storage::disk('s3')->put('path/to/file.ext', 'some-content');

The path to the file (in S3) is appended to the bucket name, so A file named path/to/file.ext will exist at s3://my-awesome-bucket/path/to/file.ext`.

Technically, directories do not exist in S3. In S3, files are called "objects" and file path names are "object keys". So, in the bucket my-awesome-bucket, we just created an object with the key path/to/file.ext.

Be sure to check out the Laravel documentation for Storage to find more useful ways to use Storage, including file streams and temporary URLs.

Price

The S3 is pretty cheap – most of us will spend a few cents to a few dollars per month. This is especially true if you delete files from S3 when you're done using them, or set up lifecycle rules to delete files after a set period of time.

Pricing is (mainly) driven by 3 dimensions. Prices vary by region and use. Here's an example of actual application usage based on a given month of Chipper CI (the CI for my Laravel application), which stores a large amount of data in S3:

• Storage: $0.023 per GB, ~992GB ~= $22.82

• Number of API calls: ~7 million requests ~ = $12

• Bandwidth usage: This is very imprecise. Data transfer costs approximately $23, but this does not include EC2-based bandwidth charges.

Useful Information About S3

If your AWS setup has servers in a private network and uses a NAT gateway, be sure to create an S3 endpoint (gateway type) . This is done in the Endpoints section of the VPC service. This allows calls to/from S3 to bypass the NAT gateway, thus avoiding additional bandwidth charges. There is no additional cost to use it.

If you are concerned about files being overwritten or deleted, consider enabling versioning in your S3 bucket

Consider enabling Intelligent Tiering in your S3 bucket to help save you money on Cost of storing files that may not be interacted with again after being old

Please note that deleting large buckets (lots of files) can cost money! This is due to the large number of API calls you have to make to delete the file.

Related recommendations: Laravel video tutorial

The above is the detailed content of Completely master the use of AWS S3 in Laravel. For more information, please follow other related articles on the PHP Chinese website!