ORM 框架之 GreenDao

最新推荐文章于 2024-05-04 14:16:27 发布

wxx614817

最新推荐文章于 2024-05-04 14:16:27 发布

阅读量441

点赞数 1

分类专栏：开源项目文章标签： Android orm greenDAO

开源项目专栏收录该内容

46 篇文章 1 订阅

订阅专栏

ORM 框架之 GreenDao（一）基本使用

GreenDao 是在 Android 开发中广泛使用的数据库框架，其优点是运行效率高，内存消耗少，性能佳（没有考证，网上说的）
其它一些常用的数据库框架有：

目前还在更新中的有 LitePal，realm。本篇博客只讲 GreenDao 相关知识

首先附上 GreenDao 官网和 github 地址
GreenDao github
GreenDao 官网

如何使用 GreenDao

在 Android 工程中配置 GreenDao Generater 模块

说白了就是配置 GreenDao 生成的代码块存放路径

首先在 src/main 目录下新建与 java 同级的 java-gen 目录
在 app 的 build.gradle 中的 android 模块中添加如下代码

 sourceSets {
        main {
            java.srcDirs = ['src/main/java', 'src/main/java-gen']
        }
    }

并添加依赖 compile ’org.greenrobot:greendao:2.2.0‘

新建 GreenDao Generator 模块（Java 工程）

新建一个 Java 工程，File -> New -> New Module -> Java Library

在新建的 Java 工程中的 build.gradle 中加入依赖 compile ’org.greenrobot:greendao-generator:2.2.0‘
定义一个 Schema，Schema schema = new Schema(1, "com.sivan.greendaopractice");
- 第一个参数为版本号
- 第二个参数为包名
编写添加实体类的代码，如下

 // 一个实体类对应一张数据库表，此处表名为 PERSON （即类名）
 Entity person = schema.addEntity("Person");
 // 也可以重新命名表名
 // person.setTableName("People");
 // 定义一个主键
 person.addIdProperty().primaryKey();
 // 定义一个非空的列，列名为 NAME
 person.addStringProperty("name").notNull();
 // 可以使用此方法定义实体类的属性名和数据库的列名不同，如下实体类名为 sex，列名为_SEX
 person.addStringProperty("sex").columnName("_sex");

最后生成实体类 new DaoGenerator().generateAll(schema, "../GreenDaoPractice/app/src/main/java-gen")
- 第一个参数为 schema
- 第二个参数为文件生成路径

完整代码如下：

public class GreenDaoGenerate {
 public static void main(String[] args) throws Exception {
  Schema schema = new Schema(1, "com.sivan.greendaopractice");
  addPerson(schema);
  new DaoGenerator().generateAll(schema, "../GreenDaoPractice/app/src/main/java-gen");
 }

 private static void addPerson(Schema schema) {
  Entity person = schema.addEntity("Person");
  person.addIdProperty().primaryKey();
  person.addStringProperty("name").notNull();
  person.addStringProperty("sex").columnName("_sex");
 }
}

运行 Java 工程

如果出下下面的提示，表示成功了

接下来看一下 Android 工程中的 java-gen 目录

在 Android 工程中进行数据库操作

接下来我们就可以对数据库进行 CRUD （增删改查）操作了
具体看代码，基本上都有注释了

public class MainActivity extends AppCompatActivity {
 @BindView(R.id.et_name)
 EditText mEtName;
 @BindView(R.id.et_sex)
 EditText mEtSex;
 @BindView(R.id.list_view)
 ListView mListView;
 @BindView(R.id.et_id)
 EditText mEtId;
 private DaoMaster.DevOpenHelper mHelper;
 private SQLiteDatabase db;
 private DaoSession mDaoSession;
 private DaoMaster mDaoMaster;
 private PersonDao mPersonDao;
 private Cursor cursor;
 private SimpleCursorAdapter mCursorAdapter;
 private String name;
 private String sex;
 private String id;

 @Override
 protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.activity_main);
  ButterKnife.bind(this);

  // 第一个参数为 context，第二个参数为数据库表名，第三个参数通常为 null
  mHelper = new DaoMaster.DevOpenHelper(this, "test-db", null);
  db = mHelper.getWritableDatabase();
  mDaoMaster = new DaoMaster(db);
  mDaoSession = mDaoMaster.newSession();
  // 得到 Dao 对象，数据库的 CRUD 操作都是通过此对象来进行
  mPersonDao = mDaoSession.getPersonDao();
  // 遍历表中所有的数据
  cursor = db.query(mPersonDao.getTablename(), mPersonDao.getAllColumns(), null, null, null, null, null);
  // 通过 PersonDao 的静态内部类得到字段所对应的 列名
  String[] from = {PersonDao.Properties.Name.columnName, PersonDao.Properties.Sex.columnName};
  int[] to = {android.R.id.text1, android.R.id.text2};
  // 使用 SimpleCursorAdapter 将数据库中的数据展示到 ListView 上
  mCursorAdapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, cursor, from, to, Adapter.NO_SELECTION);
  mListView.setAdapter(mCursorAdapter);
 }
 private void search() {
  // 通过构建 QueryBuilder 来实现查询功能
  QueryBuilder<Person> queryBuilder = mPersonDao.queryBuilder().where(PersonDao.Properties.Name.eq(name));
  // .list() 方法会返回实体类集合
  List<Person> persons = queryBuilder.list();
  // 如果想得到唯一的结果，使用 .unique() 方法
  // Person person = queryBuilder.unique();
  new AlertDialog.Builder(this).setMessage(persons != null && persons.size() > 0 ? persons.get(0).getName() + "-->" + persons.get(0).getSex() : "查无此数据").setPositiveButton("确定", null).create().show();
 }

 private void add() {
  Person person = new Person(null, name, sex);
  // 通过 insert 方法向数据库中添加数据，因为设置了 id 为主键，所以这里 id 填 null
  mPersonDao.insert(person);
 }

 @OnClick({R.id.btn_add, R.id.btn_search, R.id.btn_update, R.id.btn_delete})
 public void onClick(View view) {
  name = mEtName.getText().toString().trim();
  sex = mEtSex.getText().toString().trim();
  id = mEtId.getText().toString().trim();
  switch (view.getId()) {
    case R.id.btn_add:
     add();
     break;
    case R.id.btn_search:
     search();
     break;
    case R.id.btn_update:
     update();
     break;
    case R.id.btn_delete:
     delete();
     break;
  }
  Cursor cursor = db.query(mPersonDao.getTablename(), mPersonDao.getAllColumns(), null, null, null, null, null);
  // 通过交换 cursor 来更新 UI
  mCursorAdapter.swapCursor(cursor);
 }

 private void delete() {
  // 通过主键来删除数据
  mPersonDao.deleteByKey(Long.valueOf(id));
  // 删除所有
  // mPersonDao.deleteAll();
 }

 private void update() {
  // 通过 update 方法更新数据库中的数据
  mPersonDao.update(new Person(Long.valueOf(id), name, sex));
 }
}

GreenDao 的基本使用就介绍这么多，下一篇博客中我会讲一下 GreenDao 的一些高级用法

=====================================================================================

ORM 框架之 GreenDao（二）高级用法

notNull() 约束此属性不可为空
实体类的继承、接口、导包以及序列化

    person.implementsSerializable(); // 序列化
    person.implementsInterface("com.sivan.A"); // 实现 A 接口
    person.setSuperclass("com.sivan.B"); // 继承 B 类
    person.addImport("com.sivan.C"); // 导包

添加代码或注释

entity.setCodeBeforeClass("") // 在类前添加代码
// 在 `name` 属性前添加注解
entity.addStringProperty("abstract").codeBeforeField("@SerializableName(_abstract)"); 
// 这些方法很简单，看名字就知道什么意思了，就不再解释了
entity.addStringProperty("test").codeBeforeSetter("").codeBeforeGetter("").codeBeforeGetterAndSetter("");

设置不同的属性名和数据库列名

// 设置实体类名为 age，数据库列名为 _age
entity.addStringProperty("age").columnName("_age");

有些时候，我们会在生成的实体类中添加一些属性和方法，但是每次重新运行 Java 项目的时候都会覆盖掉以前的代码，如果不想覆盖自己添加的代码，可以这样设置：

schema.enableKeepSectionsByDefault(); // 通过此 schema 创建的实体类都不会覆盖自定义的代码
entity.setHasKeepSections(true); // 此实体类不会覆盖自定义的代码

通过上述方法运行 Java 项目后，会在实体类中多出以下注释代码

// KEEP INCLUDES - put your custom includes here
在这里添加自定义的引用
// KEEP INCLUDES END

// KEEP FIELDS - put your custom fields here
在这里添加自定义属性
// KEEP FIELDS END

// KEEP METHODS - put your custom methods here
在这里添加自定义的方法
// KEEP METHODS END

注意：自定义的代码要写在注释中，并且注释代码不要修改

暂时就想到这么多，以后有可能会补充，下一篇博客会讲一下如何使用 GreenDao 实现数据库的多表关联，即一对一，一对多，多对多的关系

=========================================================================================

ORM 框架之 GreenDao（三）多表关联

GreenDao 中，实体间的关联通过 to-one 和 to-many 来实现。

一对一

在 GreenDao 中实现一对一的关联需要讲一个实体类的主键作为另一个实体类的外键。
比如一个 Person 有一个 IDCard（身份证），这两者是一一对应的关系，同时，Person有 name（主键）、sex 和 age 三个属性，
IDCard 有 CardId 和 CardId（主键）和 Validity 两个属性。
那么可以将 Person 的主键作为 IDCard 的外键，将 IDCard 的主键作为 Person 的外键：

    Entity person = schema.addEntity("Person");
    person.addStringProperty("name").primaryKey();
    person.addStringProperty("sex");
    person.addLongProperty("age");

    Entity idCard = schema.addEntity("IDCard");
    idCard.addLongProperty("cardId").primaryKey();
    idCard.addLongProperty("validity");

    // 两个实体类通过 Property 来建立关联，此操作会在 person 表中增加一个外键，此外键是 idCard 表中的主键
    Property personProperty = person.addLongProperty("cardId").getProperty();
    // 第一个参数为目标实体类，第二个参数为此表中的外键属性
    person.addToOne(idCard, personProperty);

    Property idCardProperty = idCard.addStringProperty("name").getProperty();
    idCard.addToOne(person, idCardProperty);

注意：当使用多表关联的时候，就不要添加 id 主键了，因为需要将主键作为其它表的外键来使用

一对多

比如一个人去购物，会产生很多订单，一个人会有很多订单，但每个订单只能是一个人的，这样就会产生一对多的关联
这时需要将 Person 的主键作为 Order 的外键，因为我们可以通过订单找到唯一的 Person

    Entity order = schema.addEntity("Order");
    order.addLongProperty("orderId").primaryKey();
    order.addLongProperty("money").notNull();

    Property orderProperty = order.addStringProperty("name").getProperty();

    // 构建一对多的关联
    // 第一个参数为目标实体，第二个参数为目标属性，也就是 person 的主键（order 的外键）,第三个参数为属性名
    person.addToMany(order, orderProperty, "orders");
    // 订单对用户为一对一的关联
    order.addToOne(person, orderProperty);

这样在生成的实体类中 Person 实体中会多出 List<Order> orders 的属性，并且提供了 getOrders()方法来得到用户的所有订单
Order 实体类中会多出 name 属性，也就是 Person 表的主键，同时也提供了 getPerson()方法来得到该订单对应的用户

多对多

GreenDao 不支持多对多的关系，但是，我们可以通过其它方法来实现。
实现多对多关联需要建立一张中间表，其它两张表都要与中间表构建一对多的关联。
比如学生与课程之间的连系，一个学生可以选择多种课程，而一个课程可以被多个学生选择

    Entity course = schema.addEntity("Course");
    course.addLongProperty("courseId").primaryKey();
    course.addStringProperty("courseName").notNull();

    // 中间表有其它两个表的主键作为外键
    Entity personCourse = schema.addEntity("PersonCourse");
    Property personName = personCourse.addStringProperty("name").getProperty();
    Property courseId = personCourse.addLongProperty("courseId").getProperty();

    // 分别构建一对多的关联
    person.addToMany(personCourse, personName);
    course.addToMany(personCourse, courseId);

    personCourse.addToOne(person, personName);
    personCourse.addToOne(course, courseId);

这样生成的实体类中，Person 和 Course 实体中都会有 List<PersonCourse> personCourseList 属性，
再来看一下 PersonCourse 实体类，有 getPerson() 和 getCourse() 方法获得相应的学生和课程。
这样，我们通过学生和课程得到 PersonCourse 的集合后，通过这两个方法就可以得到相应的学生或者课程的信息

wxx614817

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
ORM 框架之 GreenDao

相关： ORM 框架之 GreenDao（一）基本使用 ORM 框架之 GreenDao（二）高级用法 ORM 框架之 GreenDao（三）多表关联 Android数据库greenDAO框架用法和源码分析 Android开源：数据库ORM框架GreenDao学习心得及使用总结
复制链接

扫一扫

专栏目录