¿Cuáles son las mejores prácticas para SQLite en Android?

¿Cuáles se considerarían las mejores prácticas al ejecutar consultas en una base de datos SQLite dentro de una aplicación de Android?

¿Es seguro ejecutar inserciones, eliminaciones y seleccionar consultas desde un doInBackground de AsyncTask? ¿O debería usar el hilo de interfaz de usuario? Supongo que las consultas de la base de datos pueden ser "pesadas" y no deberían usar el hilo de la interfaz de usuario, ya que puede bloquear la aplicación, lo que resulta en una aplicación que no responde (ANR).

Si tengo varias AsyncTasks, ¿deberían compartir una conexión o deberían abrir una conexión cada una?

¿Existen mejores prácticas para estos escenarios?

Las inserciones, actualizaciones, eliminaciones y lecturas generalmente están bien en varios subprocesos, pero la respuesta de Brad no es correcta. Debes tener cuidado con cómo creas tus conexiones y las usas. Hay situaciones en las que sus llamadas de actualización fallarán, incluso si su base de datos no se corrompe.

La respuesta básica.

El objeto SqliteOpenHelper mantiene una conexión de base de datos. Parece ofrecerle una conexión de lectura y escritura, pero realmente no lo hace. Llame al de solo lectura y obtendrá la conexión de la base de datos de escritura independientemente.

Entonces, una instancia auxiliar, una conexión db. Incluso si lo usa desde múltiples hilos, una conexión a la vez. El objeto SqliteDatabase usa bloqueos java para mantener el acceso serializado. Por lo tanto, si 100 subprocesos tienen una instancia de db, las llamadas a la base de datos en disco real se serializan.

Entonces, un ayudante, una conexión db, que se serializa en código java. Un subproceso, 1000 subprocesos, si usa una instancia auxiliar compartida entre ellos, todo su código de acceso a base de datos es serial. Y la vida es buena (ish).

Si intenta escribir en la base de datos desde conexiones distintas reales al mismo tiempo, una fallará. No esperará hasta que termine el primero y luego escribirá. Simplemente no escribirá su cambio. Peor aún, si no llama a la versión correcta de inserción / actualización en SQLiteDatabase, no obtendrá una excepción. Recibirá un mensaje en su LogCat, y eso será todo.

Entonces, ¿múltiples hilos? Usa un ayudante. Período. Si SABES que solo se escribirá un hilo, PUEDES poder usar múltiples conexiones, y tus lecturas serán más rápidas, pero ten cuidado con el comprador. No he probado tanto.

Aquí hay una publicación de blog con muchos más detalles y una aplicación de ejemplo.

• Bloqueo de Android Sqlite (Enlace actualizado 18/06/2012)
• Android-Database-Locking-Collisions-Example de touchlab en GitHub

Gray y yo estamos terminando una herramienta ORM, basada en su Ormlite, que funciona de forma nativa con implementaciones de bases de datos de Android, y sigue la estructura segura de creación / llamada que describo en la publicación del blog. Eso debería salir muy pronto. Echar un vistazo.

Mientras tanto, hay una publicación de blog de seguimiento:

• Conexión SQLite única

También revise la horquilla por 2 puntos 0 del ejemplo de bloqueo mencionado anteriormente:

• Android-Database-Locking-Collisions-Example por 2point0 en GitHub

Acceso concurrente a la base de datos

Mismo artículo en mi blog (me gusta formatear más)

Escribí un pequeño artículo que describe cómo hacer que el acceso a su hilo de base de datos de Android sea seguro.

Suponiendo que tiene su propio SQLiteOpenHelper .

public class DatabaseHelper extends SQLiteOpenHelper { ... }

Ahora desea escribir datos en la base de datos en hilos separados.

 // Thread 1
 Context context = getApplicationContext();
 DatabaseHelper helper = new DatabaseHelper(context);
 SQLiteDatabase database = helper.getWritableDatabase();
 database.insert(…);
 database.close();

 // Thread 2
 Context context = getApplicationContext();
 DatabaseHelper helper = new DatabaseHelper(context);
 SQLiteDatabase database = helper.getWritableDatabase();
 database.insert(…);
 database.close();

Recibirá el siguiente mensaje en su logcat y uno de sus cambios no se escribirá.

android.database.sqlite.SQLiteDatabaseLockedException: database is locked (code 5)

Esto sucede porque cada vez que crea un nuevo objeto SQLiteOpenHelper , en realidad está haciendo una nueva conexión de base de datos. Si intenta escribir en la base de datos desde conexiones distintas reales al mismo tiempo, una fallará. (de la respuesta anterior)

Para usar la base de datos con múltiples hilos necesitamos asegurarnos de que estamos usando una conexión de base de datos.

Hagamos el Administrador de base de datos de clase singleton que contendrá y devolverá un solo objeto SQLiteOpenHelper .

public class DatabaseManager {

    private static DatabaseManager instance;
    private static SQLiteOpenHelper mDatabaseHelper;

    public static synchronized void initializeInstance(SQLiteOpenHelper helper) {
        if (instance == null) {
            instance = new DatabaseManager();
            mDatabaseHelper = helper;
        }
    }

    public static synchronized DatabaseManager getInstance() {
        if (instance == null) {
            throw new IllegalStateException(DatabaseManager.class.getSimpleName() +
                    " is not initialized, call initialize(..) method first.");
        }

        return instance;
    }

    public SQLiteDatabase getDatabase() {
        return new mDatabaseHelper.getWritableDatabase();
    }

}

El código actualizado que escribe datos en la base de datos en hilos separados se verá así.

 // In your application class
 DatabaseManager.initializeInstance(new MySQLiteOpenHelper());
 // Thread 1
 DatabaseManager manager = DatabaseManager.getInstance();
 SQLiteDatabase database = manager.getDatabase()
 database.insert(…);
 database.close();

 // Thread 2
 DatabaseManager manager = DatabaseManager.getInstance();
 SQLiteDatabase database = manager.getDatabase()
 database.insert(…);
 database.close();

Esto te traerá otro choque.

java.lang.IllegalStateException: attempt to re-open an already-closed object: SQLiteDatabase

Puesto que estamos utilizando sólo una conexión de base de datos, método getDatabase () devolver misma instancia de SQLiteDatabase objeto para Thread1 y Thread2 . Lo que está sucediendo, Thread1 puede cerrar la base de datos, mientras que Thread2 todavía la está usando. Es por eso que tenemos el bloqueo IllegalStateException .

Necesitamos asegurarnos de que nadie esté usando la base de datos y solo luego cerrarla. Algunas personas en stackoveflow recomendaron nunca cerrar su SQLiteDatabase . Esto dará como resultado el siguiente mensaje logcat.

Leak found
Caused by: java.lang.IllegalStateException: SQLiteDatabase created and never closed

Muestra de trabajo

public class DatabaseManager {

    private int mOpenCounter;

    private static DatabaseManager instance;
    private static SQLiteOpenHelper mDatabaseHelper;
    private SQLiteDatabase mDatabase;

    public static synchronized void initializeInstance(SQLiteOpenHelper helper) {
        if (instance == null) {
            instance = new DatabaseManager();
            mDatabaseHelper = helper;
        }
    }

    public static synchronized DatabaseManager getInstance() {
        if (instance == null) {
            throw new IllegalStateException(DatabaseManager.class.getSimpleName() +
                    " is not initialized, call initializeInstance(..) method first.");
        }

        return instance;
    }

    public synchronized SQLiteDatabase openDatabase() {
        mOpenCounter++;
        if(mOpenCounter == 1) {
            // Opening new database
            mDatabase = mDatabaseHelper.getWritableDatabase();
        }
        return mDatabase;
    }

    public synchronized void closeDatabase() {
        mOpenCounter--;
        if(mOpenCounter == 0) {
            // Closing database
            mDatabase.close();

        }
    }

}

Úselo de la siguiente manera.

SQLiteDatabase database = DatabaseManager.getInstance().openDatabase();
database.insert(...);
// database.close(); Don't close it directly!
DatabaseManager.getInstance().closeDatabase(); // correct way

Cada vez que necesite una base de datos, debe llamar al método openDatabase () de la clase DatabaseManager . Dentro de este método, tenemos un contador que indica cuántas veces se abre la base de datos. Si es igual a uno, significa que necesitamos crear una nueva conexión de base de datos, de lo contrario, la conexión de base de datos ya está creada.

Lo mismo sucede en el método closeDatabase () . Cada vez que llamamos a este método, el contador disminuye, cada vez que llega a cero, estamos cerrando la conexión de la base de datos.

Ahora debería poder usar su base de datos y asegurarse de que sea segura para subprocesos.

• Utilice a Threado AsyncTaskpara operaciones de larga duración (50 ms o más). Prueba tu aplicación para ver dónde está. La mayoría de las operaciones (probablemente) no requieren un subproceso, porque la mayoría de las operaciones (probablemente) solo involucran unas pocas filas. Use un hilo para operaciones masivas.
• Comparta una SQLiteDatabaseinstancia para cada base de datos en el disco entre subprocesos e implemente un sistema de conteo para realizar un seguimiento de las conexiones abiertas.

¿Existen mejores prácticas para estos escenarios?

Comparta un campo estático entre todas sus clases. Solía ​​mantener un singleton para eso y otras cosas que necesitan ser compartidas. También se debe usar un esquema de conteo (generalmente usando AtomicInteger) para asegurarse de que nunca cierre la base de datos antes de tiempo o la deje abierta.

Mi solución:

Para obtener la versión más reciente, consulte https://github.com/JakarCo/databasemanager, pero también intentaré mantener el código actualizado aquí. Si quieres entender mi solución, mira el código y lee mis notas. Mis notas suelen ser bastante útiles.

1. copie / pegue el código en un nuevo archivo llamado DatabaseManager. (o descargarlo de github)
2. extender DatabaseManagere implementar onCreatey onUpgradecomo lo haría normalmente. Puede crear múltiples subclases de una DatabaseManagerclase para tener diferentes bases de datos en el disco.
3. Crea una instancia de tu subclase y llama getDb()para usar la SQLiteDatabaseclase.
4. Llame close()por cada subclase que haya instanciado

El código para copiar / pegar :

import android.content.Context;
import android.database.sqlite.SQLiteDatabase;

import java.util.concurrent.ConcurrentHashMap;

/** Extend this class and use it as an SQLiteOpenHelper class
 *
 * DO NOT distribute, sell, or present this code as your own. 
 * for any distributing/selling, or whatever, see the info at the link below
 *
 * Distribution, attribution, legal stuff,
 * See https://github.com/JakarCo/databasemanager
 * 
 * If you ever need help with this code, contact me at [email protected] (or [email protected] )
 * 
 * Do not sell this. but use it as much as you want. There are no implied or express warranties with this code. 
 *
 * This is a simple database manager class which makes threading/synchronization super easy.
 *
 * Extend this class and use it like an SQLiteOpenHelper, but use it as follows:
 *  Instantiate this class once in each thread that uses the database. 
 *  Make sure to call {@link #close()} on every opened instance of this class
 *  If it is closed, then call {@link #open()} before using again.
 * 
 * Call {@link #getDb()} to get an instance of the underlying SQLiteDatabse class (which is synchronized)
 *
 * I also implement this system (well, it's very similar) in my <a href="http://androidslitelibrary.com">Android SQLite Libray</a> at http://androidslitelibrary.com
 * 
 *
 */
abstract public class DatabaseManager {

    /**See SQLiteOpenHelper documentation
    */
    abstract public void onCreate(SQLiteDatabase db);
    /**See SQLiteOpenHelper documentation
     */
    abstract public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion);
    /**Optional.
     * *
     */
    public void onOpen(SQLiteDatabase db){}
    /**Optional.
     * 
     */
    public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {}
    /**Optional
     * 
     */
    public void onConfigure(SQLiteDatabase db){}



    /** The SQLiteOpenHelper class is not actually used by your application.
     *
     */
    static private class DBSQLiteOpenHelper extends SQLiteOpenHelper {

        DatabaseManager databaseManager;
        private AtomicInteger counter = new AtomicInteger(0);

        public DBSQLiteOpenHelper(Context context, String name, int version, DatabaseManager databaseManager) {
            super(context, name, null, version);
            this.databaseManager = databaseManager;
        }

        public void addConnection(){
            counter.incrementAndGet();
        }
        public void removeConnection(){
            counter.decrementAndGet();
        }
        public int getCounter() {
            return counter.get();
        }
        @Override
        public void onCreate(SQLiteDatabase db) {
            databaseManager.onCreate(db);
        }

        @Override
        public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
            databaseManager.onUpgrade(db, oldVersion, newVersion);
        }

        @Override
        public void onOpen(SQLiteDatabase db) {
            databaseManager.onOpen(db);
        }

        @Override
        public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {
            databaseManager.onDowngrade(db, oldVersion, newVersion);
        }

        @Override
        public void onConfigure(SQLiteDatabase db) {
            databaseManager.onConfigure(db);
        }
    }

    private static final ConcurrentHashMap<String,DBSQLiteOpenHelper> dbMap = new ConcurrentHashMap<String, DBSQLiteOpenHelper>();

    private static final Object lockObject = new Object();


    private DBSQLiteOpenHelper sqLiteOpenHelper;
    private SQLiteDatabase db;
    private Context context;

    /** Instantiate a new DB Helper. 
     * <br> SQLiteOpenHelpers are statically cached so they (and their internally cached SQLiteDatabases) will be reused for concurrency
     *
     * @param context Any {@link android.content.Context} belonging to your package.
     * @param name The database name. This may be anything you like. Adding a file extension is not required and any file extension you would like to use is fine.
     * @param version the database version.
     */
    public DatabaseManager(Context context, String name, int version) {
        String dbPath = context.getApplicationContext().getDatabasePath(name).getAbsolutePath();
        synchronized (lockObject) {
            sqLiteOpenHelper = dbMap.get(dbPath);
            if (sqLiteOpenHelper==null) {
                sqLiteOpenHelper = new DBSQLiteOpenHelper(context, name, version, this);
                dbMap.put(dbPath,sqLiteOpenHelper);
            }
            //SQLiteOpenHelper class caches the SQLiteDatabase, so this will be the same SQLiteDatabase object every time
            db = sqLiteOpenHelper.getWritableDatabase();
        }
        this.context = context.getApplicationContext();
    }
    /**Get the writable SQLiteDatabase
     */
    public SQLiteDatabase getDb(){
        return db;
    }

    /** Check if the underlying SQLiteDatabase is open
     *
     * @return whether the DB is open or not
     */
    public boolean isOpen(){
        return (db!=null&&db.isOpen());
    }


    /** Lowers the DB counter by 1 for any {@link DatabaseManager}s referencing the same DB on disk
     *  <br />If the new counter is 0, then the database will be closed.
     *  <br /><br />This needs to be called before application exit.
     * <br />If the counter is 0, then the underlying SQLiteDatabase is <b>null</b> until another DatabaseManager is instantiated or you call {@link #open()}
     *
     * @return true if the underlying {@link android.database.sqlite.SQLiteDatabase} is closed (counter is 0), and false otherwise (counter > 0)
     */
    public boolean close(){
        sqLiteOpenHelper.removeConnection();
        if (sqLiteOpenHelper.getCounter()==0){
            synchronized (lockObject){
                if (db.inTransaction())db.endTransaction();
                if (db.isOpen())db.close();
                db = null;
            }
            return true;
        }
        return false;
    }
    /** Increments the internal db counter by one and opens the db if needed
    *
    */
    public void open(){
        sqLiteOpenHelper.addConnection();
        if (db==null||!db.isOpen()){
                synchronized (lockObject){
                    db = sqLiteOpenHelper.getWritableDatabase();
                }
        } 
    }
}

La base de datos es muy flexible con subprocesos múltiples. Mis aplicaciones llegan a sus bases de datos desde muchos subprocesos diferentes simultáneamente y funciona bien. En algunos casos, tengo múltiples procesos golpeando la base de datos simultáneamente y eso también funciona bien.

Sus tareas asíncronas: use la misma conexión cuando pueda, pero si es necesario, está bien acceder a la base de datos desde diferentes tareas.

La respuesta de Dmytro funciona bien para mi caso. Creo que es mejor declarar la función como sincronizada. al menos para mi caso, invocaría una excepción de puntero nulo, de lo contrario, getWritableDatabase aún no devuelto en un subproceso y openDatabse llamado en otro subproceso mientras tanto.

public synchronized SQLiteDatabase openDatabase() {
    if(mOpenCounter.incrementAndGet() == 1) {
        // Opening new database
        mDatabase = mDatabaseHelper.getWritableDatabase();
    }
    return mDatabase;
}

Después de luchar con esto durante un par de horas, descubrí que solo puede usar un objeto de ayuda de db por ejecución de db. Por ejemplo,

for(int x = 0; x < someMaxValue; x++)
{
    db = new DBAdapter(this);
    try
    {

        db.addRow
        (
                NamesStringArray[i].toString(), 
                StartTimeStringArray[i].toString(),
                EndTimeStringArray[i].toString()
        );

    }
    catch (Exception e)
    {
        Log.e("Add Error", e.toString());
        e.printStackTrace();
    }
    db.close();
}

según lo dispuesto para:

db = new DBAdapter(this);
for(int x = 0; x < someMaxValue; x++)
{

    try
    {
        // ask the database manager to add a row given the two strings
        db.addRow
        (
                NamesStringArray[i].toString(), 
                StartTimeStringArray[i].toString(),
                EndTimeStringArray[i].toString()
        );

    }
    catch (Exception e)
    {
        Log.e("Add Error", e.toString());
        e.printStackTrace();
    }

}
db.close();

crear un nuevo DBAdapter cada vez que el ciclo itera era la única forma en que podía ingresar mis cadenas en una base de datos a través de mi clase auxiliar.

Comprendo las API de SQLiteDatabase es que, en caso de que tenga una aplicación multiproceso, no puede permitirse tener más de un objeto SQLiteDatabase que apunte a una sola base de datos.

El objeto definitivamente se puede crear, pero las inserciones / actualizaciones fallan si diferentes subprocesos / procesos (también) comienzan a usar diferentes objetos SQLiteDatabase (como la forma en que usamos en JDBC Connection).

La única solución aquí es quedarse con 1 objetos SQLiteDatabase y cada vez que se usa startTransaction () en más de 1 subproceso, Android administra el bloqueo en diferentes subprocesos y permite que solo 1 subproceso a la vez tenga acceso exclusivo a la actualización.

También puede hacer "Lecturas" de la base de datos y usar el mismo objeto SQLiteDatabase en un hilo diferente (mientras otro hilo escribe) y nunca habría corrupción de la base de datos, es decir, "leer hilo" no leería los datos de la base de datos hasta que " hilo de escritura "confirma los datos, aunque ambos usan el mismo objeto SQLiteDatabase.

Esto es diferente de cómo está el objeto de conexión en JDBC, donde si pasa (use el mismo) el objeto de conexión entre los hilos de lectura y escritura, probablemente también estaríamos imprimiendo datos no confirmados.

En mi aplicación empresarial, trato de usar verificaciones condicionales para que el subproceso de la interfaz de usuario nunca tenga que esperar, mientras que el subproceso BG contiene el objeto SQLiteDatabase (exclusivamente). Intento predecir las acciones de la interfaz de usuario y diferir la ejecución del hilo BG durante 'x' segundos. También se puede mantener PriorityQueue para administrar la distribución de objetos de conexión SQLiteDatabase para que el subproceso de interfaz de usuario lo obtenga primero.

Puede intentar aplicar un nuevo enfoque de arquitectura anunciado en Google I / O 2017.

También incluye una nueva biblioteca ORM llamada Room

Contiene tres componentes principales: @Entity, @Dao y @Database

User.java

@Entity
public class User {
  @PrimaryKey
  private int uid;

  @ColumnInfo(name = "first_name")
  private String firstName;

  @ColumnInfo(name = "last_name")
  private String lastName;

  // Getters and setters are ignored for brevity,
  // but they're required for Room to work.
}

UsuarioDao.java

@Dao
public interface UserDao {
  @Query("SELECT * FROM user")
  List<User> getAll();

  @Query("SELECT * FROM user WHERE uid IN (:userIds)")
  List<User> loadAllByIds(int[] userIds);

  @Query("SELECT * FROM user WHERE first_name LIKE :first AND "
       + "last_name LIKE :last LIMIT 1")
  User findByName(String first, String last);

  @Insert
  void insertAll(User... users);

  @Delete
  void delete(User user);
}

AppDatabase.java

@Database(entities = {User.class}, version = 1)
public abstract class AppDatabase extends RoomDatabase {
  public abstract UserDao userDao();
}

Habiendo tenido algunos problemas, creo que he entendido por qué me he estado equivocando.

Había escrito una clase de contenedor de base de datos que incluía una close()que llamaba al asistente de cierre como un espejo de la open()que llamaba getWriteableDatabase y luego había migrado a una ContentProvider. El modelo para ContentProviderno utiliza, SQLiteDatabase.close()lo que creo que es una gran pista, ya que el código sí lo hace. getWriteableDatabaseEn algunos casos, todavía estaba haciendo acceso directo (consultas de validación de pantalla en general, así que migré a un modelo getWriteableDatabase / rawQuery.

Yo uso un singleton y hay un comentario ligeramente ominoso en la documentación cercana

Cerrar cualquier objeto de base de datos abierto

(Mi negrita).

Así que he tenido bloqueos intermitentes donde uso hilos de fondo para acceder a la base de datos y se ejecutan al mismo tiempo que en primer plano.

Por lo tanto, creo que close()obliga a la base de datos a cerrarse independientemente de cualquier otro subproceso que contenga referencias, por close()lo que no solo deshace la coincidencia, getWriteableDatabasesino que fuerza el cierre de cualquier solicitud abierta. La mayoría de las veces esto no es un problema, ya que el código es de un solo subproceso, pero en casos de subprocesos múltiples siempre existe la posibilidad de abrir y cerrar la sincronización.

Después de leer los comentarios en otros lugares que explican que la instancia del código SqLiteDatabaseHelper cuenta, entonces la única vez que desea un cierre es donde desea la situación en la que desea hacer una copia de seguridad, y desea forzar el cierre de todas las conexiones y obligar a SqLite a escriba cualquier material almacenado en caché que pueda estar merodeando; en otras palabras, detenga toda la actividad de la base de datos de la aplicación, cierre en caso de que el Asistente haya perdido la pista, realice cualquier actividad a nivel de archivo (copia de seguridad / restauración) y luego comience de nuevo.

Aunque parece una buena idea intentar cerrar de forma controlada, la realidad es que Android se reserva el derecho de tirar a la basura su VM, por lo que cualquier cierre está reduciendo el riesgo de que no se escriban actualizaciones en caché, pero no se puede garantizar si el dispositivo está estresado, y si ha liberado correctamente sus cursores y referencias a bases de datos (que no deberían ser miembros estáticos), el ayudante habrá cerrado la base de datos de todos modos.

Entonces, mi opinión es que el enfoque es:

Use getWriteableDatabase para abrir desde un contenedor singleton. (Usé una clase de aplicación derivada para proporcionar el contexto de la aplicación desde una estática para resolver la necesidad de un contexto).

Nunca llame directamente al cierre.

Nunca almacene la base de datos resultante en ningún objeto que no tenga un alcance obvio y confíe en el recuento de referencias para desencadenar un cierre implícito ().

Si realiza el manejo a nivel de archivo, detenga toda la actividad de la base de datos y luego cierre la llamada solo en caso de que haya un subproceso fuera de control en el supuesto de que escriba transacciones adecuadas para que el subproceso fallido y la base de datos cerrada al menos tenga las transacciones adecuadas en lugar que potencialmente una copia a nivel de archivo de una transacción parcial.

Sé que la respuesta llega tarde, pero la mejor manera de ejecutar consultas sqlite en Android es a través de un proveedor de contenido personalizado. De esa manera, la interfaz de usuario se desacopla con la clase de base de datos (la clase que extiende la clase SQLiteOpenHelper). También las consultas se ejecutan en un hilo de fondo (Cursor Loader).