[Android] Room 사용법과 RecyclerView를 활용한 예제

이번 예제는 안드로이드의 가상 데이터베이스인 room을 활용해 데이터를 저장하고, 그것을 recyclerview에 보이게 하는 예제를 해보겠다.

 

room 을 사용하기 위해서는 먼저 gradle에 추가를 해줘야 한다.

 

build.gradle(app)

plugins {
    id 'kotlin-kapt'
    ...
}

android {
    ...
}

dependencies {
    implementation "androidx.room:room-runtime:2.4.2"
    kapt "androidx.room:room-compiler:2.4.2"
}

---

추가를 하고 나서, 데이터베이스에 들어갈 데이터들을 만들줘야 한다.

1. 데이터베이스 개체 클래스 생성

@Entity(tableName = "chat_table")
class ChatEntity(
    @PrimaryKey(autoGenerate = true) var uid: Long,
    @ColumnInfo(name = "sendId") var sendId: String,        // 보낸 사람의 id
    @ColumnInfo(name = "comment") var comment: String,      // 보낸 글
    @ColumnInfo(name = "sendTime") var sendTime: String     // 보낸 시간
) {
    constructor(): this(0, "", "", "00:00")
}

 

• class에 @Entity 어노테이션을 붙여 개체 클래스라는 것을 알려준다.
• @PrimaryKey는 기본 키 같은 개념으로, 무조건 있어야 한다.
• autoGenerate는 기본키 자동 생성 여부를 나타낸다.(true는 자동 생성)
• @ColumnInfo 어노테이션을 사용해서 데이터베이스에 들어갈 아이템들을 지정해준다.
• constructor 부분은 default 값을 나타낸다.

---

2. Data Access Object(DAO) 만들기

DAO는 데이터베이스의 쿼리가 있는 곳으로 데이터베이스에 접근할 수 있는 메서드들을 정의해 놓는 곳이다.(기본적인 sql 지식이 필요하다)

@Dao
interface UserDao {
    // 검색 쿼리
    @Query("SELECT * FROM user_table")
    fun getAll(): List<UserEntity>

    // 삽입 쿼리
    @Insert(onConflict = REPLACE)
    fun insert(userEntity: UserEntity)

    // 특정 데이터 삭제 쿼리
    @Query("DELETE from user_table WHERE id = :id")
    fun deleteAll(id: String)
}

 

• 먼저 interface에 @Dao 어노테이션을 붙여 Dao 클래스라는 것을 알린다.
• @Query, @Insert 어노테이션안에 sql 문법을 사용해서 데이터베이스에 접근할 수 있다.
• onConflict 부분은 중복된 기본 키 값이 존재할 경우 최근의 것으로 교체하는 기능이다.

예를 들어, 테이블 하나가 있다고 치자.

id(기본 키)	name	pw
user1	ditntlro	1234
user2	rotntldl	4321

 

id가 기본 키일때, id가 user1인 새로운 데이터가 들어왔다.

user1

orltntid

1111

 

기본 키인 id가 중복되므로 기존의 데이터인 ditntlro가 제거되고, 새로 들어온 orltntid가 들어온다.

 

결과 테이블

id	name	pw
user1	orltntid	1111
user2	rotntldl	4321

---

3. 데이터베이스 빌더 만들기

데이터베이스 빌더는 사용자가 room을 수행시키려면 있어야 하는 곳이다.

@Database(entities = [ChatEntity::class], version = 1)
abstract class ChatDbBuilder: RoomDatabase() {
    abstract fun chatDao(): ChatDao

    companion object {
        private var INSTANCE: ChatDbBuilder? = null

        fun getInstance(context: Context): ChatDbBuilder? {
            if (INSTANCE == null) {
                synchronized(ChatDbBuilder::class.java) {
                    INSTANCE = Room.databaseBuilder(context.applicationContext,
                        ChatDbBuilder::class.java, "chat_table")
                        .fallbackToDestructiveMigration()
                        .build()
                }
            }
            return INSTANCE
        }
    }
}

 

• @Database 어노테이션을 사용해서 그 안에 자신이 만든 entity 클래스를 달아주고, 버전도 설정해준다.
• 추상 클래스로 만들고, 추상 클래스이기 때문에 추상 메서드 chatDao를 만들었다.
• companion object 안에다가 데이터베이스 빌더를 설정해준다.

 

---

4. Recyclerview 구현

room 기능 구현이 끝났으므로, 이제는 recyclerView를 사용해야 한다.

 

recyclerview에 대해 잠고할 만한 것들

https://yunaaaas.tistory.com/43

[Android/Kotlin] RecyclerView 만들기

 

recyclerview item xml 파일

<?xml version="1.0" encoding="utf-8"?>
<androidx.cardview.widget.CardView
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:orientation="vertical"
    android:layout_margin="10dp"
    app:cardCornerRadius="10dp">

    <LinearLayout
        android:background="#FFF9C4"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="vertical">

        <LinearLayout
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:orientation="horizontal">

            <de.hdodenhof.circleimageview.CircleImageView
                android:layout_width="50dp"
                android:layout_height="50dp"
                android:layout_marginStart="10dp"
                android:layout_marginTop="10dp"
                android:layout_marginEnd="15dp"
                android:src="@drawable/ic_baseline_account_circle_24"/>

            <TextView
                android:id="@+id/recycler_view_item_id"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="username"
                android:layout_marginTop="5dp"
                android:layout_gravity="center"
                android:textSize="20sp"
                android:fontFamily="@font/sunflower_light"/>
        </LinearLayout>

        <LinearLayout
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_margin="15dp"
            android:orientation="horizontal">

            <TextView
                android:id="@+id/recycler_view_item_comment"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="comment"
                android:textSize="25sp"
                android:background="#FFF6A5"
                android:layout_marginEnd="10dp"/>

            <TextView
                android:id="@+id/recycler_view_item_time"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_gravity="center"
                android:text="time"
                android:textSize="20sp"/>

        </LinearLayout>
    </LinearLayout>

</androidx.cardview.widget.CardView>

 

RecyclerView Adapter 클래스

class ChattingRecyclerAdapter(val context: Context, var chatList: List<ChatEntity>)
    : RecyclerView.Adapter<ChattingRecyclerAdapter.ViewHolder>() {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder {
        val binding = RecyclerviewItemChatBinding.inflate(LayoutInflater.from(parent.context), parent, false)
        return ViewHolder(binding)
    }

    override fun onBindViewHolder(holder: ViewHolder, position: Int) {
        holder.bind(chatList[position])
    }

    override fun getItemCount(): Int {
        return chatList.size
    }

    @SuppressLint("NotifyDataSetChanged")
    fun setData(chat: List<ChatEntity>) {
        chatList = chat
        notifyDataSetChanged()
    }

    inner class ViewHolder(val binding: RecyclerviewItemChatBinding): RecyclerView.ViewHolder(binding.root) {
        val id = binding.recyclerViewItemId
        val comment = binding.recyclerViewItemComment
        val time = binding.recyclerViewItemTime

        fun bind(chatEntity: ChatEntity) {
            id.text = chatEntity.sendId
            comment.text = chatEntity.comment
            time.text = chatEntity.sendTime
        }
    }
}

어댑터에는 view binding을 사용해 보았다.

 

5. Activity 구현

recyclerview 구현도 마쳤으니, 이제는 액티비티 구현을 할 차례이다.

 

room, recyclerview 생성

val r = Runnable {
    try {
        chatList = chatDb.chatDao().getAll()
        adapter = ChattingRecyclerAdapter(this, chatList)
        adapter.notifyDataSetChanged()
        recyclerView = binding.chatRecyclerView
        recyclerView.adapter = adapter
        recyclerView.layoutManager = LinearLayoutManager(this)
        recyclerView.setHasFixedSize(true)
    } catch (e: Exception) {
        Log.e("ERROR", "$e")
    }
}

room과 recyclerview를 생성할 때, Thread 안에다가 만들어 주었다.

 

 

데이터를 삽입하는 코드

val addRunnable = Runnable {
    val newChat = ChatEntity()
    // TODO :: intent 값 받아오기
    newChat.sendId = intent.getStringExtra("id").toString()
    newChat.comment = binding.chatComment.text.toString()

    // 시간 구하기
    val now = System.currentTimeMillis()
    val date = Date(now)
    val dateFormat = SimpleDateFormat("MM/dd hh:ss")
    val getTime = dateFormat.format(date)

    newChat.sendTime = getTime.toString()
    chatDb.chatDao().insert(newChat)
}

val addThread = Thread(addRunnable)
addThread.start()

chatEntity안에다가 데이터들을 넣어준 후, 데이터베이스에 삽입 해준다.

 

 

전체 코드

class MainActivity : AppCompatActivity() {

    private lateinit var binding: ActivityRoomChatBinding
    private lateinit var chatList: List<ChatEntity>
    private lateinit var chatDb: ChatDbBuilder
    private lateinit var recyclerView: RecyclerView
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        binding = ActivityRoomChatBinding.inflate(layoutInflater)
        chatDb = ChatDbBuilder.getInstance(this)!!
        var adapter: ChattingRecyclerAdapter
        binding.chatUserId.text = intent.getStringExtra("id").toString()
        Log.d("TAG", "intent putExtra: ${intent.getStringExtra("image")}")

        val r = Runnable {
            try {
                chatList = chatDb.chatDao().getAll()
                adapter = ChattingRecyclerAdapter(this, chatList)
                adapter.notifyDataSetChanged()
                recyclerView = binding.chatRecyclerView
                recyclerView.adapter = adapter
                recyclerView.layoutManager = LinearLayoutManager(this)
                recyclerView.setHasFixedSize(true)
            } catch (e: Exception) {
                Log.e("ERROR", "$e")
            }
        }

        binding.imageSendComment.setOnClickListener {
            if (binding.chatComment.text.isNotEmpty()) {
                addData()
            } else {
                Toast.makeText(this, " 비었어요", Toast.LENGTH_SHORT).show()
            }
        }

        val thread = Thread(r)
        thread.start()
        setContentView(binding.root)
    }

    private fun addData() {
        val addRunnable = Runnable {
            val newChat = ChatEntity()
            // TODO :: intent 값 받아오기
            newChat.sendId = intent.getStringExtra("id").toString()
            newChat.comment = binding.chatComment.text.toString()

            // 시간 구하기
            val now = System.currentTimeMillis()
            val date = Date(now)
            val dateFormat = SimpleDateFormat("MM/dd hh:ss")
            val getTime = dateFormat.format(date)

            newChat.sendTime = getTime.toString()
            chatDb.chatDao().insert(newChat)
        }

        val addThread = Thread(addRunnable)
        addThread.start()
    }
}

 

---

💡느낀 점

• 옛날에는 어려웠던 room에 대해 새로운 내용을 알게 되었고, 더 많은 내용을 이해할수 있었다
• room을 공부하면서 sql 문법의 필요성(?) 을 느꼈다.
• 내가 알고 있는 내용을 설명하기가 생각보다 어려웠다.