Retrofit.Net

Tabla de contenido

• Acerca de Retrofit.Net
• Versión de tiempo de ejecución de soporte
• Instalación
• El Restfull con Retrofit.Net
  • Defina su API
  • Configurar la configuración básica de URL y más
    • Enviar obtener solicitud
    • Enviar solicitud de publicación
    • Enviar solicitud de venta
    • Enviar solicitud de eliminación
    • Subir varios archivos al servidor mediante FormData
    • Obtener flujo de respuesta
      • Descargando archivo
• tipo de contenido
• Configuración de Retrofit.Net
• Opciones de solicitud
• Esquema de respuesta
• Interceptores
  • Interceptor simple
  • Interceptor avanzado
    • Resolver y rechazar la solicitud
• Convertidor
• Verificación del certificado Https (no implementado...)
• Características y errores

Acerca de Retrofit.Net

Un potente cliente .NET Restful Http que admite interceptor, conversión de mensajes, obtención, publicación, colocación, eliminación, carga y descarga de archivos, proxy y verificación de certificados Https.

Versión de tiempo de ejecución de soporte

Marco de destino	Versión	Sí/No
.NETO	8.x	Sí
.NETO	7.x	Sí
.NETO	6.x	Sí
.NETO	5.x	No
Núcleo .NET	3.x	No
Núcleo .NET	2.x	No
Estándar .NET	2.1	No
Estándar .NET	2.0	No
Estándar .NET	1.x	No
Marco .NET	Todo	No

Instalación

  dotnet add package RetrofitNet

El Restfull con Retrofit.Net

Defina su 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 ( ) ;
}

Configurar la configuración básica de URL y más

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

Enviar obtener solicitud

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

Enviar solicitud de publicación

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

Enviar solicitud de venta

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

Enviar solicitud de eliminación

 var response = service . Delete ( 1 ) ;

Subir varios archivos al servidor mediante FormData

EnviarEntidad.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...
}

subir

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

…puedes encontrar más ejemplos de código aquí.

Obtener flujo de respuesta

Defina su API:

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

Ejemplo:

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

Descargando archivo

Después de obtener el flujo reactivo http, puede almacenarlo, así:

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

La siguiente captura de pantalla utiliza el complemento ShellProgressBar. Consulte el código para obtener más detalles. …puedes encontrar más ejemplos de código aquí.

tipo de contenido

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

Configuración de Retrofit.Net

Aquí puede configurar el convertidor 'interceptor', 'tiempo de espera' y 'respuesta'. como esto:

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

Puedes encontrar más códigos de ejemplo aquí.

Esquema de respuesta

La respuesta a una solicitud contiene la siguiente información.

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

Cuando la solicitud sea exitosa, recibirá la respuesta de la siguiente manera:

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

Interceptores

Para cada solicitud http, podemos agregar uno o más interceptores, mediante los cuales podemos interceptar solicitudes, respuestas y errores.

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

Interceptor simple:

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

Interceptor avanzado

Se pueden implementar interceptores avanzados heredando la interfaz IAdvancedInterceptor. Luego te lo cuento a través de un ejemplo de renovación de token.

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

Resolver y rechazar la solicitud

En todos los interceptores, puedes interferir con su flujo de ejecución. Si desea resolver la solicitud/respuesta con algunos datos personalizados, puede llamar return new Response<dynamic>(); .

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

Convertidor

Converter permite cambiar los datos de solicitud/respuesta antes de enviarlos/recibirlos al servidor. He implementado DefaultXmlConverter y DefaultJsonConverter como convertidor predeterminado. Si desea personalizar la conversión de datos de solicitud/respuesta, puede definir una clase que herede 'IConverter' y reemplazar DefaultJsonConverter configurando .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 ;
    }
}

Puedes encontrar más códigos de ejemplo aquí.

Verificación del certificado HTTPS

Derechos de autor y licencia

Este proyecto de código abierto está autorizado por https://github.com y la licencia es MIT.

Características y errores

Presente solicitudes de funciones y errores en el rastreador de problemas.