https://github.com/uPhyca/stetho-realm

Realm module for Stetho
https://github.com/uPhyca/stetho-realm

Last synced: about 2 months ago
JSON representation

Realm module for Stetho

• Host: GitHub
• URL: https://github.com/uPhyca/stetho-realm
• Owner: uPhyca
• License: other
• Created: 2015-04-14T15:57:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-02-17T14:02:14.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T10:02:03.399Z (5 months ago)
• Language: Java
• Size: 676 KB
• Stars: 739
• Watchers: 31
• Forks: 114
• Open Issues: 29
• Metadata Files:
  • Readme: README.ja.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-realm - Stetho-Realm - Displays Realm database content in Stetho instead of SQLite database content. (<a name="java"> Java/Kotlin / <a name="java-tools"></a>Java/Kotlin Tools)

README

        
# Stetho-Realm

Stetho-Realm は、[Stetho](https://facebook.github.io/stetho)  で [Realm](https://realm.io/)のデータベースの内容を表示するようにするための Stetho モジュールです。

Stetho がもともと持っている SQLite データベースの内容を表示する機能を置き換える形で Realm データベースの内容を表示します。

## Set-up

### Download

grab via Gradle:

```groovy

repositories {

    maven {

        url 'https://github.com/uPhyca/stetho-realm/raw/master/maven-repo'

    }

}

dependencies {

    compile 'com.facebook.stetho:stetho:1.5.0'

    compile 'com.uphyca:stetho_realm:2.1.0'

}

```

Stetho-Realm 2.0 は、 Stetho 1.1以降、Realm 2.0.0 以降に対応しています。Realm 0.80.0 からRealm 1.2.0でStetho-Realmを使用する場合は Stetho-Realm 0.x の最新版を利用してください。

### アプリケーションへの組み込み

`Application` クラスで以下のように Stetho の初期化を行ってください。

`RealmInspectorModulesProvider.ProviderBuilder` を用いて `InspectorModulesProvider` を作成します。

`RealmInspectorModulesProvider.ProviderBuilder` はデフォルトのモジュールリストにRealm 用のモジュールを追加します。

`RealmInspectorModulesProvider.ProviderBuilder#baseProvider(InspectorModulesProvider)`を用いて

デフォルト以外の InspectorModulesProvider を使用させることもできます。

以下はデフォルトの設定で有効になっている SQLite モジュールに Realm モジュールを追加して

使用する例です。

```java

public class MyApplication extends Application {

    @Override

    public void onCreate() {

        super.onCreate();

        Realm.init(this);

        Stetho.initialize(

                Stetho.newInitializerBuilder(this)

                        .enableDumpapp(Stetho.defaultDumperPluginsProvider(this))

                        .enableWebKitInspector(RealmInspectorModulesProvider.builder(this).build())

                        .build());

    }

}

```

`RealmInspectorModulesProvider.ProviderBuilder` の各種メソッドを呼び出すことで、データベースファイルを

探すフォルダの指定、表示する件数の上限、表示をidの昇順にする加か降順にするか、メタデータのテーブル

(pk と metadataテーブル)の情報を表示するかどうか、復号に使用するキー、

データベースファイル名のパターンを指定することができます。

```java

    RealmInspectorModulesProvider.builder(this)

            .withFolder(getCacheDir())

            .withEncryptionKey("encrypted.realm", key)

            .withMetaTables()

            .withDescendingOrder()

            .withLimit(1000)

            .databaseNamePattern(Pattern.compile(".+\\.realm"))

            .build()

```

## デバッグビルドのみに Stetho を組み込む方法

英語ですが以下のページを参考にしてください。

http://littlerobots.nl/blog/stetho-for-android-debug-builds-only/

## License

Stetho-Realm is BSD-licensed.

## TODO

* SQLite モジュールとの共存

* 読み込み以外の実装

## deployメモ

1. バージョン番号を変更

2. ./gradlew clean assemble :stetho_realm:publishMavenPublicationToMavenRepository

3. git に add して commit して push (masterブランチで！)