Awesome Open Source
Awesome Open Source

EasyGo

简介:

基于Kotlin、OkHttp、HttpsUrlConnection整合的Http链式调用框架。

特性:

1、充分应用了Kotlin DSL语法糖,摆脱回调式写法,像写HTML界面文件一样写网络调用代码;

2、支持restful风格api接口请求,支持get、post、put、delete、head、patch、head请求方式;

3、请求数据格式支持Form表单格式、MultiPart多请求体格式、Json请求体格式;

4、支持文件断点下载、下载进度监听、文件下载中断;

5、支持多项全局性配置,如代理、超时时间、dns解析、HTTPS验证SSL等等;

6、支持配置全局的拦截器,也可以为每个请求单独设置拦截器,对请求进行拦截配置;

7、框架进行了分层设计,请求数据装载层、网络请求层、数据解析层完全解耦分离;

8、网络请求层设计了统一的接口,目前已内置OkHttp,HttpsUrlConnection,可自主实现HttpHandler使用其他网络框架作为HTTP请求层;

9、可在全局配置网络请求层的Handler(默认为OkHttpHandler,基于OkHttp),可以在全局配置,也可以在每次网络请求时自由切换;

10、文件下载时文件保存使用OkIo来读写,可以实现DownloadHandler自定义其他框架来进行文件的读写;

11、支持动态配置各个请求的各自的超时时间,全局一次配置,各个请求全都生效;

12、依赖库相当少,仅依赖OkHttp和OkIo框架,接入成本较低,jar包仅100多kb,十分轻量级;

......

一、添加依赖

implementation 'com.nick.code:easygo:1.0.1'

二、使用方法

1、全局配置

	// 配置全局的HttpConfig,该配置代码只可执行一次,可在项目初始化时执行
	EasyGo.initialize {

		// 配置请求客户端,内置OkHttp和HttpUrlConnection两种
		httpHandler(HttpHandler.OK_HTTP_HANDLER)

		// 设置连接超时时间,默认15s,单位为毫秒
		connectTimeOut(20000L)

		// 设置读取时间,默认15s,单位为毫秒
		readTimeOut(20000L)

		// 设置代理,默认不需要代理
		proxy(Proxy.NO_PROXY)

		// 自定义dns, 默认为系统dns解析 
		dns { host: String -> InetAddress.getAllByName(host) }

		// 自定义主机名验证,默认为不验证
		hostNameVerifier { hostname, session -> true }

		// 自定义证书,使用默认证书
		sslSocketFactory(SslHelper.getSSLSocketFactory())

		// 全局请求拦截器(对全部请求进行拦截,对全部请求生效),可添加多个
		addInterceptor { chain ->
			val req = chain.request()
			chain.proceed(req.newBuilder().addQuery("query1", "value1").build())
		}

		// 有条件的进行timeout配置
		timeoutHandler { url, tag, method, headers -> TimeoutConfig() }
	}

2、发送请求

   // 比如当前为post请求方式
	val httpResult = httpPost {

		// 配置请求的url
		url("https://www.baidu.com/app/search")

		// 配置header
		header {
			"header1" with "value1"
			"header2" with "value2"
		}

		// 配置url上的查询,url?query1=value1&query2=value2
		query {
			"query1" with "value1"
			"query2" with "value2"
		}

		// 配置请求体
		body {

			// 配置表单数据
			field {
				"field1" with "value1"
				"field2" with "value2"
			}

			// 配置json请求体数据
			json("{\"name\":\"zhangsan\", \"password\":\"123456\"}")

			// 配置多请求体part数据
			part {
				"part1" with "value1"
				"part2" with "value2"
			}

			// 配置当前是多请求体方式还是表单方式,默认为false,表单方式
			multi(true)
		}
	}
		// 对单个请求配置网络层的HttpHandler
		.httpHandler(HttpHandler.OK_HTTP_HANDLER)

		// 配置请求的tag
		.tag("tag")

		// 单个请求拦截器(对当前请求进行拦截,只对当前请求生效),可添加多个
		.addInterceptor { chain ->
			val req = chain.request()
			chain.proceed(req.newBuilder().addHeader("header1", "value1").build())
		}

		// 结果解析成哪种类型,泛型类型
		.asResult<List<String>>()

		// 发送请求
		.send()

三、注意事项

1、该库未加入线程调度机制,可使用RxJava、Kotlin协程(推荐)、ThreadPool开启的线程中进行网络请求的调用;

2、该库为纯Kotlin Library,不依赖Retrofit、不受Android开发环境限制,可在任意的Kotlin开发环境中使用;


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
java (30,061
android (6,000
kotlin (3,286
library (1,254
http (878
network (437
http-client (177
download (159
retrofit (89
java-library (85
okhttp (78
kotlin-dsl (29
coroutines-android (26
http-requests (25
chain (24
lib (23

Find Open Source By Browsing 7,000 Topics Across 59 Categories