Drive

node ace add @adonisjs/drive

import env from '#start/env'
import app from '@adonisjs/core/services/app'
import { defineConfig, services } from '@adonisjs/drive'

const driveConfig = defineConfig({
  default: env.get('DRIVE_DISK'),

  services: {
    /**
     * ローカルファイルシステムにファイルを保存します
     */
    fs: services.fs({
      location: app.makePath('storage'),
      serveFiles: true,
      routeBasePath: '/uploads',
      visibility: 'public',
    }),

    /**
     * Digital Ocean Spaces にファイルを保存します
     */
    spaces: services.s3({
      credentials: {
        accessKeyId: env.get('SPACES_KEY'),
        secretAccessKey: env.get('SPACES_SECRET'),
      },
      region: env.get('SPACES_REGION'),
      bucket: env.get('SPACES_BUCKET'),
      endpoint: env.get('SPACES_ENDPOINT'),
      visibility: 'public',
    }),
  },
})

export default driveConfig

import { cuid } from '@adonisjs/core/helpers'
import drive from '@adonisjs/drive/services/main'
import router from '@adonisjs/core/services/router'

router.put('/me', async ({ request, response }) => {
  /**
   * ステップ1: リクエストから画像を取得し、基本的なバリデーションを行います
   */
  const image = request.file('avatar', {
    size: '2mb',
    extnames: ['jpeg', 'jpg', 'png'],
  })
  if (!image) {
    return response.badRequest({ error: '画像がありません' })
  }

  /**
   * ステップ2: Drive を使用して一意の名前で画像を移動します
   */
  const key = `uploads/${cuid()}.${image.extname}`
  await image.moveToDisk(key)

  /**
   * ファイルの公開URLを返します
   */
  return {
    message: '画像がアップロードされました',
    url: await drive.use().getUrl(key),
  }
})

import drive from '@adonisjs/drive/services/main'

drive instanceof DriveManager // true

/**
 * デフォルトディスクのインスタンスを返します
 */
const disk = drive.use()

/**
 * 名前付きディスクのインスタンスを返します
 */
const disk = drive.use('r2')

/**
 * 名前付きディスクのインスタンスを返します
 */
const disk = drive.use('spaces')

await disk.put(key, value)
await disk.putStream(key, readableStream)

await disk.get(key)
await disk.getStream(key)
await disk.getArrayBuffer(key)

await disk.delete(key)
await disk.deleteAll(prefix)

await disk.copy(source, destination)
await disk.move(source, destination)

await disk.copyFromFs(source, destination)
await disk.moveFromFs(source, destination)

{
  services: {
    fs: services.fs({
      location: app.makePath('storage'),
      visibility: 'public',

      appUrl: env.get('APP_URL'),
      serveFiles: true,
      routeBasePath: '/uploads',
    }),
  }
}

<img src="{{ await driveUrl(user.avatar) }}" />

<!-- 名前付きディスクのためのURLを生成します -->
<img src="{{ await driveUrl(user.avatar, 's3') }}" />
<img src="{{ await driveUrl(user.avatar, 'r2') }}" />

<a href="{{ await driveSignedUrl(invoice.key) }}">
  請求書をダウンロード
</a>

<!-- 名前付きディスクのためのURLを生成します -->
<a href="{{ await driveSignedUrl(invoice.key, 's3') }}">
  請求書をダウンロード
</a>

<!-- 署名付きオプションを使用してURLを生成します -->
<a href="{{ await driveSignedUrl(invoice.key, {
  expiresIn: '30 mins',
}) }}">
  請求書をダウンロード
</a>

const image = request.file('image')!

const key = 'user-1-avatar.png'

/**
 * デフォルトディスクにファイルを移動します
 */
await image.moveToDisk(key)

/**
 * 名前付きディスクにファイルを移動します
 */
await image.moveToDisk(key, 's3')

/**
 * 移動操作中に追加のプロパティを定義します
 */
await image.moveToDisk(key, 's3', {
  contentType: 'image/png',
})

import { test } from '@japa/runner'
import drive from '@adonisjs/drive/services/main'
import fileGenerator from '@poppinss/file-generator'

test.group('Users | update', () => {
  test('自分のアバターを更新できること', async ({ client, cleanup }) => {
    /**
     * "spaces" ディスクをフェイクし、テストが終了したらフェイクを復元します
     */
    const fakeDisk = drive.fake('spaces')
    cleanup(() => drive.restore('spaces'))

    /**
     * ログインと更新を行うためのユーザーを作成します
     */
    const user = await UserFactory.create()

    /**
     * 1MB のサイズのフェイクなメモリ内 PNG ファイルを生成します
     */
    const { contents, mime, name } = await fileGenerator.generatePng('1mb')

    /**
     * ファイルを送信するための put リクエストを作成します
     */
    await client
      .put('me')
      .file('avatar', contents, {
        filename: name,
        contentType: mime,
      })
      .loginAs(user)

    /**
     * ファイルが存在することをアサートします
     */
    fakeDisk.assertExists(user.avatar)
  })
})