Retrofit.Netダウンロード - Retrofit.Netソースコードのダウンロード

Retrofit.Netについて
サポートランタイムバージョン
インストール中
Retrofit.Net による休息
- API を定義する
- 基本的な URL 設定などをセットアップする
  - 取得リクエストの送信
  - 投稿リクエストを送信する
  - Put リクエストを送信する
  - 削除リクエストを送信する
  - FormDataで複数のファイルをサーバーにアップロードする
  - 応答ストリームの取得
    - ファイルをダウンロード中
コンテンツタイプ
Retrofit.Net 構成
リクエストオプション
応答スキーマ
インターセプター
- シンプルなインターセプター
- アドバンスト・インターセプター
  - リクエストを解決して拒否する
コンバータ
HTTPS 証明書の検証 (実装されていません...)
機能とバグ

Retrofit.Netについて

強力な .NET Restful Http クライアント。インターセプター、メッセージ変換、Get、Post、Put、Delete、ファイルアップロード、ファイルダウンロード、プロキシ、HTTPS 証明書検証をサポートします。

サポートランタイムバージョン

ターゲットフレームワーク	バージョン	はい/いいえ
。ネット	8.x	はい
。ネット	7.x	はい
。ネット	6.x	はい
。ネット	5.x	いいえ
.NETコア	3.x	いいえ
.NETコア	2.x	いいえ
.NET標準	2.1	いいえ
.NET標準	2.0	いいえ
.NET標準	1.x	いいえ
.NETフレームワーク	全て	いいえ

インストール中

  dotnet add package RetrofitNet

Retrofit.Net による休息

API を定義する

 public interface IPersonService
{
  [ HttpPost ( "/api/Auth/GetJwtToken" ) ]
  Response < TokenModel > GetJwtToken ( [ FromForm ] AuthModel auth ) ;

  [ HttpGet ( "/api/Person" ) ]
  Response < IList < Person > > Get ( ) ;

  [ HttpPost ( "/api/Person" ) ]
  Response < Person > Add ( [ FromBody ] Person person ) ;

  [ HttpGet ( "/api/Person/{id}" ) ]
  Response < Person > Get ( [ FromPath ] int id ) ;

  [ HttpPut ( "/api/Person/{id}" ) ]
  Response < Person > Update ( [ FromPath ] int id , [ FromBody ] Person person ) ;

  [ HttpDelete ( "/api/Person/{id}" ) ]
  Response < Person > Delete ( [ FromPath ] int id ) ;
        
  [ HttpGet ( "https://www.baidu.com/index.html" ) ]
  Response < dynamic > GetBaiduHome ( ) ;
}

基本的な URL 設定などをセットアップする

 using Retrofit . Net . Core ;
using Retrofit . Net . Core . Models ;

var client = new RetrofitClient . Builder ( )
    . AddInterceptor ( new HeaderInterceptor ( ) )
    . Build ( ) ;
var retrofit = new Retrofit . Net . Core . Retrofit . Builder ( )
    . AddBaseUrl ( "https://localhost:7177" )
    . AddClient ( client )
    . Build ( ) ;
var service = retrofit . Create < IPersonService > ( ) ;
Response < TokenModel > authResponse = service . GetJwtToken ( new AuthModel ( ) { Account = "admin" , Password = "admin" } ) ;

取得リクエストの送信

 Response < IList < Person > > response = await service . Get ( ) ;
Console . WriteLine ( JsonConvert . SerializeObject ( response ) ) ;

投稿リクエストを送信する

 Response < Person > response = await service . Add ( new Person { Id = 1 , Name = "老中医" , Age = 18 } ) ;
Console . WriteLine ( JsonConvert . SerializeObject ( response ) ) ;

Put リクエストを送信する

 var response = service . Update ( 1 , new Person ( ) { Name = "Charlie" } ) ;

削除リクエストを送信する

 var response = service . Delete ( 1 ) ;

FormDataで複数のファイルをサーバーにアップロードする

SubmitEntity.cs

 public class SubmitEntity
{
    public string Name { get ; set ; }
    public FieldFile File { get ; set ; }
    // You can upload multiple files including parameters like this
    // public FieldFile File2 { get; set; }
    // for more File3,File4...
}

アップロード

 var response = service . Submit ( new SubmitEntity { 
        Name = "老中医" ,
        File = new FieldFile { FilePath = "/Users/onllyarchibald/Downloads/icon_unlocked.png" }
    } ) ;
Console . WriteLine ( JsonConvert . SerializeObject ( response ) ) ;

…その他のコード例はここで見つけることができます。

応答ストリームの取得

API を定義します。

 [ HttpGetStream ( "/WeatherForecast/Download" ) ]
Task < Response < Stream > > Download ( [ FromQuery ] string arg1 ) ;

例：

 Response < Stream > response = await service . Download ( "test" ) ;

ファイルをダウンロード中

http リアクティブストリームを取得したら、次のように保存できます。

 Response < Stream > response = await service . Download ( "test" ) ;
Stream outStream = File . Create ( "/Users/onllyarchibald/Desktop/a.zip" ) ;
byte [ ] buffer = new byte [ 1024 ] ;
int i ;
do {
    i = response . Body ! . Read ( buffer , 0 , buffer . Length ) ;
    if ( i > 0 ) outStream . Write ( buffer , 0 , i ) ;
} while ( i > 0 ) ;
outStream . Close ( ) ;
response . Body . Close ( ) ;
Console . WriteLine ( "File download completed..." ) ;

以下のスクリーンショットは ShellProgressBar プラグインを使用しています。詳細についてはコードを参照してください。ダウンロード中 …その他のコード例はここで見つけることができます。

コンテンツタイプ

 application / json    - > [ FromBody ]
multipart / form - data - > [ FromForm ]

Retrofit.Net 構成

ここでは、「インターセプター」、「タイムアウト」、「応答」コンバーターを構成できます。このような：

 var client = new RetrofitClient . Builder ( )
    . AddInterceptor ( new HeaderInterceptor ( ) )     // Add Interceptor
    . AddInterceptor ( new SimpleInterceptorDemo ( ) ) // ...
    . AddTimeout ( TimeSpan . FromSeconds ( 10 ) ) // The default wait time after making an http request is 6 seconds
    . Build ( ) ;
var retrofit = new Retrofit . Net . Core . Retrofit . Builder ( )
    . AddBaseUrl ( "https://localhost:7283" ) // Base Url
    . AddClient ( client )
    . AddConverter ( new DefaultXmlConverter ( ) ) // The internal default is ‘DefaultJsonConverter’ if you don’t call ‘.AddConverter(new DefaultJsonConverter())’
    . Build ( ) ;

ここでその他のコード例を見つけることができます。

応答スキーマ

リクエストに対するレスポンスには次の情報が含まれます。

 public class Response < T >
{
   // Http message
   public string ? Message { get ; internal set ; }
   // Response body. may have been transformed, please refer to Retrofit.Builder.AddConverterFactory(...).
   public T ? Body { get ; internal set ; }
   // Http status code.
   public int StatusCode { get ; internal set ; }
   // Response headers.
   public IEnumerable < KeyValuePair < string , object > > ? Headers { get ; internal set ; }
}

リクエストが成功すると、次のようなレスポンスが返されます。

 Response < IList < Person > > response = await service . Get ( ) ;
Console . WriteLine ( response . Body ) ;
Console . WriteLine ( response . Message ) ;
Console . WriteLine ( response . StatusCode ) ;
Console . WriteLine ( response . Headers ) ;

インターセプター

http リクエストごとに、リクエスト、レスポンス、エラーをインターセプトできる 1 つ以上のインターセプターを追加できます。

.. . RetrofitClient . Builder ( )
    . AddInterceptor ( new YourCustomInterceptor ( ) )
    . Build ( ) ;

単純なインターセプター:

 public class SimpleInterceptorDemo : ISimpleInterceptor
{
    public void OnRequest ( Request request )
    {
        Debug . WriteLine ( $ "REQUEST[ { request . Method } ] => PATH: { request . Path } " ) ;
    }

    public void OnResponse ( Response < dynamic > response )
    {
        Debug . WriteLine ( $ "RESPONSE[ { response . StatusCode } ] => Message: { response . Message } " ) ;
    }
}

アドバンスト・インターセプター

高度なインターセプターは、IAdvancedInterceptor インターフェイスを継承することで実装できます。それでは、トークン更新の例を通して説明します

 public class HeaderInterceptor : IAdvancedInterceptor
{
    public Response < dynamic > Intercept ( IChain chain )
    {
        // Get token from local file system
        string ? token = null ;
        if ( File . Exists ( "token.txt" ) ) token = File . ReadAllText ( "token.txt" ) ;

        // Add token above
        Request request = chain . Request ( ) . NewBuilder ( )
            . AddHeader ( "Authorization" , $ "Bearer { token } " )
            . Build ( ) ;

        Response < dynamic > response = chain . Proceed ( request ) ;
        if ( response . StatusCode == 401 )
        {
            // Get a new token and return
            // The way to get the new token here depends on you,
            // you can ask the backend to write an API to refresh the token
            request = chain . Request ( ) . NewBuilder ( )
                . AddHeader ( "Authorization" , $ "Bearer <new token>" )
                . Build ( ) ;
            // relaunch!
            response = chain . Proceed ( request ) ;
        }
        return response ;
    }
}

リクエストを解決して拒否する

すべてのインターセプターで、その実行フローを妨害することができます。カスタムデータを使用してリクエスト/レスポンスを解決したい場合は、 return new Response<dynamic>();を呼び出すことができます。。

 public Response < dynamic > Intercept ( IChain chain )
{
    return new Response < dynamic > ( ) ;
}

コンバータ

Converter使用すると、リクエスト/レスポンスデータをサーバーに送受信する前に変更できます。デフォルトのコンバータとしてDefaultXmlConverterとDefaultJsonConverterを実装しました。リクエスト/レスポンスデータの変換をカスタマイズする場合は、「IConverter」を継承するクラスを定義し、 .AddConverter(new YourCustomConverter())を設定することでDefaultJsonConverterを置き換えることができます。

 public class DefaultJsonConverter : IConverter
{
    // value:        Data returned from the server
    // type:         The return type of the interface you declared
    // return value: What type do you want to convert to? Here is to convert the json returned by the server /// to the interface return type you defined
    public object ? OnConvert ( string from , Type to )
    {
        if ( from is null ) return from ;
        if ( to == typeof ( Stream ) ) return from ;
        if ( to ? . Namespace ? . StartsWith ( "System" ) is not true )
        {
            return JsonConvert . DeserializeObject ( from . ToString ( ) ?? "" , to ! ) ;
        }
        return from ;
    }
}