RetroCache


Source link: https://github.com/iagocanalejas/retrocache

Android RetroCache

Description

This library provide an easy way for configure retrofit with a 2 layer cache (RAM and Disk). To see more details about the cache used visit DualCache

This allow you to improve the data usage of your apps.

Setup

  • Ensure you can pull artifacts from JitPack :
repositories {

  maven {
 url 'https://jitpack.io' 
}
 
}
  • And add to your module gradle file :
android {

  packagingOptions {

exclude 'META-INF/LICENSE'

exclude 'META-INF/NOTICE'
  
}
 
}
  dependencies {

  compile 'com.github.iagocanalejas:retrocache:<VERSION>' 
}

Usage

  1. In your Service Api Interface change all Call<T> return types for CachedCall<T>

    public interface ApiService {
    
    @GET("/")
      Cached<MyObject> getResource();
      
    }
    
  2. Build your cache. Library include some shortcuts for this tasks but you can always build a full configured cache using DualCache. Just remember cache key type must be String and entry type must be byte[]

    • Basic cache using only RAM.
    DualCache<String, byte[]> mCache = RetroCache.getRamCache(APP_VERSION);
    
    • Basic cache using both, Disk and Ram, layers.
    DualCache<String, byte[]> mCache = RetroCache.getDualCache(context, APP_VERSION);
    
    • Basic cache using both, Disk and Ram, layers and setting a life time for entries.
    DualCache<String, byte[]> mCache = RetroCache.getVolatileCache(context, APP_VERSION);
    
    • You can also get a non configured Builder.
    Builder<String, byte[]> builder = RetroCache.getBuilder(APP_VERSION);
    

    For see default values in this caches take a look at RetroCache

    Important

    • APP_VERSION is a static integer. When APP_VERSION changes the cache is automatically cleared. It's recommended to use BuildConfig.VERSION_CODE as APP_VERSION
  3. Add the cache to your Retrofit service with one of the following methods.

    retrofitBuilder.addCallAdapterFactory(CachedCallAdapterFactory.create(cache));
     retrofitBuilder.addCallAdapterFactory(CachedCallAdapterFactory.create(context, APP_VERSION));
     retrofitBuilder.addCallAdapterFactory(CachedCallAdapterFactory.createWithExecutor(cache, executor));
    
  4. Use it as normal retrofit. Just remember to use Cached. All retrofit methods are included, and you can also use methods explained in Included section.

Included

In addition to normal retrofit usage you can also call refresh(callback) to avoid looking in the cache or remove() to invalidate a cached call.

```java Cached<MyObject> call = ... call.refresh(new Callback<MyObject>() {

 ... 
}
);
 call.remove();
 ``` 

RX-Java2

RxJava2 adapter is still in beta. You can use it as normal retrofit rxjava2 adapter just add your adapter like:

```java retrofitBuilder.addCallAdapterFactory(RxJava2CachedCallAdapterFactory.create(cache));
 retrofitBuilder.addCallAdapterFactory(RxJava2CachedCallAdapterFactory.create(context, APP_VERSION));
 retrofitBuilder.addCallAdapterFactory(RxJava2CachedCallAdapterFactory.createAsync(cache));
 retrofitBuilder.addCallAdapterFactory(RxJava2CachedCallAdapterFactory.createAsync(context, APP_VERSION));
 retrofitBuilder.addCallAdapterFactory(RxJava2CachedCallAdapterFactory.createWithScheduler(cache, scheduler));
 retrofitBuilder.addCallAdapterFactory(RxJava2CachedCallAdapterFactory.createWithScheduler(context, APP_VERSION, scheduler));
 ``` 

Don't forget to include dependency:

dependencies {

  compile 'com.github.iagocanalejas:retrocache-rxjava2:<VERSION>' 
}

Pull Requests

I welcome and encourage all pull requests. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (on Mac) or Ctrl+Alt+L on Windows to reformat code with Android Studio defaults.
  2. Pull Request must pass all tests with gradlew check for styling, and gradlew test for unit tests.
  3. If its a feature, bugfix, or anything please only change code to what you specify.
  4. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge.
  5. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  6. Have fun!

Maintained By

IagoCanalejas ( @iagocanalejas)

Andy ( @ANDYear21)

License

Copyright 2016 IagoCanalejas.  Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 

Resources

Fluent API for common Intent use-cases in Android.

This library wraps Intents with a clean and simple to understand interface for a number of specific use-cases.

Generally percent layouts can be a efficient way to utilising the screens of different resolutions percent wise in Android. It can be a better approach for using LinearLayout which is specified by weight.

This is a library project which makes the instagram login much easier.

Task Manager is an open sourced application for managing running apps.

It makes a preview from an URL, grabbing all information (such as title, relevant texts and images).

An Android TabLayout library.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes