[Android] Green Market 프로젝트

해당 프로젝트 GitHub Repository

https://github.com/ssarisong/Green-Market

GitHub - ssarisong/Green-Market: 2023년 한성대학교 고급모바일프로그래밍 팀 프로젝트

 

1. 주제 설명

 한성대학교 고급모바일프로그래밍 과목 기말 프로젝트입니다.

고급모바일프로그래밍 수업에서 배운 기능들을 최대한 활용하기 위해서 여러가지 기능의 총집합이라고 생각하는 중고마켓을 주제로 선정하게 되었습니다.

---

2. 개발 기간

2023.08.24 ~ 2023.12.02 (약 3개월)

---

3. 역할

팀장, 백엔드 총괄

• 설계
  • FireStore 데이터베이스 설계
  • 로그인 과정 설계
  • Storage에 적재될 Resource 구조 설계
• 구현
  • 로그인 기능 구현
  • 중고마켓 게시글 CRUD 구현
  • 채팅 기능 구현
• 연결
  • 개발된 Util 기능 UI에 연결

---

4. 기술 스택

• 언어: Kotlin
• 프레임워크: Android
• BaaS: Firebase
• 데이터베이스: Firestore
• 문서화: Dokka

---

5. 전체 구조

 

 

---

6. 상세 구현 내용

BaaS 서비스를 사용했기 때문에 백엔드 기능을 따로 Api로 구현하지 않았고, Util 클래스를 만들어 UI에서 사용할 기능을 함수로 표현했습니다.

Callback 함수를 주로 사용한 이유
Firebase에서 작업을 처리하고 다시 애플리케이션으로 돌아오는 과정에서 비동기 작업이 발생하기 때문에 Callback 함수로 구현했습니다.

6-1. 로그인

Firebase에서 Authentication 기능을 활성화했습니다.

로그인 방법으로는 이메일 / 비밀번호 방법을 채택했고, Firestore에도 회원정보를 저장했습니다.

Firestore에 회원정보를 저장한 이유
Authentication에는 사용자의 이메일과 비밀번호로만 저장하기 때문에 추가적인 사용자 관련 정보를 저장할 수 없었습니다.
이 때문에 Firestore 기능을 활성화하였고, 사용자 정보인 생년월일 등의 정보를 저장하고 가져올 수 있도록 개선했습니다.

 

[회원가입 구현]

fun doSignUp(userEmail: String, password: String, name: String, birth: String, callback: (Int, String?) -> Unit){
        Firebase.auth.createUserWithEmailAndPassword(userEmail, password)
            .addOnCompleteListener{additionTask ->
                if(additionTask.isSuccessful){
                    val uid = Firebase.auth.currentUser?.uid.toString()
                    val currentUser = Firebase.auth.currentUser
                    val parser = SimpleDateFormat("yyyy-MM-dd", Locale.getDefault())
                    val birthDate = Timestamp(parser.parse(birth))
                    val newUser = User(userEmail, name, birthDate, Timestamp.now())
                    userModel.insertUser(uid, newUser) { STATUS_CODE ->
                        if (STATUS_CODE == StatusCode.SUCCESS) {
                            callback(StatusCode.SUCCESS, uid)
                        } else {
                            currentUser?.delete()
                                ?.addOnCompleteListener { deletionTask ->
                                    if (deletionTask.isSuccessful) {
                                        Log.d("FirebaseLoginUtils", "[${uid}] 계정 DB 정보 추가 실패로 인한 Auth 계정 삭제 성공")
                                    } else {
                                        Log.w("FirebaseLoginUtils", "[${uid}] 계정 DB 정보 추가 실패로 인한 Auth 계정 삭제 실패!!! -> ", deletionTask.exception)
                                    }
                                }
                            callback(StatusCode.FAILURE, null)
                        }
                    }
                }else{
                    Log.w("FirebaseLoginUtils", "Auth에서 사용자 생성 중 에러 발생!!! -> ", additionTask.exception)
                    callback(StatusCode.FAILURE, null)
                }
            }
    }

 

[회원정보 Firebase에 저장]

fun insertUser(uid: String, user: User, callback: (Int) -> Unit) {
        db.collection("User").document(uid).set(user)
            .addOnSuccessListener {
                Log.d("FirestoreUserModel", "[${uid}]:사용자명[${user.name}]:사용자이메일[(${user.email})] 사용자 DB 정보 성공적으로 생성")
                callback(StatusCode.SUCCESS)
            }
            .addOnFailureListener { e ->
                Log.w("FirestoreUserModel", "[${uid}] 사용자 DB 정보 생성 중 에러 발생!!! -> ", e)
                callback(StatusCode.FAILURE)
            }
    }

6-2. 중고마켓 게시글

중고마켓 게시글은 Firestore를 통해 CRUD 기능을 구현했습니다.

중고물품 이미지가 첨부 가능해야 했기 때문에, Firebase에 Storage 기능을 활성화했습니다.

이미지 업로드 관련 예외처리 방식
이미지를 업로드 하거나 가져오는 과정에서 여러 이유로 예외 사항이 발생할 일이 많았습니다.
이를 해결하기 위해 addOnFailureListener{}를 활용하여 예외 사항을 로그로 전달하고, StatusCode를 만들어서 http의 상태코드처럼 작동하도록 하여 Callback으로 return 했습니다.
이 방식을 사용하여 기능 중 예외 사항이 발생했을 때, 어떤 이유의 에러인지 파악하기 쉬웠습니다.

 

[이미지 업로드 과정 - 중고물품 추가 과정 중]

...
	imageRef.putFile(Uri.parse(product.img))
            .addOnSuccessListener {
                imageRef.downloadUrl.addOnSuccessListener { uri ->
                    val updatedProduct =
                        product.copy(productId = newProduct.id, img = uri.toString())

                    newProduct.set(updatedProduct).addOnSuccessListener {
                        Log.d(
                            "FirestoreProductModel",
                            "([${newProduct.id}]:상품명[${product.name}] 상품 DB 성공적으로 생성"
                        )
                        callback(StatusCode.SUCCESS, newProduct.id)
                    }.addOnFailureListener { e ->
                        Log.w("FirestoreProductModel", "[${newProduct.id}]:상품명[${product.name}] 상품 DB 정보 생성 중 에러 발생!!! -> ", e)
                        callback(StatusCode.FAILURE, null)
                    }
                }.addOnFailureListener { e ->
                    Log.w("FirestoreProductModel", "[${newProduct.id}]:상품명[${product.name}] 상품 이미지 다운로드 URL 받기 실패!!! -> ", e)
                    callback(StatusCode.FAILURE, null)
                }
            }
            .addOnFailureListener { e ->
                Log.w("FirestoreProductModel", "[${newProduct.id}]:상품명[${product.name}]상품 이미지 저장 중 에러 발생!!! -> ", e)
                callback(StatusCode.FAILURE, null)
            }
 ...

 

[ 이미지 삭제 과정 - 중고물품 삭제 과정 중 ]

...
    val imageRef = FirebaseStorage.getInstance().reference.child("Product/${pid}")
        imageRef.metadata
            .addOnSuccessListener {
                imageRef.delete()
                    .addOnSuccessListener {
                        db.collection("Product").document(pid).delete()
                            .addOnSuccessListener {
                                Log.d("FirestoreProductModel", "[${pid}] 상품 DB 정보 성공적으로 삭제")
                                callback(StatusCode.SUCCESS)
                            }
                            .addOnFailureListener { e ->
                                Log.w("FirestoreProductModel", "[${pid}] 상품 DB 정보 삭제 중 에러 발생!!! -> ", e)
                                callback(StatusCode.FAILURE)
                            }
                    } .addOnFailureListener { e ->
                        Log.w("FirestoreProductModel", "[${pid}] 상품 이미지 Storage에서 삭제 중 에러 발생!!! -> ", e)
                        callback(StatusCode.FAILURE)
                    }
            }
            .addOnFailureListener {
                db.collection("Product").document(pid).delete()
                    .addOnSuccessListener {
                        Log.d("FirestoreProductModel", "[${pid}] 상품 DB 정보 성공적으로 삭제")
                        callback(StatusCode.SUCCESS)
                    }
                    .addOnFailureListener { e ->
                        Log.w("FirestoreProductModel", "[${pid}] 상품 DB 정보 삭제 중 에러 발생!!! -> ", e)
                        callback(StatusCode.FAILURE)
                    }
            }
...

 

6-3. 채팅

채팅은 Firestore Database에 의해 관리되도록 했습니다.

NoSQL인 Firestore의 특성을 활용하여 아래와 같이 ChatRoom이란 컬렉션을 만들고 그 안에서 쌓이는 모든 채팅 메시지들을 Chat이란 하위 컬렉션으로 구성했습니다.

 

[채팅 DB 구성 예시]

ChatRoom [
	{
        chatRoomId : "3pjzurfyPFkyebOVX6mf"
        productId : "zmaQgjjQLZ5W05ZAjwXf"
        buyerId : "vwyi7dnkKCaH5adeXPk1NrsEdue2"
        sellerId : "kcjEOOK3VtOk0rTpnks8QTPxLbJ2"
        lastMessage : "아직 있습니다!"
        lastMessageAt : 2023년 12월 1일 오후 7시 33분 59초 UTC+9
        createdAt : 2023년 12월 1일 오후 7시 33분 36초 UTC+9
        Chat : [
        	{
            	senderId : "vwyi7dnkKCaH5adeXPk1NrsEdue2"
                message : "팔렸을까요?"
                createdAt : 2023년 12월 1일 오후 7시 33분 36초 UTC+9
            }, 
            {
            	senderId : "kcjEOOK3VtOk0rTpnks8QTPxLbJ2"
                message : "아직 있습니다!"
                createdAt : 2023년 12월 1일 오후 7시 33분 59초 UTC+9
            }, 
            ...
        ]
    }, 
    ...
]

 

채팅에서 메시지는 상대방이 보내는 즉시 확인이 가능해야 했습니다.

이를 위해 Listener 메서드를 구현하였고, 이를 통해 메시지를 실시간으로 감지하여 두 사용자가 바로바로 메시지를 주고받을 수 있도록 했습니다.

또한, addSnapshotListener{} 기능을 활용하였는데, 이는 query가 감지하는 데이터를 실시간으로 가져오고 변경이 발생할 때마다 콜백을 실행합니다.

 

[채팅방 내에서 메지지 감지 Listener]

/**
 * 특정 채팅방의 메시지를 실시간으로 감지합니다.
 *
 * @param chatRoomId 감지할 채팅방의 ID.
 * @param callback 새 메시지 또는 오류 발생 시 상태 코드(StatusCode)와 메시지 내용을 인자로 받는 콜백 함수입니다.
 * @return 리스너 등록을 해제하는 함수.
 */
fun listenForMessages(chatRoomId: String, callback: (Int, List<Chat>?) -> Unit): () -> Unit {
    val chatMessagesRef = db.collection("ChatRoom").document(chatRoomId).collection("Chat")
    val query = chatMessagesRef.orderBy("createdAt", Query.Direction.ASCENDING)

    val registration = query.addSnapshotListener { snapshots, e ->
        if (e != null) {
            Log.w("FirestoreChattingModel", "[$chatRoomId] 메시지 실시간 감지 실패!!! -> ", e)
            callback(StatusCode.FAILURE, null)
            return@addSnapshotListener
        }
        if (snapshots != null && !snapshots.isEmpty) {
            val messages = snapshots.mapNotNull { it.toObject(Chat::class.java) }
            Log.d("firestoreChattingModel", "[$chatRoomId] 채팅방의 채팅 목록 불러오기 완료")
            callback(StatusCode.SUCCESS, messages)
        } else {
            Log.d("FirestoreChattingModel", "[$chatRoomId] 메시지가 아직 없음")
            callback(StatusCode.SUCCESS, emptyList())
        }
    }
    return { registration.remove() }
}

 

또한, 채팅방 밖에 사용자가 위치할 경우에 새로운 채팅이 발생하면 마지막 채팅 내용을 확인할 수 있어야 하기 때문에 마지막 채팅 메시지를 실시간으로 감지하는 Listener도 구현했습니다.

 

[채팅방 외에서 메시지 감지 Listener]

/**
 * Firestore의 특정 채팅방에 대한 lastMessage 변경을 실시간으로 감지합니다.
 *
 * @param chatRoomId 실시간으로 감지할 채팅방의 ID입니다.
 * @param callback lastMessage 정보를 반환하는 콜백 함수입니다.
 */
fun listenForLastMessage(chatRoomId: String, callback: (Int, String?, Timestamp?) -> Unit) {
    db.collection("ChatRoom").document(chatRoomId)
        .addSnapshotListener { snapshot, e ->
            if (e != null) {
                Log.w("FirestoreChatModel", "[${chatRoomId}]채팅방 lastMessage 리스너 오류 발생!!! -> ", e)
                return@addSnapshotListener
            }
            if (snapshot != null && snapshot.exists()) {
                Log.d("FirestoreChatModel", "[${chatRoomId}] 채팅방의 마지막 메시지와 보낸 시간 실시간 불러오기 완료")
                callback(StatusCode.SUCCESS, snapshot.getString("lastMessage"), snapshot.getTimestamp("lastMessageAt"))
            } else {
                Log.d("FirestoreChatModel", "[${chatRoomId}] 채팅방의 lastMessage 데이터 없음")
                callback(StatusCode.FAILURE, null, null)
            }
        }
}

---

7. 실행 시나리오

7-1. 회원가입, 로그인

• 회원가입: 이메일, 비밀번호, 이름, 생년월일 모두 입력해야합니다.
• 로그인: 회원가입 후, 이메일과 비밀번호를 입력해야합니다.

7-2. 홈 화면

• 등록되어 있는 중고물품 게시글을 확인할 수 있습니다.

7-3. 중고물품 검색 필터

• 판매중, 예약중, 판매 완료별로 등록되어 있는 중고물품 게시글을 확인할 수 있습니다.

7-4. 중고물품 상세 페이지

• 각각의 중고물품마다 상태 현황을 볼 수 있고, '채팅하기' 버튼을 통해 판매자와 채팅이 가능합니다.

7-5. 중고물품 게시글 등록

• '상품등록' 버튼을 누르면 중고물품 게시글을 등록할 수 있는 화면이 나옵니다.
• 제목, 가격, 상품 설명을 쓰고 사진을 첨부한 후에 게시글을 올릴 수 있습니다.

7-6. 중고물품 게시글 수정

• 중고물품 정보와 판매 상태 수정이 가능합니다.

7-7. 채팅

7-8. 마이페이지

• '내가 쓴 글'에서 사용자가 작성한 글을 확인할 수 있으며, 해당 페이지에서 게시글 수정이 가능합니다.
• 로그아웃 하면 로그인 페이지로 이동합니다.