Android OrmLite 超过 SQLite 的例子

ORMLite 是一个对象关系映射包，它提供简单和轻量级的功能，用于将 Java 对象持久化到 SQL 数据库，同时避免更多标准 ORM 包的复杂性和开销。

对于 Android，OrmLite 是通过开箱即用的支持数据库 SQLite 实现的。它直接调用 API 来访问 SQLite。

Gradle 设置

要开始，你应该将包包含在构建 gradle 中。

 // 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 和其他人。
• 为每个类添加一个无参数构造函数，至少包可见性。

 @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;
    }
}

在上面的示例中，有一个包含 4 个字段的表（form_model）。

id 字段是自动生成的索引。

username 是数据库的索引。

有关注释的更多信息，请参阅官方文档 。

数据库助手

要继续，你需要创建一个数据库助手类，该类应该扩展 OrmLiteSqliteOpenHelper 类。

此类在安装应用程序时创建并升级数据库，还可以提供其他类使用的 DAO 类。

DAO 代表数据访问对象，它提供所有的 Scrum 功能，专门处理单个持久化类。

辅助类必须实现以下两种方法：

• onCreate（SQLiteDatabase sqliteDatabase，ConnectionSource connectionSource）;

  onCreate 在首次安装应用程序时创建数据库

• onUpgrade（SQLiteDatabase 数据库，ConnectionSource connectionSource，int oldVersion，int newVersion）;

  将应用程序升级到新版本时，onUpgrade 会处理数据库表的升级

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;
        }
    }

将对象持久化到 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;
}