Retrofit.Net

Índice

• Sobre Retrofit.Net
• Versão de tempo de execução de suporte
• Instalando
• O Restfull com Retrofit.Net
  • Defina sua API
  • Defina a configuração básica de URL e muito mais
    • Enviar solicitação Obter
    • Enviar solicitação de postagem
    • Enviar solicitação de colocação
    • Enviar solicitação de exclusão
    • Fazendo upload de vários arquivos para o servidor por FormData
    • Obtenha fluxo de resposta
      • Baixando arquivo
• Tipo de conteúdo
• Configuração Retrofit.Net
• Opções de solicitação
• Esquema de Resposta
• Interceptadores
  • Interceptador simples
  • Interceptador avançado
    • Resolver e rejeitar a solicitação
• Conversor
• Verificação de certificado HTTPS (não implementado...)
• Recursos e bugs

Sobre Retrofit.Net

Um poderoso cliente .NET Restful Http, suporta interceptor, conversão de mensagens, obter, postar, colocar, excluir, upload de arquivo, download de arquivo, proxy, verificação de certificado Https

Versão de tempo de execução de suporte

Estrutura de destino	Versão	Sim/Não
.LÍQUIDO	8.x	Sim
.LÍQUIDO	7.x	Sim
.LÍQUIDO	6.x	Sim
.LÍQUIDO	5.x	Não
.NET Núcleo	3.x	Não
.NET Núcleo	2.x	Não
Padrão .NET	2.1	Não
Padrão .NET	2,0	Não
Padrão .NET	1.x	Não
Estrutura .NET	Todos	Não

Instalando

  dotnet add package RetrofitNet

O Restfull com Retrofit.Net

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

Defina a configuração básica de URL e muito mais

 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 solicitação Obter

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

Enviar solicitação de postagem

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

Enviar solicitação de colocação

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

Enviar solicitação de exclusão

 var response = service . Delete ( 1 ) ;

Fazendo upload de vários arquivos para o servidor por 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...
}

carregar

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

… você pode encontrar mais exemplos de código aqui.

Obtenha fluxo de resposta

Defina sua API:

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

Exemplo:

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

Baixando arquivo

Depois de obter o fluxo reativo http, você pode armazená-lo, assim:

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

A captura de tela abaixo usa o plugin ShellProgressBar. Por favor, veja o código para detalhes. … você pode encontrar mais exemplos de código aqui.

Tipo de conteúdo

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

Configuração Retrofit.Net

Aqui você pode configurar o conversor 'interceptor', 'timeout' e 'response'. assim:

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

você pode encontrar mais exemplos de código aqui.

Esquema de Resposta

A resposta a uma solicitação contém as informações a seguir.

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

Quando a solicitação for bem-sucedida, você receberá a resposta da seguinte forma:

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

Interceptadores

Para cada solicitação http, podemos adicionar um ou mais interceptadores, pelos quais podemos interceptar solicitações, respostas e erros.

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

Interceptador simples:

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

Interceptador avançado

Interceptores avançados podem ser implementados herdando a interface IAdvancedInterceptor. Então vou contar a vocês através de um exemplo de renovação 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 e rejeitar a solicitação

Em todos os interceptores, você pode interferir no fluxo de execução deles. Se você quiser resolver a solicitação/resposta com alguns dados personalizados, você pode chamar return new Response<dynamic>(); .

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

Conversor

Converter permite que os dados de solicitação/resposta sejam alterados antes de serem enviados/recebidos ao servidor. Implementei um DefaultXmlConverter e DefaultJsonConverter como conversor padrão. Se quiser personalizar a conversão de dados de solicitação/resposta, você pode definir uma classe que herda 'IConverter' e substituir 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 ;
    }
}

você pode encontrar mais exemplos de código aqui.

Verificação de certificado HTTPS

Direitos autorais e licença

Este projeto de código aberto é autorizado por https://github.com e a licença é MIT.

Recursos e bugs

Registre solicitações de recursos e bugs no rastreador de problemas.