kache

Kotlin Cache Abstraction

Programming language: Kotlin

License: MIT License

Tags: Misc    

Latest version: v0.5.0

README

Kotlin Cache Abstraction

This library applies caching to Kotlin functions, thus reducing the count of function executions.

Documentation

You can read more about Kache on our Documentation.

Setup

Gradle / Groovy

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

dependencies {
  implementation 'com.themichailov:kache:0.5.0'
}

Gradle / Kotlin

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

dependencies {
  implementation("com.themichailov:kache:0.5.0")
}

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.themichailov</groupId>
    <artifactId>kache</artifactId>
    <version>0.5.0</version>
</dependency>

Supported cache engines

• Caffeine
• Hazelcast
• Ehcache

Usage

import com.themichailov.kache.KacheConfig
import com.themichailov.kache.cacheable
import com.themichailov.kache.updateCache
import com.themichailov.kache.evictCache

data class User(val email: String, var age: Int)
private val users = mapOf<String, User>()

KacheConfig.config("User", CaffeineKache(Caffeine.newBuilder().build()))

fun fetchUser(email: String): User = cacheable(name = "User", key = email) {
    users[email] ?: error("User not found!")
}

fun updateUser(email: String, age: Int) = updateCache(name = "User", key = email) {
    val user = users[email] ?: error("User not found!")
    user.age = age
}

fun importUsers(source: Path) = evictCache(name = "User", all = true) {

}

Contributing

Thank you for considering contributing to Kache! You can read the contribution guide [here](CONTRIBUTING.md).

Code of Conduct

In order to ensure that the Kache is welcoming to all, please review and abide by the [Code of Conduct](CODE_OF_CONDUCT.md).

License

Kache is open-sourced software licensed under the [MIT licensed](LICENSE).