DoraCache使用文档V1.0.4

作者: dora丶Android | 来源:发表于2021-07-20 00:33 被阅读0次

简介：一个使用在Android平台的数据缓存框架，支持将model数据从后端接口下载后，简单的配置即可自动映射到数据库，并在断网的情况下可以离线读取。

开发前的准备

开发环境

Android Studio、gradle

需要具备的技能

SQLite数据库和Android网络数据请求相关的基础知识

gradle依赖配置


maven { url 'https://jitpack.io' }

def latest_version = 'x.x.x'

api "com.github.dora4:dcache-android:$latest_version"

使用文档

一、dcache的orm详解

配置初始化


Orm.init(this, OrmConfig.Builder()

                .database("dcache_sample")

                .tables(Account::class.java)

                .version(1)

                .build())

在自定义的Application类的入口加入一行配置，database为数据库名，version从1开始每次递增1，tables用来配置需要初始化的表，dcache中所有的表需要实现OrmTable接口。

注解详解

表和列相关
- @Table
  
  此注解配置在OrmTable的实现类的类名之上，用来指定一个类映射到表的名称
- @Column
  
  此注解配置在OrmTable的实现类的成员属性之上，用来指定一个属性映射到字段的名称
- @Ignore
  
  此注解的优先级高于@Column，配置在OrmTable的实现类的成员属性之上，配置了此注解的成员属性，不会作为表的字段进行映射
约束相关
- @NotNull
  
  此注解配置在OrmTable的实现类的成员属性之上，用来指定这个字段为非空字段
- @PrimaryKey
  
  此注解配置在OrmTable的实现类的成员属性之上，用来指定这个字段为表的主键
- @Id
  
  此注解配置在OrmTable的实现类的成员属性之上，作用类似于@PrimaryKey，并
  
  在它的基础上指定了该字段名为”_id“，相当于@PrimaryKey+@Column("_id")
- @Unique
  
  此注解配置在OrmTable的实现类的成员属性之上，表示这个字段的值在这张表中从不重复
- @Default
  
  此注解配置在OrmTable的实现类的成员属性之上，通过它可以给字段指定默认值

CRUD操作

插入数据


DaoFactory.getDao(Account::class.java).insert(Account(generateAccKey(),

                    "D"+generateAccKey(), "P"+generateAccKey()))

insert不仅可以被用来插入单条数据，也可以插入一个List数据

删除数据


val selectOne = DaoFactory.getDao(Account::class.java)

                    .selectOne(QueryBuilder.create().orderBy(OrmTable.INDEX_ID))

            if (selectOne != null) {

                DaoFactory.getDao(Account::class.java).delete(selectOne)

            }

更新数据


DaoFactory.getDao(Account::class.java).update(Account("这个是key",

                    "D"+generateAccKey(), "P"+generateAccKey()))

查询数据
- Condition
  
  selection：where子句，不带where，可以带”？“占位符
  
  selectionArgs：”？“占位符的所有值
- WhereBuilder
  
  where子句的构建类，通过WhereBuilder.create ()创建实例
```
public WhereBuilder addWhereEqualTo(String column, Object value) {

        return append(null, column + EQUAL_HOLDER, value);

    }
```
  可以通过调用addWhereEqualTo添加key=value条件。
- QueryBuilder
  
  支持where、orderBy、limit、groupBy等
查询记录数
```
val count = DaoFactory.getDao(Account::class.java).selectCount()
```
通过selectCount查询符合查询条件的记录条数。

其他注意事项

复杂数据类型字段映射
```
@Convert(converter = StringListConverter.class, columnType = String.class)

@Column("acc_child_values")

private List<String> accChildValues;
```
使用@Convert注解可以保存复杂的数据类型，例如ArrayList，一般将复杂数据类型转成格式化后的字符串类型保存到数据库，读取数据的时候进行自动解码操作。converter类型转换器可以自行定义，columnType为你保存到数据库的实际数据类型。
表结构升级
```
  @Override

  public boolean isUpgradeRecreated() {

      return false;

  }
```
只需要在配置中将数据库版本提升1，即可自动进行表结构的升级。在OrmTable的实现类重写isUpgradeRecreated()来确定表升级后是否要清空之前保存的数据，如果return true，则在表升级后将数据清空。

事务操作


Transaction.execute(Account::class.java) {

                val selectOne = it.selectOne(QueryBuilder.create().orderBy(OrmTable.INDEX_ID))

                if (selectOne != null) {

                    it.delete(selectOne)

                }

            }

使用Transaction.execute()可以在代码块中执行事务操作，it指代的是OrmDao<Account>。

二、网络数据的读取和解析

配置和使用

按模块对接口进行分类

所有api接口必须实现ApiService，才可以通过DoraRetrofitManager进行管理，业务模块分类后，将同一类url加入到相同的Service中，有助于职责的清晰划分。

基本配置

URL和OkHttpClient的配置

Kotlin配置

你可以通过调用DoraRetrofitManager的init方法进行网络请求的相关配置。


    DoraRetrofitManager.init {

            okhttp {

                authenticator(Authenticator.NONE)

                cookieJar(CookieJar.NO_COOKIES)

              // add返回值是boolean，所以调用了networkInterceptors还需要返回this

                networkInterceptors().add(FormatLogInterceptor())

                this

            }

            registerBaseUrl(TestService::class.java, "http://api.k780.com")

      registerBaseUrl(AccountService::class.java, "http://github.com/dora4")

        }

也可以通过扩展BaseRetrofitManager来进行url和服务的注册。

Java配置


// 配置client

DoraRetrofitManager.INSTANCE.setClient(new OkHttpClient());

// 配置url

DoraRetrofitManager.INSTANCE.getConfig()

            .registerBaseUrl(TestService.class, "http://api.k780.com")

            .registerBaseUrl(AccountService.class, "http://github.com/dora4");

- 拦截器配置

  - Token拦截器

    你可以直接给DoraRetrofitManager的client添加一个token拦截器来拦截token。

  - 格式化输出响应数据到日志

    你可以添加dora.http.log.FormatLogInterceptor来将响应数据以日志形式格式化输出。

开始使用


        // 方式一：并行请求，直接调用即可

        DoraRetrofitManager.getService(AccountService::class.java).getAccount()

                .enqueue(object : DoraCallback<Account>() {

 

                    override fun onFailure(code: Int, msg: String?) {

                    }

 

                    override fun onSuccess(data: Account) {

                    }

                })

        // 方式二：串行请求，在net作用域内的api请求，可以很方便的进行数据的合并处理，推荐使用

        net {

            val account1 = api {

                DoraRetrofitManager.getService(AccountService::class.java).getAccount()

            }

            val account2 = result {

                DoraRetrofitManager.getService(AccountService::class.java).getAccount()

            }

        }

其它注意事项

DoraCallback和DoraListCallback这两个回调接口扩展自retrofit2.Callback，DoraListCallback可以方便用于集合数据的回调。

net作用域下request、api和result的区别

首先这三个方法都需要在net作用域下执行，net作用域下的请求是串行执行的。



request：用来自己执行网络请求，比如自己使用okhttp进行请求。



api：使用DoraRetrofitManager请求，如果执行失败，会抛出异常，你需要捕获DoraHttpException来查看异常信息。



```kotlin

val testRequest = try {

                api {

                    DoraRetrofitManager

                            .getService(TestService::class.java).testRequest()

                }

            } catch (e: DoraHttpException) {

                Toast.makeText(this, e.toString(), Toast.LENGTH_SHORT).show()

            }

```



result：使用DoraRetrofitManager请求，如果执行失败，直接返回null，不会抛出异常。



```kotlin

val testRequest3 = result {

                DoraRetrofitManager

                        .getService(TestService::class.java).testRequest()

            }

```



我们来看看整体的代码。



```kotlin

net {

            val testRequest = try {

                api {

                    DoraRetrofitManager

                            .getService(TestService::class.java).testRequest()

                }

            } catch (e: DoraHttpException) {

                Toast.makeText(this, e.toString(), Toast.LENGTH_SHORT).show()

            }

            val testRequest2 = api {

                DoraRetrofitManager

                        .getService(TestService::class.java).testRequest()

            }

            val testRequest3 = result {

                DoraRetrofitManager

                        .getService(TestService::class.java).testRequest()

            }

            Toast.makeText(this, "$testRequest--$testRequest2--$testRequest3", Toast.LENGTH_SHORT).show()

        }

```

三、repository的使用

数据缓存的设计思维

通常所说的数据缓存包括数据库缓存和内存缓存两种。内存缓存是指以内存保存的数据优先，而数据库缓存指以数据保存的数据优先。内存缓存的整体逻辑是，在app冷启动的时候，从数据库加载数据到内存，然后全局共享数据，网络请求返回新的数据后，会同时更新内存中缓存的数据和数据库缓存的数据，以内存保存的数据为准，数据库保存的数据只用在下一次app冷启动的预加载。而数据库缓存的整体逻辑是，在有网络连接的情况下请求数据将数据显示在界面上，并缓存到数据库，在断网的情况下，则从数据库中取离线数据。

@Repository和BaseRepository

并不是所有Repository类都需要手动配置@Repository注解，只有在不使用缺省值时需要配置。isListData，如果修改为false，则表示这个Repository被用来缓存非集合数据。而BaseRepository为所有数据缓存逻辑的基类，数据缓存流程控制在其子类实现。

使用示例


    val repository = AccountRepository(this, Account::class.java)

        repository.fetchListData().observe(this,

            Observer<List<Account>> {



            })

如果设置了isListData为false，则应该调用fetchData。

本地缓存数据处理

过滤
- DataFetcher

  fetch非集合类型数据的实现类。



- ListDataFetcher



  fetch集合类型数据的实现类。

分页
- DataPager

  在将数据加载到界面前，用它来对数据进行分页。



- 基于访问者模式的数据读取



  ```kotlin

  // 从Repository中获取分页器，仅限集合数据模式

          val pager = repository.obtainPager()

  // 设置分页数据结果的回调

          pager.setPageCallback(object : PageCallback<Account> {

              override fun onResult(model: List<Account>) {

              }

          })

  // 使用默认的分页访问者访问数据

          DefaultPageDataVisitor<Account>().visitDataPager(pager)

  ```

整合ORM框架

通常情况下，在一个已经成型的项目，更换orm框架抛开开发成本先不说，风险也是很大的。所以这里提供了一种无缝衔接主流orm框架的接口CacheFactory和ListCacheFactory。顾名思义，ListCacheFactory用于集合数据模式下的Repository。默认Repository采用的orm框架是内置的dora-db，如果你使用dora-db，你就无须考虑整合orm框架的问题。如果你用的是市面上主流的orm框架，比如greendao、ormlite或是realm，甚至是room，你就需要自己更换CacheFactory了。以下提供和dora-db整合的源代码，你可以参考它进行整合。


abstract class DoraDatabaseCacheRepository<T: OrmTable>(context: Context, private val ormClass: Class<T>)

    : BaseDatabaseCacheRepository<T>(context, ormClass) {



    override fun createCacheFactory(): CacheFactory<T> {

        return DoraCacheFactory<T, T>(ormClass)

    }



    override fun createListCacheFactory(): CacheFactory<List<T>> {

        return DoraListCacheFactory<T, T>(ormClass)

    }

}


class DoraListCacheFactory<M, T : OrmTable>(var clazz: Class<out OrmTable>) : ListCacheFactory<M>() {



    lateinit var dao: OrmDao<T>



    override fun queryCache(condition: Condition): List<M>? {

        return dao.select(WhereBuilder.create(condition)) as List<M>?

    }



    override fun removeOldCache(condition: Condition) {

        dao.delete(WhereBuilder.create(condition))

    }



    override fun init() {

        dao = DaoFactory.getDao(clazz) as OrmDao<T>

    }



    override fun addNewCache(model: List<M>) {

        dao.insert(model as List<T>)

    }

}

四、支持开源项目

如果帮您节省了大量的开发时间，对您有所帮助，欢迎您的赞赏！

捐赠虚拟货币

| 代币 | 钱包地址 | 备注 |

| -------------- | ------------------------------------------ | ----------------------------------------------------------- |

| 柚子(EOS) | doramusic123 | TAG中直接填写你的github用户名 |

| USDT(TRC-20链) | TYVXzqctSSPSTeVPYg7i7qbEtSxwrAJQ5y | 发送你的钱包地址和github用户名至邮箱dora924666990@gmail.com |

| 以太坊(ETH) | 0x5dA12D7DB7B5D6C8D2Af78723F6dCE4A3C89caB9 | 发送你的钱包地址和github用户名至邮箱dora924666990@gmail.com |

捐赠价值大于等于1 EOS 或 5 USDT 或 0.003 ETH 即可加入到开源项目开发团队，一起为dcache的发展而努力。加入SSH key，请发送你的github用户名，以及你的SSH key至邮箱dora924666990@gmail.com，被采纳的提交将有机会获得EOS的奖励，具体方案待定。

注：所有捐赠的虚拟货币被存放在单独的账户中，将用于奖励未来的代码贡献者。

DoraCache使用文档V1.0.4

开发前的准备

开发环境

需要具备的技能

gradle依赖配置

使用文档

一、dcache的orm详解

二、网络数据的读取和解析

三、repository的使用

四、支持开源项目

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读