ccolorcat/KingFisher

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.ccolorcat:kingfisher:3.0.0'
	}
	dependencies {
		implementation("com.github.ccolorcat:kingfisher:3.0.0")
	}
	<dependency>
	    <groupId>com.github.ccolorcat</groupId>
	    <artifactId>kingfisher</artifactId>
	    <version>3.0.0</version>
	</dependency>

                            
    libraryDependencies += "com.github.ccolorcat" % "kingfisher" % "3.0.0"
        
        

                            
    :dependencies [[com.github.ccolorcat/kingfisher "3.0.0"]]

Readme

KingFisher

用于网络请求，以 NetBird 为基础，使用方式与 retrofit 类似。实现方式上 retrofit 使用代理，本项目利用注解编译期自动生成代码。支持上传、下载及相关的进度监听等。

1. 特性

  • 支持同步和异步请求。
  • 支持 Android 平台，相关回调均在主线程进行。
  • 支持日志、自定义缓存等特性。
  • 支持数据解析且可自定义，其中数据解析均在后台线程中执行。
  • 支持文件上传、下载及进度的监听。
  • 支持对请求和响应进行拦截。

2. 模块简介

| 模块名 | 功能说明 | | ----------------------- | ---------------------------- | | core | 核心模块，必须。 | | annotation | 提供注解，必须。 | | processor | 处理注解，并生成代码，必须。 | | gson_parser_factory | 提供 Gson 数据解析支持。 | | jackson_parser_factory | 提供 Jackson 数据解析支持。 | | fastjson-parser-factory | 提供 fastjson 数据解析支持。 |

3. 用法举例

（1）初始化

NetBird netBird = new NetBird.Builder("https://api.github.com/")
    .addTailInterceptor(new JsonLoggingTailInterceptor())
    .enableGzip(true)
    .build();
// 简单初始化无需单独设置 client 但需设置 baseUrl，此处添加了自定义日志模块。
new KingFisher.Builder()
    .client(netBird)
    .addParserFactory(new GsonParserFactory<>(new Gson()))
    .initialize();

（2）编写接口

@Api
public interface TestApi {
    @GET("users/{user}/repos")
    Call<List<Repo>> listRepos(@Path("user") String user);

    @BaseUrl("http://www.imooc.com/")
    @GET("api/teacher")
    Call<List<Course>> listCourses(@Param("type") int type, @Param("num") int num);

    @BaseUrl("https://dldir1.qq.com/weixin/android/weixin673android1360.apk")
    @GET
    Call<File> downloadWeChat(@Down DownPack pack);

    @GET
    Call<File> downloadWeChat(@Url String url, @Down File savePath);
}

（3）同步请求

TestApi api = new TestApiService();
List<Repo> repos = api.listRepos("ccolorcat").execute();
System.out.println(repos);

（4）异步请求

TestApi api = new TestApiService();
api.listRepos("ccolorcat").enqueue(new SimpleCallback<List<Repo>>() {
    @Override
    public void onSuccess(List<Repo> result) {
        System.out.println(result);
    }
});

4. 使用方法

(1) 在项目的 build.gradle 中配置仓库地址：

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

(2) 添加项目依赖：

java

dependencies {
    implementation 'com.github.ccolorcat.NetBird:netbird:v4.3.4'
    implementation 'com.github.ccolorcat.KingFisher:core:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:annotation:v2.2.2'
    annotationProcessor 'com.github.ccolorcat.KingFisher:processor:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:gson_parser_factory:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:jackson-parser_factory:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:fastjson-parser_factory:v2.2.2'
}

kotlin

apply plugin: 'kotlin-kapt'
...
dependencies {
    implementation 'com.github.ccolorcat.NetBird:netbird:v4.3.4'
    implementation 'com.github.ccolorcat.KingFisher:core:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:annotation:v2.2.2'
    kapt 'com.github.ccolorcat.KingFisher:processor:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:gson_parser_factory:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:jackson-parser_factory:v2.2.2'
    implementation 'com.github.ccolorcat.KingFisher:fastjson-parser_factory:v2.2.2'
}

安卓平台，需额外添加支持：

dependencies {
    implementation 'com.github.ccolorcat.NetBird:netbird-android-support:v4.3.4'
}

5. 版本历史

v2.2.2

  1. 增加自定义生成类类名的功能，可在 @Api 注解中指定。

v2.1.2

  1. 允许添加 null 参数和 header，但会被忽略。
  2. bug 修复。

v2.1.1

增加对 @Path 注解的参数类型的检查。

v2.1.0

添加覆盖自带的 StringParserFactory 的方法，使用情景说明如下：

自带 StringParserFactory 在解析字符串时，首先会检测服务器返回的编码信息，如果有则使用服务器返回的编码格式进行解析，如果没有则使用 UTF-8。

如果服务器没有返回字符编码信息，而字符又不是 UTF-8 编码，则解析出来的字符串可能是乱码，此时可调用此方法自定义字符解析。

v2.0.0

  1. 上传、下载新增更加简单的使用方式，见用法举例。
  2. 新增动态 Url 支持。
  3. 生成的代码更好看了。

v1.0.1

更改注解的 Retention

v1.0.0

首次发布。