基于Android RxCache使用方法詳解

RxCache is a reactive caching library for Android and Java which turns your caching needs into an interface.
RxCache是一個用于Android和Java的響應式緩存庫，它可將您的緩存需求轉換為一個接口。

allprojects {
  repositories {
    jcenter()
    maven { url "https://jitpack.io" }
  }
}

dependencies {
  compile "com.github.VictorAlbertos.RxCache:runtime:1.8.1-2.x"
  compile "io.reactivex.rxjava2:rxjava:2.0.6"
  //我們再添加這個依賴，下面有說明
  compile 'com.github.VictorAlbertos.Jolyglot:gson:0.0.3'
}

dependencies {
  // To use Gson 
  compile 'com.github.VictorAlbertos.Jolyglot:gson:0.0.3'
  // To use Jackson
  compile 'com.github.VictorAlbertos.Jolyglot:jackson:0.0.3'
  // To use Moshi
  compile 'com.github.VictorAlbertos.Jolyglot:moshi:0.0.3'
}

public interface GitHubService {
  @GET("users/{user}")
  Observable<User> getRxUser(@Path("user") String user);
}

public class GitHubServiceManager {
  private GitHubService service;
  public GitHubServiceManager() {
    init();
  }
  private void init() {
    HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor()
        .setLevel(HttpLoggingInterceptor.Level.BODY);
    OkHttpClient client = new OkHttpClient()
        .newBuilder()
        .addInterceptor(interceptor)
        .build();
    service = new Retrofit.Builder()
        .baseUrl("https://api.github.com/")
        .addConverterFactory(GsonConverterFactory.create())
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .client(client)
        .build()
        .create(GitHubService.class);
  }
  public Observable<User> getUser(String user){
    return service.getRxUser(user);
  }
}

@Data  //lombok插件的注解，自動生成get、set方法
public class User {
 public String login;
 public String name;
}

 new GitHubServiceManager()
        .getUser(userName)
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(user1 -> Toast.makeText(this, user1.toString(), Toast.LENGTH_SHORT).show());

public interface UserCacheProviders {
  /**
   * LifeCache設置緩存過期時間. 如果沒有設置@LifeCache , 數據將被永久緩存理除非你使用了 EvictProvider,EvictDynamicKey or EvictDynamicKeyGroup .
   * @param user
   * @param userName 驅逐與一個特定的鍵使用EvictDynamicKey相關的數據。比如分頁，排序或篩選要求
   * @param evictDynamicKey  可以明確地清理指定的數據 DynamicKey.
   * @return
   */
  @LifeCache(duration = 1,timeUnit = TimeUnit.MINUTES)
  Observable<User> getUser(Observable<User> user, DynamicKey userName, EvictDynamicKey evictDynamicKey);
}

@param user：這是個Observable類型的對象，簡單來說，這就是你將要緩存的數據對象。
@param userName:DynamicKey類型，顧名思義，就是一個動態的key，我們以它作為tag，將數據存儲到對應名字的File中
@param evictDynamicKey 可以明確地清理指定的數據 ，很簡單，如果我們該參數傳入為true，那么RxCache就會驅逐對應的緩存數據直接進行網絡的新一次請求（即使緩存沒有過期）。如果傳入為false，說明不驅逐緩存數據，如果緩存數據沒有過期，那么就不請求網絡，直接讀取緩存數據返回。
@return 可以看到，該接口方法中，返回值為Observable,泛型為user，這個Observable的對象user和參數中傳進來的Observable的對象user有什么區別呢？ 
— 很簡單，返回值Observable中的數據為經過緩存處理的數據。

public class CacheProviders {
  private static UserCacheProviders userCacheProviders;
  public synchronized static UserCacheProviders getUserCache() {
    if (userCacheProviders == null) {
      userCacheProviders = new RxCache.Builder()
          .persistence(BaseApplication.getApplication().getExternalCacheDir(), new GsonSpeaker())//緩存文件的配置、數據的解析配置
          .using(UserCacheProviders.class);//這些配置對應的緩存接口
    }
    return userCacheProviders;
  }
}

 private void requestHttp(String userName) {
     //網絡請求數據
    Observable<User> user = new GitHubServiceManager()
        .getUser(userName);
    //緩存配置    
    CacheProviders.getUserCache()
        .getUser(user, new DynamicKey(userName), new EvictDynamicKey(false))//用戶名作為動態key生成不同文件存儲數據，默認不清除緩存數據
        .subscribeOn(Schedulers.io())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(user1 -> Toast.makeText(this, user1.toString(), Toast.LENGTH_SHORT).show());
}