Skip to content

Latest commit

 

History

History
541 lines (412 loc) · 10.9 KB

README.md

File metadata and controls

541 lines (412 loc) · 10.9 KB
Raw

Android Easy Http Library

繁體中文文檔

About Android Easy Http Library

  • Made on OkHttp.
  • Easy to do http request, just make request and listen for the response.
  • Visual http request record, make you debug easily.
  • Http cookies persistence and editable.

Using Library In Your Application

Add this in your app build.gradle file.

android {
    buildFeatures {
        viewBinding true
        dataBinding true
    }
}

dependencies {
    implementation 'io.github.af19git5:easy-http-android:0.0.6'
}

Add permission in your AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET" />

And check your application minSdk must be greater than 24.

Do Request

GET Request

Kotlin Example:

EasyHttp.get(context, url)
  .build()
  .getAsString(object : StringResponseListener {
    override fun onSuccess(headers: Headers, body: String) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

EasyHttp.get(context, url)
  .build()
  .getAsString(new StringResponseListener() {
    @Override
    public void onSuccess(@NonNull Headers headers, @NonNull String body) {
      // Do something...
    }

    @Override
    public void onError(@NonNull HttpException e) {
      // Do something...
    }
  });

Value Settings:

  • .tag - Add tag for request, can use in cancel request.
  • .addUrlParams - Add url query param.
  • .urlParams - Add url query params.
  • .addHeader - Add header for request.
  • .headers - Add headers for request.
  • .cacheable - Cache response.
  • .saveRecord - Do save http request record. Default value is true.
  • .connectTimeout - Connect timeout time.
  • .readTimeout - Read timeout time.
  • .writeTimeout - Write timeout time.

Post Request

Kotlin Example:

EasyHttp.post(context, url)
  .jsonBody(obj)
  .build()
  .getAsString(object : StringResponseListener {
    override fun onSuccess(headers: Headers, body: String) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

EasyHttp.post(context, url)
  .jsonBody(obj)
  .build()
  .getAsString(new StringResponseListener() {
    @Override
    public void onSuccess(@NonNull Headers headers, @NonNull String body) {
      // Do something...
    }

    @Override
    public void onError(@NonNull HttpException e) {
      // Do something...
    }
  })

Value Settings:

Have the value settings in the get example.

  • .stringBody - Set string request body, also can set your custom content type.
  • .jsonBody - Set json object request body, also can set your custom content type.
  • .formBody - Set form request body.
  • .requestBody - Set your custom okhttp request body.

Upload File

Kotlin Example:

EasyHttp.upload(context, url)
  .addMultipartFile("file", file)
  .addMultipartParameter("text", "text")
  .build()
  .getAsString(object : StringResponseListener {
    override fun onSuccess(headers: Headers, body: String) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

EasyHttp.upload(context, url)
  .addMultipartFile("file", file)
  .addMultipartParameter("text", "text")
  .build()
  .getAsString(new StringResponseListener() {
    @Override
    public void onSuccess(@NonNull Headers headers, @NonNull String body) {
      // Do something...
    }

    @Override
    public void onError(@NonNull HttpException e) {
      // Do something...
    }
  })

Value Settings:

Have the value settings in the get example.

  • .contentType - Set upload request content type. Default value is "multipart/form-data".
  • .addMultipartParam - Add multipart parameter.
  • .addMultipartFile - Add multipart parameter. You can put File, ByteArray, Uri.

Cancel Request

Kotlin Example:

EasyHttp.cancel(tag)

Java Example:

EasyHttp.cancel(tag);

Custom OkHttpClient Builder

You can easily get OkHttpClient Builder and modify it.

Kotlin Example:

val easyHttpBuilder = EasyHttp.get(context, url)
val okHttpClientBuilder = easyHttpBuilder.okHttpClientBuilder

// Do something modify for OkHttpClient Builder...

easyHttpBuilder
  .build()
  .getAsString(object : StringResponseListener{
    override fun onSuccess(headers: Headers, body: String) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

RequestBuilder requestBuilder = EasyHttp.get(context, url);
OkHttpClient.Builder okHttpClientBuilder = requestBuilder.getOkHttpClientBuilder();

// Do something modify for OkHttpClient Builder...

requestBuilder.build().getAsString(new StringResponseListener() {
  @Override
  public void onSuccess(@NonNull Headers headers, @NonNull String body) {
	// Do something...
  }

  @Override
  public void onError(@NonNull HttpException e) {
	// Do something...
  }
});

Response Listener

Get response as String

Kotlin Example:

EasyHttp.get(context, url)
  .build()
  .getAsString(object : StringResponseListener {
    override fun onSuccess(headers: Headers, body: String) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

EasyHttp.get(context, url)
  .build()
  .getAsString(new StringResponseListener() {
    @Override
    public void onSuccess(@NonNull Headers headers, @NonNull String body) {
      // Do something...
    }

    @Override
    public void onError(@NonNull HttpException e) {
      // Do something...
    }
  });

Get json response as custom object

Kotlin Example:

// Use class
EasyHttp.get(context, url)
  .build()
  .getJsonAsObject(CustomObj::class.java, object : JsonResponseListener<CustomObj> {
    override fun onSuccess(headers: Headers, body: CustomObj)  {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

// Use Gson TypeToken
EasyHttp.get(context, url)
  .build()
  .getJsonAsObject(
    object : TypeToken<CustomObj>() {},
    object : JsonResponseListener<CustomObj> {
      override fun onSuccess(headers: Headers, body: CustomObj) {
        // Do something...
      }

      override fun onError(e: HttpException) {
        // Do something...
      }
    })

Java Example:

// Use class
EasyHttp.get(context, url)
  .build()
  .getJsonAsObject(
    CustomObj.class,
    new JsonResponseListener<>() {
      @Override
      public void onSuccess(@NonNull Headers headers, CustomObj body) {
        // Do something...
      }

      @Override
      public void onError(@NonNull HttpException e) {
        // Do something...
      }
  });

// Use Gson TypeToken
EasyHttp.get(context, url)
  .build()
  .getJsonAsObject(
    new TypeToken<CustomObj>() {},
    new JsonResponseListener<>() {
      @Override
      public void onSuccess(@NonNull Headers headers, CustomObj body) {
        // Do something...
      }

      @Override
      public void onError(@NonNull HttpException e) {
        // Do something...
      }
  });

Get response as bitmap

Kotlin Example:

EasyHttp.get(context, url)
  .build()
  .getAsBitmap(file, object : BitmapResponseListener {
    override fun onSuccess(headers: Headers, bitmap: Bitmap) {
      // Do something...
    }

    override fun onProgress(downloadBytes: Long, totalBytes: Long) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

EasyHttp.get(context, url)
  .build()
  .getAsBitmap(file, new BitmapResponseListener() {
    @Override
    public void onSuccess(@NonNull Headers headers, @NonNull Bitmap bitmap) {
       // Do something...
    }

    @Override
    public void onProgress(long downloadBytes, long totalBytes) {
      // Do something...
    }

    @Override
    public void onError(@NonNull HttpException e) {
      // Do something...
    }
  });

Download response

Kotlin Example:

EasyHttp.get(context, url)
  .build()
  .download(file, object : DownloadListener {
    override fun onSuccess(headers: Headers, file: File) {
      // Do something...
    }

    override fun onProgress(downloadBytes: Long, totalBytes: Long) {
      // Do something...
    }

    override fun onError(e: HttpException) {
      // Do something...
    }
  })

Java Example:

EasyHttp.get(context, url)
  .build()
  .download(file, new DownloadListener() {
    @Override
    public void onSuccess(@NonNull Headers headers, @NonNull File file) {
       // Do something...
    }

    @Override
    public void onProgress(long downloadBytes, long totalBytes) {
      // Do something...
    }

    @Override
    public void onError(@NonNull HttpException e) {
      // Do something...
    }
  });

Cookie Modify

Clear cookies

Kotlin Example:

// clear all
EasyHttp.clearCookies(context)
// clear by host
EasyHttp.clearCookies(context, host)
// clear by host and cookie name
EasyHttp.clearCookies(context, host, name)

Java Example:

// clear all
EasyHttp.clearCookies(context);
// clear by host
EasyHttp.clearCookies(context, host);
// clear by host and cookie name
EasyHttp.clearCookies(context, host, name);

Android EasyHttp Page

Http Record Page

This page can show Easy Http record.

If your request saveRecord is open, you can find record in the http record page.

Preview:

You can use this code to intent record page.

Kotlin Example:

EasyHttp.intentEasyHttpRecord(context)

Java Example:

EasyHttp.intentEasyHttpRecord(context);

Cookies Page

This page can show Easy Http persistence cookies.

Also you can modify it.

Preview:

You can use this code to intent cookies page.

Kotlin Example:

EasyHttp.intentEasyHttpCookies(context)

Java Example:

EasyHttp.intentEasyHttpCookies(context);

Demo App

License

Copyright 2022 Jimmy Kang

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.