GreenDao 3.0解析

老马的编程之旅

发布于 2022-06-22 09:53:21

6300

发布于 2022-06-22 09:53:21

文章被收录于专栏：深入理解Android

GreenDao 3.0简介：在Android开发中，数据缓存的开发可能会使用到SQLite，然而在使用它的时候，我们往往要进行许多额外的工作，编写原生的SQL语句与解析查询结果等。所以适应Android的ORM框架就产生了。目前较为流行的Android的ORM框架就是GreenDao, ORM就是关系映射（Object Relation Mapping），即对象关系映射。它的实现思想就是将关系数据库中表的数据映射为对象，以对象的形式展现，这样开发人员就可以把数据库的操作转化为对这些对象的操作。因此它的目的就是为了方便开发人员用面向对象的思想来实现数据库的操作。

大家应该对ORM框架有了初步的了解，下面我们就来使用GreenDao，我们就通过GreenDao的官网，http://greenrobot.org/greendao/ ，来学习如何对它进行使用。

从图中我们可以知道GreenDao已经升级到了3.0版本，相比之前的旧版本，3.0版本采用注解的方式通过编译方式生成Java数据对象和DAO对象。相比之前需要通过新建GreenDaoGenerator工程生成Java数据对象（实体）和DAO对象，大大减少了使用的成本。

GreenDao 3.0使用我们跟着官网的步骤来对学习如何使用GreenDao 3.0 1) 导入相关的包

根据上面的内容，我们需要在在gradle的dependencies中导入如下内容

compile 'org.greenrobot:greendao:3.0.1'
compile 'org.greenrobot:greendao-generator:3.0.0'

2) 配置gradle

官网上说，GreenDao 3.0通过一个新的插件来生成代码，这个插件会去浏览所有的被Entity注释的类去收集表信息，并生成3个类，DaoSession,DaoMaster,和所有的Dao类。使用这个插件的话，需要在gradle中配置如下的内容

apply plugin: 'org.greenrobot.greendao'

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.greenrobot:greendao-gradle-plugin:3.0.0'
    }
}

同时一般我们还会添加如下的内容

greendao {
    schemaVersion 1
    daoPackage 'com.example.jikeyoujikeyou.greendao2'
    targetGenDir 'src/main/java'
}

需要说明一下含义： schemaVersion:指定数据库schema版本号，迁移等操作会用到 daoPackage:通过gradle插件生成的数据库相关文件的包名，默认为你的entity所在的包名 targetGenDir:这就是我们上面说到的自定义生成数据库文件的目录了，可以将生成的文件放到我们的java目录中，而不是build中，这样就不用额外的设置资源目录了 3) 新建实体类以下为基础属性注解

@Id :主键 long/Long型，可以通过@Id(autoincrement = true)设置自增长 @Property：设置一个非默认关系映射所对应的列名，默认是的使用字段名举例：@Property (nameInDb=”name”) @NotNul：设置数据库表当前列不能为空 @Transient ：添加次标记之后不会生成数据库表的列

@Entity
public class User {

    @Id(autoincrement = true)
    private Long id;
    private String name;
    @Transient
    private int tempUsageCount; // not persisted
   }

我们在新建实体类的时候，id是我们数据库表的主键，上面代码中我给id使用自增长的注解，如果这里不设置的话，我们就需要在创建User对象的时候给id赋值，如果不这样做，就会报出空指针的异常。

上面为索引注解 @Index：使用@Index作为一个属性来创建一个索引，通过name设置索引别名，也可以通过unique给索引添加约束 @Unique：向数据库列添加了一个唯一的约束

关系注解 @ToOne：定义与另一个实体（一个实体对象）的关系 @ToMany：定义与多个实体对象的关系接下来让我们点击as中Build菜单栏中的Make Project，make完成之后会发现我们的User类中突然多了好多代码，这就是GreenDAO自动为你生成的了，代码如下

@Entity
public class User {
    @Id(autoincrement = true)
    private Long id;

    private String name;
    private int age;

    public int getAge() {
        return this.age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getName() {
        return this.name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Long getId() {
        return this.id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    @Generated(hash = 1309193360)
    public User(Long id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    @Generated(hash = 586692638)
    public User() {
    }

}

Make Project后生成了如下的类：

4) 使用GreenDAO进行增删改查这里我都封装在了一个类DBManager之中

public class DBManager {
    private static final String dbName = "DBdemo";

    private static DBManager mInstance;

    private final Context context;

    private DaoMaster.DevOpenHelper openHelper;

    private DBManager(Context context) {
        this.context = context;
        openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);

    }

    //单例模式
    public static DBManager getInstance(Context context) {
        if (mInstance == null) {
            synchronized (DBManager.class) {
                if (mInstance == null) {
                    mInstance = new DBManager(context);
                }
            }
        }
        return mInstance;
    }

    //可读数据库
    private SQLiteDatabase getReadableDatabase() {
        if (openHelper == null) {
            openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);

        }
        SQLiteDatabase db = openHelper.getReadableDatabase();
        return db;
    }

    //可写数据库
    private SQLiteDatabase getWritableDatabase() {
        if (openHelper == null) {
            openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);

        }
        SQLiteDatabase db = openHelper.getWritableDatabase();
        return db;
    }

    //插入数据
    public void insertUser(User user) {
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.insert(user);
    }

    //插入数据集合
    public void insertUserList(List<User> users) {
        if (users == null || users.isEmpty()) {
            return;
        }
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.insertInTx(users);
    }

    //删除数据
    public void deleteUser(User user) {
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.delete(user);
    }

    //更新数据
    public void updateUser(User user) {
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.update(user);
    }
    /*
    *
    * 查询用户列表
    */

    public List<User> queryUserList() {
        DaoMaster daoMaster = new DaoMaster(getReadableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        QueryBuilder<User> qb = userDao.queryBuilder();
        List<User> list = qb.list();
        return list;
    }


}

对上述代码说明一下： (1) 一个DaoMaster就代表着一个数据库的连接；DaoSession可以让我们使用一些Entity的基本操作和获取Dao操作类，DaoSession可以创建多个，每一个都是属于同一个数据库连接的。 (2) 通过userDao的queryBuilder()方法，生成一个查找构造器，可以给构造器添加where条件判断、按照某某字段排序以及查询的条数等基本的数据库操作。list()方法表示查询的结果为一个集合。 5) 进行试验接下来，我在MainAcitivty写入如下代码，进行试验

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        testDBManager();
    }

    private void testDBManager() {

        DBManager dbManager = DBManager.getInstance(this);
        for (int i = 0; i < 10; i++) {
            User user = new User();

            user.setAge(i * 3);
            user.setName("我是第" + i + "选手");
            dbManager.insertUser(user);
        }

        List<User> userList = dbManager.queryUserList();

        for (User user : userList) {
            Log.e("MainActivity", "queryUserList--before-->" + user.getId() + "--" + user.getName() + "--" + user.getAge());

            if (user.getId() == 5) {
                user.setAge(17);
                dbManager.updateUser(user);
            }

            if (user.getId() == 7) {
                dbManager.deleteUser(user);
            }
        }
        userList = dbManager.queryUserList();
        for (User user : userList) {
            Log.e("MainActivity", "queryUserList--after--->" + user.getId() + "---" + user.getName() + "--" + user.getAge());

        }
    }
}

运行程序，输出如下内容，说明使用GreenDAO成功！