Android
ORMLite en Android
Buscar..
Ejemplo de Android OrmLite sobre SQLite
ORMLite es un paquete de asignación relacional de objetos que proporciona una funcionalidad simple y liviana para la persistencia de objetos Java en bases de datos SQL, evitando la complejidad y la sobrecarga de paquetes ORM más estándar.
Hablando para Android, OrmLite se implementa en la base de datos compatible con el sistema, SQLite. Hace llamadas directas a la API para acceder a SQLite.
Configuración de Gradle
Para empezar, debes incluir el paquete en la versión de compilación.
// https://mvnrepository.com/artifact/com.j256.ormlite/ormlite-android
compile group: 'com.j256.ormlite', name: 'ormlite-android', version: '5.0'
POJO configuration
A continuación, debe configurar un POJO para persistir en la base de datos. Aquí se debe tener cuidado con las anotaciones:
- Agregue la anotación @DatabaseTable en la parte superior de cada clase. También puedes usar @Entity.
- Agregue la anotación @DatabaseField justo antes de cada campo a persistir. También puedes usar @Column y otros.
- Agregue un constructor sin argumentos a cada clase con al menos visibilidad del paquete.
@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;
}
}
En el ejemplo anterior hay una tabla (form_model) con 4 campos.
El campo id es un índice generado automáticamente.
nombre de usuario es un índice de la base de datos.
Se puede encontrar más información sobre la anotación en la documentación oficial .
Ayudante de base de datos
Para continuar, deberá crear una clase auxiliar de base de datos que extienda la clase OrmLiteSqliteOpenHelper.
Esta clase crea y actualiza la base de datos cuando su aplicación está instalada y también puede proporcionar las clases DAO utilizadas por sus otras clases.
DAO significa Objeto de acceso a datos, proporciona toda la funcionalidad de scrum y se especializa en el manejo de una sola clase persistente.
La clase auxiliar debe implementar los siguientes dos métodos:
onCreate (SQLiteDatabase sqliteDatabase, ConnectionSource connectionSource);
onCreate crea la base de datos cuando su aplicación se instala por primera vez
onUpgrade (base de datos SQLiteDatabase, ConnectionSource connectionSource, int oldVersion, int newVersion);
onUpgrade maneja la actualización de las tablas de la base de datos cuando actualiza su aplicación a una nueva versión
Ejemplo de clase de Asistente de base de datos:
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;
}
}
Objeto persistente a SQLite
Finalmente, la clase que persiste el objeto hasta la base de datos.
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;
}
}
El descriptor de acceso del DOA en el constructor de la clase anterior se define como:
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;
}