Android
ORMLite в android
Поиск…
Android OrmLite по примеру SQLite
ORMLite - это пакет реляционного сопоставления объектов, который обеспечивает простую и легкую функциональность для сохранения объектов Java в SQL-базах данных, избегая при этом сложностей и накладных расходов более стандартных пакетов ORM.
Говоря о Android, OrmLite реализуется по доступной базе данных SQLite. Он делает прямые вызовы API для доступа к SQLite.
Настройка гребенки
Чтобы начать работу, вы должны включить пакет в градиент сборки.
// https://mvnrepository.com/artifact/com.j256.ormlite/ormlite-android
compile group: 'com.j256.ormlite', name: 'ormlite-android', version: '5.0'
POJO configuration
Затем вы должны настроить POJO для сохранения в базе данных. Здесь следует обратить внимание на аннотации:
- Добавьте аннотацию @DatabaseTable в начало каждого класса. Вы также можете использовать @Entity.
- Добавьте аннотацию @DatabaseField прямо перед каждым полем, которое необходимо сохранить. Вы также можете использовать @Column и другие.
- Добавьте конструктор no-argument для каждого класса с видимостью по крайней мере пакета.
@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;
}
}
В приведенном выше примере есть одна таблица (form_model) с 4 полями.
Поле id - это автоматически созданный индекс.
username - это индекс базы данных.
Более подробную информацию об аннотации можно найти в официальной документации .
Помощник базы данных
Для продолжения вам необходимо создать вспомогательный класс базы данных, который должен расширить класс OrmLiteSqliteOpenHelper.
Этот класс создает и обновляет базу данных, когда ваше приложение установлено, а также может предоставлять классы DAO, используемые другими вашими классами.
DAO означает объект доступа к данным и обеспечивает все функциональные возможности scrum и специализируется на обработке одного сохраненного класса.
Класс-помощник должен реализовывать следующие два метода:
onCreate (SQLiteDatabase sqliteDatabase, ConnectionSource connectionSource);
onCreate создает базу данных, когда ваше приложение впервые установлено
onUpgrade (база данных SQLiteDatabase, ConnectionSource connectionSource, int oldVersion, int newVersion);
onUpgrade обрабатывает обновление таблиц базы данных при обновлении приложения до новой версии
Пример класса помощника базы данных:
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;
}
}
Постоянный объект для SQLite
Наконец, класс, который сохраняет объект в базе данных.
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;
}
}
Аксессор DOA у конструктора вышеуказанного класса определяется как:
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;
}