greendao的使用(簡潔易懂)
今天在專案裡使用到了greendao,記錄一下greendao的使用過程。
greendao是對sqlite資料庫操作的封裝,可以讓我們更加方便的使用sqlite,其它類似的框架還有OrmLite、SugarORM、Active Android、Realm。但是greendao的效能要遠遠的高於其它四個框架,在官網有測試結果,因為它不是使用反射的機制,而是直接生成相關的程式碼。這就大幅度提升了它的效能。
從這個圖片裡就很清楚的看出,greendao是將一個Java物件直接對映到了資料庫中。
使用步驟:
1、配置android工程的build.gradle,引入greendao的相關配置。
sourceSets {
main {
java.srcDirs = ['src/main/java', 'src/main/java-gen']
}
}
注意android工程依賴的包是de.greenrobot:greendao:2.1.0
compile 'de.greenrobot:greendao:2.1.0'
2、在android工程裡建立一個java-gen資料夾,用來存放greendao生成的一些類
3、建立java工程
如果我們要使用greendao需要另建一個純java工程,這個Java工程用來生成我們android工程中需要用到的一些類,包括Bean,DAO,DaoMaster,DaoSession.
1.1 建立工程
1.2 配置java工程的build.gradle
java工程的build.gradle裡新增dependencies
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'de.greenrobot:greendao-generator:2.1.0'
}
注意java工程依賴的包是:
de.greenrobot:greendao-generator:2.1.0
1.3 配置好之後要重新編譯一下工程,讓android studio去下載對應版本的庫檔案
1.4 編寫java工程裡的MyGreenDaoClass類
這個類很關鍵,它裡面會建立資料庫和表以及表的各個欄位,程式碼如下
public class MyGreenDaoClass {
public static void main(String[] args) throws Exception {
//1、 引數: 1表示資料庫版本號 "lhd.test.hello"表示自動生成程式碼的路徑
Schema schema = new Schema(1,"lhd.test.hello");
//2、 建立了schema後,就可以用這個schema物件操作資料庫了
//這裡我們寫了個方法
mydatabase(schema);
//3、 使用 DAOGenerator 類的 generateAll() 方法自動生成程式碼
//我們將程式碼自動生成到我們之前建立的android的java-gen目錄下,這個路徑不是固定的,可以自由設定
new DaoGenerator().generateAll(schema,"F:\\androidg4\\MyGreenDao\\app\\src\\java-gen");
}
private static void mydatabase(Schema schema){
//1、 建立一個實體類,一個實體類就是資料庫的一張表 這裡表名為mydata,資料庫的名字會在android工程中指定
Entity mydata = schema.addEntity("MyData");
//2、 設定實體類的屬性,每個屬性就是表中的一個欄位
mydata.addIdProperty(); //首先設定一個Id
mydata.addStringProperty("name"); //設定一個name欄位
mydata.addStringProperty("age"); //設定一個age欄位
mydata.addStringProperty("cool").notNull();//設定一個cool欄位,並且不能為空
}
}
注意一點就是:千萬不要倒錯包了
import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Schema;
1.5 執行java工程生成程式碼
執行成功會在java-gen目錄下產生DaoMaster,DaoSession,mydata,mydataDao檔案
執行沒有錯誤,控制檯輸出
執行後生成的檔案
4、android工程使用greendao生成的檔案
4.1建立自己的application
// 我們將DaoSession物件放在myapplication裡,避免多次生成 Session 物件,這樣全域性就使用同一個session連結到資料庫啦。
myapplication.java
package com.example.lhd.mygreendao;
import android.app.Application;
import android.database.sqlite.SQLiteDatabase;
import lhd.test.hello.DaoMaster;
import lhd.test.hello.DaoSession;
/**
* Created by LHD on 2016/6/14.
*/
public class myapplication extends Application{
//建立全域性的daoSession
public static DaoSession daoSession;
public static SQLiteDatabase db;
@Override
public void onCreate() {
super.onCreate();
setupDatabase();
}
private void setupDatabase() {
// 通過 DaoMaster 的內部類 DevOpenHelper,你可以得到一個便利的 SQLiteOpenHelper 物件。
// 可能你已經注意到了,你並不需要去編寫「CREATE TABLE」這樣的 SQL 語句,因為 greenDAO 已經幫你做了。
// 注意:預設的 DaoMaster.DevOpenHelper 會在資料庫升級時,刪除所有的表,意味著這將導致資料的丟失。
// 所以,在正式的專案中,你還應該做一層封裝,來實現資料庫的安全升級。
//資料庫的名字是my_data
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "my_data", null);
db = helper.getWritableDatabase();
// 注意:該資料庫連線屬於 DaoMaster,所以多個 Session 指的是相同的資料庫連線。
DaoMaster daoMaster = new DaoMaster(db);
daoSession = daoMaster.newSession();
}
}
別忘了在manifest檔案裡宣告:
<application
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:supportsRtl="true"
<!-- 宣告自定義的application -->
android:name=".myapplication"
android:theme="@style/AppTheme">
<activity
android:name=".MainActivity"
android:label="@string/app_name"
android:theme="@style/AppTheme.NoActionBar">
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
</intent-filter>
</activity>
</application>
佈局檔案:
activity_main.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="horizontal">
<EditText
android:id="@+id/edit_input"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_weight="1"
android:hint="輸入要新增的資料"
android:inputType="text"></EditText>
<Button
android:id="@+id/add"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:onClick="onMyClick"
android:text="新增資料">
</Button>
<Button
android:id="@+id/search"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:onClick="onMyClick"
android:text="查詢">
</Button>
</LinearLayout>
<ListView
android:id="@android:id/list"
android:layout_width="match_parent"
android:layout_height="wrap_content">
</ListView>
</LinearLayout>
主程式碼檔案:
MainActivity.java
package com.example.lhd.mygreendao;
import android.app.ListActivity;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.os.Bundle;
import android.view.View;
import android.widget.EditText;
import android.widget.ListView;
import android.widget.SimpleCursorAdapter;
import android.widget.Toast;
import java.util.List;
import de.greenrobot.dao.query.Query;
import lhd.test.hello.MyData;
import lhd.test.hello.MyDataDao;
public class MainActivity extends ListActivity {
private SQLiteDatabase db;
private EditText edit_input;
private Cursor cursor;
private String str_input;
private MyDataDao dataDao;
//定義一個全域性變數i 用來模擬年齡
private static int i = 0;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
edit_input = (EditText) findViewById(R.id.edit_input);
//獲取全域性的daoSession然後通過daoSession獲取mydataDao
dataDao = myapplication.daoSession.getMyDataDao();
db = myapplication.db;
//獲取name欄位的行
String textColumn = MyDataDao.Properties.Name.columnName;
//按本地語言進行排序
String orderBy = textColumn + " COLLATE LOCALIZED ASC";
//執行查詢返回一個cursor
cursor = db.query(dataDao.getTablename(), dataDao.getAllColumns(), null, null, null, null, orderBy);
//SimpleCursorAdapter的使用
String[] from = {textColumn, MyDataDao.Properties.Age.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);
}
public void onMyClick(View v) {
switch (v.getId()) {
case R.id.add:
add_data();
break;
case R.id.search:
search_data();
break;
}
}
//新增一條資料
public void add_data() {
str_input = edit_input.getText().toString();
edit_input.setText("");
//1、建立物件
MyData data = new MyData();
String name = str_input;
String age = "20" + i++;
String cool = "yes";
//2、設定資料
data.setName(name);
data.setAge(age);
data.setCool(cool);
//3、插入資料
dataDao.insert(data);
cursor.requery();
}
//查詢
public void search_data() {
str_input = edit_input.getText().toString();
if (edit_input.getText().toString().isEmpty()) {
Toast.makeText(MainActivity.this, "輸入錯誤", Toast.LENGTH_SHORT).show();
} else {
Query query = dataDao.queryBuilder()
.where(MyDataDao.Properties.Name.eq(str_input))
.orderAsc(MyDataDao.Properties.Age)
.build();
List ls = query.list(); //查詢返回的list
Toast.makeText(MainActivity.this, "有" + ls.size() + "條資料符合", Toast.LENGTH_SHORT).show();
edit_input.setText("");
}
}
//刪除
@Override
protected void onListItemClick(ListView l, View v, int position, long id) {
//刪除操作,通過id刪除
dataDao.deleteByKey(id);
cursor.requery();
}
}
特別注意:
android工程和Java工程依賴的包是不同的:
android:
compile ‘de.greenrobot:greendao:2.1.0’
java:
compile ‘de.greenrobot:greendao-generator:2.1.0’
效果圖: