Android使用Chucker监控网络请求的操作指南

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

dependencies {
    // Chucker 核心库（仅Debug生效）
    debugImplementation("com.github.chuckerteam.chucker:library:3.5.2")
    
    // Release环境无操作实现
    releaseImplementation("com.github.chuckerteam.chucker:library-no-op:3.5.2")
    
    // 网络库（以Retrofit为例）
    implementation("com.squareup.retrofit2:retrofit:2.9.0")
    implementation("com.squareup.okhttp3:okhttp:4.12.0")
}

// NetworkModule.kt
object NetworkModule {

    // 创建带Chucker的OkHttpClient
    fun provideOkHttpClient(context: Context): OkHttpClient {
        return OkHttpClient.Builder()
            .addInterceptor(createChuckerInterceptor(context))
            .connectTimeout(30, TimeUnit.SECONDS)
            .readTimeout(30, TimeUnit.SECONDS)
            .build()
    }

    // 创建Chucker拦截器
    private fun createChuckerInterceptor(context: Context): Interceptor {
        return ChuckerInterceptor.Builder(context)
            .setMaxContentLength(250_000L) // 限制捕获数据大小
            .redactHeaders("Authorization", "Cookie") // 敏感头脱敏
            .alwaysReadResponseBody(true) // 强制读取响应体
            .addFilter { request -> 
                // 过滤不需要监控的请求
                !request.url.host.contains("analytics")
            }
            .build()
    }

    // 创建Retrofit实例
    fun provideRetrofit(okHttpClient: OkHttpClient): Retrofit {
        return Retrofit.Builder()
            .baseUrl("https://api.example.com/")
            .client(okHttpClient)
            .addConverterFactory(GsonConverterFactory.create())
            .build()
    }
}

class MyApp : Application() {

    override fun onCreate() {
        super.onCreate()
        
        // 初始化网络模块
        val okHttpClient = NetworkModule.provideOkHttpClient(this)
        retrofit = NetworkModule.provideRetrofit(okHttpClient)
        
        // 可选：设置全局异常处理器
        setupGlobalExceptionHandler()
    }

    private fun setupGlobalExceptionHandler() {
        // 监控网络请求异常
        ChuckerCollector(this).apply {
            onError("NETWORK_ERROR") { transaction, error ->
                Log.e("Chucker", "网络请求失败: ${transaction.requestUrl}", error)
            }
        }
    }
}

class CustomChuckerCollector(
    context: Context,
    private val analyticsService: AnalyticsService
) : ChuckerCollector(context) {

    // 重写请求处理方法
    override fun onRequestProcessed(transaction: HttpTransaction) {
        super.onRequestProcessed(transaction)
        
        // 自定义处理：发送请求数据到分析服务
        if (transaction.responseCode == 200) {
            analyticsService.logRequest(
                url = transaction.requestUrl,
                duration = transaction.duration,
                size = transaction.responseBodySize
            )
        }
    }
}

// 使用自定义收集器
ChuckerInterceptor.Builder(context)
    .setChuckerCollector(CustomChuckerCollector(context, analyticsService))
    .build()

// 根据构建类型创建不同配置
fun createChuckerInterceptor(context: Context): Interceptor {
    return when (BuildConfig.BUILD_TYPE) {
        "debug" -> ChuckerInterceptor.Builder(context)
            .setMaxContentLength(500_000L)
            .build()
        
        "staging" -> ChuckerInterceptor.Builder(context)
            .redactHeaders("Auth-Token")
            .setMaxContentLength(100_000L)
            .build()
        
        else -> ChuckerInterceptor.Builder(context).build()
    }
}

CREATE TABLE transactions (
    _id INTEGER PRIMARY KEY,
    requestUrl TEXT NOT NULL,
    requestHeaders TEXT,
    requestBody TEXT,
    responseHeaders TEXT,
    responseBody TEXT,
    responseCode INTEGER,
    duration INTEGER,
    createdAt INTEGER
);

// 数据清理任务
internal class CleanupTask(private val db: TransactionDatabase) : Runnable {
    override fun run() {
        val sevenDaysAgo = System.currentTimeMillis() - TimeUnit.DAYS.toMillis(7)
        db.transactionDao().deleteOldTransactions(sevenDaysAgo)
    }
}

// 确保release版本使用无操作实现
releaseImplementation "com.github.chuckerteam.chucker:library-no-op:3.5.2"

.redactHeaders("Authorization", "X-Api-Key", "Set-Cookie")

// 限制大文件捕获
.setMaxContentLength(500_000) // 500KB

// 排除二进制请求
.addFilter { transaction ->
    !transaction.requestContentType?.contains("image/") 
}

// 仅监控特定域名
.addFilter { transaction ->
    transaction.requestUrl.contains("api.example.com")
}

// 仅记录错误请求
.addFilter { transaction ->
    transaction.responseCode >= 400
}

@Test
fun testLoginRequest() {
    // 执行登录操作
    loginViewModel.login("user", "pass")
    
    // 验证请求是否触发
    val transactions = Chucker.getDatabase(context).transactionDao()
        .getTransactionsForUrl("%/login%")
    
    assertTrue(transactions.isNotEmpty())
    assertEquals(200, transactions.first().responseCode)
}

// 收集慢请求数据
fun monitorSlowRequests() {
    val slowThreshold = 3000 // 3秒
    val slowTransactions = getAllTransactions()
        .filter { it.duration > slowThreshold }
    
    analyticsService.logSlowRequests(
        urls = slowTransactions.map { it.requestUrl },
        avgDuration = slowTransactions.map { it.duration }.average()
    )
}