Retrofit.Net下载 - Retrofit.Net源代码下载

关于 Retrofit.Net
支持运行版本
安装中
Retrofit.Net 带来的 Restfull
- 定义您的 Api
- 设置基本 url 配置等
  - 发送获取请求
  - 发送帖子请求
  - 发送放置请求
  - 发送删除请求
  - 通过FormData上传多个文件到服务器
  - 获取响应流
    - 下载文件
内容类型
Retrofit.Net配置
请求选项
响应模式
拦截器
- 简单拦截器
- 先进拦截机
  - 解决并拒绝请求
转换器
https证书验证（未实现...）
功能和错误

关于 Retrofit.Net

一个强大的.NET Restful Http客户端，支持拦截器、消息转换、Get、Post、Put、Delete、文件上传、文件下载、Proxy、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 带来的 Restfull

定义您的 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上传多个文件到服务器

提交实体.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接口来实现。那我通过一个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 ;
    }
}

解决并拒绝请求

在所有拦截器中，您都可以干扰它们的执行流程。如果你想用一些自定义数据来解析请求/响应，你可以调用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 ;
    }
}