Join the social network of Tech Nerds, increase skill rank, get work, manage projects...
 

  • How to Implement Room Database in Android using RxJava2?

    @rohit.puri
    Recommendations Offline Message

    • 0
    • 0
    • 0
    • 0
    • 0
    • 0
    • 1
    • 0
    • 6.13k
    Comment on it

    The Room is basically an easier implementation of SQLite database and a part of Android Architecture components.

    We know that SQLite uses SQLite open helper class to manage SQLite database but Room provides migration by removing this implementation.

     

    In SQLite database, we basically use content values to map data into a table or construct queries and then uses the cursor to get data one by one but in case if we add incorrect column name in the query then runtime exception occurs and it takes more time to identify the syntax error. 

    But Room library provides you an easy interface to implement a database, by using Room you can check all the queries at runtime like for syntax error or column name error.

     

     

    Now this example will show you how to use RxJava with Room library to provide an asynchronous mechanism.

    Please follow the step by step procedure to implement Room with RxJava:

     

    Step 1: Add dependencies in app.gradle :

    1. compile "android.arch.lifecycle:runtime:1.0.0-alpha5"
    2. compile "android.arch.lifecycle:extensions:1.0.0-alpha5"
    3. annotationProcessor "android.arch.lifecycle:compiler:1.0.0-alpha5"
    4.  
    5. compile "android.arch.persistence.room:runtime:1.0.0-alpha5"
    6. annotationProcessor "android.arch.persistence.room:compiler:1.0.0-alpha5"
    7.  
    8. compile "android.arch.persistence.room:rxjava2:1.0.0-alpha5"

     

    add maven in project gradle file :

    1. allprojects {
    2.     repositories {
    3.         jcenter()
    4.         maven { url 'https://maven.google.com' }
    5.     }
    6. }

     

    Step 2: Declare a model class using Entity, ColumnInfo, Primary key annotation :

    1. @Entity (tableName = "Students")
    2. public class StudentModel {
    3.  
    4.     //Declare student id as a primary key in database will auto generate by Room
    5.     @PrimaryKey (autoGenerate = true)
    6.     public int mId;
    7.  
    8.     //Declare Column name in table Students
    9.     @ColumnInfo (name = "StudentName")
    10.     public String mName;
    11.  
    12.     @ColumnInfo (name = "StudentClass")
    13.     public String mStd;
    14.  
    15.     public int getmId() {
    16.         return mId;
    17.     }
    18.  
    19.     public void setmId(int mId) {
    20.         this.mId = mId;
    21.     }
    22.  
    23.     public String getmName() {
    24.         return mName;
    25.     }
    26.  
    27.     public void setmName(String mName) {
    28.         this.mName = mName;
    29.     }
    30.  
    31.     public String getmStd() {
    32.         return mStd;
    33.     }
    34.  
    35.     public void setmStd(String mStd) {
    36.         this.mStd = mStd;
    37.     }
    38. }

    Step 3: Now create a Data access object class to define the queries using query, insert, delete annotation and it will return flowable, maybe, single type of data as an observable:

    1. @Dao
    2. public interface StudentDao {
    3.  
    4.     //Flowable or observable is used to emits Student model types of data and it emits whenever database is updated
    5.     @Query("SELECT * FROM Students")
    6.     Flowable <List<StudentModel>> getStudents();
    7.  
    8.     //This Maybe class is used to emit only a single row data
    9.     @Query("SELECT * FROM Students WHERE StudentName =:aStudentName ")
    10.     Maybe<StudentModel> getStudentByName(String aStudentName);
    11.  
    12.     //Insert the parameters in table like list of students
    13.     @Insert
    14.     void insertStudent(ArrayList<StudentModel> mStudentModelArrayList);
    15.  
    16.     //This Query will delete all the students from table Students
    17.     @Query("DELETE FROM Students")
    18.     void deleteAllStudents();
    19.  
    20. }

     

    Step 4: Create abstract class that will extend Room database and will return Dao like this :

    1. //Declare entities of your room database with version
    2. @Database(entities = StudentModel.class,version = 1)
    3. public abstract class StudentDatabase extends RoomDatabase{
    4.  
    5.     public abstract StudentDao getStudentDao();
    6. }

     

    Step 5: Now insert and retrieve the data from Room database :

    1. public class MainActivity extends AppCompatActivity {
    2.  
    3.     @Override
    4.     protected void onCreate(Bundle savedInstanceState) {
    5.         super.onCreate(savedInstanceState);
    6.         setContentView(R.layout.activity_main);
    7.  
    8.         //Access Room database in activity to get data access object
    9.         StudentDatabase mStudentDatabase = StudentDatabase.getAppDatabase(MainActivity.this);
    10.  
    11.         ArrayList<StudentModel> modelArrayList = new ArrayList<>();
    12.         //Saving some records
    13.         for (int i=0;i<10;i++){
    14.             StudentModel mStudentModel = new StudentModel();
    15.             mStudentModel.setmName("Name :"+i);
    16.             mStudentModel.setmStd("class :"+i);
    17.             modelArrayList.add(mStudentModel);
    18.         }
    19.  
    20.         //inserting records
    21.         mStudentDatabase.getStudentDao().insertStudent(modelArrayList);
    22.  
    23.         //getting flowable to subscribe consumer that will access the data from Room database.
    24.         mStudentDatabase.getStudentDao().getStudents().subscribe(new Consumer<List<StudentModel>>() {
    25.             @Override
    26.             public void accept(@NonNull List<StudentModel> studentModels) throws Exception {
    27.                 handleResponse(studentModels);
    28.             }
    29.         });
    30.  
    31.     }
    32.  
    33.     private void handleResponse(List<StudentModel> studentModels){
    34.         Log.e("student size :",studentModels.size()+"");
    35.  
    36.         for (int i=0;i<studentModels.size();i++){
    37.             Log.e("student name :",studentModels.get(i).getmName());
    38.         }
    39.     }
    40.  
    41. }

     

    Hope you enjoy the tutorial ! If you have any question, feel free to write in comment section.

    How to Implement Room Database in Android using RxJava2?
    Android RxJava 2 Room databse Room databse with RxJAva Reactive programming java
    Comment on it

 0 Comment(s)

Sign In
Forgot Password?
                           OR                           
Create an account !!
                           OR                           
Register

Sign up using

                           OR                           
Forgot Password
Reset Password
Fill out the form below and reset your password: