Tải tệp xuống bằng Cloud Storage trên các nền tảng của Apple

Cloud Storage for Firebase cho phép bạn nhanh chóng và dễ dàng tải tệp xuống từ một vùng lưu trữ Cloud Storage do Firebase cung cấp và quản lý.

Lưu ý: Theo mặc định, một vùng chứa Cloud Storage for Firebase yêu cầu Firebase Authentication để thực hiện mọi thao tác trên dữ liệu hoặc tệp của vùng chứa. Bạn có thể thay đổi Firebase Security Rules cho Cloud Storage thành cho phép truy cập chưa xác thực trong một số trường hợp cụ thể. Tuy nhiên, trong hầu hết các trường hợp, bạn nên hạn chế quyền truy cập và thiết lập các quy tắc bảo mật mạnh mẽ (đặc biệt là đối với các ứng dụng phát hành công khai). Xin lưu ý rằng nếu bạn sử dụng Google App Engine và có một vùng chứa Cloud Storage mặc định có định dạng tên là *.appspot.com, thì bạn có thể cần cân nhắc mức độ ảnh hưởng của các quy tắc bảo mật đến quyền truy cập vào các tệp App Engine.

Tạo tệp đối chiếu

Để tải một tệp xuống, trước tiên, hãy tạo một tham chiếu Cloud Storage cho tệp mà bạn muốn tải xuống.

Bạn có thể tạo một tham chiếu bằng cách nối các đường dẫn con vào gốc của vùng chứa Cloud Storage hoặc bạn có thể tạo một tham chiếu từ URL gs:// hoặc https:// hiện có tham chiếu đến một đối tượng trong Cloud Storage.

Swift

// Create a reference with an initial file path and name
let pathReference = storage.reference(withPath: "images/stars.jpg")

// Create a reference from a Google Cloud Storage URI
let gsReference = storage.reference(forURL: "gs://<your-firebase-storage-bucket>/images/stars.jpg")

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
let httpsReference = storage.reference(forURL: "https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg")

Objective-C

// Create a reference with an initial file path and name
FIRStorageReference *pathReference = [storage referenceWithPath:@"images/stars.jpg"];

// Create a reference from a Google Cloud Storage URI
FIRStorageReference *gsReference = [storage referenceForURL:@"gs://<your-firebase-storage-bucket>/images/stars.jpg"];

// Create a reference from an HTTPS URL
// Note that in the URL, characters are URL escaped!
FIRStorageReference *httpsReference = [storage referenceForURL:@"https://firebasestorage.googleapis.com/b/bucket/o/images%20stars.jpg"];
  

Tải tệp xuống

Sau khi có tệp đối chiếu, bạn có thể tải tệp xuống từ Cloud Storage theo 3 cách:

1. Tải xuống NSData trong bộ nhớ
2. Tải xuống một NSURL đại diện cho một tệp trên thiết bị
3. Tạo một NSURL đại diện cho tệp trên mạng

Tải xuống trong bộ nhớ

Tải tệp xuống đối tượng NSData trong bộ nhớ bằng phương thức dataWithMaxSize:completion:. Đây là cách dễ nhất để tải nhanh một tệp xuống, nhưng cách này phải tải toàn bộ nội dung của tệp vào bộ nhớ. Nếu bạn yêu cầu một tệp lớn hơn bộ nhớ có sẵn của ứng dụng, thì ứng dụng sẽ gặp sự cố. Để tránh các vấn đề về bộ nhớ, hãy nhớ đặt kích thước tối đa thành một giá trị mà bạn biết ứng dụng của mình có thể xử lý hoặc sử dụng một phương thức tải xuống khác.

Swift

// Create a reference to the file you want to download
let islandRef = storageRef.child("images/island.jpg")

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
islandRef.getData(maxSize: 1 * 1024 * 1024) { data, error in
  if let error = error {
    // Uh-oh, an error occurred!
  } else {
    // Data for "images/island.jpg" is returned
    let image = UIImage(data: data!)
  }
}
    

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"];

// Download in memory with a maximum allowed size of 1MB (1 * 1024 * 1024 bytes)
[islandRef dataWithMaxSize:1 * 1024 * 1024 completion:^(NSData *data, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Data for "images/island.jpg" is returned
    UIImage *islandImage = [UIImage imageWithData:data];
  }
}];
    

Tải xuống tệp cục bộ

Phương thức writeToFile:completion: tải trực tiếp một tệp xuống thiết bị cục bộ. Sử dụng phương thức này nếu người dùng muốn truy cập vào tệp khi không có mạng hoặc chia sẻ trong một ứng dụng khác. writeToFile:completion: sẽ trả về một FIRStorageDownloadTask mà bạn có thể dùng để quản lý quá trình tải xuống và theo dõi trạng thái tải lên.

Swift

// Create a reference to the file you want to download
let islandRef = storageRef.child("images/island.jpg")

// Create local filesystem URL
let localURL = URL(string: "path/to/image")!

// Download to the local filesystem
let downloadTask = islandRef.write(toFile: localURL) { url, error in
  if let error = error {
    // Uh-oh, an error occurred!
  } else {
    // Local file URL for "images/island.jpg" is returned
  }
}
    

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *islandRef = [storageRef child:@"images/island.jpg"];

// Create local filesystem URL
NSURL *localURL = [NSURL URLWithString:@"path/to/image"];

// Download to the local filesystem
FIRStorageDownloadTask *downloadTask = [islandRef writeToFile:localURL completion:^(NSURL *URL, NSError *error){
  if (error != nil) {
    // Uh-oh, an error occurred!
  } else {
    // Local file URL for "images/island.jpg" is returned
  }
}];
    

Nếu muốn chủ động quản lý quá trình tải xuống, bạn có thể sử dụng phương thức writeToFile: và quan sát tác vụ tải xuống thay vì sử dụng trình xử lý hoàn tất. Hãy xem phần Quản lý nội dung tải xuống để biết thêm thông tin.

Tạo URL tải xuống

Nếu đã có cơ sở hạ tầng tải xuống dựa trên URL hoặc chỉ muốn chia sẻ một URL, bạn có thể nhận URL tải xuống cho một tệp bằng cách gọi phương thức downloadURLWithCompletion: trên một tham chiếu Cloud Storage.

Swift

// Create a reference to the file you want to download
let starsRef = storageRef.child("images/stars.jpg")

// Fetch the download URL
starsRef.downloadURL { url, error in
  if let error = error {
    // Handle any errors
  } else {
    // Get the download URL for 'images/stars.jpg'
  }
}
    

Objective-C

// Create a reference to the file you want to download
FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"];

// Fetch the download URL
[starsRef downloadURLWithCompletion:^(NSURL *URL, NSError *error){
  if (error != nil) {
    // Handle any errors
  } else {
    // Get the download URL for 'images/stars.jpg'
  }
}];
    

Tải hình ảnh xuống bằng FirebaseUI

FirebaseUI cung cấp các liên kết gốc đơn giản, có thể tuỳ chỉnh và sẵn sàng cho sản xuất trên thiết bị di động để loại bỏ mã lặp lại và thúc đẩy các phương pháp hay nhất của Google. Khi sử dụng FirebaseUI, bạn có thể tải xuống, lưu vào bộ nhớ đệm và hiển thị hình ảnh từ Cloud Storage một cách nhanh chóng và dễ dàng bằng cách sử dụng tính năng tích hợp của chúng tôi với SDWebImage.

Trước tiên, hãy thêm FirebaseUI vào Podfile:

pod 'FirebaseStorageUI'

Sau đó, bạn có thể tải hình ảnh trực tiếp từ Cloud Storage vào một UIImageView:

Swift

// Reference to an image file in Firebase Storage
let reference = storageRef.child("images/stars.jpg")

// UIImageView in your ViewController
let imageView: UIImageView = self.imageView

// Placeholder image
let placeholderImage = UIImage(named: "placeholder.jpg")

// Load the image using SDWebImage
imageView.sd_setImage(with: reference, placeholderImage: placeholderImage)
    

Objective-C

// Reference to an image file in Firebase Storage
FIRStorageReference *reference = [storageRef child:@"images/stars.jpg"];

// UIImageView in your ViewController
UIImageView *imageView = self.imageView;

// Placeholder image
UIImage *placeholderImage;

// Load the image using SDWebImage
[imageView sd_setImageWithStorageReference:reference placeholderImage:placeholderImage];
    

Quản lý nội dung tải xuống

Ngoài việc bắt đầu tải xuống, bạn có thể tạm dừng, tiếp tục và huỷ quá trình tải xuống bằng các phương thức pause, resume và cancel. Các phương thức này sẽ tạo ra các sự kiện pause, resume và cancel mà bạn có thể quan sát.

Swift

// Start downloading a file
let downloadTask = storageRef.child("images/mountains.jpg").write(toFile: localFile)

// Pause the download
downloadTask.pause()

// Resume the download
downloadTask.resume()

// Cancel the download
downloadTask.cancel()
    

Objective-C

// Start downloading a file
FIRStorageDownloadTask *downloadTask = [[storageRef child:@"images/mountains.jpg"] writeToFile:localFile];

// Pause the download
[downloadTask pause];

// Resume the download
[downloadTask resume];

// Cancel the download
[downloadTask cancel];
    

Theo dõi tiến trình tải xuống

Bạn có thể đính kèm các đối tượng theo dõi vào FIRStorageDownloadTask để theo dõi tiến trình tải xuống. Việc thêm một đối tượng tiếp nhận dữ liệu sẽ trả về một FIRStorageHandle mà bạn có thể dùng để xoá đối tượng tiếp nhận dữ liệu.

Swift

// Add a progress observer to a download task
let observer = downloadTask.observe(.progress) { snapshot in
  // A progress event occurred
}
    

Objective-C

// Add a progress observer to a download task
NSString *observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress
                                         handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];
    

Bạn có thể đăng ký những đối tượng theo dõi này cho một sự kiện FIRStorageTaskStatus:

Sự kiện `FIRStorageTaskStatus`	Cách sử dụng thông thường
FIRStorageTaskStatusResume	Sự kiện này kích hoạt khi tác vụ bắt đầu hoặc tiếp tục tải xuống và thường được dùng kết hợp với sự kiện FIRStorageTaskStatusPause.
FIRStorageTaskStatusProgress	Sự kiện này sẽ kích hoạt bất cứ khi nào dữ liệu được tải xuống từ Cloud Storage và có thể dùng để điền thông tin vào chỉ báo tiến trình tải xuống.
FIRStorageTaskStatusPause	Sự kiện này sẽ kích hoạt bất cứ khi nào quá trình tải xuống bị tạm dừng và thường được dùng kết hợp với sự kiện FIRStorageTaskStatusResume.
FIRStorageTaskStatusSuccess	Sự kiện này sẽ kích hoạt khi quá trình tải xuống hoàn tất thành công.
FIRStorageTaskStatusFailure	Sự kiện này kích hoạt khi quá trình tải xuống không thành công. Kiểm tra lỗi để xác định lý do thất bại.

Khi một sự kiện xảy ra, một đối tượng FIRStorageTaskSnapshot sẽ được truyền trở lại. Ảnh chụp nhanh này là một chế độ xem bất biến của việc cần làm, tại thời điểm xảy ra sự kiện. Đối tượng này chứa các thuộc tính sau:

Tài sản	Loại	Mô tả
progress	NSProgress	Một đối tượng NSProgress chứa tiến trình tải xuống.
error	NSError	Lỗi xảy ra trong quá trình tải xuống (nếu có).
metadata	FIRStorageMetadata	nil đối với lượt tải xuống.
task	FIRStorageDownloadTask	Đây là ảnh chụp nhanh của tác vụ, có thể dùng để quản lý (pause, resume, cancel) tác vụ.
reference	FIRStorageReference	Nguồn tham chiếu của việc cần làm này.

Bạn cũng có thể xoá từng đối tượng tiếp nhận dữ liệu, theo trạng thái hoặc xoá tất cả.

Swift

// Create a task listener handle
let observer = downloadTask.observe(.progress) { snapshot in
// A progress event occurred
}

// Remove an individual observer
downloadTask.removeObserver(withHandle: observer)

// Remove all observers of a particular status
downloadTask.removeAllObservers(for: .progress)

// Remove all observers
downloadTask.removeAllObservers()
    

Objective-C

// Create a task listener handle
NSString *observer = [downloadTask observeStatus:FIRStorageTaskStatusProgress
                                         handler:^(FIRStorageTaskSnapshot *snapshot) {
  // A progress event occurred
}];

// Remove an individual observer
[downloadTask removeObserverWithHandle:observer];

// Remove all observers of a particular status
[downloadTask removeAllObserversForStatus:FIRStorageTaskStatusProgress];

// Remove all observers
[downloadTask removeAllObservers];
    

Để tránh làm rò rỉ bộ nhớ, tất cả các đối tượng theo dõi sẽ bị xoá sau khi FIRStorageTaskStatusSuccess hoặc FIRStorageTaskStatusFailure xảy ra.

Xử lý lỗi

Có một số lý do khiến lỗi có thể xảy ra khi tải xuống, bao gồm cả việc tệp không tồn tại hoặc người dùng không có quyền truy cập vào tệp mong muốn. Bạn có thể xem thêm thông tin về các lỗi trong phần Xử lý lỗi của tài liệu.

Ví dụ đầy đủ

Sau đây là ví dụ đầy đủ về cách tải xuống một tệp cục bộ có xử lý lỗi:

Swift

// Create a reference to the file we want to download
let starsRef = storageRef.child("images/stars.jpg")

// Start the download (in this case writing to a file)
let downloadTask = storageRef.write(toFile: localURL)

// Observe changes in status
downloadTask.observe(.resume) { snapshot in
  // Download resumed, also fires when the download starts
}

downloadTask.observe(.pause) { snapshot in
  // Download paused
}

downloadTask.observe(.progress) { snapshot in
  // Download reported progress
  let percentComplete = 100.0 * Double(snapshot.progress!.completedUnitCount)
    / Double(snapshot.progress!.totalUnitCount)
}

downloadTask.observe(.success) { snapshot in
  // Download completed successfully
}

// Errors only occur in the "Failure" case
downloadTask.observe(.failure) { snapshot in
  guard let errorCode = (snapshot.error as? NSError)?.code else {
    return
  }
  guard let error = StorageErrorCode(rawValue: errorCode) else {
    return
  }
  switch (error) {
  case .objectNotFound:
    // File doesn't exist
    break
  case .unauthorized:
    // User doesn't have permission to access file
    break
  case .cancelled:
    // User cancelled the download
    break

  /* ... */

  case .unknown:
    // Unknown error occurred, inspect the server response
    break
  default:
    // Another error occurred. This is a good place to retry the download.
    break
  }
}
    

Objective-C

// Create a reference to the file we want to download
FIRStorageReference *starsRef = [storageRef child:@"images/stars.jpg"];

// Start the download (in this case writing to a file)
FIRStorageDownloadTask *downloadTask = [storageRef writeToFile:localURL];

// Observe changes in status
[downloadTask observeStatus:FIRStorageTaskStatusResume handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download resumed, also fires when the download starts
}];

[downloadTask observeStatus:FIRStorageTaskStatusPause handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download paused
}];

[downloadTask observeStatus:FIRStorageTaskStatusProgress handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download reported progress
  double percentComplete = 100.0 * (snapshot.progress.completedUnitCount) / (snapshot.progress.totalUnitCount);
}];

[downloadTask observeStatus:FIRStorageTaskStatusSuccess handler:^(FIRStorageTaskSnapshot *snapshot) {
  // Download completed successfully
}];

// Errors only occur in the "Failure" case
[downloadTask observeStatus:FIRStorageTaskStatusFailure handler:^(FIRStorageTaskSnapshot *snapshot) {
  if (snapshot.error != nil) {
    switch (snapshot.error.code) {
      case FIRStorageErrorCodeObjectNotFound:
        // File doesn't exist
        break;

      case FIRStorageErrorCodeUnauthorized:
        // User doesn't have permission to access file
        break;

      case FIRStorageErrorCodeCancelled:
        // User canceled the upload
        break;

      /* ... */

      case FIRStorageErrorCodeUnknown:
        // Unknown error occurred, inspect the server response
        break;
    }
  }
}];
    

Bạn cũng có thể lấy và cập nhật siêu dữ liệu cho các tệp được lưu trữ trong Cloud Storage.