Retrofit.Net 다운로드 - Retrofit.Net 소스 코드 다운로드

Retrofit.Net 소개
지원 런타임 버전
설치 중
Retrofit.Net을 이용한 The Restfull
- API 정의
- 기본 URL 구성 등을 설정하세요.
  - 받기 요청 보내기
  - 게시물 요청 보내기
  - Put 요청 보내기
  - 삭제 요청 보내기
  - FormData를 통해 여러 파일을 서버에 업로드
  - 응답 스트림 가져오기
    - 파일 다운로드 중
콘텐츠 유형
Retrofit.Net 구성
요청 옵션
응답 스키마
인터셉터
- 간단한 인터셉터
- 고급 인터셉터
  - 요청 해결 및 거부
변환기
Https 인증서 검증(구현되지 않음...)
기능 및 버그

Retrofit.Net 정보

강력한 .NET Restful Http 클라이언트는 인터셉터, 메시지 변환, 가져오기, 게시, 넣기, 삭제, 파일 업로드, 파일 다운로드, 프록시, 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을 이용한 The 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 ) ) ;

Put 요청 보내기

 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'를 상속하는 클래스를 정의하고 .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 ;
    }
}