Android Esempio di Android OrmLite su SQLite


Esempio

ORMLite è un pacchetto di mappatura relazionale degli oggetti che fornisce funzionalità semplici e leggere per gli oggetti Java persistenti ai database SQL, evitando la complessità e il sovraccarico di pacchetti ORM standard.

Parlando per Android, OrmLite è implementato sul database supportato pronto all'uso, SQLite. Effettua chiamate dirette all'API per accedere a SQLite.

Configurazione gradle

Per iniziare dovresti includere il pacchetto nel gradle di build.

 // https://mvnrepository.com/artifact/com.j256.ormlite/ormlite-android
compile group: 'com.j256.ormlite', name: 'ormlite-android', version: '5.0'
POJO configuration

Quindi è necessario configurare un POJO da mantenere nel database. Qui bisogna fare attenzione alle annotazioni:

  • Aggiungi l'annotazione @DatabaseTable all'inizio di ogni classe. Puoi anche usare @Entity.
  • Aggiungi l'annotazione @DatabaseField prima di ogni campo da mantenere. Puoi anche usare @Column e altri.
  • Aggiungi un costruttore senza argomento a ogni classe con almeno visibilità del pacchetto.
 @DatabaseTable(tableName = "form_model")
 public class FormModel implements Serializable {

    @DatabaseField(generatedId = true)
    private Long id;
    @DatabaseField(dataType = DataType.SERIALIZABLE)
    ArrayList<ReviewItem> reviewItems;

    @DatabaseField(index = true)
    private String username;

    @DatabaseField
    private String createdAt;

    public FormModel() {
    }

    public FormModel(ArrayList<ReviewItem> reviewItems, String username, String createdAt) {
        this.reviewItems = reviewItems;
        this.username = username;
        this.createdAt = createdAt;
    }
}

Nell'esempio sopra c'è una tabella (form_model) con 4 campi.

il campo ID è l'indice generato automaticamente.

username è un indice del database.

Ulteriori informazioni sull'annotazione sono disponibili nella documentazione ufficiale .

Database Helper

Per continuare, è necessario creare una classe helper del database che dovrebbe estendere la classe OrmLiteSqliteOpenHelper.

Questa classe crea e aggiorna il database quando viene installata l'applicazione e può anche fornire le classi DAO utilizzate dalle altre classi.

DAO è l'acronimo di Data Access Object e fornisce tutte le funzionalità di Scrum e si specializza nella gestione di una singola classe persistente.

La classe helper deve implementare i seguenti due metodi:

  • onCreate (SQLiteDatabase sqliteDatabase, ConnectionSource connectionSource);

    onCreate crea il database quando la tua app viene installata per la prima volta

  • onUpgrade (database SQLiteDatabase, ConnectionSource connectionSource, int oldVersion, int newVersion);

    onUpgrade gestisce l'aggiornamento delle tabelle del database quando si aggiorna l'app a una nuova versione

Esempio di classe Database Helper:

  public class OrmLite extends OrmLiteSqliteOpenHelper {
    
        //Database name
        private static final String DATABASE_NAME = "gaia";
        //Version of the database. Changing the version will call {@Link OrmLite.onUpgrade}
        private static final int DATABASE_VERSION = 2;
    
        /**
         * The data access object used to interact with the Sqlite database to do C.R.U.D operations.
         */
        private Dao<FormModel, Long> todoDao;
    
    
    
        public OrmLite(Context context) {
            super(context, DATABASE_NAME, null, DATABASE_VERSION,
                    /**
                     * R.raw.ormlite_config is a reference to the ormlite_config2.txt file in the
                     * /res/raw/ directory of this project
                     * */
                    R.raw.ormlite_config2);
        }
    
        @Override
        public void onCreate(SQLiteDatabase database, ConnectionSource connectionSource) {
            try {
    
                /**
                 * creates the database table
                 */
                TableUtils.createTable(connectionSource, FormModel.class);
    
            } catch (SQLException e) {
                e.printStackTrace();
            } catch (java.sql.SQLException e) {
                e.printStackTrace();
            }
        }
        /*
            It is called when you construct a SQLiteOpenHelper with version newer than the version of the opened database.
         */
        @Override
        public void onUpgrade(SQLiteDatabase database, ConnectionSource connectionSource,
                              int oldVersion, int newVersion) {
            try {
                /**
                 * Recreates the database when onUpgrade is called by the framework
                 */
                TableUtils.dropTable(connectionSource, FormModel.class, false);
                onCreate(database, connectionSource);
    
            } catch (SQLException | java.sql.SQLException e) {
                e.printStackTrace();
            }
        }
    
        /**
         * Returns an instance of the data access object
         * @return
         * @throws SQLException
         */
        public Dao<FormModel, Long> getDao() throws SQLException {
            if(todoDao == null) {
                try {
                    todoDao = getDao(FormModel.class);
                } catch (java.sql.SQLException e) {
                    e.printStackTrace();
                }
            }
            return todoDao;
        }
    }

Oggetto persistente in SQLite

Infine, la classe che persiste l'oggetto nel database.

     public class ReviewPresenter {
    Dao<FormModel, Long> simpleDao;


    public ReviewPresenter(Application application) {
        this.application = (GaiaApplication) application;
        simpleDao = this.application.getHelper().getDao();
    }

    public void storeFormToSqLite(FormModel form) {

        try {
            simpleDao.create(form);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        List<FormModel> list = null;
        try {
// query for all of the data objects in the database
            list = simpleDao.queryForAll();
        } catch (SQLException e) {
            e.printStackTrace();
        }
// our string builder for building the content-view
        StringBuilder sb = new StringBuilder();
        int simpleC = 1;
        for (FormModel simple : list) {
            sb.append('#').append(simpleC).append(": ").append(simple.getUsername()).append('\n');
            simpleC++;
        }
        System.out.println(sb.toString());
    }
    
    //Query to database to get all forms by username
    public List<FormModel> getAllFormsByUsername(String username) {
        List<FormModel> results = null;
        try {
            results = simpleDao.queryBuilder().where().eq("username", PreferencesManager.getInstance().getString(Constants.USERNAME)).query();
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return results;
    }
}

L'accessor del DOA presso il costruttore della suddetta classe è definito come:

 private OrmLite dbHelper = null;

/*
Provides the SQLite Helper Object among the application
 */
public OrmLite getHelper() {
    if (dbHelper == null) {
        dbHelper = OpenHelperManager.getHelper(this, OrmLite.class);
    }
    return dbHelper;
}