使用Greendao進行Android本地數據存儲

Android開發中的本地數據存儲是一個非常關鍵的問題。不同的應用程序可能需要存儲各種類型的數據，包括設置、用戶配置、用戶信息、本地緩存等等。而Greendao是一個優秀的Android ORM庫，提供了簡單易用的API和高效的性能，使得我們可以輕鬆地實現本地數據存儲。本文將詳細介紹如何使用Greendao進行Android本地數據存儲。

一、快速入門

Greendao是一個輕量級的ORM框架，提供了一個實體類和一個DAO類。我們只需要定義好實體類，然後通過DAO類訪問數據庫即可。下面是一個快速入門的示例：


@Entity
public class User {
    @Id(autoincrement = true)
    private Long id;
    private String name;
    // getters and setters...
}

DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(context, "my-db");
Database db = helper.getWritableDb();
DaoSession daoSession = new DaoMaster(db).newSession();
UserDao userDao = daoSession.getUserDao();

User user = new User();
user.setName("Tom");
userDao.insert(user);

上面這段代碼用到了Greendao的幾個重要概念：

實體類(Entity Class)：定義了數據庫表的結構，即表名和各個字段。
DAO(Data Access Object)：提供了對數據庫的CRUD操作。
DaoMaster：控制數據庫的創建和升級。
DaoSession：提供了對具體實體類DAO操作的入口。
Database：持有數據庫對象。

上面這個例子就實現了向用戶表中插入一條數據的功能，非常簡單。接下來我們將對上面的示例進行詳細解讀，並介紹如何進行查詢操作。

二、實體類(Entity Class)

在Greendao中，實體類對應着一個數據庫表。我們可以使用註解進行定義和配置，它們的作用如下：

@Entity：表明這是一個實體類。
@Id：指定一個Long類型的主鍵字段，並且可以使用autoincrement屬性開啟自增長功能。
@Property：指定一個非主鍵的字段名稱，對應數據庫表中的列名。
@Unique：指定一個字段為唯一索引。
@NotNull：指定一個字段不允許為空。
@Transient：指定一個字段不映射到數據庫中。
@Generated：標識由greendao自動生成的字段。

下面是一個完整的實體類示例：


@Entity
public class User {
    @Id(autoincrement = true)
    private Long id;
    @Property(nameInDb = "user_name")
    private String name;
    @Unique
    private String email;
    private int age;
    @Transient
    private String temp;
    @Generated
    private byte[] picture;
    // getters and setters...
}

上面這個實體類定義了一個User表，包含了id、name、email和age等4個字段。其中id為自增長的主鍵，name字段對應數據庫中的user_name列名，並且不允許為空；email字段為唯一索引；age字段不需要額外配置；temp字段不映射到數據庫中；picture字段為greendao自動生成的字段。

三、DAO(Data Access Object)

DAO表示數據訪問對象，通常包括數據的增加、刪除、修改和查詢等操作。在Greendao中，每個實體類擁有一個自己的DAO，我們可以通過這個DAO對該實體類進行數據的增刪改查等操作。下面是一段簡單的示例：


// insert
User user = new User();
user.setName("Tom");
user.setEmail("tom@example.com");
user.setAge(20);
userDao.insert(user);

// update
user.setName("Jerry");
userDao.update(user);

// delete
userDao.deleteByKey(user.getId());

// query
Query query = userDao.queryBuilder()
                .where(UserDao.Properties.Age.eq(20))
                .orderAsc(UserDao.Properties.Name)
                .limit(10)
                .build();
List<User> userList = query.list();

如上所示，簡單地使用插入、更新、刪除與查詢方法即可完成相應的操作。需要注意的是，查詢方法返回了一個Query對象，該對象是一個鏈式調用的Builder，它能夠靈活地構建複雜查詢語句。

四、高級查詢

Greendao支持多種查詢方式，包括列表查詢、唯一查詢、聚合查詢、原始SQL查詢等。接下來我們會逐一介紹這些查詢方式。

1. 列表查詢

列表查詢是最常用的查詢方式，它可以返回指定條件下的所有結果。查詢條件通常使用查詢構建器QueryBuilder來指定，查詢結果使用list()方法返回一個List對象，每個元素是一個實體對象。


QueryBuilder<User> queryBuilder = userDao.queryBuilder();
queryBuilder.where(UserDao.Properties.Name.eq("Tom"));
List<User> userList = queryBuilder.list();

2. 唯一查詢

唯一查詢是針對僅返回一個結果的場景，它將返回一個實體對象。查詢條件與列表查詢相同，差別在於調用了unique()方法而不是list()方法。


QueryBuilder<User> queryBuilder = userDao.queryBuilder();
queryBuilder.where(UserDao.Properties.Name.eq("Tom"));
User user = queryBuilder.unique();

3. 聚合查詢

聚合查詢是指查詢出滿足某種條件的所有結果，並且對這些結果進行某種計算操作（如求和、平均值、最大值、最小值等），返回計算結果。查詢條件與列表查詢相同，使用count()、sum()、mean()、max()、min()等方法計算相應的結果。


QueryBuilder<User> queryBuilder = userDao.queryBuilder();
queryBuilder.where(UserDao.Properties.Age.gt(20));
long count = queryBuilder.count();
int sumAge = queryBuilder.where(UserDao.Properties.Age.gt(20)).sum(UserDao.Properties.Age).intValue();
float avgAge = queryBuilder.where(UserDao.Properties.Age.gt(20)).average(UserDao.Properties.Age);
int maxAge = queryBuilder.where(UserDao.Properties.Age.gt(20)).max(UserDao.Properties.Age).intValue();
int minAge = queryBuilder.where(UserDao.Properties.Age.gt(20)).min(UserDao.Properties.Age).intValue();

4. 原始SQL查詢

如果以上三種查詢方式不能滿足需求，你可以通過原始SQL來實現自定義查詢。Greendao支持使用QueryBuilder.RawBuilder來構建原始SQL查詢，並且返回結果也能夠轉換為實體對象。下面是一個使用原始SQL查詢的示例：


QueryBuilder<User> queryBuilder = userDao.queryBuilder();
QueryBuilder.RawBuilder rawBuilder = queryBuilder.buildRaw("SELECT * FROM user WHERE age > ?", "20");
List<User> userList = queryBuilder.list();

五、創建數據庫

在前面的示例中，我們使用了DaoMaster.DevOpenHelper來創建和升級數據庫。這個類繼承自SQLiteOpenHelper類，它會在需要時自動創建和升級數據庫。當然，如果你希望自己處理數據庫的創建和升級，也是可以的。下面是一個自定義DevOpenHelper的示例：


public class MyDatabaseOpenHelper extends DaoMaster.OpenHelper {
    public MyDatabaseOpenHelper(Context context, String name) {
        super(context, name);
    }
 
    @Override
    public void onCreate(Database db) {
        super.onCreate(db);
        // Do something when created
    }
 
    @Override
    public void onUpgrade(Database db, int oldVersion, int newVersion) {
        super.onUpgrade(db, oldVersion, newVersion);
        // Do something when upgraded
    }
}

調用MyDatabaseOpenHelper時，傳入數據庫名稱即可創建和升級數據庫。


MyDatabaseOpenHelper helper = new MyDatabaseOpenHelper(context, "my-db");
Database db = helper.getWritableDb();
DaoSession daoSession = new DaoMaster(db).newSession();
UserDao userDao = daoSession.getUserDao();

六、總結

Greendao是一款穩定高效的Android ORM庫，它提供了簡單易用的API和高效的性能，使得我們可以輕鬆地實現本地數據存儲。在本文中，我們詳細介紹了Greendao的實體類、DAO、高級查詢等方面的使用方法，並提供了代碼示例。希望這篇文章能夠幫助您在Android應用程序開發中解決本地數據存儲的問題。

原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-hant/n/207028.html