Share
Embed
Getting started with ROOM
Slide to my talk at Devfest17.
Room is a persistence library. It is one of the architecture components. It is a wrapper around SQLite.
Omolara Adejuwon
November 18, 2017
Transcript
51 slides
-
Features • Wrapper around SQLite • Eliminates boilerplate code •
Upgrade database versions with ease - MIGRATION • Enforces you don’t perform database operations on the main thread • Checks query at compile time • Testing is easier -
Features • Wrapper around SQLite • Eliminates boilerplate code •
Upgrade database versions with ease - MIGRATION • Enforces you don’t perform database operations on the main thread • Checks query at compile time • Testing is easier -
Features • Wrapper around SQLite • Eliminates boilerplate code •
Upgrade database versions with ease - MIGRATION • Enforces you don’t perform database operations on the main thread • Checks query at compile time • Testing is easier -
Features • Wrapper around SQLite • Eliminates boilerplate code •
Upgrade database versions with ease - MIGRATION • Enforces you don’t perform database operations on the main thread • Checks query at compile time • Testing is easier -
Features • Wrapper around SQLite • Eliminates boilerplate code •
Upgrade database versions with ease - MIGRATION • Enforces you don’t perform database operations on the main thread • Checks query at compile time • Testing is easier -
Features • Wrapper around SQLite • Eliminates boilerplate code •
Upgrade database versions with ease - MIGRATION • Enforces you don’t perform database operations on the main thread • Checks query at compile time • Testing is easier -
Major Components • @Entity - Defines table structure • @DAO
- An interface or abstract class. The functions define how to access the database • @Database - Connects all the pieces of Room together -
Update app level gradle file dependencies { ... implementation "android.arch.persistence.room:runtime:1.0.0"
annotationProcessor "android.arch.persistence.room:compiler:1.0.0" ... } -
Basic POJO public class Attendee { private int id; private
String name; private String email; private String category; private String extraFieldWeWantToIgnore; //other Getters & Setters } id name email category 1 Omolara [email protected] Speaker ... ... ... ... Attendee Table -
Create Entity @Entity (tableName="Attendee") public class Attendee { @PrimaryKey(autoGenerate =
true) @ColumnInfo(name = "id") private int id; @ColumnInfo(name = "name") private String name; @ColumnInfo(name = "email") private String email; private String category; @Ignore private String extraFieldWeWantToIgnore; //other Getters & Setters } id name email category 1 Omolara [email protected] Speaker ... ... ... ... Attendee Table -
Create Entity @Entity (tableName="Attendee") public class Attendee { @PrimaryKey(autoGenerate =
true) @ColumnInfo(name = "id") private int id; @ColumnInfo(name = "name") private String name; @ColumnInfo(name = "email") private String email; private String category; @Ignore private String extraFieldWeWantToIgnore; //other Getters & Setters } id name email category 1 Omolara [email protected] Speaker ... ... ... ... Attendee Table -
Create Entity @Entity (tableName="Attendee") public class Attendee { @PrimaryKey(autoGenerate =
true) @ColumnInfo(name = "id") private int id; @ColumnInfo(name = "name") private String name; @ColumnInfo(name = "email") private String email; private String category; @Ignore private String extraFieldWeWantToIgnore; //other Getters & Setters } id name email category 1 Omolara [email protected] Speaker ... ... ... ... Attendee Table -
Create Entity @Entity (tableName="Attendee") public class Attendee { @PrimaryKey(autoGenerate =
true) @ColumnInfo(name = "id") private int id; @ColumnInfo(name = "name") private String name; @ColumnInfo(name = "email") private String email; private String category; @Ignore private String extraFieldWeWantToIgnore; //other Getters & Setters } id name email category 1 Omolara [email protected] Speaker ... ... ... ... Attendee Table -
Create the DAO @Dao public interface AttendeeDao { @Insert/@delete/@update void
insert/delete/update (Attendee attendee); } Annotations for the win -
Create the DAO @Dao public interface AttendeeDao { @Insert/@delete/@update void
insert/delete/update (Attendee attendee); @Query("Select * from attendee where email=:email") Attendee getAttendedByEmail (String email); } Parameter Binding -
Create the DAO @Dao public interface AttendeeDao { @Insert/@delete/@update void
insert/delete/update (Attendee attendee); @Query("Select * from attendee where email=:email") Attendee getAttendedByEmail (String email); @Query("Select * from attendee") List<Attendee> getAllAttendees (); } Return a list -
Create the DAO @Dao public interface AttendeeDao { @Query("Select *
from attendeeess where email=:email") Attendee getAttendedByEmail (String email); } Compile Time Error -
Create the database class @Database(entities = {Attendee.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase { public abstract AttendeeDao attendeeDao (); } -
Get the database instance public static AppDatabase database; database =
Room.databaseBuilder (this, AppDatabase.class, "database_name") .build (); CAUTION!!! Recommended to keep it a singleton ‘cos database calls are not cheap -
Access the DB - Insert new record Attendee attendee =
new Attendee (1, "Omolara Adejuwon", "[email protected]", "Speaker"); RoomApp.database.attendeeDao ().insert (attendee); -
Access the DB - Retrieve All Attendees List<Attendee> attendees =
RoomApp.database.attendeeDao ().getAllAttendees (); -
Access the DB - Retrieve Attendees By Email Attendee attendee
= RoomApp.database.attendeeDao () .getAttendeesByEmail ("[email protected]"); -
defines the actions that should be performed when migrating from
one specific version to another Migration 1 2 3 -
Scenarios and actions • Modify schema, no change in version
- IllegalStateException -
Scenarios and actions • Modify schema, no change in version
- IllegalStateException • Increase version, no provision for migration - IllegalStateException -
Scenarios and actions • Modify schema, no change in version
- IllegalStateException • Increase version, no provision for migration - IllegalStateException • Increase version, enable fallback to destructive migration - wipes data -
Scenarios and actions • Modify schema, no change in version
- IllegalStateException • Increase version, no provision for migration - IllegalStateException • Increase version, enable fallback to destructive migration - wipes data • Increase version, provide migration - preserves data -
Fallback to destructive migration? database = Room.databaseBuilder (this, AppDatabase.class, "database_name")
.fallbackToDestructiveMigration () .build (); Wipe the data. I don’t care -
Modify Schema, Provide Migration @Database(entities = {Attendee.class}, version = 2)
public abstract class AppDatabase extends RoomDatabase { public abstract AttendeeDao attendeeDao (); } Change version number -
Modify Schema, Provide Migration public static final Migration MIGRATION_1_2 =
new Migration (1, 2) { @Override public void migrate (@NonNull SupportSQLiteDatabase database) { database.execSQL ("ALTER TABLE attendee ADD COLUMN phone_number TEXT"); } }; ------------------------------------------------------------------------- database = Room.databaseBuilder (this, AppDatabase.class, "devfestsw-java.db") .addMigrations (AppDatabase.MIGRATION_1_2) .build (); -
Testing DAOs - Initialize DB @Before public void initDb ()
{ database = Room.inMemoryDatabaseBuilder (InstrumentationRegistry.getContext (), AppDatabase.class).build (); } -
Testing DAOs - Insert new record @Test public void insert_retrieveAll_hasCorrectSize
() throws Exception { database.attendeeDao ().insert (ATTENDEE); } -
Testing DAOs - Retrieve all records @Test public void insert_retrieveAll_hasCorrectSize
() throws Exception { database.attendeeDao ().insert (ATTENDEE); List<Attendee> attendees = database.attendeeDao ().getAllAttendees (); } -
Testing DAOs - Verify records @Test public void insert_retrieveAll_hasCorrectSize ()
throws Exception { database.attendeeDao ().insert (ATTENDEE); List<Attendee> attendees = database.attendeeDao ().getAllAttendees (); assertEquals (1, attendees.size ()); assertEquals (ATTENDEE.getName (), attendees.get (0).getName ()); } -
Testing DAOs - Close DB @After public void closeDb ()
{ database.close (); } -
Testing Migrations - Define Schema Location defaultConfig { ... javaCompileOptions
{ annotationProcessorOptions { arguments = ["room.schemaLocation": "$projectDir/schemas".toString()] } } } -
Testing Migrations - Add schema location to source sets android
{ ... sourceSets { androidTest.assets.srcDirs += files("$projectDir/schemas".toString()) } } -
Testing Migrations - Update build.gradle file dependencies { ... androidTestImplementation
"android.arch.persistence.room:testing:1.0.0" } -
Testing Migrations - Create test rule @Rule public MigrationTestHelper mMigrationTestHelper
= new MigrationTestHelper (InstrumentationRegistry.getInstrumentation (), AppDatabase.class.getCanonicalName (), new FrameworkSQLiteOpenHelperFactory ()); -
Testing Migrations - Migrate and validate @Test public void migrationFrom1To2_containsCorrectData
() throws IOException { SupportSQLiteDatabase db = mMigrationTestHelper.createDatabase (DB_NAME, 1); db.execSQL ("INSERT INTO attendee VALUES(" + ATTENDEE.getId () + ",'" + ATTENDEE.getName () + "','" + ATTENDEE.getEmail () + "','" + ATTENDEE.getCategory () + "')"); db.close (); mMigrationTestHelper.runMigrationsAndValidate (DB_NAME, 2, validateDroppedTables , MIGRATION_1_2); ... } -
Testing Migrations - Migrate and validate @Test public void migrationFrom1To2_containsCorrectData
() throws IOException { ... Attendee attendee = getMigratedRoomDatabase ().attendeeDao (). getAttendedByEmail (ATTENDEE.getEmail ()); assertEquals (ATTENDEE.getId (), attendee.getId ()); assertEquals (ATTENDEE.getName (), attendee.getName ()); assertEquals (attendee.getPhoneNumber (), null); } -
Show Me The Code I have provided a repo that
demonstrates all that have been said. It has two branches: room-kotlin and room-java Check it out: https://github.com/larikraun/RoomDevfestSW17