()
38 | private val NO_OVERRIDING = BaseUrlPlaceholder.instance
39 | private fun parseOverridingUrl(invokeMethod: Method): HttpUrl {
40 | cachedOverridingUrls[invokeMethod]?.let { return@parseOverridingUrl it }
41 | synchronized(BaseUrlInterceptor::class) {
42 | cachedOverridingUrls[invokeMethod]?.let { return@parseOverridingUrl it }
43 | val baseUrlStr = invokeMethod.getAnnotation(BaseUrl::class.java)?.value
44 | ?: invokeMethod.declaringClass.getAnnotation(BaseUrl::class.java)?.value
45 | baseUrlStr?.let {
46 | if (!it.endsWith("/")) throw IllegalStateException("base url must be ended with /. please fix the api interface #${invokeMethod.declaringClass.name}.${invokeMethod.name}#'s base url:$it")
47 | HttpUrl.get(it).let { httpUrl ->
48 | cachedOverridingUrls[invokeMethod] = httpUrl
49 | return@parseOverridingUrl httpUrl
50 | }
51 | }
52 | cachedOverridingUrls[invokeMethod] = NO_OVERRIDING
53 | return@parseOverridingUrl NO_OVERRIDING
54 | }
55 | }
56 |
57 |
58 |
59 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ##### 试试作者其他的开源库?
2 | * [smart-show](https://github.com/vincent-series/smart-show)
3 | # sharp-retrofit
4 |
5 | ### 功能概览
6 |
7 | 1. FlowCallAdapter，将Call对象转成Flow对象，Retrofit同Kotlin携程无缝对接，同Rxjava一致的流式编程体验
8 | 2. 可为ApiService接口或单个接口方法添加自定义注解，优雅、简便、无耦合地实现同一Retrofit实例满足不同功能配置需求，避免传统解决方式（创建多个Retrofit对象）带来的效率低下和维护不便。如
9 | * 同一开发环境下多base url问题，通过@BaseUrl + BaseUrlInterceptor实现
10 | * 不同接口指定不同超时时间问题，通过@CallTimeout、@ConnectTimeout、@ReadTimeout、@WriteTimeout注解 + TimeoutInterceptor实现
11 |
12 | ### 添加依赖
13 |
14 | implementation "io.github.vincent-series:sharp-retrofit:2.0"
15 |
16 | ### API DOC
17 | 完整API文档，请查阅[wiki](https://github.com/vincent-series/sharp-retrofit/wiki)
18 | ### 代码示例
19 | #### FlowCallAdapter的使用
20 | 1. 为`Retrofit`添加`FlowCallAdapterFactory`。
21 | ```kotlin
22 | private val retrofit = Retrofit.Builder()
23 | //...
24 | .addCallAdapterFactory(FlowCallAdapterFactory.create())
25 | .addConverterFactory(GsonConverterFactory.create())
26 | //...
27 | .build()
28 | ```
29 | 2. 声明api接口，指定返回类型为`Flow`类型，即`Flow`、`Flow>`，如果使用了`GsonConverter`,还可声明为`Flow<[Bean]>`、`Flow>`
30 | ```kotlin
31 | interface WeatherApiService {
32 | @GET("weather/now.json")
33 | fun getWeatherInfoNow(@Query("location") location: String): Flow
34 | }
35 | ```
36 | 3. 调用接口。
37 | ```kotlin
38 | ApiServiceManager.weatherApiService
39 | .getWeatherInfoNow(location = "北京")
40 | //transform data,if you want to
41 | .map {
42 | // ...
43 | }
44 | //subscribe on io dispatcher
45 | .flowOn(Dispatchers.IO)
46 | //catch errors
47 | .catch { ex ->
48 | println("error occurs:$ex")
49 | }
50 | //subscribe data
51 | .collect {
52 | println("weather info:$it")
53 | }
54 | ```
55 | #### @BaseUrl注解的使用
56 | 1. 设置BaseUrl占位符及添加BaseUrlInterceptor拦截器。
57 | ```kotlin
58 | private val retrofit = Retrofit.Builder()
59 | //设置BaseUrl占位符
60 | .baseUrl(BaseUrlPlaceholder.instance)
61 | .client(
62 | OkHttpClient.Builder()
63 | //添加BaseUrlInterceptor拦截器
64 | .addInterceptor(BaseUrlInterceptor())
65 | //...
66 | .build()
67 | )
68 | //...
69 | .build()
70 | ```
71 | 2. 为api接口添加@BaseUrl注解。
72 | ```kotlin
73 | @BaseUrl("https://api.seniverse.com/v3/")
74 | interface WeatherApiService {
75 | @GET("weather/now.json")
76 | fun getWeatherInfoNow(@Query("location") location: String): Flow
77 | }
78 | ```
79 | ```kotlin
80 | @BaseUrl("https://v2.alapi.cn/api/")
81 | interface LunarApiService {
82 | @GET("lunar")
83 | fun getLunarInfo(@Query("date") date: String): Flow
84 | }
85 | ```
86 |
87 |
88 |
89 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 |
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 |
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 |
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 |
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 |
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 |
51 | goto fail
52 |
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 |
57 | if exist "%JAVA_EXE%" goto execute
58 |
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 |
65 | goto fail
66 |
67 | :execute
68 | @rem Setup the command line
69 |
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 |
72 |
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 |
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 |
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 |
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 |
89 | :omega
90 |
--------------------------------------------------------------------------------
/sharp-retrofit/src/main/java/com/coder/vincent/sharp_retrofit/interceptors/TimeoutInterceptor.kt:
--------------------------------------------------------------------------------
1 | package com.coder.vincent.sharp_retrofit.interceptors
2 |
3 | import com.coder.vincent.sharp_retrofit.annotations.CallTimeout
4 | import com.coder.vincent.sharp_retrofit.annotations.ConnectTimeout
5 | import com.coder.vincent.sharp_retrofit.annotations.ReadTimeout
6 | import com.coder.vincent.sharp_retrofit.annotations.WriteTimeout
7 | import com.coder.vincent.sharp_retrofit.bean.TimeoutSetting
8 | import okhttp3.Interceptor
9 | import okhttp3.Response
10 | import okhttp3.internal.http.RealInterceptorChain
11 | import okio.AsyncTimeout
12 | import retrofit2.Invocation
13 | import java.lang.reflect.Method
14 |
15 | class TimeoutInterceptor : Interceptor {
16 | override fun intercept(chain: Interceptor.Chain): Response {
17 | val srcRequest = chain.request()
18 | val realChain = chain as? RealInterceptorChain
19 | srcRequest.tag(Invocation::class.java)?.let { invocation ->
20 | val timeoutSetting = parseOverridingTimeout(invocation.method())
21 | timeoutSetting.call?.let {
22 | val callTimeout = chain.call().timeout()
23 | callTimeout.timeout(it.timeout.toLong(), it.timeUnit)
24 | if (callTimeout is AsyncTimeout) {
25 | callTimeout.exit()
26 | callTimeout.enter()
27 | }
28 | }
29 |
30 | timeoutSetting.connect?.let {
31 | realChain?.withConnectTimeout(it.timeout, it.timeUnit)
32 | }
33 |
34 | timeoutSetting.read?.let {
35 | realChain?.withReadTimeout(it.timeout, it.timeUnit)
36 | }
37 |
38 | timeoutSetting.write?.let {
39 | realChain?.withWriteTimeout(it.timeout, it.timeUnit)
40 | }
41 |
42 | }
43 | return chain.proceed(chain.request())
44 | }
45 | }
46 |
47 | private val cachedOverridingTimeouts = mutableMapOf()
48 | private fun parseOverridingTimeout(invokeMethod: Method): TimeoutSetting {
49 | cachedOverridingTimeouts[invokeMethod]?.let { return@parseOverridingTimeout it }
50 | synchronized(TimeoutInterceptor::class) {
51 | cachedOverridingTimeouts[invokeMethod]?.let { return@parseOverridingTimeout it }
52 | val callTimeout = invokeMethod.getAnnotation(CallTimeout::class.java)
53 | ?: invokeMethod.declaringClass.getAnnotation(CallTimeout::class.java)
54 | val connectTimeout = invokeMethod.getAnnotation(ConnectTimeout::class.java)
55 | ?: invokeMethod.declaringClass.getAnnotation(ConnectTimeout::class.java)
56 | val readTimeout = invokeMethod.getAnnotation(ReadTimeout::class.java)
57 | ?: invokeMethod.declaringClass.getAnnotation(ReadTimeout::class.java)
58 | val writeTimeout = invokeMethod.getAnnotation(WriteTimeout::class.java)
59 | ?: invokeMethod.declaringClass.getAnnotation(WriteTimeout::class.java)
60 | val timeoutSetting = TimeoutSetting(callTimeout, connectTimeout, readTimeout, writeTimeout)
61 | cachedOverridingTimeouts[invokeMethod] = timeoutSetting
62 | return@parseOverridingTimeout timeoutSetting
63 | }
64 | }
--------------------------------------------------------------------------------
/sharp-retrofit/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.library'
3 | id 'kotlin-android'
4 | id 'kotlin-kapt'
5 | id 'maven-publish'
6 | id 'signing'
7 | }
8 |
9 | android {
10 | compileSdk 32
11 |
12 | defaultConfig {
13 | minSdk 17
14 | targetSdk 32
15 |
16 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
17 | consumerProguardFiles "consumer-rules.pro"
18 | }
19 |
20 | buildTypes {
21 | release {
22 | minifyEnabled false
23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
24 | }
25 | }
26 | compileOptions {
27 | sourceCompatibility JavaVersion.VERSION_1_8
28 | targetCompatibility JavaVersion.VERSION_1_8
29 | }
30 | kotlinOptions {
31 | jvmTarget = '1.8'
32 | }
33 | }
34 |
35 | dependencies {
36 | compileOnly 'com.squareup.retrofit2:retrofit:2.9.0'
37 | compileOnly 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.0'
38 | }
39 |
40 | afterEvaluate {
41 | publishing {
42 | def stagingVersion = "2.0"
43 | def snapshotsVersion = "1.8-1.0-SNAPSHOT"
44 | def uploadVersion = stagingVersion
45 | publications {
46 | maven(MavenPublication) {
47 | from components.release
48 | groupId = 'io.github.vincent-series'
49 | artifactId = 'sharp-retrofit'
50 | version = uploadVersion
51 |
52 | pom {
53 | name = 'sharp-retrofit'
54 | description = 'extended retrofit lib developed by zhiqiang.zhu.'
55 | url = 'https://github.com/vincent-series/sharp-retrofit'
56 |
57 | licenses {
58 | license {
59 | name = 'The Apache License, Version 2.0'
60 | url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
61 | }
62 | }
63 |
64 | developers {
65 | developer {
66 | id = 'zhiqiang.zhu'
67 | name = 'zhiqiang.zhu'
68 | email = 'coder_zzq@aliyun.com'
69 | }
70 | }
71 | scm {
72 | connection = 'scm:git:https://github.com/vincent-series/sharp-retrofit.git'
73 | developerConnection = 'scm:git:https://github.com/vincent-series/sharp-retrofit.git'
74 | url = 'https://github.com/vincent-series/sharp-retrofit'
75 | }
76 | }
77 |
78 | artifact generateSourcesJar
79 | }
80 | }
81 |
82 | repositories {
83 | maven {
84 | url = uploadVersion == stagingVersion ?
85 | 'https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/'
86 | : 'https://s01.oss.sonatype.org/content/repositories/snapshots/'
87 | credentials {
88 | username repo_user_name
89 | password repo_password
90 | }
91 | }
92 | }
93 |
94 | signing {
95 | sign publishing.publications.maven
96 | }
97 | }
98 | }
99 |
100 | task generateSourcesJar(type: Jar) {
101 | group = 'jar'
102 | archiveClassifier.set("sources")
103 | from("src/main/java")
104 | }
--------------------------------------------------------------------------------
/demo/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
10 |
15 |
20 |
25 |
30 |
35 |
40 |
45 |
50 |
55 |
60 |
65 |
70 |
75 |
80 |
85 |
90 |
95 |
100 |
105 |
110 |
115 |
120 |
125 |
130 |
135 |
140 |
145 |
150 |
155 |
160 |
165 |
170 |
171 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | #
4 | # Copyright 2015 the original author or authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 |
19 | ##############################################################################
20 | ##
21 | ## Gradle start up script for UN*X
22 | ##
23 | ##############################################################################
24 |
25 | # Attempt to set APP_HOME
26 | # Resolve links: $0 may be a link
27 | PRG="$0"
28 | # Need this for relative symlinks.
29 | while [ -h "$PRG" ] ; do
30 | ls=`ls -ld "$PRG"`
31 | link=`expr "$ls" : '.*-> \(.*\)$'`
32 | if expr "$link" : '/.*' > /dev/null; then
33 | PRG="$link"
34 | else
35 | PRG=`dirname "$PRG"`"/$link"
36 | fi
37 | done
38 | SAVED="`pwd`"
39 | cd "`dirname \"$PRG\"`/" >/dev/null
40 | APP_HOME="`pwd -P`"
41 | cd "$SAVED" >/dev/null
42 |
43 | APP_NAME="Gradle"
44 | APP_BASE_NAME=`basename "$0"`
45 |
46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48 |
49 | # Use the maximum available, or set MAX_FD != -1 to use that value.
50 | MAX_FD="maximum"
51 |
52 | warn () {
53 | echo "$*"
54 | }
55 |
56 | die () {
57 | echo
58 | echo "$*"
59 | echo
60 | exit 1
61 | }
62 |
63 | # OS specific support (must be 'true' or 'false').
64 | cygwin=false
65 | msys=false
66 | darwin=false
67 | nonstop=false
68 | case "`uname`" in
69 | CYGWIN* )
70 | cygwin=true
71 | ;;
72 | Darwin* )
73 | darwin=true
74 | ;;
75 | MINGW* )
76 | msys=true
77 | ;;
78 | NONSTOP* )
79 | nonstop=true
80 | ;;
81 | esac
82 |
83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84 |
85 |
86 | # Determine the Java command to use to start the JVM.
87 | if [ -n "$JAVA_HOME" ] ; then
88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
89 | # IBM's JDK on AIX uses strange locations for the executables
90 | JAVACMD="$JAVA_HOME/jre/sh/java"
91 | else
92 | JAVACMD="$JAVA_HOME/bin/java"
93 | fi
94 | if [ ! -x "$JAVACMD" ] ; then
95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
96 |
97 | Please set the JAVA_HOME variable in your environment to match the
98 | location of your Java installation."
99 | fi
100 | else
101 | JAVACMD="java"
102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
103 |
104 | Please set the JAVA_HOME variable in your environment to match the
105 | location of your Java installation."
106 | fi
107 |
108 | # Increase the maximum file descriptors if we can.
109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
110 | MAX_FD_LIMIT=`ulimit -H -n`
111 | if [ $? -eq 0 ] ; then
112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
113 | MAX_FD="$MAX_FD_LIMIT"
114 | fi
115 | ulimit -n $MAX_FD
116 | if [ $? -ne 0 ] ; then
117 | warn "Could not set maximum file descriptor limit: $MAX_FD"
118 | fi
119 | else
120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
121 | fi
122 | fi
123 |
124 | # For Darwin, add options to specify how the application appears in the dock
125 | if $darwin; then
126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
127 | fi
128 |
129 | # For Cygwin or MSYS, switch paths to Windows format before running java
130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
133 |
134 | JAVACMD=`cygpath --unix "$JAVACMD"`
135 |
136 | # We build the pattern for arguments to be converted via cygpath
137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
138 | SEP=""
139 | for dir in $ROOTDIRSRAW ; do
140 | ROOTDIRS="$ROOTDIRS$SEP$dir"
141 | SEP="|"
142 | done
143 | OURCYGPATTERN="(^($ROOTDIRS))"
144 | # Add a user-defined pattern to the cygpath arguments
145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
147 | fi
148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
149 | i=0
150 | for arg in "$@" ; do
151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
153 |
154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
156 | else
157 | eval `echo args$i`="\"$arg\""
158 | fi
159 | i=`expr $i + 1`
160 | done
161 | case $i in
162 | 0) set -- ;;
163 | 1) set -- "$args0" ;;
164 | 2) set -- "$args0" "$args1" ;;
165 | 3) set -- "$args0" "$args1" "$args2" ;;
166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
172 | esac
173 | fi
174 |
175 | # Escape application args
176 | save () {
177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
178 | echo " "
179 | }
180 | APP_ARGS=`save "$@"`
181 |
182 | # Collect all arguments for the java command, following the shell quoting and substitution rules
183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
184 |
185 | exec "$JAVACMD" "$@"
186 |
--------------------------------------------------------------------------------