Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skydoves/firebase-android-ktx
🔥 Kotlin & Compose-friendly Firebase extensions designed to help you focus on your business logic.
https://github.com/skydoves/firebase-android-ktx
android androidx compose extension firebase jetpack kotlin ktx library skydoves
Last synced: 7 days ago
JSON representation
🔥 Kotlin & Compose-friendly Firebase extensions designed to help you focus on your business logic.
- Host: GitHub
- URL: https://github.com/skydoves/firebase-android-ktx
- Owner: skydoves
- License: apache-2.0
- Created: 2024-09-03T05:13:06.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T13:18:25.000Z (about 2 months ago)
- Last Synced: 2024-10-23T08:55:04.033Z (15 days ago)
- Topics: android, androidx, compose, extension, firebase, jetpack, kotlin, ktx, library, skydoves
- Language: Kotlin
- Homepage:
- Size: 165 KB
- Stars: 102
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Firebase Android KTX
🔥 Kotlin & Compose-friendly Firebase extensions designed to help you focus on your business logic.
- **Firebase Realtime Database KTX**: Enables observing snapshot data changes as Kotlin Flow with fully customizable serialization, making it easy to adapt the data format to your application's needs.
- **Firebase Messaging Lifecycle KTX**: Provides a lifecycle-aware version of `FirebaseMessagingService`, allowing you to cancel coroutine tasks within the `onNewToken` method in accordance with the service's lifecycle, ensuring efficient resource management and preventing leaks.
## Firebase Realtime Database KTX
The Firebase Realtime Database KTX library allows you to observe changes in the Realtime Database as a Flow, with fully customizable serialization options. This makes it easy to handle data streams while adapting the data format to fit your app's needs, ensuring seamless integration with Kotlin and Jetpack Compose.
[](https://search.maven.org/search?q=g:%22com.github.skydoves%22%20AND%20a:%22firebase-database-ktx%22)
### Version Catalog
If you're using Version Catalog, you can configure the dependency by adding it to your `libs.versions.toml` file as follows:
```toml
[versions]
#...
firebaseKtx = "0.2.0"
[libraries]
#...
firebase-database-ktx = { module = "com.github.skydoves:firebase-database-ktx", version.ref = "firebaseKtx" }
```
### Gradle
Add the dependency below to your **module**'s `build.gradle.kts` file:
```gradle
dependencies {
implementation("com.github.skydoves:firebase-database-ktx:$version")
// if you're using Version Catalog
implementation(libs.firebase.database.ktx)
}
```
### The Problem
The [Firebase Realtime Database](https://firebase.google.com/docs/database) is primarily based on Java and callback listeners, making it less compatible with Coroutines and Jetpack Compose. Furthermore, since it returns snapshot values in non-JSON formats, handling objects and implementing custom serialization solutions can be challenging, as shown in the example below:
```kotlin
val listener = object : ValueEventListener {
override fun onDataChange(snapshot: DataSnapshot) {
val value = snapshot.child("timeline")
// ..
}
override fun onCancelled(error: DatabaseError) {
// ..
}
}
database.addValueEventListener(listener)
```
The result (`value`) isn't in JSON format, so we can't directly serialize it into a target object like this:
```
{top={banner={size={width=0, height=300}, scaleType=crop, url=https://blog.icons8.com/wp-content/uploads/2020/02/city-illustration-graphic-art.jpg}, order=0}, bottom={list={layout=grid, itemSize={width=135, height=210}, items=[{scaleType=crop, title=Frozen ...
```
They provide their own serialization algorithm internally, but it's not customizable. Additionally, you need to attach specific annotations and initialize fields with default values, as shown in the example below:
```kotlin
@IgnoreExtraProperties
data class Post(
var uid: String? = "",
var author: String? = "",
var title: String? = "",
) {
@Exclude
fun toMap(): Map {
return mapOf(
"uid" to uid,
"author" to author,
"title" to title,
}
}
```
### DatabaseReference.flow()
You can easily serialize snapshot values from the Realtime Database and observe them as a Flow by using the `DatabaseReference.flow()` extension, as shown in the example below:
```kotlin
class MainViewModel : ViewModel() {
private val database = Firebase.database(BuildConfig.REALTIME_DATABASE_URL).reference
private val json = Json {
isLenient = true
ignoreUnknownKeys = true
}
val timelineUi = database.flow(
path = { dataSnapshot ->
dataSnapshot.child("timeline")
},
decodeProvider = { jsonString ->
json.decodeFromString(jsonString)
},
).flatMapLatest { result ->
if (result.isSuccess) {
flowOf(result.getOrNull())
} else {
throw RuntimeException("parsing error!")
}
}.stateIn(
scope = viewModelScope,
started = SharingStarted.WhileSubscribed(5000),
initialValue = null,
)
}
```
Now, you can safely observe it in Jetpack Compose using `collectAsStateWithLifecycle`, as demonstrated in the code below:
```kotlin
val timelineUI by viewModel.timelineUi.collectAsStateWithLifecycle()
```
### DatabaseReference.flowSingle()
This functions similarly to `DatabaseReference.flow()`, but it only emits the value once, even if the value changes dynamically. It uses `addListenerForSingleValueEvent` instead of `addValueEventListener`. So, it's suitable for the one-shot flow.
### DatabaseReference.flowChild()
This observes all changes in the child nodes of the Realtime Database, including additions, modifications, deletions, movements, and cancellations. The flow emits `ChildState`, which encapsulates the state changes along with the snapshot value and any errors.
```kotlin
class MainViewModel : ViewModel() {
val childState = database.flowChild(
path = { dataSnapshot ->
dataSnapshot
},
decodeProvider = { jsonString ->
json.decodeFromString(jsonString)
},
).stateIn(
scope = viewModelScope,
started = SharingStarted.WhileSubscribed(5000),
initialValue = null,
)
}
```
Now, you can safely observe it in Jetpack Compose using `collectAsStateWithLifecycle`, as demonstrated in the code below:
```kotlin
val childState by viewModel.childState.collectAsStateWithLifecycle()
when (childState) {
is ChildState.ChildAdded -> ..
is ChildState.ChildChanged -> ..
is ChildState.ChildMoved -> ..
is ChildState.ChildRemoved -> ..
is ChildState.ChildCanceled -> ..
else -> ..
}
```
## Firebase Messaging Lifecycle KTX
The Firebase Messaging Lifecycle KTX extension allows you to implement a lifecycle-aware [FirebaseMessagingService](https://firebase.google.com/docs/reference/android/com/google/firebase/messaging/FirebaseMessagingService), enabling you to manage and cancel coroutine scopes based on the service’s lifecycle. This is especially useful when you need to send a refreshed token to the server in the [onNewToken](https://firebase.google.com/docs/reference/android/com/google/firebase/messaging/FirebaseMessagingService#onNewToken(java.lang.String)) method, ensuring that the coroutine scope is properly handled and preventing potential memory leaks from continuing to run after the service is no longer need to be actived.
[](https://search.maven.org/search?q=g:%22com.github.skydoves%22%20AND%20a:%22firebase-database-ktx%22)
### Gradle
Add the dependency below to your **module**'s `build.gradle.kts` file:
```gradle
dependencies {
implementation("com.github.skydoves:firebase-messaging-lifecycle-ktx:$version")
}
```
### LifecycleAwareFirebaseMessagingService
`LifecycleAwareFirebaseMessagingService` is a lifecycle-aware version of [FirebaseMessagingService](https://firebase.google.com/docs/reference/android/com/google/firebase/messaging/FirebaseMessagingService), designed to manage tasks in alignment with the service's lifecycle. For instance, you can send a token to your backend in the `onNewToken` method using the `lifecycleOwner.lifecycleScope.launch` function. This ensures the coroutine scope is automatically canceled when the service lifecycle changes, preventing any unintended background tasks from continuing to run.
```kotlin
class AppFirebaseMessagingService : LifecycleAwareFirebaseMessagingService() {
override fun onNewToken(token: String) {
super.onNewToken(token)
lifecycleScope.launch {
// send the token to the server
..
}
}
override fun onMessageReceived(message: RemoteMessage) {
super.onMessageReceived(message)
Log.d(APP_LOG_TAG, "FCMService#onMessageRec onMessageReceived: ${message.data}")
}
override fun onDestroy() {
super.onDestroy()
Log.d(APP_LOG_TAG, "FCMService#onDestroy onDestroy")
}
}
```
## Find this repository useful? :heart:
Support it by joining __[stargazers](https://github.com/skydoves/firebase-android-ktx/stargazers)__ for this repository. :star:
Also, __[follow me](https://github.com/skydoves)__ on GitHub for my next creations! 🤩
# License
```xml
Designed and developed by 2024 skydoves (Jaewoong Eum)
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.
```