Atlantis Android

AndroidアプリからのHTTP/HTTPSトラフィックをキャプチャし、デバッグのためにProxymanに送信します。

概要

Atlantis Androidは、Proxymanのコンパニオンライブラリです。プロキシの設定や証明書のインストールを行わずに、Androidアプリケーションのネットワークトラフィックをキャプチャして検査できます。

特徴

OkHttpトラフィックの自動インターセプト
WebSocketメッセージのキャプチャ（送信、受信、クローズ）
Retrofit 2.9+ および Apollo Kotlin 3.x/4.x に対応
Network Service Discovery (NSD) によるProxymanの自動検出
エミュレーター向けの直接接続サポート
GZIP圧縮による効率的なデータ転送
最小限の設定で利用可能

必要条件

Android API 26+ (Android 8.0 Oreo)
OkHttp 4.x または 5.x
Kotlin 1.9+

インストール

オプション1: JitPack (推奨)

JitPackリポジトリを settings.gradle.kts に追加します:

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://jitpack.io") }
    }
}

次に、モジュールの build.gradle.kts に依存関係を追加します:

dependencies {
    debugImplementation("com.github.ProxymanApp:atlantis-android:v1.0.0")
}

またはGroovy (build.gradle) の場合:

dependencies {
    debugImplementation 'com.github.ProxymanApp:atlantis-android:v1.0.0'
}

オプション2: Maven Central

モジュールの build.gradle.kts に依存関係を追加します:

dependencies {
    debugImplementation("com.proxyman:atlantis-android:1.0.0")
}

またはGroovy (build.gradle) の場合:

dependencies {
    debugImplementation 'com.proxyman:atlantis-android:1.0.0'
}

クイックスタート

1. Applicationでの初期化

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        
        if (BuildConfig.DEBUG) {
            Atlantis.start(this)
        }
    }
}

2. OkHttpClientへのインターセプター追加

val okHttpClient = OkHttpClient.Builder()
    .addInterceptor(Atlantis.getInterceptor())
    .build()

3. WebSocketトラフィックのキャプチャ (オプション)

WebSocketListener を Atlantis.wrapWebSocketListener() でラップしてWebSocketメッセージをキャプチャします:

val listener = Atlantis.wrapWebSocketListener(object : WebSocketListener() {
    override fun onOpen(webSocket: WebSocket, response: Response) {
        // 独自のロジック
    }
    override fun onMessage(webSocket: WebSocket, text: String) {
        // 独自のロジック
    }
    // ...
})

okHttpClient.newWebSocket(request, listener)

4. アプリを実行

MacでProxymanを起動し、Androidアプリを実行すると、トラフィックが表示されます！

プロジェクト構成

atlantis-android/
├── atlantis/              # ライブラリモジュール
│   └── src/
│       ├── main/kotlin/
│       │   └── com/proxyman/atlantis/
│       │       ├── Atlantis.kt                  # メインエントリポイント
│       │       ├── AtlantisInterceptor.kt        # OkHttpインターセプター
│       │       ├── AtlantisWebSocketListener.kt  # WebSocketキャプチャ
│       │       ├── Base64Utils.kt                # Base64エンコーディング
│       │       ├── Configuration.kt              # 設定モデル
│       │       ├── GzipCompression.kt            # 圧縮
│       │       ├── Message.kt                    # メッセージタイプ
│       │       ├── NsdServiceDiscovery.kt        # mDNSディスカバリー
│       │       ├── Packages.kt                   # データモデル
│       │       └── Transporter.kt                # TCP接続
│       └── test/kotlin/                          # ユニットテスト
├── sample/                # サンプルアプリ
├── PUBLISHING.md          # 公開ガイド
└── README.md

セットアップ

オプション1: Android Studioで開く (推奨)

atlantis-android フォルダをAndroid Studioで開くだけです。自動的にGradle Wrapperがダウンロードされ、プロジェクトが同期されます。

オプション2: Gradle Wrapperを手動で生成

Gradleがローカルにインストールされている場合:

cd atlantis-android
gradle wrapper --gradle-version 8.7

ビルド

# ライブラリをビルド
./gradlew :atlantis:build

# テストを実行
./gradlew :atlantis:test

# サンプルアプリをビルド
./gradlew :sample:assembleDebug

テスト

./gradlew :atlantis:test

公開

Maven CentralまたはJitPackへの公開方法については、PUBLISHING.mdを参照してください。

ライセンス

Apache License 2.0

atlantis-android

人気