retrofit spring boot starter
release 3.1.2
英語文書
改造用のスプリング ブート スターター。迅速な統合と機能強化をサポートします。
プロジェクトは引き続き最適化および反復されており、誰でも問題や PR を送信することができます。スターを付けてください。あなたのスターが継続的な更新のモチベーションになります。
Github プロジェクトのアドレス: https://github.com/LianjiaTech/retrofit-spring-boot-starter
gitee プロジェクトのアドレス: https://gitee.com/lianjiatech/retrofit-spring-boot-starter
サンプルデモ: https://github.com/ismart-yuxi/retrofit-spring-boot-demo
このプロジェクトのサンプルデモを作成してくれた
@ismart-yuxiに感謝します。
< dependency >
< groupId >com.github.lianjiatech</ groupId >
< artifactId >retrofit-spring-boot-starter</ artifactId >
< version >3.1.3</ version >
</ dependency >起動に失敗した場合は、依存関係の競合が発生している可能性が高く、関連する依存関係を導入または除外してください。
インターフェイスには@RetrofitClientアノテーションを付ける必要があります。 HTTP 関連の情報については、公式ドキュメント「レトロフィット公式ドキュメント」を参照してください。
@ RetrofitClient ( baseUrl = "${test.baseUrl}" )
public interface UserService {
/**
* 根据id查询用户姓名
*/
@ POST ( "getName" )
String getName ( @ Query ( "id" ) Long id );
}注:メソッド リクエストのパスは
/で始まる必要があることに注意してください。Retrofitの場合、baseUrl=http://localhost:8080/api/test/でメソッド リクエスト パスがpersonの場合、メソッドの完全なリクエスト パスはhttp://localhost:8080/api/test/personになります。メソッドのリクエスト パスが/person場合、メソッドの完全なリクエスト パスはhttp://localhost:8080/personになります。
インターフェースを他のサービスに挿入して使用してください。
@ Service
public class BusinessService {
@ Autowired
private UserService userService ;
public void doBusiness () {
// call userService
}
}デフォルトでは、 SpringBootスキャンパスがRetrofitClient登録に自動的に使用されます。 @RetrofitScan構成クラスに追加して、スキャンパスを手動で指定することもできます。
HTTPリクエストに関連するアノテーションはすべてRetrofitネイティブ アノテーションを使用します。簡単に説明します。
| 注釈の分類 | サポートされている注釈 |
|---|---|
| リクエスト方法 | @GET @HEAD @POST @PUT @DELETE @OPTIONS @HTTP |
| リクエストヘッダー | @Header @HeaderMap @Headers |
| クエリパラメータ | @Query @QueryMap @QueryName |
| パスパラメータ | @Path |
| フォームエンコードされたパラメータ | @Field @FieldMap @FormUrlEncoded |
| リクエストボディ | @Body |
| ファイルのアップロード | @Multipart @Part @PartMap |
| URLパラメータ | @Url |
詳細については、公式ドキュメントを参照してください: レトロフィット公式ドキュメント
このコンポーネントは、さまざまなビジネス シナリオに対応するために複数の構成可能な属性をサポートしています。サポートされている具体的な構成属性とデフォルト値は次のとおりです。
注: アプリケーションは、変更する構成項目を構成するだけで済みます。
retrofit :
# 全局转换器工厂
global-converter-factories :
- com.github.lianjiatech.retrofit.spring.boot.core.BasicTypeConverterFactory
- retrofit2.converter.jackson.JacksonConverterFactory
# 全局调用适配器工厂(组件扩展的调用适配器工厂已经内置，这里请勿重复配置)
global-call-adapter-factories :
# 全局日志打印配置
global-log :
# 启用日志打印
enable : true
# 全局日志打印级别
log-level : info
# 全局日志打印策略
log-strategy : basic
# 是否聚合打印请求日志
aggregate : true
# 全局重试配置
global-retry :
# 是否启用全局重试
enable : false
# 全局重试间隔时间
interval-ms : 100
# 全局最大重试次数
max-retries : 2
# 全局重试规则
retry-rules :
- response_status_not_2xx
- occur_io_exception
# 全局超时时间配置
global-timeout :
# 全局读取超时时间
read-timeout-ms : 10000
# 全局写入超时时间
write-timeout-ms : 10000
# 全局连接超时时间
connect-timeout-ms : 10000
# 全局完整调用超时时间
call-timeout-ms : 0
# 熔断降级配置
degrade :
# 熔断降级类型。默认none，表示不启用熔断降级
degrade-type : none
# 全局sentinel降级配置
global-sentinel-degrade :
# 是否开启
enable : false
# 各降级策略对应的阈值。平均响应时间(ms)，异常比例(0-1)，异常数量(1-N)
count : 1000
# 熔断时长，单位为 s
time-window : 5
# 降级策略（0：平均响应时间；1：异常比例；2：异常数量）
grade : 0
# 全局resilience4j降级配置
global-resilience4j-degrade :
# 是否开启
enable : false
# 根据该名称从#{@link CircuitBreakerConfigRegistry}获取CircuitBreakerConfig，作为全局熔断配置
circuit-breaker-config-name : defaultCircuitBreakerConfig
# 自动设置PathMathInterceptor的scope为prototype
auto-set-prototype-scope-for-path-math-interceptor : true OkHttpClientのタイムアウトのみを変更する必要がある場合は、 @RetrofitClient関連フィールドを使用して変更するか、グローバル タイムアウト構成を変更できます。
OkHttpClient他の構成を変更する必要がある場合は、 OkHttpClientカスタマイズすることで実行できます。手順は次のとおりです。
SourceOkHttpClientRegistrarインターフェイスを実装し、 SourceOkHttpClientRegistry#register()メソッドを呼び出してOkHttpClientを登録します
@ Component
public class CustomOkHttpClientRegistrar implements SourceOkHttpClientRegistrar {
@ Override
public void register ( SourceOkHttpClientRegistry registry ) {
// 注册customOkHttpClient，超时时间设置为1s
registry . register ( "customOkHttpClient" , new OkHttpClient . Builder ()
. connectTimeout ( Duration . ofSeconds ( 1 ))
. writeTimeout ( Duration . ofSeconds ( 1 ))
. readTimeout ( Duration . ofSeconds ( 1 ))
. addInterceptor ( chain -> chain . proceed ( chain . request ()))
. build ());
}
} @RetrofitClient.sourceOkHttpClientを通じて現在のインターフェイスで使用されるOkHttpClient指定します
@ RetrofitClient ( baseUrl = "${test.baseUrl}" , sourceOkHttpClient = "customOkHttpClient" )
public interface CustomOkHttpUserService {
/**
* 根据id查询用户信息
*/
@ GET ( "getUser" )
User getUser ( @ Query ( "id" ) Long id );
}注: コンポーネントは、指定された
OkHttpClient直接使用しませんが、OkHttpClientに基づいて新しい OkHttpClient を作成します。
このコンポーネントは、URL パスの一致に基づいたインターセプトをサポートするアノテーション インターセプターを提供します。使用する手順は次のとおりです。
BasePathMatchInterceptorの継承@Interceptアノテーションを使用して、使用するインターセプターを指定します複数のインターセプターを使用する必要がある場合は、インターフェース上で複数の
@Interceptアノテーションをマークするだけです。
BasePathMatchInterceptorを継承してインターセプト プロセッサを作成する @ Component
public class PathMatchInterceptor extends BasePathMatchInterceptor {
@ Override
protected Response doIntercept ( Chain chain ) throws IOException {
Response response = chain . proceed ( chain . request ());
// response的Header加上path.match
return response . newBuilder (). header ( "path.match" , "true" ). build ();
}
}デフォルトでは、コンポーネントはBasePathMatchInterceptorのscope prototypeに自動的に設定します。 この機能はretrofit.auto-set-prototype-scope-for-path-math-interceptor=falseによってオフにできます。閉じた後、 scopeをprototypeに手動で設定する必要があります。
@ Component
@ Scope ( "prototype" )
public class PathMatchInterceptor extends BasePathMatchInterceptor {
}@Intercept使用してインターフェイスにアノテーションを付けます @ RetrofitClient ( baseUrl = "${test.baseUrl}" )
@ Intercept ( handler = PathMatchInterceptor . class , include = { "/api/user/**" }, exclude = "/api/user/getUser" )
// @Intercept() 如果需要使用多个路径匹配拦截器，继续添加@Intercept即可
public interface InterceptorUserService {
/**
* 根据id查询用户姓名
*/
@ POST ( "getName" )
Response < String > getName ( @ Query ( "id" ) Long id );
/**
* 根据id查询用户信息
*/
@ GET ( "getUser" )
Response < User > getUser ( @ Query ( "id" ) Long id );
}上記の@Intercept設定は、 InterceptorUserServiceインターフェイス ( /api/user/getUserを除く) の/api/user/**パスにあるリクエストをインターセプトし、インターセプト プロセッサはPathMatchInterceptorを使用することを意味します。
場合によっては、「インターセプト アノテーション」でいくつかのパラメーターを動的に渡し、インターセプト時にこれらのパラメーターを使用する必要があります。 このとき、「カスタム インターセプト アノテーション」を使用できます。手順は次のとおりです。
@InterceptMarkマークを使用する必要があり、注釈にはinclude、exclude、handlerフィールドを含める必要があります。BasePathMatchInterceptorを継承してインターセプト プロセッサを作成するたとえば、「HTTP リクエストを開始する前に、 accessKeyIdとaccessKeySecret署名情報をリクエスト ヘッダーに動的に追加する」必要がある場合、これを実現するために@Signアノテーションをカスタマイズできます。
@Signアノテーション @ Retention ( RetentionPolicy . RUNTIME )
@ Target ( ElementType . TYPE )
@ Documented
@ InterceptMark
public @interface Sign {
String accessKeyId ();
String accessKeySecret ();
String [] include () default { "/**" };
String [] exclude () default {};
Class <? extends BasePathMatchInterceptor > handler () default SignInterceptor . class ;
}使用されるインターセプターは、 @Signアノテーションで指定されたSignInterceptorです。
SignInterceptorの実装 @ Component
@ Setter
public class SignInterceptor extends BasePathMatchInterceptor {
private String accessKeyId ;
private String accessKeySecret ;
@ Override
public Response doIntercept ( Chain chain ) throws IOException {
Request request = chain . request ();
Request newReq = request . newBuilder ()
. addHeader ( "accessKeyId" , accessKeyId )
. addHeader ( "accessKeySecret" , accessKeySecret )
. build ();
Response response = chain . proceed ( newReq );
return response . newBuilder (). addHeader ( "accessKeyId" , accessKeyId )
. addHeader ( "accessKeySecret" , accessKeySecret ). build ();
}
}注:
accessKeyIdフィールドとaccessKeySecretフィールドはsetterメソッドを提供する必要があります。
インターセプターのaccessKeyIdおよびaccessKeySecretフィールドの値は、 @SignアノテーションのaccessKeyId()およびaccessKeySecret()値に基づいて自動的に挿入されます。 @Signプレースホルダーの形式で文字列を指定する場合、構成属性値はインジェクションに使用されます。
@Signを使用する @ RetrofitClient ( baseUrl = "${test.baseUrl}" )
@ Sign ( accessKeyId = "${test.accessKeyId}" , accessKeySecret = "${test.accessKeySecret}" , include = "/api/user/getAll" )
public interface InterceptorUserService {
/**
* 查询所有用户信息
*/
@ GET ( "getAll" )
Response < List < User >> getAll ();
}このコンポーネントは、グローバル ログ出力と宣言型ログ出力をサポートしています。
デフォルトでは、グローバル ログの印刷が有効になっており、デフォルトの構成は次のとおりです。
retrofit :
# 全局日志打印配置
global-log :
# 启用日志打印
enable : true
# 全局日志打印级别
log-level : info
# 全局日志打印策略
log-strategy : basic
# 是否聚合打印请求日志
aggregate : true
# 日志名称，默认为{@link LoggingInterceptor} 的全类名
logName : com.github.lianjiatech.retrofit.spring.boot.log.LoggingInterceptor4 つのログ出力戦略の意味は次のとおりです。
NONE : ログはありません。BASIC : リクエスト行とレスポンス行をログに記録します。HEADERS : リクエスト行と応答行、およびそれぞれのヘッダーをログに記録します。BODY : リクエスト行と応答行、およびそれぞれのヘッダーと本文 (存在する場合) をログに記録します。 一部のリクエストのログのみを出力する必要がある場合は、関連するインターフェイスまたはメソッドで@Loggingアノテーションを使用できます。
ログの出力動作を変更する必要がある場合は、 LoggingInterceptor継承し、 Spring beanとして構成できます。
コンポーネントのサポートは、グローバル再試行と宣言的再試行をサポートします。
グローバル再試行はデフォルトでオフになっており、デフォルトの構成項目は次のとおりです。
retrofit :
# 全局重试配置
global-retry :
# 是否启用全局重试
enable : false
# 全局重试间隔时间
interval-ms : 100
# 全局最大重试次数
max-retries : 2
# 全局重试规则
retry-rules :
- response_status_not_2xx
- occur_io_exception再試行ルールは 3 つの構成をサポートしています。
RESPONSE_STATUS_NOT_2XX : レスポンスステータスコードが2xx以外の場合にリトライOCCUR_IO_EXCEPTION : IO例外が発生したときに再試行しますOCCUR_EXCEPTION : 例外が発生した場合に再試行します一部のリクエストのみを再試行する必要がある場合は、対応するインターフェイスまたはメソッドで@Retryアノテーションを使用できます。
リクエストの再試行動作を変更する必要がある場合は、 RetryInterceptor継承してSpring beanとして構成できます。
サーキット ブレーカーのダウングレードはデフォルトでオフになっており、現在はsentinelとresilience4jの実装をサポートしています。
retrofit :
# 熔断降级配置
degrade :
# 熔断降级类型。默认none，表示不启用熔断降级
degrade-type : sentinel degrade-type=sentinelを設定して有効にし、関連するインターフェイスまたはメソッドで@SentinelDegradeアノテーションを宣言します。
Sentinel依存関係を手動で導入することを忘れないでください。
< dependency >
< groupId >com.alibaba.csp</ groupId >
< artifactId >sentinel-core</ artifactId >
< version >1.6.3</ version >
</ dependency >さらに、グローバルSentinelサーキット ブレーカーのダウングレードもサポートされています。
retrofit :
# 熔断降级配置
degrade :
# 熔断降级类型。默认none，表示不启用熔断降级
degrade-type : sentinel
# 全局sentinel降级配置
global-sentinel-degrade :
# 是否开启
enable : true
# ...其他sentinel全局配置これを有効にするには、 degrade-type=resilience4jを構成します。次に、関連するインターフェイスまたはメソッドで@Resilience4jDegradeを宣言します。
Resilience4j依存関係を手動で導入することを忘れないでください。
< dependency >
< groupId >io.github.resilience4j</ groupId >
< artifactId >resilience4j-circuitbreaker</ artifactId >
< version >1.7.1</ version >
</ dependency >グローバルな resilience4j サーキット ブレーカーのダウングレードは、次の構成を通じて有効にできます。
retrofit :
# 熔断降级配置
degrade :
# 熔断降级类型。默认none，表示不启用熔断降级
degrade-type : resilience4j
# 全局resilience4j降级配置
global-resilience4j-degrade :
# 是否开启
enable : true
# 根据该名称从#{@link CircuitBreakerConfigRegistry}获取CircuitBreakerConfig，作为全局熔断配置
circuit-breaker-config-name : defaultCircuitBreakerConfigサーキットブレーカーの構成管理:
CircuitBreakerConfigRegistrarインターフェイスを実装し、 CircuitBreakerConfigを登録します。
@ Component
public class CustomCircuitBreakerConfigRegistrar implements CircuitBreakerConfigRegistrar {
@ Override
public void register ( CircuitBreakerConfigRegistry registry ) {
// 替换默认的CircuitBreakerConfig
registry . register ( Constants . DEFAULT_CIRCUIT_BREAKER_CONFIG , CircuitBreakerConfig . ofDefaults ());
// 注册其它的CircuitBreakerConfig
registry . register ( "testCircuitBreakerConfig" , CircuitBreakerConfig . custom ()
. slidingWindowType ( CircuitBreakerConfig . SlidingWindowType . TIME_BASED )
. failureRateThreshold ( 20 )
. minimumNumberOfCalls ( 5 )
. permittedNumberOfCallsInHalfOpenState ( 5 )
. build ());
}
} CircuitBreakerConfig circuitBreakerConfigNameによって指定されます。 retrofit.degrade.global-resilience4j-degrade.circuit-breaker-config-nameまたは@Resilience4jDegrade.circuitBreakerConfigNameを含めます
ユーザーが他のサーキット ブレーカーの劣化実装を使用する必要がある場合は、 BaseRetrofitDegradeを継承し、 Spring Bean設定します。
@RetrofitClient fallbackまたはfallbackFactory設定していない場合、サーキット ブレーカーがトリガーされると、 RetrofitBlockException直接スローされます。 ユーザーは、 fallbackまたはfallbackFactoryを設定することで、融合が発生したときのメソッドの戻り値をカスタマイズできます。
注:
fallbackクラスは現在のインターフェイスの実装クラスである必要があり、fallbackFactoryFallbackFactory<T>実装クラスである必要があり、ジェネリック パラメーターの型は現在のインターフェイスの型である必要があります。さらに、fallbackとfallbackFactoryインスタンスをSpring Beanとして構成する必要があります。
fallbackと比べて、fallbackFactory fallback fallbackFactory 、各サーキットブレーカーの異常原因（原因）を検知できることです。参考例は以下の通りです。
@ Slf4j
@ Service
public class HttpDegradeFallback implements HttpDegradeApi {
@ Override
public Result < Integer > test () {
Result < Integer > fallback = new Result <>();
fallback . setCode ( 100 )
. setMsg ( "fallback" )
. setBody ( 1000000 );
return fallback ;
}
} @ Slf4j
@ Service
public class HttpDegradeFallbackFactory implements FallbackFactory < HttpDegradeApi > {
@ Override
public HttpDegradeApi create ( Throwable cause ) {
log . error ( "触发熔断了! " , cause . getMessage (), cause );
return new HttpDegradeApi () {
@ Override
public Result < Integer > test () {
Result < Integer > fallback = new Result <>();
fallback . setCode ( 100 )
. setMsg ( "fallback" )
. setBody ( 1000000 );
return fallback ;
}
};
}
}HTTP要求エラー (例外や応答データが期待を満たさないことを含む) が発生すると、エラー デコーダーはHTTP関連の情報をカスタム例外にデコードできます。 @RetrofitClientの errorDecoder errorDecoder()アノテーションで現在のインターフェースのエラー デコーダーを指定できます。カスタム エラー デコーダーはErrorDecoderインターフェースを実装する必要があります。
ServiceInstanceChooserの継承ユーザーは自分でServiceInstanceChooserインターフェースを実装し、サービス インスタンスの選択ロジックを完成させ、それをSpring Beanとして構成できます。 Spring Cloudアプリケーションの場合、次の実装を使用できます。
@ Service
public class SpringCloudServiceInstanceChooser implements ServiceInstanceChooser {
private LoadBalancerClient loadBalancerClient ;
@ Autowired
public SpringCloudServiceInstanceChooser ( LoadBalancerClient loadBalancerClient ) {
this . loadBalancerClient = loadBalancerClient ;
}
/**
* Chooses a ServiceInstance URI from the LoadBalancer for the specified service.
*
* @param serviceId The service ID to look up the LoadBalancer.
* @return Return the uri of ServiceInstance
*/
@ Override
public URI choose ( String serviceId ) {
ServiceInstance serviceInstance = loadBalancerClient . choose ( serviceId );
Assert . notNull ( serviceInstance , "can not found service instance! serviceId=" + serviceId );
return serviceInstance . getUri ();
}
}serviceIdとpathを指定します @ RetrofitClient ( serviceId = "user" , path = "/api/user" )
public interface ChooserOkHttpUserService {
/**
* 根据id查询用户信息
*/
@ GET ( "getUser" )
User getUser ( @ Query ( "id" ) Long id );
}システム全体のHTTPリクエストに対して統一的なインターセプト処理を行う必要がある場合は、グローバル インターセプターGlobalInterceptorを実装し、 spring Beanとして構成できます。
@ Component
public class MyGlobalInterceptor implements GlobalInterceptor {
@ Override
public Response intercept ( Chain chain ) throws IOException {
Response response = chain . proceed ( chain . request ());
// response的Header加上global
return response . newBuilder (). header ( "global" , "true" ). build ();
}
}NetworkInterceptorインターフェースを実装し、 spring Beanとして構成します。
Retrofit CallAdapterFactoryを通じてCall<T>オブジェクトをインターフェイス メソッドの戻り値の型に適応させることができます。このコンポーネントは、いくつかのCallAdapterFactory実装を拡張します。
BodyCallAdapterFactoryHTTPリクエストを同期的に実行し、レスポンス本文の内容をメソッドの戻り値の型に適合させます。BodyCallAdapterFactory最も低い優先順位で使用できます。ResponseCallAdapterFactoryHTTPリクエストを同期的に実行し、レスポンス本文の内容をRetrofit.Response<T>に適合させて返します。ResponseCallAdapterFactory 、メソッドの戻り値の型がRetrofit.Response<T>の場合にのみ使用できます。CallAdapterFactory Retrofitメソッドの戻り値の型に基づいて、対応するCallAdapterFactory選択して適応処理を実行します。現在サポートされている戻り値の型は次のとおりです。
String : Response Body Stringに適応させて返します。Long / Integer / Boolean / Float / Double ): Response Body上記の基本タイプに適合させます。Javaタイプ: Response Body対応するJavaオブジェクトに適応させて返します。CompletableFuture<T> : Response Body CompletableFuture<T>オブジェクトに適応させて返します。Void : 戻り値の型を気にしない場合は、 Voidを使用できます。Response<T> : Response Response<T>オブジェクトに適応させて返します。Call<T> : アダプテーション処理を実行せず、 Call<T>オブジェクトを直接返します。Mono<T> : Project Reactorリアクティブな戻り値の型Single<T> : Rxjava応答型戻り値の型 ( Rxjava2/Rxjava3をサポート)Completable : Rxjava応答型戻り値、 HTTPリクエストには応答本文がありません ( Rxjava2/Rxjava3をサポート) CallAdapter CallAdapter.Factoryを継承することで拡張できます。
このコンポーネントはretrofit.global-call-adapter-factories設定を通じてグローバル呼び出しアダプター ファクトリをサポートします。
retrofit :
# 全局转换器工厂(组件扩展的`CallAdaptorFactory`工厂已经内置，这里请勿重复配置)
global-call-adapter-factories :
# ... Java インターフェイスごとに、 @RetrofitClient.callAdapterFactoriesを通じて現在のインターフェイスで使用されるCallAdapter.Factory指定することもできます。
提案:
CallAdapter.FactorySpring Beanとして構成する
Retrofit Converter使用して@Bodyアノテーション付きオブジェクトをRequest Bodyに変換し、 Response Body Javaオブジェクトに変換します。次のConverterから選択できます。
このコンポーネントはretrofit.global-converter-factoriesによるグローバルConverter.Factoryの構成をサポートします。デフォルトは、 retrofit2.converter.jackson.JacksonConverterFactoryです。
Jackson構成を変更する必要がある場合は、 JacksonConverterFactoryのbean構成を自分で上書きするだけです。
retrofit :
# 全局转换器工厂
global-converter-factories :
- com.github.lianjiatech.retrofit.spring.boot.core.BasicTypeConverterFactory
- retrofit2.converter.jackson.JacksonConverterFactory Javaインターフェイスごとに、 @RetrofitClient.converterFactoriesを通じて現在のインターフェイスで使用されるConverter.Factoryを指定することもできます。
提案:
Converter.FactorySpring Beanとして構成します。
@RetrofitClient 、 @Retry 、 @Logging 、 @Resilience4jDegradeなどのアノテーションは、メタ アノテーション、継承、 @AliasForをサポートします。
@ Retention ( RetentionPolicy . RUNTIME )
@ Target ( ElementType . TYPE )
@ Documented
@ Inherited
@ RetrofitClient ( baseUrl = "${test.baseUrl}" )
@ Logging ( logLevel = LogLevel . WARN )
@ Retry ( intervalMs = 200 )
public @interface MyRetrofitClient {
@ AliasFor ( annotation = RetrofitClient . class , attribute = "converterFactories" )
Class <? extends Converter . Factory >[] converterFactories () default { GsonConverterFactory . class };
@ AliasFor ( annotation = Logging . class , attribute = "logStrategy" )
LogStrategy logStrategy () default LogStrategy . BODY ;
} @ FormUrlEncoded
@ POST ( "token/verify" )
Object tokenVerify ( @ Field ( "source" ) String source , @ Field ( "signature" ) String signature , @ Field ( "token" ) String token );
@ FormUrlEncoded
@ POST ( "message" )
CompletableFuture < Object > sendMessage ( @ FieldMap Map < String , Object > param ); // 对文件名使用URLEncoder进行编码
public ResponseEntity importTerminology ( MultipartFile file ){
String fileName = URLEncoder . encode ( Objects . requireNonNull ( file . getOriginalFilename ()), "utf-8" );
okhttp3 . RequestBody requestBody = okhttp3 . RequestBody . create ( MediaType . parse ( "multipart/form-data" ), file . getBytes ());
MultipartBody . Part part = MultipartBody . Part . createFormData ( "file" , fileName , requestBody );
apiService . upload ( part );
return ok (). build ();
}HTTPアップロードインターフェース @ POST ( "upload" )
@ Multipart
Void upload ( @ Part MultipartBody . Part file );HTTPダウンロードインターフェース @ RetrofitClient ( baseUrl = "https://img.ljcdn.com/hc-picture/" )
public interface DownloadApi {
@ GET ( "{fileKey}" )
Response < ResponseBody > download ( @ Path ( "fileKey" ) String fileKey );
}HTTPダウンロードの使用法 @ SpringBootTest ( classes = { RetrofitBootApplication . class })
@ RunWith ( SpringRunner . class )
public class DownloadTest {
@ Autowired
DownloadApi downLoadApi ;
@ Test
public void download () throws Exception {
String fileKey = "6302d742-ebc8-4649-95cf-62ccf57a1add" ;
Response < ResponseBody > response = downLoadApi . download ( fileKey );
ResponseBody responseBody = response . body ();
// 二进制流
InputStream is = responseBody . byteStream ();
// 具体如何处理二进制流，由业务自行控制。这里以写入文件为例
File tempDirectory = new File ( "temp" );
if (! tempDirectory . exists ()) {
tempDirectory . mkdir ();
}
File file = new File ( tempDirectory , UUID . randomUUID (). toString ());
if (! file . exists ()) {
file . createNewFile ();
}
FileOutputStream fos = new FileOutputStream ( file );
byte [] b = new byte [ 1024 ];
int length ;
while (( length = is . read ( b )) > 0 ) {
fos . write ( b , 0 , length );
}
is . close ();
fos . close ();
}
}動的 URL は@urlアノテーションを使用して実装できます。現時点では、 baseUrl任意の有効な URL で構成できます。例: http://github.com/ 。実行時、リクエストは@Urlアドレスに基づいてのみ開始されます。
注:
@urlメソッドパラメータの最初の位置に配置する必要があります。また、@GET、@POSTおよびその他のアノテーションはエンドポイント パスを定義する必要はありません。
@ GET
Map < String , Object > test3 ( @ Url String url , @ Query ( "name" ) String name );DELETEリクエストはリクエストボディを追加します @ HTTP ( method = "DELETE" , path = "/user/delete" , hasBody = true )GETリクエストに追加するokhttp3自体は、 GETリクエストボディの追加をサポートしていません。ソースコードは次のとおりです。
著者は具体的な理由を述べています。以下を参照してください。
ただし、これを本当に行う必要がある場合は、 @HTTP(method = "get", path = "/user/get", hasBody = true)使用し、小文字のgetを使用して上記の制限を回避できます。
ご質問がある場合は、問題を提起するか、QQ グループに参加してフィードバックを求めてください。
グループ番号: 806714302
