greenDao框架使用心得

最新推荐文章于 2024-04-10 04:18:08 发布
最新推荐文章于 2024-04-10 04:18:08 发布
阅读量2.2k 收藏 3
点赞数
分类专栏： Android数据存储 Android框架 文章标签： Android ORM greenDAO 数据存储

原文：http://itangqi.me/android/using-greendao-experience/ 

文章转自：http://www.open-open.com/lib/view/open1438065400878.html#_label0

前言

我相信，在平时的开发过程中，大家一定会或多或少地接触到 SQLite。然而在使用它时，我们往往需要做许多额外的工作，像编写 SQL 语句与解析查询结果等。所以，适用于 Android 的ORM 框架也就孕育而生了，现在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 与 GreenDAO。而今天的主角便是 greenDAO，下面，我将详解地介绍如何在 Android Studio 上使用 greenDAO，并结合代码总结一些使用过程中的心得。

关于 greenDAO

Android ORM 框架之 greenDAO 使用心得

简单的讲，greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案。（greenDAO is a light & fast ORM solution that maps objects to SQLite databases.） 
而关于 ORM （Object Relation Mapping - 对象关系映射）的概念，可参见 Wikipedia。

GREENDAO 设计的主要目标

  • 一个精简的库

  • 性能最大化

  • 内存开销最小化

  • 易于使用的 APIs

  • 对 Android 进行高度优化

GREENDAO 设计的主要特点

  • greenDAO 性能远远高于同类的 ORMLite，具体测试结果可见官网

  • greenDAO 支持 protocol buffer(protobuf) 协议数据的直接存储，如果你通过 protobuf 协议与服务器交互，将不需要任何的映射。

  • 与 ORMLite 等使用注解方式的 ORM 框架不同，greenDAO 使用「Code generation」的方式，这也是其性能能大幅提升的原因。

DAO CODE GENERATION PROJECT

Android ORM 框架之 greenDAO 使用心得

这是其核心概念：为了在我们的 Android 工程中使用 greenDAO ，我们需要另建一个纯 Java Project，用于自动生成后继 Android 工程中需要使用到的 Bean、DAO、DaoMaster、DaoSession 等类。

CORE CLASSES & MODELLING ENTITIES

关于以上几个类的相关概念与作用，我将在下面的代码（注释）中详细讲解。
当然，你也可以在 官网 中找到相关介绍。

让我们开始吧

一. 在 ANDROID 工程中配置「GREENDAO GENERATOR」模块

  1. 在 .src/main 目录下新建一个与 java 同层级的「java-gen」目录，用于存放由 greenDAO 生成的 Bean、DAO、DaoMaster、DaoSession 等类。 
    Android ORM 框架之 greenDAO 使用心得Android ORM 框架之 greenDAO 使用心得

  2. 配置 Android 工程（app）的 build.gradle，如图分别添加 sourceSets 与dependencies。 Android ORM 框架之 greenDAO 使用心得

1
2
3
4
5
sourceSets {
         main {
             java.srcDirs = [ 'src/main/java' ,  'src/main/java-gen' ]
         }
     }
1
compile  'de.greenrobot:greendao:1.3.7'


二. 新建「GREENDAO GENERATOR」模块 (纯 JAVA 工程）

  1. 通过 File -> New -> New Module -> Java Library -> 填写相应的包名与类名 -> Finish.
    Android ORM 框架之 greenDAO 使用心得Android ORM 框架之 greenDAO 使用心得Android ORM 框架之 greenDAO 使用心得

  2. 配置 daoexamplegenerator 工程的 build.gradle，添加 dependencies.

  3.  Android ORM 框架之 greenDAO 使用心得

1
compile  'de.greenrobot:greendao-generator:1.3.1'

  1. 编写 ExampleDaoGenerator 类，注意： 我们的 Java 工程只有一个类，它的内容决定了「GreenDao Generator」的输出，你可以在这个类中通过对象、关系等创建数据库结构，下面我将以注释的形式详细讲解代码内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
public class ExampleDaoGenerator {
     public static void main(String[] args) throws Exception {
         // 正如你所见的，你创建了一个用于添加实体（Entity）的模式（Schema）对象。
         // 两个参数分别代表：数据库版本号与自动生成代码的包路径。
         Schema schema =  new  Schema(1,  "me.itangqi.greendao" );
//      当然，如果你愿意，你也可以分别指定生成的 Bean 与 DAO 类所在的目录，只要如下所示：
//      Schema schema = new Schema(1, "me.itangqi.bean");
//      schema.setDefaultJavaPackageDao("me.itangqi.dao");
 
         // 模式（Schema）同时也拥有两个默认的 flags，分别用来标示 entity 是否是 activie 以及是否使用 keep sections。
         // schema2.enableActiveEntitiesByDefault();
         // schema2.enableKeepSectionsByDefault();
 
         // 一旦你拥有了一个 Schema 对象后，你便可以使用它添加实体（Entities）了。
         addNote(schema);
 
         // 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码，此处你需要根据自己的情况更改输出目录（既之前创建的 java-gen)。
         // 其实，输出目录的路径可以在 build.gradle 中设置，有兴趣的朋友可以自行搜索，这里就不再详解。
         new  DaoGenerator().generateAll(schema,  "/Users/tangqi/android-dev/AndroidStudioProjects/MyGreenDAO/app/src/main/java-gen" );
     }
 
     /**
      * @param schema
      */
     private static void addNote(Schema schema) {
         // 一个实体（类）就关联到数据库中的一张表，此处表名为「Note」（既类名）
         Entity note = schema.addEntity( "Note" );
         // 你也可以重新给表命名
         // note.setTableName("NODE");
 
         // greenDAO 会自动根据实体类的属性值来创建表字段，并赋予默认值
         // 接下来你便可以设置表中的字段：
         note.addIdProperty();
         note.addStringProperty( "text" ).notNull();
         // 与在 Java 中使用驼峰命名法不同，默认数据库中的命名是使用大写和下划线来分割单词的。
         // For example, a property called “creationDate” will become a database column “CREATION_DATE”.
         note.addStringProperty( "comment" );
         note.addDateProperty( "date" );
     }
}

三. 生成 DAO 文件（数据库）

  • 执行 generator 工程，如一切正常，你将会在控制台看到如下日志，并且在主工程「java-gen」下会发现生成了DaoMaster、DaoSession、NoteDao、Note共4个类文件。 Android ORM 框架之 greenDAO 使用心得

如果在此处出错，你可以依据错误日志进行排查，主要看是否输出目录存在？其他配置是否正确？等

四. 在 ANDROID 工程中进行数据库操作

这里，我们只创建一个 NodeActivity 类，用于测试与讲解 greenDAO 的增、删、查功能。

  • activity_note.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<?xml version= "1.0"  encoding= "utf-8" ?>
<LinearLayout xmlns:android= "http://schemas.android.com/apk/res/android"
     android:layout_width= "fill_parent"
     android:layout_height= "fill_parent"
     android:orientation= "vertical" >
 
     <LinearLayout
         android:id= "@+id/linearLayout1"
         android:layout_width= "fill_parent"
         android:layout_height= "wrap_content"
         android:orientation= "horizontal" >
 
         <EditText
             android:id= "@+id/editTextNote"
             android:layout_width= "wrap_content"
             android:layout_height= "wrap_content"
             android:layout_weight= "1"
             android:hint= "Enter new note"
             android:inputType= "text" ></EditText>
 
         <Button
             android:id= "@+id/buttonAdd"
             android:layout_width= "wrap_content"
             android:layout_height= "wrap_content"
             android:onClick= "onMyButtonClick"
             android:text= "Add" ></Button>
 
         <Button
             android:id= "@+id/buttonSearch"
             android:layout_width= "wrap_content"
             android:layout_height= "wrap_content"
             android:onClick= "onMyButtonClick"
             android:text= "Search" ></Button>
     </LinearLayout>
 
     <ListView
         android:id= "@android:id/list"
         android:layout_width= "fill_parent"
         android:layout_height= "wrap_content" ></ListView>
</LinearLayout>

  • NoteActivity.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
public class NoteActivity extends ListActivity {
     private SQLiteDatabase db;
     private EditText editText;
     private DaoMaster daoMaster;
     private DaoSession daoSession;
     private Cursor cursor;
     public static final String TAG =  "DaoExample" ;
 
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super .onCreate(savedInstanceState);
         setContentView(R.layout.activity_note);
         // 官方推荐将获取 DaoMaster 对象的方法放到 Application 层，这样将避免多次创建生成 Session 对象
         setupDatabase();
         // 获取 NoteDao 对象
         getNoteDao();
 
         String textColumn = NoteDao.Properties.Text.columnName;
         String orderBy = textColumn +  " COLLATE LOCALIZED ASC" ;
         cursor = db.query(getNoteDao().getTablename(), getNoteDao().getAllColumns(),  null ,  null ,  null ,  null , orderBy);
         String[] from = {textColumn, NoteDao.Properties.Comment.columnName};
         int[] to = {android.R.id.text1, android.R.id.text2};
 
         SimpleCursorAdapter adapter =  new  SimpleCursorAdapter( this , android.R.layout.simple_list_item_2, cursor, from,
                 to);
         setListAdapter(adapter);
 
         editText = (EditText) findViewById(R.id.editTextNote);
     }
 
     private void setupDatabase() {
         // 通过 DaoMaster 的内部类 DevOpenHelper，你可以得到一个便利的 SQLiteOpenHelper 对象。
         // 可能你已经注意到了，你并不需要去编写「CREATE TABLE」这样的 SQL 语句，因为 greenDAO 已经帮你做了。
         // 注意：默认的 DaoMaster.DevOpenHelper 会在数据库升级时，删除所有的表，意味着这将导致数据的丢失。
         // 所以，在正式的项目中，你还应该做一层封装，来实现数据库的安全升级。
         DaoMaster.DevOpenHelper helper =  new  DaoMaster.DevOpenHelper( this ,  "notes-db" ,  null );
         db = helper.getWritableDatabase();
         // 注意：该数据库连接属于 DaoMaster，所以多个 Session 指的是相同的数据库连接。
         daoMaster =  new  DaoMaster(db);
         daoSession = daoMaster.newSession();
     }
 
     private NoteDao getNoteDao() {
         return  daoSession.getNoteDao();
     }
 
     /**
      * Button 点击的监听事件
      *
      * @param view
      */
     public void onMyButtonClick(View view) {
         switch  (view.getId()) {
             case  R.id.buttonAdd:
                 addNote();
                 break ;
             case  R.id.buttonSearch:
                 search();
                 break ;
             default :
                 Log.d(TAG,  "what has gone wrong ?" );
                 break ;
         }
     }
 
     private void addNote() {
         String noteText = editText.getText().toString();
         editText.setText( "" );
 
         final DateFormat df = DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM);
         String comment =  "Added on "  + df.format( new  Date());
 
         // 插入操作，简单到只要你创建一个 Java 对象
         Note note =  new  Note( null , noteText, comment,  new  Date());
         getNoteDao().insert(note);
         Log.d(TAG,  "Inserted new note, ID: "  + note.getId());
         cursor.requery();
     }
 
     private void search() {
         // Query 类代表了一个可以被重复执行的查询
         Query query = getNoteDao().queryBuilder()
                 .where(NoteDao.Properties.Text.eq( "Test1" ))
                 .orderAsc(NoteDao.Properties.Date)
                 .build();
 
//      查询结果以 List 返回
//      List notes = query.list();
         // 在 QueryBuilder 类中内置两个 Flag 用于方便输出执行的 SQL 语句与传递参数的值
         QueryBuilder.LOG_SQL =  true ;
         QueryBuilder.LOG_VALUES =  true ;
     }
 
     /**
      * ListView 的监听事件，用于删除一个 Item
      * @param l
      * @param v
      * @param position
      * @param id
      */
     @Override
     protected void onListItemClick(ListView l, View v, int position, long id) {
         // 删除操作，你可以通过「id」也可以一次性删除所有
         getNoteDao().deleteByKey(id);
//        getNoteDao().deleteAll();
         Log.d(TAG,  "Deleted note, ID: "  + id);
         cursor.requery();
     }
}

五. 运行结果

一切就绪，让我们看看效果吧！运行程序，分别执行添加按钮、删除（点击 List 的 Item）与查询按钮，可以在控制台得到如下日志：
Android ORM 框架之 greenDAO 使用心得 Android ORM 框架之 greenDAO 使用心得 Android ORM 框架之 greenDAO 使用心得

最后

  • 本文的 Demo 下载链接：https://github.com/tangqi92/MyGreenDAO

  • 本教程旨在介绍 greenDAO 的基本用法与配置，更高级与详细的使用，请参见 官网

  • 如本文有任何错误与遗漏，欢迎指正。同时我期待与大家成为朋友，所以欢迎在社交网络上互粉！！！

References & More

http://greendao-orm.com/ https://github.com/greenrobot/greenDAOhttp://stackoverflow.com/questions/tagged/greendaohttps://groups.google.com/forum/#!forum/greendao


Android之禅
关注
专栏目录
Android ORM 框架之 greenDAO 使用心得
xjbclz的专栏
11-05 249
原文：http://itangqi.me/android/using-greendao-experience/  前言 我相信，在平时的开发过程中，大家一定会或多或少地接触到 SQLite。然而在使用它时，我们往往需要做许多额外的工作，像编写 SQL 语句与解析查询结果等。所以，适用于 Android 的ORM 框架也就孕育而生了，现在市面上主流的框架有 OrmLite、Sugar
[Android第三方类库]greenDao使用心得（一）
Meggie_love的专栏
03-24 2875
公司新项目第一阶段框架完工，用到了greenDao，做个总结 先要给greenDao点给赞，greenDao确实大大提高了数据库开发的速度，让我在开发中能更加专注于数据结构的设计。 什么是greenDao Android ORM(Object Relational Mapping对象关系映射) for SQLite. greenDAO is an open source pr
greenDAO generator 支持默认值defaultValue和原始数据类型
05-05
此jar是修改了原作者的greenDAO generator项目的源码使其能支持defaultValue,以及产生的实体类entity支持原始数据. 具体可参考我的blog:http://blog.csdn.net/enyusmile/article/details/45498307
[Android第三方类库]greenDAO入门文章
Meggie_love的专栏
03-18 1488
最近一直在研究一个第三方的开源框架，greenDaoMaster是一个移动开发的ORM框架，由于网上一直查不到使用资料，所以自己摸索总结下用法。 首先需要新建一个JAVA项目用来自动生成文件。需要导入greendao-generator-1.3.0.jar和freemarker.jar到项目中 示例代码如下： [java] view plaincopy
GreenDaoGenerator生成代码
qq_36075937的博客
06-27 1224
 由于公司项目使用的greenDao版本1.3.7,我们都知道greenDao3.2我们只要定义一个实体标注@Entity注解在同步下工程就能生成DAO等代码  在greenDao低版本我们需要DaoGenerator来生成Dao等代码public class PatrolcheckDaoGenerator extends libDaoGenerator { public final st...
GreenDAOGenerator:Android 绿色 DAO 生成器示例
07-02
绿色 DAO 生成器示例 这是 Green DAO Generator 的一个简单而灵活的框架： 所有实体都有可序列化的实现。 能够为项目生成多个模式。 能够为多个项目生成。 （从一个地方处理不同的项目） 如何使用 1.生成器类： 在 Generator 类中，添加默认输出项目路径。 private final static String DEFAULT_PROJ_OUTPUT_PATH = " ../../_fwGreenDAO/src " ; 2. 添加模式： /** * Here is the ERD for the Store schema: * ---------- ---------- * | Customer | ---< | Purchase | * ---------- ---------- *
Greendao 简单实现增删改查使用过GreenDao的同学都知道，3.0之前需要通过新建GreenDaoGenerator工程生成Java数据对象（实体）和DAO对象，非常的繁琐而且也加大了使用成
TSBBjc
11-15 1353
第一步先来配置坏境 先在app工程下面的build.gredle里面
GreenDao 使用详解（入门篇）
热门推荐
bencheng06的博客
03-24 1万+
Android ORM 框架：GreenDao 使用详解 最近太忙了，直接引用网上的图片 一、GreenDao 简介 greenDAO 是一款开源的面向 Android 的轻便、快捷的 ORM 框架，将 Java 对象映射到 SQLite 数据库中，我们操作数据库的时候，不在需要编写复杂的 SQL语句， 在性能方面，greenDAO 针对 Android 进行了高度优化， 最小的内存开销
Android开发数据库之第三方ORM框架（GreenDao）
zyxNobita专栏
03-16 2720
移动APP追求追求功能实现的同时，用户体验非常重要。开始APP的同时，要时刻的切换开发者的角色，如你开发的时候，是 站在APP的开发角色，处于生产者的位置；当你测试的时候，你应该把自己放在用户的角色上去考虑所做的APP了。举一个很简单的 例子，就像我们天天使用手机上的新闻、好友动态等，当你没有网络的时候，也还有数据的存在提供用户浏览，而不是一篇”白 色“的，如同电脑死机一般。这就是移动APP在开发的时候，提供了最后一次网络状态下的数据缓存，提到数据缓存，可想而知有内 存缓存、硬件缓存之分。在这我主要讲述的是
greendao 一对多
06-26
简单对greendao实现一对多张表的添加与查询， @ToMany(referencedJoinProperty = "parentId") 举例，teacher和studeng，每个teacher可能对应多个student
Android ORM 框架 GreenDao 使用详解，2024年最新妈妈再也不用担心我找工作了
2301_82242988的博客
04-09 1034
希望大家能有一个好心态，想进什么样的公司要想清楚，并不一定是大公司，我选的也不是特大厂。当然如果你不知道选或是没有规划，那就选大公司！希望我们能先选好想去的公司再投或内推，而不是有一个公司要我我就去！还有就是不要害怕，也不要有压力，平常心对待就行，但准备要充足。最后希望大家都能拿到一份满意的 offer！如果目前有一份工作也请好好珍惜好好努力，找工作其实挺累挺辛苦的。这里附上上述的面试题相关的几十套字节跳动，京东，小米，腾讯、头条、阿里、美团等公司19年的面试题。
Android开发，GreenDao的简单使用
qq_41904106的博客
08-28 522
Android开发，GreenDao的简单使用，个人学习记录，错误很多，不供参考 绿刀（自己编）数据库开源框架使用方法： 1.在项目的app,单击右键选择Open Moudle Setting, 找到 app, 右方选择 Dependences依赖，选择”+”添加，输入greendao, 回车（需要网络），然后选择你想要版本. 我选的是“de.greenrobot:greendao:2.1.0” **2.在项目名上，单击右键选择 new --> Moudle. 选择 java Moudle,名字自取
Android greenDao
xiaowang_lj的博客
07-02 1517
greenDAO是一个开源的Android ORM(对象-关系映射)，它让SQLite数据库的开发再次变得有趣。它使开发人员免于处理低级数据库要求，同时节省了开发时间。SQLite是一个很棒的嵌入式关系数据库。尽管如此，编写SQL和解析查询结果仍然是非常繁琐且耗时的任务。通过将Java对象映射到数据库表（称为ORM，“对象/关系映射”），greenDAO使您摆脱了这些麻烦。这样，您可以使用简单的面向对象的API来存储，更新，删除和查询Java对象。 最佳性能 (可能是 Android 中最快的 ORM) ，
Dao
程序小白
04-21 150
1.RetorFitUtil //声明 private static RetorFitUtil retorFitUtil; public Retrofit retrofit; //网络判断 public static boolean isNABoolean(Context context){ //判断参数是否为空 if (con...
GreenDao-多表关联
三杯五岳
09-29 3005
利用GreenDAO可以非常方便的建立多张表之间的关联 一对一关联 通常我们在操作数据库的时候，我们往往不是单独的对一张表进行操作，而是对这张表的操作会联动的影响另外一张表或者多张表，比如：现在有两张表，一张是用户User表（有name、age、sex三个字段），一张是头像Picture表（有pictureId、pictureName、width、height四个字段）。假如用户表和头
Android ORM框架 GreenDao 的使用详解
weixin_38478780的博客
10-23 944
一、前言 关于 Android 中常用的数据存储方式我们前面已经讲了 Sp 存储 和 文件存储，但是对于数据量比较大，并且结构复杂的数据我们想要存储只能通过数据库进行处理，Android 中提供了一个 SQLite 数据库，但是使用起来比较繁琐和复杂，所以 Android 又推出了 Room 持久性库，Room 持久性库在 SQLite 的基础上提供了一个抽象层，让用户能够在充分利用 SQLite 的强大功能的同时，获享更强健的数据库访问机制。但是我们今天不讲 Room 这个组件（以后讲 Jetpack
Android数据库框架-GreenDao入门，2024年最新flutter 页面跳转动画
最新发布
m0_60721649的博客
04-10 604
public void setAddress(String address) {this.address = address;}@Overridepublic String toString() {return “UserInfo{” +“id=” + id +“, userName='” + userName + ‘’’ +“, phoneNumber='” + phoneNumber + ‘’’ +“, address='” + address + ‘’’ +‘}’;}}上述操作结束之后，在工程目录下，
【框架】GreenDao数据库框架
weixin_43526787的博客
06-21 1632
一、背景 Android数据库SQLite原生API SqliteOpenHelper不友好，所以出现了许多ORM框架来帮助我们处理数据库操作。所谓ORM框架，即Object-Relational Mapping，它的作用是在关系型数据库和对象之间做一个映射，这样，我们在具体的操作数据库的时候，就不需要再去和复杂的SQL语句打交道，只要像平时操作对象一样操作它就可以了。而GreenDao是基于Android的ORM框架中的佼佼者，优点如下： 性能（可能是Android上最快的ORM） 易用性（..
练习greenDao数据库框架引入
05-12
GreenDao是一个高效、轻量级、快速的ORM（对象关系映射）框架，可以方便地将Java对象映射到SQLite数据库中。下面是GreenDao的引入和使用步骤： 1. 在build.gradle文件中添加以下依赖： ```groovy dependencies { ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值