throwsが見当たらないがtryキーワードがついている

実現したいこと

前提

https://firebase.google.com/docs/firestore/solutions/swift-codable-data-mapping?hl=ja#handling_errors
firestoreのドキュメントで理解できない記述を見つけたため質問させていただきたいです。
collectionRef.addDocument(from: newColor)の前に　try　がついていますが、これはなぜ記述しなければいけないのでしょうか。そしてどこにthrowsがあるのでしょうか。

swift
1  func addColorEntry() {
2    let collectionRef = db.collection("colors")
3    do {
4      let newDocReference = try collectionRef.addDocument(from: newColor)
5      print("ColorEntry stored with new document reference: \(newDocReference)")
6    }
7    catch {
8      print(error)
9    }
10  }

こちらはfirestoreドキュメントの別のサンプルコードですが、このコードではtryをつけずにaddDocumentメソッドを呼び出していて、違いがわかりません。
do,try,catch,throwsの基本的な文法は一応理解しているつもりです。
わかりづらい文章になってしまっているかもしれませんが、ご教授いただけますと嬉しいです。よろしくお願いいたします。

swift
1// Add a new document with a generated id.
2var ref: DocumentReference? = nil
3ref = db.collection("cities").addDocument(data: [
4    "name": "Tokyo",
5    "country": "Japan"
6]) { err in
7    if let err = err {
8        print("Error adding document: \(err)")
9    } else {
10        print("Document added with ID: \(ref!.documentID)")
11    }
12}

念の為全てのコードを記載します。

swift
1class MappingColorsViewModel: ObservableObject {
2  @Published var colorEntries = [ColorEntry]()
3  @Published var newColor = ColorEntry.empty
4  @Published var errorMessage: String?
5  
6  private var db = Firestore.firestore()
7  private var listenerRegistration: ListenerRegistration?
8  
9  public func unsubscribe() {
10    if listenerRegistration != nil {
11      listenerRegistration?.remove()
12      listenerRegistration = nil
13    }
14  }
15  
16  func subscribe() {
17    if listenerRegistration == nil {
18      listenerRegistration = db.collection("colors")
19        .addSnapshotListener { [weak self] (querySnapshot, error) in
20          guard let documents = querySnapshot?.documents else {
21            self?.errorMessage = "No documents in 'colors' collection"
22            return
23          }
24          
25          self?.colorEntries = documents.compactMap { queryDocumentSnapshot in
26            let result = Result { try queryDocumentSnapshot.data(as: ColorEntry.self) }
27            
28            switch result {
29            case .success(let colorEntry):
30              if let colorEntry = colorEntry {
31                // A ColorEntry value was successfully initialized from the DocumentSnapshot.
32                self?.errorMessage = nil
33                return colorEntry
34              }
35              else {
36                // A nil value was successfully initialized from the DocumentSnapshot,
37                // or the DocumentSnapshot was nil.
38                self?.errorMessage = "Document doesn't exist."
39                return nil
40              }
41            case .failure(let error):
42              // A ColorEntry value could not be initialized from the DocumentSnapshot.
43              switch error {
44              case DecodingError.typeMismatch(_, let context):
45                self?.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
46              case DecodingError.valueNotFound(_, let context):
47                self?.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
48              case DecodingError.keyNotFound(_, let context):
49                self?.errorMessage = "\(error.localizedDescription): \(context.debugDescription)"
50              case DecodingError.dataCorrupted(let key):
51                self?.errorMessage = "\(error.localizedDescription): \(key)"
52              default:
53                self?.errorMessage = "Error decoding document: \(error.localizedDescription)"
54              }
55              return nil
56            }
57          }
58        }
59    }
60  }
61  
62  func addColorEntry() {
63    let collectionRef = db.collection("colors")
64    do {
65      let newDocReference = try collectionRef.addDocument(from: newColor)
66      print("ColorEntry stored with new document reference: \(newDocReference)")
67    }
68    catch {
69      print(error)
70    }
71  }
72}

試したこと

補足情報（FW/ツールのバージョンなど）

hoshi-takanori

2023/02/19 12:32

addDocument(data:) と addDocument(data:completion:) の違いだと思うけど、ドキュメントに throws がないのは変ですね…。 https://firebase.google.com/docs/reference/swift/firebasefirestore/api/reference/Classes/CollectionReference

grf__

2023/02/19 13:21

コメントありがとうございます。こちらの記事にもtryが使われているコードがあったのですが、Result型と関係があるのでしょうか。 https://ja.stackoverflow.com/questions/84114/swift-firestore-result%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6

grf__

2023/02/19 13:47 編集

こちらにthrowsのついたバージョン？のメソッドが記載されてました。 asyncについて勉強していないので理解できないのですが、どういった違いがあるのかご存知でしたらお伺いさせていただきたいです。 https://firebase.google.com/docs/reference/swift/firebasefirestore/api/reference/Classes/DocumentReference

hoshi-takanori

2023/02/19 14:05

async は非同期処理のことで、例えば Firebase へのアクセスはネットワークが絡むので時間がかかり、結果を関数の戻り値で返そうとすると結果が返ってくるまで待つ必要があります。で、addDocument(data:completion:) の場合はサーバーにリクエストを送信したらすぐに関数を抜けて、結果が帰ってきた時に改めて completion という引数で指定したクロージャが実行されます。が、この書き方は読みづらいので、async/await というものを使うと普通に関数の結果を受け取っているかのように書くことができます。(実際にはクロージャで書いたのと同等の処理になります。) https://qiita.com/daiki_U/items/49f12b680850f797b2fb

MasakiHori

2023/02/20 06:48

`addDocument(from:`と`addDocument(data:`は別のものです。

grf__

2023/03/03 03:11

@hoshi-takanori様ご返信が遅くなり申し訳ございません。クロージャを使った非同期処理の方法しか知らなかったため大変勉強になりました。 async/awaitを勉強してみたいと思います。

grf__

2023/03/03 03:13

＠MasakiHori様ご返信が遅くなり申し訳ございません。同一メソッドとして混同しておりました、ご回答ありがとうございました。

回答1件

ベストアンサー

collectionRef.addDocument(from: newColor)の前に　try　がついていますが、これはなぜ記述しなければいけないのでしょうか。そしてどこにthrowsがあるのでしょうか。

こちらで使用しているaddDocumentは、第一引数がfrom:指定になっています。これは、FirebaseFireStoreが提供しているメソッドではなく、FirebaseFireStoreSwiftが提供しているメソッドで、次の場所にAPIリファレンスがあります。

https://firebase.google.com/docs/reference/swift/firebasefirestoreswift/api/reference/Extensions/CollectionReference#adddocumentfrom:encoder:completion:

上記のリファレンスには throws がついており、tryで処理しなければならないことがわかると思います。

from:指定のaddDocumentメソッドはCodableに準拠した構造体を送信に使用できるメソッドで、FirebaseFireStoreSwiftは、Codableやasync/await等のSwiftの最新機能をFirebaseFireStoreで使用できるようにするための付加ライブラリです。(これを利用するためにFirebaseFireStoreSwiftのライブラリを追加インストールしているはずです。)