firebase-java-sdk

KO | EN

gitlite — search

#android #python #php #docker #java #linux #python3 #tensorflow #javascript #nodejs #go #iot

firebase-java-sdk

★ 38 Open GitHub ↗

A pure java port of the Firebase Android SDK

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="left">Firebase Java SDK <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/gitliveapp/firebase-java-sdk?style=flat-square"> <a href="https://git.live"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fapp.git.live%2Fbadge%3Forg%3DGitLiveApp%26repo%3Dfirebase-java-sdk"></a></h1>
<img align="left" width="75px" src="https://avatars2.githubusercontent.com/u/42865805?s=200&v=4"> 
 Built and maintained with 🧡 by <a href="https://git.live">GitLive</a> 
 Development teams merge faster with GitLive 
 
 
The Firebase Java SDK is a pure java port of the <a href="https://github.com/firebase/firebase-android-sdk">Firebase Android SDK</a> 
to run in clientside java environments such as the desktop.

Note this is different to the official [Firebase Admin Java SDK](https://github.com/firebase/firebase-admin-java) which enables access 
to Firebase services from privileged environments (such as servers or cloud).

It is used by the <a href="https://github.com/GitLiveApp/firebase-kotlin-sdk">Firebase Kotlin SDK</a> to support the JVM target for 
multiplatform projects, enabling you to use Firebase directly from your common source targeting Desktop, 
iOS, Android and Web, enabling the use of Firebase as a backend for 
<a href="https://www.jetbrains.com/lp/compose-multiplatform/">Compose Multiplatform</a>, for example.

It's currently in an alpha state, to be used at your own discretion, and contributions are very welcome!

## Using in your projects

You can add the library via Gradle:

```kotlin
dependencies {
    implementation("dev.gitlive:firebase-java-sdk:0.6.2")
}
```

Or Maven:

```xml
<dependency>
 <groupId>dev.gitlive</groupId>
 <artifactId>firebase-java-sdk</artifactId>
 <version>0.6.2</version>
</dependency>
```

You can skip the above if you are using the SDK via the <a href="https://github.com/GitLiveApp/firebase-kotlin-sdk">Firebase Kotlin SDK</a>

### Initializing the SDK

Before you can use the SDK you need to call the `FirebasePlatform.initializeFirebasePlatform` function to provide an implementation for 
logging, and persistent storage for simple key value pairs. This is used by the various Firebase products, for example, to persist the 
signed-in user in Firebase Auth.

Here's a simple example implementation in Kotlin that only persists in-memory:

```kotlin
FirebasePlatform.initializeFirebasePlatform(object : FirebasePlatform() {
 val storage = mutableMapOf<String, String>()
 override fun store(key: String, value: String) = storage.set(key, value)
 override fun retrieve(key: String) = storage[key]
 override fun clear(key: String) { storage.remove(key) }
 override fun log(msg: String) = println(msg)
})
```

#### Customizing Firestore offline data persistence database location

The `FirebasePlatform` interface also includes a `getDatabasePath` method for you to override if the following default implementation is not suitable:

```kotlin
    open fun getDatabasePath(name: String): File = File("${System.getProperty("java.io.tmpdir")}${File.separatorChar}$name")
```

This is used by Firestore to support [offline data persistence](https://firebase.google.com/docs/firestore/manage-data/enable-offline).

#### Initialize the Firebase application

It is also up to you to initialize the Firebase application object manually (unlike the Android SDK which is normally initialized via 
the configuration file).

You first need to create a Firebase options object to hold the configuration data for the Firebase application. Full documentation for 
the options can be found in the [Android API reference documentation](https://firebase.google.com/docs/reference/android/com/google/firebase/FirebaseOptions.Builder).

The use of `FirebaseOptions.Builder` is shown in the following example:

```java
// Manually configure Firebase Options. The following fields are REQUIRED:
//   - Project ID
//   - App ID
//   - API Key
FirebaseOptions options = new FirebaseOptions.Builder()
        .setProjectId("my-firebase-project")
        .setApplicationId("1:27992087142:android:ce3b6448250083d1")
        .setApiKey("AIzaSyADUe90ULnQDuGShD9W23RDP0xmeDc6Mvw")
        // setDatabaseURL(...)
        // setStorageBucket(...)
        .build();
```

You can then pass this to the `initialize` function, along with a mock Android `context` supplied by the `firebase-java-sdk`, like so:
```kotlin
import android.app.Application

val app = Firebase.initialize(Application(), options)
```

## Project status

The following libraries are available for the various Firebase products.

| Service or Product	                                                                               | Port of Android version |
|---------------------------------------------------------------------------------------------------|:------------------------|
| [Firebase Android BoM](https://maven.google.com/web/index.html?#com.google.firebase:firebase-bom) | `32.7.0`                |
| [Authentication](https://firebase.google.com/docs/auth)                                           | N/A[^1]                 |
| [Cloud Firestore](https://firebase.google.com/docs/firestore)                                     | `24.10.0`               |
| [Realtime Database](https://firebase.google.com/docs/database)                                    | `20.3.0`                |
| [Cloud Functions](https://firebase.google.com/docs/functions)                                     | `20.4.0`                |
| ~[Remote Config](https://firebase.google.com/docs/remote-config)~                                 | `21.6.0`[^2]            |
| ~[Installations](https://firebase.google.com/docs/projects/manage-installations)~                 | `17.2.0`[^2]            |

[^1]: Google has not open-sourced the Firebase Auth implementation for Android so a basic implementation using the Rest API is provided.
[^2]: Although the libraries are inlcuded they are currently not funtional

Is the Firebase library or API you need missing? [Create an issue](https://github.com/GitLiveApp/firebase-java-sdk/issues/new?labels=API+coverage&template=increase-api-coverage.md&title=Add+%5Bclass+name%5D.%5Bfunction+name%5D+to+%5Blibrary+name) to request additional API coverage or be awesome and [submit a PR](https://github.com/GitLiveApp/firebase-java-sdk/fork).

### Limitations

Currently, the following limitations are observed:

#### Firebase Auth implementation is minimal and only supports a small subset of the API:
 -  `createUserWithEmailAndPassword`
  - `signInAnonymously`
  - `signInWithCustomToken`
  - `signInWithEmailAndPassword`
  - `currentUser`
  - `getAccessToken`
  - `getUid`
  - `addIdTokenListener`
  - `removeIdTokenListener`
  - `addAuthStateListener`
  - `removeAuthStateListener`
  - `signOut`
#### Realtime Database does not support [Disk Persistence](https://firebase.google.com/docs/database/android/offline-capabilities), and should be setup as follows:
```java
FirebaseDatabase.getInstance().setPersistenceEnabled(false)
```

## Building and contributing

This library is built with Gradle.

Run `./gradlew build` to build the library locally.

### Implementation details

Apart from Firebase Auth, the Firebase Android libraries and their dependencies are used as-is from the published maven artifacts available
at [Google's Maven Repository](https://maven.google.com). These are obviously designed to run on Android so to use them without modification we 
include a minimal Android emulation layer in the SDK only implementing the functionality used by the Firebase libraries at runtime.

Robolectric is included as a compile-only dependency to overcome compilation errors due to missing Android APIs as they are many more 
compile-time dependencies on the Android SDK than what is required for proper functioning at run-time. This makes development of the SDK 
somewhat challenging as the compiler is unable to assist you on what Android functionality needs to be emulated before the library will 
function correctly (instead the library will error at runtime usually with one of the [ReflectiveOperationException](https://docs.oracle.com/javase%2F7%2Fdocs%2Fapi%2F%2F/java/lang/ReflectiveOperationException.html) subclasses.)

The best way to support more of the Firebase SDKs is via writing unit tests to test the required functionality at 
runtime and assert the correct behavior.

firebase-java-sdk

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README