美文网首页
GreenDao的使用

GreenDao的使用

作者: wzg_gitee | 来源:发表于2020-11-03 16:03 被阅读0次

1.库
GreenDao是一个开源的 Android ORM嵌入式关系数据库,通过将 Java 对象映射到数据库表(称为 ORM,“对象/关系映射”) ,使用一个简单的面向对象的 API 来存储、更新、删除和查询 Java 对象。

2.gitHub地址:

https://github.com/greenrobot/greenDAO

3.配置

buildscript {
    repositories {
        google()
        jcenter()
        // GreenDao仓库
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.4'
        // GreenDao插件
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
    }
}

4.app配置:

apply plugin: 'com.android.application'
//GreenDao插件
apply plugin: 'org.greenrobot.greendao'
implementation 'org.greenrobot:greendao:3.2.2'
greendao {
    // 数据库版本号
    schemaVersion 1
    // 生成数据库文件的目录
    targetGenDir 'src/main/java'
    // 生成的数据库相关文件的包名
    daoPackage 'com.xxx.greendao.gen'
}

5.相关的注解:

@Entity:告诉GreenDao该对象为实体,只有被@Entity注释的Bean类才能被dao类操作

@Id:对象的Id,使用Long类型作为EntityId,否则会报错。(autoincrement = true)表示主键会自增,如果false就会使用旧值

@Property:可以自定义字段名,注意外键不能使用该属性

@NotNull:属性不能为空

@Transient:使用该注释的属性不会被存入数据库的字段中

@Unique:该属性值必须在数据库中是唯一值

@Generated:编译后自动生成的构造函数、方法等的注释,提示构造函数、方法等不能被修改

6.使用比较简单:
实体类建完毕后,通过点击AndroidStudio中的Make Project(小锤子的图标),便发现GreenDao为我们的User实体类生成了对应的Getter、Setter方法以及俩个构造函数,同时在我们配置的com.xxx.greendao.gen包下生成了三个对应类文件DaoMaster、DaoSession和UserDao,之后所有相关的数据库操作都依靠这三个文件了:

DaoMaster:使用greenDAO的切入点。DaoMaster保存数据库对象(SQLiteDatabase)并管理特定模式的DAO类(而不是对象)。 它具有静态方法来创建表或将它们删除。 其内部类OpenHelper和DevOpenHelper是在SQLite数据库中创建模式的SQLiteOpenHelper实现。一个DaoMaster就代表着一个数据库的连接;
DaoSession:管理特定模式的所有可用DAO对象,您可以使用其中一个getter方法获取。 DaoSession还为实体提供了一些通用的持久性方法,如插入,加载,更新,刷新和删除。 DaoSession可以让我们使用一些Entity的基本操作和获取Dao操作类,DaoSession可以创建多个,每一个都是属于同一个数据库连接的;
XxDAO:数据访问对象(DAO)持续存在并查询实体。 对于每个实体,GreenDAO生成一个DAO。 它比DaoSession有更多的持久化方法,例如:count,loadAll和insertInTx等。

7.以下代码均是他人之作,有侵权行为请联系本人删除:
1.实体类:

@Entity
public class User {

    @Id(autoincrement = true)
    private Long id;

    @Unique
    private String userId;

    @Property
    private String userName;

    @Property
    private int age;

}

2.编写DaoManager,用于创建数据库、创建数据库表、包含增删改查的操作。

/**
 * 创建数据库、创建数据库表、包含增删改查的操作 
 */
public class DaoManager {
    private static final String TAG = DaoManager.class.getSimpleName();
    private static final String DB_NAME = "RECORD_DB";

    private Application mApplication;

    //多线程中要被共享的使用volatile关键字修饰
    private volatile static DaoManager manager = new DaoManager();
    private DaoMaster mDaoMaster;
    private DaoMaster.DevOpenHelper mHelper;
    private DaoSession mDaoSession;

    /**
     * 单例模式获得操作数据库对象
     */
    public static DaoManager getInstance() {
        return manager;
    }

    private DaoManager() {
        setDebug();
    }

    public void init(Application application) {
        this.mApplication = application;
    }

    /**
     * 判断是否有存在数据库,如果没有则创建
     */
    public DaoMaster getDaoMaster() {
        if (mDaoMaster == null) {
            DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(mApplication, DB_NAME, null);
            mDaoMaster = new DaoMaster(helper.getWritableDatabase());
        }
        return mDaoMaster;
    }

    /**
     * 完成对数据库的添加、删除、修改、查询操作,仅仅是一个接口
     */
    public DaoSession getDaoSession() {
        if (mDaoSession == null) {
            if (mDaoMaster == null) {
                mDaoMaster = getDaoMaster();
            }
            mDaoSession = mDaoMaster.newSession();
        }
        return mDaoSession;
    }

    /**
     * 打开输出日志,默认关闭
     */
    public void setDebug() {
        if (BuildConfig.DEBUG) {
            QueryBuilder.LOG_SQL = true;
            QueryBuilder.LOG_VALUES = true;
        }
    }

    /**
     * 关闭所有的操作,数据库开启后,使用完毕要关闭
     */
    public void closeConnection() {
        closeHelper();
        closeDaoSession();
    }

    public void closeHelper() {
        if (mHelper != null) {
            mHelper.close();
            mHelper = null;
        }
    }

    public void closeDaoSession() {
        if (mDaoSession != null) {
            mDaoSession.clear();
            mDaoSession = null;
        }
    }
}

3.编写CommonDaoUtils,用于完成对数据表的操作。

public class CommonDaoUtils<T> {

    private DaoSession mDaoSession;
    private Class<T> entityClass;
    private AbstractDao<T, Long> entityDao;

    public CommonDaoUtils(Class<T> pEntityClass, AbstractDao<T, Long> pEntityDao) {
        DaoManager mManager = DaoManager.getInstance();
        mDaoSession = mManager.getDaoSession();
        entityClass = pEntityClass;
        entityDao = pEntityDao;
    }

    /**
     * 插入记录,如果表未创建,先创建表
     */
    public boolean insert(T pEntity) {
        return entityDao.insert(pEntity) != -1;
    }

    /**
     * 插入多条数据,在子线程操作
     */
    public boolean insertMultiple(final List<T> pEntityList) {
        try {
            mDaoSession.runInTx(new Runnable() {
                @Override
                public void run() {
                    for (T entity : pEntityList) {
                        mDaoSession.insertOrReplace(entity);
                    }
                }
            });
            return true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

    /**
     * 修改一条数据
     */
    public boolean update(T entity) {
        try {
            mDaoSession.update(entity);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

    /**
     * 删除单条记录
     */
    public boolean delete(T entity) {
        try {
            //按照id删除
            mDaoSession.delete(entity);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

    /**
     * 删除所有记录
     */
    public boolean deleteAll() {
        try {
            //按照id删除
            mDaoSession.deleteAll(entityClass);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
    }

    /**
     * 查询所有记录
     */
    public List<T> queryAll() {
        return mDaoSession.loadAll(entityClass);
    }

    /**
     * 根据主键id查询记录
     */
    public T queryById(long key) {
        return mDaoSession.load(entityClass, key);
    }

    /**
     * 使用native sql进行查询操作
     */
    public List<T> queryByNativeSql(String sql, String[] conditions) {
        return mDaoSession.queryRaw(entityClass, sql, conditions);
    }

    /**
     * 使用queryBuilder进行查询
     */
    public List<T> queryByQueryBuilder(WhereCondition cond, WhereCondition... condMore) {
        QueryBuilder<T> queryBuilder = mDaoSession.queryBuilder(entityClass);
        return queryBuilder.where(cond, condMore).list();
    }
}

3.编写DaoUtilsStore,用于存放及提取DaoUtils。

/**
 * 初始化、存放及获取DaoUtils
 */
public class DaoUtilsStore {
    private volatile static DaoUtilsStore instance = new DaoUtilsStore();
    private CommonDaoUtils<User> mUserDaoUtils;

    public static DaoUtilsStore getInstance() {
        return instance;
    }

    private DaoUtilsStore() {
        DaoManager mManager = DaoManager.getInstance();
        UserDao _UserDao = mManager.getDaoSession().getUserDao();
        mUserDaoUtils = new CommonDaoUtils<>(User.class, _UserDao);
    }

    public CommonDaoUtils<User> getUserDaoUtils() {
        return mUserDaoUtils;
    }

}

4.调用DaoUtilsStore,进行数据操作及查看:
初始化生成数据,进行批量插入:

private void initUser() {

    //用户ID生成器
    mIdWorker = new SnowflakeIdGenerator(0, 0);

    DaoUtilsStore.getInstance().getUserDaoUtils().deleteAll();

    mUserList = new ArrayList<>();
    Random random = new Random();
    for (int i = 0; i < 10; i++) {
        User user = new User();
        user.setId((long) i);
        user.setUserId(String.valueOf(mIdWorker.nextId()));
        // 随机生成汉语名称
        user.setUserName(NameUtils.createRandomZHName(random.nextInt(4) + 1));
        user.setAge(18 + random.nextInt(10));
        mUserList.add(user);
    }

    mUserAdapter = new UserAdapter(mUserList);
    rvUser.setAdapter(mUserAdapter);

    DaoUtilsStore.getInstance().getUserDaoUtils().insertMultiple(mUserList);
}

查询数据

private void queryAllUser() {
    mUserList = DaoUtilsStore.getInstance().getUserDaoUtils().queryAll();
    mUserAdapter.setNewData(mUserList);
    rvUser.smoothScrollToPosition(mUserList.size() - 1);
}

插入数据

User user = new User();
user.setId((long) mUserList.size());
user.setUserId(String.valueOf(mIdWorker.nextId()));
user.setUserName(NameUtils.createRandomZHName(new Random().nextInt(4) + 1));
user.setAge(18 + new Random().nextInt(10));

// 插入新用户
DaoUtilsStore.getInstance().getUserDaoUtils().insert(user);

修改数据

User user = mUserList.get(mUserList.size() - 1);

//删除最末用户
DaoUtilsStore.getInstance().getUserDaoUtils().delete(user);

删除数据

User user = mUserList.get(mUserList.size() - 1);
user.setUserName(NameUtils.createRandomZHName(new Random().nextInt(4) + 1));

//更新最末用户
DaoUtilsStore.getInstance().getUserDaoUtils().update(user);

8.升级:
一下都是别人的代码,如有侵权,请联系本人删除:

相关文章

网友评论

      本文标题:GreenDao的使用

      本文链接:https://www.haomeiwen.com/subject/ubbrvktx.html