[Swift] Cloud Firestore(2) 실습해보기

지난 포스팅에서는 간단하게 Cloud Firestore에 데이터가 어떻게 저장되는지 전체적인 구조를 살펴보았는데요~!!

데이터 구조를 잘 모르면 먼저 구조부터 확실하게 알고 실습을 시작하는게 좋습니다 👍👍

👉 2021/02/08 - [iOS [Swift]/기초를 탄탄히!] - [Swift] Cloud Firestore(1) 데이터 구조

 

이번에는 실제로 XCode에서 어떻게 Firestore를 통해 CURD를 할 수 있는지 실습해볼거에요.

---

먼저 실습을 위해서, Firestore를 비어있게 준비하고, Console을 바로바로 확인할 수 있도록 띄워줍시다!

 

Database 참조

본격 CRUD 실습에 앞서, 우리가 Cloud의 Firestore이 어디있는지 위치정보를 알아야 CRUD를 진행하겠죠~?

아래 코드로 실제로 Firestore 상에 우리의 DB위치를 참조할 수 있어요.

let db = Firestore.firestore()

 

데이터 저장 (Create)

데이터를 저장할때는 이전 포스팅에서 정리했던 것처럼 Collection에 Document를 만들고, Document에 Data를 저장하면 되겠죠? Documenet를 만들때는 명시적으로 Document 이름을 지정할 수도 있고, 자동으로 이름을 지어주는 Auto Generated 방법이 있어요. 먼저 명시적으로 "users"라는 collection에 "userid123"이라는 document를 만들고, 그안에 데이터를 넣어볼게요.

db.collection("users").document("userid123").setData(["firstname":"Tom", "lastname":"Bee", "age":26])

오오~~👍👍 예상했던 대로 Firebase Console에서 데이터가 만들어진게 보이네요. 역시 눈에 바로바로 보여야 쉽게 이해가 되고 흥미가 생기는 것 같아요 ㅎㅎ 여기서 자동으로 콘솔이 갱신이 안되면 새로고침을 해주세요 ~~

 

다음으로, 자동으로 Document 이름을 지어주는 방법으로 하나 생성해볼게요.

db.collection("users").addDocument(data: ["firstname":"Jay", "lastname":"Koo", "age":35])
// db.collection("users").document().setData(["firstname":"Jay", "lastname":"Koo", "age":35])

이렇게 addDocument Method를 바로 사용해줄 수도 있고, document() 이렇게 이름을 비워두면 자동으로 이름을 지어준답니다. 바로바로 잘 반영이 되었는지 확인해줍니다~~ 🤟

조금만 응용해보면, 이렇게 특정 변수에 document를 할당하고 사용할 수도 있겠네요. 데이터를 넣기도 하고, 업데이트도 하고, 그러고 싶을 수도 있잖아요~~ ㅋㅋ 그리고 살짝만 자세히 보면, "id"라는 필드를 documentID로 지정해줬어요. 이렇게 id를 사용해서 값을 정해놓으면, 다른 collection이나 document에서 참조할때 쓰일 수도 있어요. (마치 foreign key 같이요)

let myNewDoc = db.collection("users").document() // create new doc
myNewDoc.setData(["firstname":"John", "lastname":"Qoo", "age":30, "id": myNewDoc.documentID])

살짝 느낌 오시나요~? 예를 들어서 위와 같이 id를 documentId를 사용해서 지정해주고, 아래 코드를 같이 실행하면

db.collection("allergies").document(myNewDoc.documentID).setData(["allergies":"peanuts"])

John에 대한 데이터가 users 컬렉션에 생기고, allergies 컬렉션을 만들면서 하위의 document 이름을 동일하게 맞춰 줄 수 있어요. 이렇게 구성해놓으면, John은 땅콩 알레르기가 있다고 쉽게 찾아갈 방법이 생기겠죠~?ㅎㅎ

 

 

데이터 업데이트 (Update)

이번에는 데이터를 업데이트를 해봅시다. 예를 들어서 위에서 만든 데이터에 userid123의 firstname을 Mike로 바꾸고 싶어요.

db.collection("users").document("userid123").setData(["firstname":"Mike"])

헉.. firstname만 새로 지정해주면 업데이트 될 줄 알았는데 낭패를 봤어요. 원래 만들었던 lastname, age는 온데간데 없고.. ㅠㅠ 이렇게 setData를 그냥 사용해버리면 Overwrite(덮어쓰기) 해버리기 때문에 사용할때 위험하니 조심해야되요. 😁

그럼 정말로 업데이트는 어떻게 할까요~?

db.collection("users").document("userid123").setData(["lastname":"Chang", "firstname":"Marly", "age":26], merge: true)

이렇게 setData를 사용하면 merge라는 파라미터를 추가로 사용할 수 있어요. 말 그대로 Merge하면서 Overwrite 하겠다는 거에요! 원래 있던 필드값은 업데이트 해주고, 원래 없던 필드값은 새로 만들어줍니다.

업데이트가 잘 되었고, 새로운 필드도 잘 생겼네요 ~~!! 👍👍 그래도 setData를 사용하는건.. 언제까지나 매우 위험한 요소를 늘 가지고 있다는거에요. 혹시라도 실수로 merge 파라미터를 빠뜨렸다고 생각하면.. 끄악! 이전에 저장되있던 데이터가 모두 Overwrite될거에요 😭

사실은 setData를 사용해서 업데이트 하는 방법도 있어요~ 하고 정리한거구요~!!ㅋㅋ

 

실제로는 updateData Method를 사용하면 됩니다. 😄  편 - 안..

물론, 있는 필드는 업데이트 해주면서 새로운 필드에 대한 데이터는 신규로 생성해준답니다~~

db.collection("users").document("userid123").updateData(["firstname":"sarah", "hair":"black"])

 

 

데이터 삭제 (Delete)

이번에는 데이터를 한번 삭제해볼게요! 먼저 document를 통째로 삭제하고 싶어요. 이 사람이 회원탈퇴를 해버렸어요..😭

그럴때는 이렇게 documentId를 가지고 delete해버리면 되요! 간단하쥬~~?

db.collection("users").document("SepScv75QCfhd1rpaEeA").delete()

실제로 sep~~어쩌구 하는 document가 삭제되었어요. 음.. 좋아! document는 삭제할 수 있겠어. 근데 나는 회원정보중에 필드 하나만 삭제하고 싶은데 어떻게 하지.. 라고 생각이 드셨다면 정상입니다!! 필드 하나만 삭제하기 위해서는 updateData Method를 사용해줘야 하는데요, 이렇게 실제 value값을 FieldValue.delete()로 넣어주면 된답니다! hair 필드값 하나만 삭제완료!👍

db.collection("users").document("userid123").updateData(["hair":FieldValue.delete()])

 

 

Error Handling (에러 핸들링)

데이터 조회하기에 앞서, 우리가 데이터를 저장/업데이트/삭제를 하는데 호옥~~시나 실패할 수도 있잖아요~~?

그럴때 에러를 핸들링하라고 따로 completion Handler를 제공해주고 있어요. 예를 들어서 위에서 데이터 저장시 사용했던 addDocument 메소드도 핸들러를 제공해요.

db.collection("users").addDocument(data: [:]) { error in
            // this code is run after the operation is complete
            if error == nil {
                // operation success
            } else {
                // error, do something
            }
        }

물론 setData, update, delete 모두 같은 방식으로 Completion Handler를 제공해준답니다.

db.collection("users").document("userid123").setData([:], merge: true) { (error) in
            // this code is run after the operation is complete
            if error == nil {
                // operation success
            } else {
                // error, do something
            }
        }

 

 

데이터 조회 (Read)

firestore database 에서 데이터를 읽는것은 push방식과 pull방식이 있어요. pull방식은 일반적으로 우리가 db에 뭔가 데이터를 요청해서 받는거고 push방식은 데이터 변동이 있으면 db에서 알아서 데이터를 보내주는 방식이에요.

 

먼저 pull 방식은 어떻게 사용하는지 알아볼거에요. 데이터를 요청할때 getDocument Method를 사용하면 되는데요~!

 

특정 document 를 조회하기 (pull)

이렇게 자동완성기능에서 설명을 보면, 특정 document를 요청하는 경우 리턴받는 데이터 타입이 FIRDocumentSnapshotBlock 이네요! 여기서 이 타입에 한번 주목해볼게요. 이 데이터 타입은 DocumentSnapshot(실제 추출한 데이터)와, Error(에러)로 구성되요. 의미 그대로 DocumentSnapshot은 document 하나를 의미하는거에요.👍

 

예를 들면 이렇게 userid123에 대한 document를 요청하고, 리턴받은 데이터(snapshot)을 보면 우리가 저장했던 userid123에 대한 data가 제대로 내려왔음을 확인할 수 있어요!

db.collection("users").document("userid123").getDocument { (snapshot, error) in
            if error == nil && snapshot != nil && snapshot!.data() != nil {
                print(snapshot!.data())
            }
        }

 

collection안에있는 모든 document들을 조회하기 (pull)

이번에는 특정 document가 아니라, 존재하는 모든 document를 조회해볼거에요. 동일하게 getDocuments를 호출하는데 이번에는 collection에서 바로 getDocuments를 호출해주면 됩니다. 이번에도 자동완성 기능에서 한번 설명을 볼까요?

오! 이번에는 아까와 약~간 다르게 데이터 타입이 FIRQuerySnapshotBlock 이네요! 이 데이터 타입은 QuerySnapshot(실제 추출한 데이터), Error(에러)로 구성되요. 이번에는 Query데이터에 대한 snapshot으로, 모든 documents들을 Array형태로 가지고 있어요. snapshot.documents로 해당 array에 접근할 수 있답니다.

db.collection("users").getDocuments { (snapshot, error) in
            if error == nil && snapshot != nil {
                for document in snapshot!.documents {
                    print(document.documentID)
                }
            } else {
                // error. do something
            }
        }

실제로 firestore에 저장된 document의 ID들이 잘 출력되었네요~!!

 

잘 따라오고 계시죠? 🙏 조금은 생소할 수 있어요! 그치만 위에서 pull 방식에 대한 리턴데이터 타입만 잘 이해하셨으면 push방식은 정말 방식만 다를 뿐 완전히 동일하답니다 🤟🤟

 

특정 document 를 조회하기 (push)

위에서 했던 것과 거의 동일한데 호출하는 Method만 addSnapshotListener로 바뀌었죠??

아까는 우리가 db로 "야 이거 데이터 줘!" 라고 요청해서 받았다면, 이번에는 db에서 우리에게 "야 이거 데이터 변동있으니까 준다. 할거 있으면 알아서 처리해!" 라고 하는 방식이에요. 정말 이것만 달라요 😎

let listener = db.collection("users").document("userid123").addSnapshotListener { (snapshot, error) in
            if error == nil && snapshot != nil && snapshot!.data() != nil {
                print(snapshot!.data())
            }
        }

이렇게 코드가 있으면 userid123이라는 document 안의 데이터가 추가/업데이트/삭제 되면 저 print() 구문이 실행되는거에요. print()에 중단점을 걸고 디버깅해보면 최초에 한번(초기 db데이터 상태를 읽어오는과정) 호출이 되고, 그 다음부터는 변동이 있을때만 데이터를 보내준답니다. 한번 Console에서 뭔가 삭제/업데이트/추가를 직접 해보시길 추천드려요 👍👍

 

collection안에있는 모든 document들을 조회하기 (push)

위에서는 특정 document 내의 데이터 변화에 대해 Push를 받았다면, 이번에는 전체 collection 내에서 변동이 생기면 push를 받을 뿐, 위와 완전히 동일합니다. 😇😇

다..다만... 한가지.. 알고 있으면 좋은 점이 있어요. 똑같이 snapshot.documents로 모든 데이터를 받아와서.. Loop를 돌면서 변화된 데이터를 찾아서 뭔가 Action을 하기엔, 변화가 없는 멀쩡한 data들을 모두 Loop하기에 너무 비효율적이죠 😭

그래서 이때는 변화가 실제로 발생한 document를 가져올 수 있어요. snapshot.documentChanges를 사용해서요!

let listener = db.collection("users").addSnapshotListener { (snapshot, error) in
            if error == nil && snapshot != nil {

                // 변화가 있는것만 가져올 수 있다.
                for change in snapshot!.documentChanges {
                    print(change.document.documentID)
                }
            } else {
                // error. do something
            }
        }

 

 

Query

지금까지는..ㅎㅎ 단순히 데이터를 조회해봤는데요~! 특정조건을 추가해서 데이터를 조회하고 싶으면 어떻게 해야할까요?

SQL을 예로 들면 SELECT, FROM은 모두 됐죠~~? 그런데.. WHERE절은 어떻게 한단 말인가.. 😭

여기서도 동일하게 where절 조건을 넣는 것처럼 Query를 할 수 있답니다. 바로 whereField를 사용해서요~!

바로 예시를 보도록 할께요~~

let query = db.collection("users").whereField("age", isEqualTo: 30)
        query.getDocuments { (snapshot, error) in
            let docs = snapshot!.documents

            for doc in docs {
                print(doc.documentID)
            }
        }

users collection 안에서 age가 30인것들의 document들을 가져와라!

 

let query = db.collection("users").whereField("lastname", in: ["Harry", "chang"])
        query.getDocuments { (snapshot, error) in
            let docs = snapshot!.documents

            for doc in docs {
                print(doc.documentID)
            }
        }

users collection 안에서 lastname이 in: [ ] 배열 안에 있는 document들을 가져와라!

 

let query = db.collection("users").whereField("pets", arrayContains: "dog")
        query.getDocuments { (snapshot, error) in
            let docs = snapshot!.documents

            for doc in docs {
                print(doc.documentID)
            }
        }

users collection 안에서 pets라는 array안에 "dog"가 있는 document들을 가져와라! (arrayContains를 사용하려면 반드시 Field의 타입이 Array이어야 동작합니다!)

 

let query = db.collection("users").whereField("pets", arrayContainsAny: ["dog", "lion"]) // 이거중 아무거나 있는사람.
        query.getDocuments { (snapshot, error) in
            let docs = snapshot!.documents

            for doc in docs {
                print(doc.documentID)
            }
        }

users collection 안에서 pets라는 array안에 [ ] 안에 있는 것중 아무거나 가지고 있는 document를 가져와라! (마찬가지로 반드시 Field의 타입이 Array이어야 동작합니다!)

 

let query = db.collection("users").whereField("pets", arrayContainsAny: ["dog", "lion"]).whereField("age", isEqualTo: 30)
        query.getDocuments { (snapshot, error) in
            let docs = snapshot!.documents

            for doc in docs {
                print(doc.documentID)
            }
        }

이렇게 Query를 중첩해서 사용할 수도 있어요! users collection 안에서 pets라는 array안에 [ ] 안에 있는 것중 아무거나 가지고 있으면서 age가 30인 document들을 가져와라!

 

간단한 Query들까지 살짝 살펴보았는데요~!

firestore가 Indexing도 지원해서 빠르게 쿼리를 하고 데이터를 받아올 수 있는 장점이 있는 반면에, 약간 아쉬운 점들도 있습니다. 

• 예를 들면 "!=" 연산자를 사용할수 없다는 점
• 중첩해서 사용할때 isLessThan, isGreaterThan 등 크기비교 연산은 하나의 필드값에 대해서만 사용이 가능하다는 점
• arrayContains, arrayContainsAny는 동시에 사용할 수 없다는 점

 

대표적으로 위와 같지만 실제로는 조금 더 있어요. 

firebase.google.com/docs/firestore/query-data/queries

Cloud Firestore에서 단순 쿼리 및 복합 쿼리 실행  |  Firebase

직접 실습해보며 간단한 CRUD와 Query를 살펴보았는데요~!! 실제로는 다양한 Query 조건이 있고, 정렬, 제한사항 등등 확장해서 사용할 수 있는 기능이 정말 많답니다!! 위의 공식 가이드도 매우매우 잘 정리되어 있으니, 참고하시면 좋을 것 같습니다 🙏

 

 

간단하게 정리하고 싶었는데 생각보다 긴 포스팅이 되었네요 😎 

언젠가, 누군가에겐 꼭 도움이 되었으면 좋겠습니당 🤙🤙