Change Retrofit's Base Url at runtime.

Giới thiệu.

Square Team đóng góp cho cộng đồng phát triển ứng dụng Android một công cụ để dễ dàng thực hiện, quản lý các HTTP requests cho ứng của mình đó là Retrofit. Với khả năng tùy biến cao, Android Developers hoàn toàn có thể tùy biến Retrofit nhằm adapt được Retrofit với Network Module trong ứng dụng của mình, cũng như adapt được với những đòi hỏi cho những phiên giao tiếp từ phía server. Chính vì vậy, Android Retrofit được coi là thư viện networking được sử dụng phổ biến nhất trong cộng đồng lập trình ứng dụng Android. Một trong những công cụ đi kèm siêu tiện ích đó chính là Okhttp(một HTTP client). Thông qua Okhttp, người dùng hoàn toàn có thể custom lại những HTTP requests của mình nhằm đáp ứng được những đòi hỏi cho những phiên giao tiếp giữa ứng dụng Android với phía server. Android Developers có thể thiết lập cơ chế logging cho quá trình phát triển; custom headers(Thiết lập cơ chế giao tiếp, loại dữ liệu(content-type), cơ chế encode/decode data, cơ chế bảo mật, ...); thay đổi hẳn HTTP request method, host, hay thậm chí là cả các params đã được thiết lập từ origin HTTP request từ trước. Tất cả những điều này hoàn toàn có thể được thực hiện bằng cách tùy biến rồi thêm vào Okhttp những Interceptors tùy biến đó cho những mục đích của mình.

Chắc hẳn đối với những Android Developers, các bạn không mấy xa lạ với những đoạn mã nguồn nhằm thiết lập mặc định những thông số trong header của tất cả các HTTP request của mình như: Content-Type, Authorization,... hoặc thêm header/body các giá trị mặc định khác như: OS-Name, OS-Version,... và đã phần nào hình dung ra được cơ chế custom lại các HTTP requests thông qua Interceptor. Về mặt lý thuyết, Interceptor có thể hiểu đơn giản là kẻ đánh chặn. Đánh chặn tất cả các requests được gửi đi, tùy biến nó theo mục đích riêng, gửi đi, rồi nhận lại responses theo đúng kì vọng. Hôm nay, mình sẽ giới thiệu đến các bạn hai ứng dụng khác của Interceptor cho quá trình phát triển ứng dụng của mình đó là: MockInterceptor - nhằm giả lập kết quả trả về trong quá trình phát triển khi các real APIs từ phía server chưa được phát triển xong), và ChangeableBaseUrlInterceptor nhằm thay đổi base_url(host) cái đã thiết lập sẵn cho Retrofit từ trước.

Change Retrofit's BASE_URL at runtime.

1. Mô tả bài toán.

Trong quá trình phát triển ứng dụng Client-Server cho Android, việc thay đổi các URL liên kết tới server là rất ít nhưng hoàn toàn vẫn có thể xảy ra. Điều này đòi hỏi ứng dụng của chúng ta phải tải về dữ liệu cấu hình các URL này trước khi thực hiện bất cứ requests nào khác tới server. Thông thường để giải quyết được vấn đề này chúng ta phải tách công việc của mình ra thành hai giai đoạn:

  1. Tải file cấu hình từ một server cố định(Không bao giờ thay đổi trong quá trình phát triển + triển khai ứng dụng).
  2. Thay đổi Server URL theo file cấu hình ở giai đoạn 1 trước khi call bất cứ APIs nào khác.

Đối mặt với bài toán này, ngay lập tức chúng ta sẽ nghĩ đến một trong hai cách thức bên dưới:

  1. Tạo ra hai đối tượng networking để thực hiện trong các giai đoạn riêng biệt.
  2. Tạo ra đối tượng networking duy nhất có khả năng thay đổi base_url trong lúc thực thi.

Với cách thức thứ nhất(tạo ra 2 đối tượng networking khác nhau) sẽ làm cho việc triển khai mã nguồn của chúng ta trở nên rắc rối, cả về mặt triển khai mã nguồn, cũng như quản lý các request. Đặc biệt là khi chúng ta cần phải cung cấp hai đối tượng networking này gần như là cùng lúc, điều này dẫn đến đối tượng thứ 2 gần như được khởi tạo cùng lúc với đối tượng đầu tiên, nếu sử dụng retrofit + một dependency injection thì gần như chúng ta vẫn phải gán một base_url cho việc call APIs(không phải lấy cấu hình) cùng một lúc. Hay nói cách khác vẫn phải tìm cách để change base_url cho đối tượng networking thứ hai. Do đó có vẻ cách thức thứ hai sẽ khả thi hơn.

Với cách thức thứ hai, ý tưởng đầu tiên là chúng ta kì vọng Retrofit sẽ cung cấp sẵn một API để chúng ta chỉ việc call nó và rồi base_url sẽ tự động được thay đổi cho các lần call APIs sau đó. Nhưng các bạn có thể sẽ phải thất vọng ngay lập tức vì Retrofit vẫn chưa cung cấp một API như thế. Và vì thế chúng ta sẽ phải tìm cách khác. Nếu đã từng google research thì các bạn sẽ thấy một suggestion là khởi tạo lại đối tượng này. Nó sẽ khá phức tạp nếu như chúng ta provide đối tượng networking của mình thông qua một Dependency Injection và nó được tạo + quản lý thông qua Dependency Injection đó. VD: Bạn sẽ phải gán scope cho đối tượng đó, rồi gọi refresh các đối tượng theo scope đó lúc runtime để tạo ra một đối tượng retrofit theo base_url mới(Điều này là cần thiếu để tránh phải tạo lại tất cả các đối tượng đã được tạo + provide trong grah của Dependency Injection). Vậy là cách change giá trị base_url thông qua Builder của Retrofit cũng là một giải pháp gây ra rắc rối lớn. Rất may là chúng ta có thể tìm đến một công cụ khác mà Square cung cấp cùng Retrofit đó là Okhttp. Chúng ta có thể sử dụng Interceptor để chặn bắt các origin HTTP request từ Retrofit, thay đổi base_url(host), tổ chức lại request rồi gửi đi và nhận lại kết quả. 😄

Phân tích như vậy có vẻ khá là khó hiểu và mình nghĩ giờ là lúc focus vào code để làm rõ hơn những luận điểm. Mình sẽ focus vào giải pháp sử dụng Interceptor(dĩ nhiên rồi) còn cách thức khác các bạn có thể tự thực hiện để có thêm trải nghiệm cũng như dữ liệu để so sánh.

2. Các bước thực hiện.

Okay. Mình sẽ đi ngay vào quá trình triển khai.

Đầu tiên bạn cần tạo ra một ChangeableBaseUrlInterceptor cái kế thừa Interceptor của Okhttp với nội dung như bên dưới:

class ChangeableBaseUrlInterceptor : Interceptor {
    @Volatile
    private var host: HttpUrl? = null

    @Volatile
    private var headersToRedact = emptySet<String>()

    fun setApiDomain(apiDomain: String) {
        this.host = apiDomain.toHttpUrlOrNull()
    }

    fun clearApiDomain() {
        host = null
    }

    @Throws(IOException::class)
    override fun intercept(chain: Interceptor.Chain): okhttp3.Response {
        var request = chain.request()
        host?.let {
            val newHost = HttpUrl.Builder()
                .scheme(it.scheme)
                .host(it.toUrl().toURI().host)
                .port(it.port)
            for (pathSegment in it.encodedPathSegments) {
                if (pathSegment.isNotBlank()) newHost.addPathSegment(pathSegment)
            }
            newHost.addPathSegment(request.url.encodedPathSegments.last())
            val newUrl = newHost.build()
            val oldUrl = request.url
            request = request.newBuilder().url(newUrl).build()
            HttpLoggingInterceptor.Logger.DEFAULT.log("--> Change request from $oldUrl to $newUrl")
            logRequest(chain)
        }
        return chain.proceed(request)
    }
}

Đến đây có vẻ rõ ràng hơn chút rồi đúng ko nào? Chúng ta sẽ chặn lại request, thay đổi URL của nó, rồi tiếp tục chuyển request đi tới một server mới(theo file cấu hình).

Với mỗi lần nhận được intercept callback từ Okhttp, chúng ta sẽ tạo ra một HttpUrl với host mới nếu như host mới của chúng ta được tạo sau khi gọi phương thức setApiDomain(apiDomain: String).

host?.let {
    val newHost = HttpUrl.Builder()
        .scheme(it.scheme)
        .host(it.toUrl().toURI().host)
        .port(it.port)
}

Sau đó chúng ta sẽ phải tách các path segments từ HttpUrl cũ của request rồi thêm vào HttpUrl mới:

for (pathSegment in it.encodedPathSegments) {
    if (pathSegment.isNotBlank()) newHost.addPathSegment(pathSegment)
}

Và cuối cùng là apply HttpUrl mới này cho request và tiếp tục chuyển request này đi:

request = request.newBuilder().url(newUrl).build()
// Tiếp tục chuyển tiếp request đến server với url mới để lấy về kết quả
return chain.proceed(request)

Đến đây, về cơ bản là chúng ta đã thực hiện xong việc chặn bắt và thay đổi URL cho các requests phát ra từ Retrofit.

Ngoài ra, trong quá trình debug, nếu chúng ta muốn nhìn thấy logs để nhận biết được đúng request + response trả về(Một cách thức để hiểu rõ những gì đang xảy ra. 😄) thì bạn có thể study thêm HttpLoggingInterceptor và custom cho ChangeableBaseUrlInterceptor của mình. Mã nguồn cho các methods show log còn lại như logRequest(chain) bạn có thể tìm thấy ở đây: Github

Bonus: Mock(giả lập) kết quả trả về.

Một trong những ứng dụng tuyệt vời khác của Interceptor trong Okhttp đó chính là mock dữ liệu trả về theo các APIs requests. Một việc làm cần thiết nếu như ứng dụng của bạn được phát triển song song với quá trình phát triển APIs của phía server.

class MockInterceptor(private val assets: AssetManager) : Interceptor {

    override fun intercept(chain: Interceptor.Chain): Response {
        if (BuildConfig.DEBUG) {
            val uri = chain.request().url.toUri().toString()
            val responseString = when {
                uri.endsWith(SAMPLE_REQUEST) -> getJsonStringFromFile(assets, MOCK_SAMPLE_RESPONSE_FILE_NAME)
                else -> ""
            }

            return if (responseString.isNotEmpty()) {
                chain.proceed(chain.request())
                    .newBuilder()
                    .code(HTTP_OK)
                    .protocol(Protocol.HTTP_2)
                    .message(responseString)
                    .body(
                        responseString.toByteArray()
                            .toResponseBody("application/json".toMediaTypeOrNull())
                    )
                    .addHeader("content-type", "application/json")
                    .build()
            } else {
                chain.proceed(chain.request())
            }
        } else {
            //just to be on safe side.
            throw IllegalAccessError(
                "MockInterceptor is only meant for Testing Purposes and " +
                        "bound to be used only with DEBUG mode"
            )
        }
    }

    companion object {
        const val SAMPLE_REQUEST = "SWFR01011991.seam"
        const val MOCK_SAMPLE_RESPONSE_FILE_NAME = "SWFR01011991.json"
    }

}

Với MockInterceptor này, các bạn hoàn toàn có thể giả được tất cả các kiểu dữ liệu(Cái là kết quả mà các bạn mong muốn khi gọi một API bất kì). Thậm chí là cả các response lỗi theo các HTTP Response Code. Nó sẽ là một công cụ hữu ích giúp chúng ta giảm bớt quá trình mock response trong mã nguồn, gây tốn kém efforts trong việc chỉnh sửa(host & handle logics) trong mã nguồn về sau nếu có API thật đúng ko nào?

Kết luận.

Đến đây chúng ta có thể thấy Retrofit và các công cụ kèm theo của nó quả là bá đạo phải không nào. Chỉ cần study một xíu là chúng ta có thể custom lại các components nhằm tương thích với những yều cầu về networking trong dự án của chúng ta có phải không? Mã nguồn bạn có thể đục khoét ở đây: Github Clap, upvote, leave a comment nếu bài viết có ích đối với bạn.

{>;} Happy coding!