Retrofit.Net

Оглавление

• О Retrofit.Net
• Поддержка версии времени выполнения
• Установка
• Отдых с Retrofit.Net
  • Определите свой API
  • Настройка базовой конфигурации URL и многое другое
    • Отправить Получить запрос
    • Отправить запрос на публикацию
    • Отправить запрос на размещение
    • Отправить запрос на удаление
    • Загрузка нескольких файлов на сервер с помощью FormData
    • Получить поток ответа
      • Загрузка файла
• Тип контента
• Конфигурация Retrofit.Net
• Запросить варианты
• Схема ответа
• Перехватчики
  • Простой перехватчик
  • Усовершенствованный перехватчик
    • Решить и отклонить запрос
• Конвертер
• Проверка сертификата HTTP(не реализована...)
• Особенности и ошибки

О Retrofit.Net

Мощный клиент .NET Restful Http, поддерживает перехватчик, преобразование сообщений, получение, публикацию, размещение, удаление, загрузку файлов, загрузку файлов, прокси, проверку сертификата Https.

Поддержка версии времени выполнения

Целевая структура	Версия	Да/Нет
.СЕТЬ	8.х	Да
.СЕТЬ	7.х	Да
.СЕТЬ	6.х	Да
.СЕТЬ	5.х	Нет
.NET ядро	3.х	Нет
.NET ядро	2.х	Нет
.NET Стандарт	2.1	Нет
.NET Стандарт	2.0	Нет
.NET Стандарт	1.х	Нет
.NET Framework	Все	Нет

Установка

  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 ) ) ;

Отправить запрос на размещение

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

Отправить запрос на удаление

 var response = service . Delete ( 1 ) ;

Загрузка нескольких файлов на сервер с помощью FormData

ОтправитьEntity.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-запроса мы можем добавить один или несколько перехватчиков, с помощью которых мы можем перехватывать запросы, ответы и ошибки.

.. . 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, и заменить DefaultJsonConverter , установив .AddConverter(new YourCustomConverter()) .

 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 ;
    }
}

Больше примеров кода вы можете найти здесь.

Проверка сертификата HTTPS

Авторские права и лицензия

Этот проект с открытым исходным кодом авторизован https://github.com и имеет лицензию MIT.

Особенности и ошибки

Пожалуйста, отправляйте запросы на добавление функций и сообщения об ошибках в систему отслеживания проблем.