Room 개념 및 예제 [JAVA]

 안드로이드를 공부하기로 시작하기 앞서, 공부할 목록들을 정리하는 중인데 생각보다 내가 아는게 없고.. 매우 심각한 상황임을 새삼 다시 깨달아서 1주일에 1개는 공부해서 정리보려 한다. 언제까지 갈 진 모르나 1일차엔 Android Room 개념 및 코드를 정리해보았다.

 

코드는 Java로 작성했고, 깃헙 코드도 참고할 수 있다. https://github.com/leesoeun98/android-room-java 

 

Android developer 문서에서는 SQLite대신 Room을 사용할 것을 적극적으로 권장하고 있다. 

Android Room 장점

1. SQLite는 DB Scheme이 바뀔 때 자동 업데이트가 되지 않으나, Room은 자동으로 DB 업데이트를 해준다. 

2. SQLite는 Boilerplate code를 많이 사용하나, Room은 Boilerplate code없이 DB 매핑이 가능하다. (LiveData, RxJava 와 같은 Observer 패턴의 데이터를 생성, 동작하는데에 있어서) 

 

Android Room 구성

1. Entity :

  Database 내의 테이블을 자바나 코틀린으로 나타낸 것.

 

2. DAO :

  Database Access Object, insert와 delete등 DB에 접근하는데 사용되는 메서드를 포함한다. 

 

3. Database:

  Database holder를 포함하며 RoomDatabase를 확장하는 추상클래스여야 한다. 주석 내에 DB와 연결된 Entity의 목록을 포함해야 한다. 또한 런타임시 Room.databaseBuilder() 나 Room.inMemoryDatabaseBuilder() 를 호출해 DB 인스턴스를 가져올 수 있다. 

 

[Room 아키텍처 다이어그램]

 

Android Room 예제 [Java]

예제는 다음과 같이 노래리스트를 추가하는 예제이다. 비록...DB에 아무값이나 넣느라 이상해보이지만 마지막 데이터를 보면 정상적으로 잘 들어간다. 

 

Add Activity & Main Activity  

 

1. build.gradle에 Dependency 추가

  build.gradle(Module:app) 파일에 Dependency를 다음과 같이 추가한다. 

dependencies {
    def room_version ="2.3.0"
    implementation "androidx.room:room-runtime:$room_version"
    annotationProcessor "androidx.room:room-compiler:$room_version"
    ...
}

 

2. Entity 

  데이터 모델인 Entity를 만들어보자. Annotation으로 Entity를 추가해서 Music 클래스를 만든다. Music클래스에 뭐뭐 들어갈 지 정의해주면 된다. 각 Entity는 PrimaryKey가 반드시 필요한데, autoGenerate=true를 하면 키가 자동으로 생성된다. 

package com.example.sampleroom;

import androidx.room.ColumnInfo;
import androidx.room.Entity;
import androidx.room.PrimaryKey;

@Entity
public class Music {
    @PrimaryKey(autoGenerate = true)
    public int id;

    @ColumnInfo(name="title")
    public String title;

    @ColumnInfo(name="Singer")
    public String singer;

    @ColumnInfo(name="play_time")
    public long playTime;

    @ColumnInfo(name="lyrics")
    public String lyrics;
}

 

3. DAO 

  DB에 접근해 query, insert, delete등을 수행할 메소드를 포함한다. 

@Dao
public interface MusicDao {
    @Query("SELECT * FROM music")
    List<Music> getAll();

    @Query("SELECT * FROM music WHERE id IN (:musicIds)")
    List<Music> loadAllByIds(int[] musicIds);

    @Insert
    void insertAll(Music... musics);

    @Delete
    void delete(Music music);
}

4. Database

  Database는 Entity를 기반으로 하고,  Room.databaseBuilder()로 DB를 생성해 가져온다. 우선 RoomDatabase를 extends한 후 getInstance와 destroyInstance를 만든다. getInstance는 말그대로 MainActivity에서 이 메서드를 호출해 DB 객체를 반환받을 것이고, destroyInstance는 DB 객체를 삭제한다. 

  여기서 잠깐 헤맸던게, MainActivity의 onCreate는 static이기 때문에 여기서 INSTANCE와 함수 역시 static이어야만 MainActivity에서 호출할 수 있다. 

@Database(entities = {Music.class}, version = 1)
public abstract class MusicDB extends RoomDatabase {

    private static MusicDB INSTANCE = null;

    public abstract MusicDao musicDao();


    public static MusicDB getInstance(Context context) {
        if (INSTANCE == null) {
            INSTANCE = Room.databaseBuilder(context.getApplicationContext(),
                    MusicDB.class, "music.db").build();

        }
        return INSTANCE;
    }

    public static void destroyInstance() {
        INSTANCE = null;
    }

}

 

5. Activity에서 Room 접근

  이제 MainActivity에서 Room 객체를 생성해 DB에 접근해보자. 단, main thread에서 접근 할 시 에러가 발생하므로 별도의 thread에서 수행해 백드라운드로 작업해야 한다. thread의 경우 Runnable을 implement해서 run 메서드내에서 DB에 접근했다. (사실 thread도 뭔지 잘 몰라서 한참 헤매고 코드 겨우 작성한 정도인데, 추후에 thread도 다시 정리할 예정이다.) 우선은 이렇게 작성하고 7번 이후에 다시 코드 전체를 올릴 예정이다. 

 

6. RecyclerView & Adapter

  MainActivity에 RecyclerView를 추가하고, RecyclerView안에 들어갈 item xml도 만든다. (RecyclerView도....정리해서 추가할 예정)

 

[activity_main.xml]

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/mTextView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="My Music Playlist"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        />

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/mRecyclerView"
        android:layout_width="match_parent"
        android:layout_height="500dp"
        android:layout_marginLeft="20dp"
        android:layout_marginTop="10dp"
        android:layout_marginRight="20dp"
        app:layout_constraintHorizontal_bias="0.3"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/mTextView"
        app:layout_constraintBottom_toTopOf="@id/mAddButton"/>

    <Button
        android:id="@+id/mAddButton"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:backgroundTint="@color/teal_200"
        android:text="Add"
        android:layout_marginLeft="20dp"
        android:layout_marginTop="10dp"
        android:layout_marginRight="20dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/mRecyclerView"/>


</androidx.constraintlayout.widget.ConstraintLayout>

 

[item_music.xml]

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="100dp"
    android:orientation="vertical">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="1"
        android:orientation="horizontal">

        <TextView
            android:id="@+id/itemTitle"
            android:layout_width="0dp"
            android:layout_weight="1"
            android:gravity="center"
            android:layout_height="wrap_content"
            android:textColor="@android:color/holo_green_dark"
            android:textSize="18sp"
            android:textStyle="bold"
            tools:text="Title"/>

        <TextView
            android:id="@+id/itemSinger"
            android:layout_width="0dp"
            android:layout_weight="1"
            android:gravity="center"
            android:layout_height="wrap_content"
            android:textColor="@android:color/black"
            android:textSize="16sp"
            android:textStyle="normal"
            tools:text="Singer"/>

        <TextView
            android:id="@+id/itemPlayTime"
            android:layout_width="0dp"
            android:layout_weight="1"
            android:gravity="center"
            android:layout_height="wrap_content"
            android:textColor="@android:color/black"
            android:textSize="16sp"
            android:textStyle="normal"
            tools:text="PlayTime"/>

    </LinearLayout>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:layout_weight="2"
        android:orientation="horizontal">

        <TextView
            android:id="@+id/itemLyrics"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:textColor="@android:color/black"
            android:textSize="14sp"
            android:textStyle="normal"/>

    </LinearLayout>

</LinearLayout>

 

[MusicAdapter.java]

public class MusicAdapter extends RecyclerView.Adapter<MusicAdapter.ViewHolder> {

    private List<Music> musicList;

    public MusicAdapter(List<Music> list) {
        musicList = list;
    }

    @NonNull
    @Override
    public ViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        Context context = parent.getContext();
        LayoutInflater inflater = (LayoutInflater) context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);

        View view = inflater.inflate(R.layout.item_music, parent, false);
        MusicAdapter.ViewHolder vh = new MusicAdapter.ViewHolder(view);

        return vh;
    }

    @Override
    public void onBindViewHolder(@NonNull ViewHolder holder, int position) {
        Music item = musicList.get(position);
        holder.title.setText(item.title);
        holder.singer.setText(item.singer);
        holder.playTime.setText(Long.toString(item.playTime));
        holder.lyrics.setText(item.lyrics);
    }

    @Override
    public int getItemCount() {
        return musicList.size();
    }

    public class ViewHolder extends RecyclerView.ViewHolder {
        TextView title;
        TextView singer;
        TextView playTime;
        TextView lyrics;

        ViewHolder(View itemView) {
            super(itemView);

            title = itemView.findViewById(R.id.itemTitle);
            singer = itemView.findViewById(R.id.itemSinger);
            playTime=itemView.findViewById(R.id.itemPlayTime);
            lyrics = itemView.findViewById(R.id.itemLyrics);
        }
    }
}

 

7. Add Activity 추가

  앞에서 RoomDB 구축과 연동도 끝마친 상태지만, 데이터가 아무것도 없어서 MainActivity의 RecyclerView에는 아무것도 안 뜰 것이다. 데이터를 동적으로 추가하기 위해 AddActivity를 추가하고, intent로 화면전환도 넣어주자. AddActivity 역시 RoomDB에 접근해서 insert를 해야하므로 thread를 별도로 만들어서 수행해야 한다. 

  AddActivity에서 run메서드 안에서 Music클래스를 만들고 각 Music객체의 속성에 값을 넣어준다. 그 후 music 객체를 MusicDB에 insert한다. 이때, musicDao를 호출해서 진행한다. (insertAll 메서드가 musicDao에 있으니까)

 

[MainActivity.java]

public class MainActivity extends AppCompatActivity {

    private List<Music> musicList;
    private MusicDB musicDB = null;
    private Context mContext = null;
    private MusicAdapter musicAdapter;
    private Button mAddButton;
    private RecyclerView mRecyclerView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mAddButton = (Button) findViewById(R.id.mAddButton);
        mRecyclerView = (RecyclerView) findViewById(R.id.mRecyclerView);

        mContext = getApplicationContext();
        musicAdapter = new MusicAdapter(musicList);

        // DB 생성
        musicDB = MusicDB.getInstance(this);


        // main thread에서 DB 접근 불가 => data 읽고 쓸 때 thread 사용하기
        class InsertRunnable implements Runnable {

            @Override
            public void run() {
                try {
                    musicList = MusicDB.getInstance(mContext).musicDao().getAll();
                    musicAdapter = new MusicAdapter(musicList);
                    musicAdapter.notifyDataSetChanged();

                    mRecyclerView.setAdapter(musicAdapter);
                    LinearLayoutManager mLinearLayoutManager = new LinearLayoutManager(mContext, RecyclerView.VERTICAL, false);
                    mRecyclerView.setLayoutManager(mLinearLayoutManager);
                }
                catch (Exception e) {

                }
            }
        }
        InsertRunnable insertRunnable = new InsertRunnable();
        Thread t = new Thread(insertRunnable);
        t.start();

        mAddButton.setOnClickListener(v -> {
            Intent intent = new Intent(getApplicationContext(), AddActivity.class);
            startActivity(intent);
            finish();
        });
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        MusicDB.destroyInstance();
        musicDB = null;
    }
}

[AddActivity.java]

public class AddActivity extends AppCompatActivity {

    private MusicDB musicDB = null;
    private Context mContext;
    private EditText mEditTextTitle;
    private EditText mEditTextSinger;
    private EditText mEditTextPlayTime;
    private EditText mEditTextLyrics;
    private Button mAddButton;


    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_add);

        mAddButton = (Button) findViewById(R.id.mAddItemButton);
        mEditTextTitle = (EditText) findViewById(R.id.mEditTextTitle);
        mEditTextSinger = (EditText) findViewById(R.id.mEditTextSinger);
        mEditTextPlayTime = (EditText) findViewById(R.id.mEditTextPlayTime);
        mEditTextLyrics = (EditText) findViewById(R.id.mEditTextLyrics);

        musicDB = MusicDB.getInstance(this);
        mContext = getApplicationContext();

        class InsertRunnable implements Runnable {

            @Override
            public void run() {
               Music music = new Music();
               music.title = mEditTextTitle.getText().toString();
               music.singer = mEditTextSinger.getText().toString();
               music.playTime = Long.parseLong(mEditTextPlayTime.getText().toString());
               music.lyrics = mEditTextLyrics.getText().toString();
               MusicDB.getInstance(mContext).musicDao().insertAll(music);
            }
        }

        mAddButton.setOnClickListener(v -> {

            InsertRunnable insertRunnable = new InsertRunnable();
            Thread addThread = new Thread(insertRunnable);
            addThread.start();

            Intent intent = new Intent(getApplicationContext(), MainActivity.class);
            startActivity(intent);
            finish();

        });
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        MusicDB.destroyInstance();
    }
}

 

[activity_add.xml]

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_height="match_parent">


    <EditText
        android:id="@+id/mEditTextTitle"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginLeft="20dp"
        android:layout_marginTop="140dp"
        android:layout_marginRight="20dp"
        android:hint="title"
        app:layout_constraintHorizontal_bias="0.0"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <EditText
        android:id="@+id/mEditTextSinger"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginLeft="20dp"
        android:layout_marginRight="20dp"
        android:hint="singer"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintHorizontal_bias="0.0"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/mEditTextTitle"
        app:layout_constraintVertical_bias="0.179" />

    <EditText
        android:id="@+id/mEditTextPlayTime"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginLeft="20dp"
        android:layout_marginRight="20dp"
        android:hint="playTime"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintHorizontal_bias="0.0"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/mEditTextSinger"
        app:layout_constraintVertical_bias="0.163" />

    <EditText
        android:id="@+id/mEditTextLyrics"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginLeft="20dp"
        android:layout_marginTop="96dp"
        android:layout_marginRight="20dp"
        android:hint="lyrics"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintHorizontal_bias="0.0"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/mEditTextPlayTime"
        app:layout_constraintVertical_bias="0.0" />

    <Button
        android:id="@+id/mAddItemButton"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_marginLeft="20dp"
        android:layout_marginRight="20dp"
        android:backgroundTint="@color/teal_700"
        android:text="ADD"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintHorizontal_bias="0.0"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/mEditTextLyrics" />

</androidx.constraintlayout.widget.ConstraintLayout>

 

 

 

Reference

https://blog.yena.io/studynote/2018/09/08/Android-Kotlin-Room.html

https://developer.android.com/training/data-storage/room?hl=ko 

https://youngest-programming.tistory.com/113