Tweet
Tweet

Slide 1

Slide 1 text

Retrofit Two Jake Wharton

Slide 2

Slide 2 text

Retrofit 2 will be out by the end of this year " " — Naïve Man

Slide 3

Slide 3 text

Retrofit 2 will be out by the end of this year " " — Jake Wharton

Slide 4

Slide 4 text

Retrofit 2 will be out by the end of this year " " Droidcon NYC 2014 — Jake Wharton

Slide 5

Slide 5 text

Retrofit 2 will be out by the end of this year " " Droidcon NYC 2015 — Jake Wharton

Slide 6

Slide 6 text

Retrofit 1

Slide 7

Slide 7 text

Retrofit 1 • Made open source on October 13th, 2010

Slide 8

Slide 8 text

Retrofit 1 • Made open source on October 13th, 2010 • Originally a Bob Lee joint

Slide 9

Slide 9 text

Retrofit 1 • Made open source on October 13th, 2010 • Originally a Bob Lee joint • Took over / stole stewardship mid-2012

Slide 10

Slide 10 text

Retrofit 1 • Made open source on October 13th, 2010 • Originally a Bob Lee joint • Took over / stole stewardship mid-2012 • Released 1.0 on May 13th, 2013

Slide 11

Slide 11 text

Retrofit 1 • Made open source on October 13th, 2010 • Originally a Bob Lee joint • Took over / stole stewardship mid-2012 • Released 1.0 on May 13th, 2013 • 18 releases post-1.0 with tons of features / fixes

Slide 12

Slide 12 text

The Good

Slide 13

Slide 13 text

The Good • Interface service declarations • Method and parameter annotations customize request

Slide 14

Slide 14 text

Interface and annotations interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 15

Slide 15 text

The Good • Interface service declarations • Method and parameter annotations customize request • Pluggable HTTP client and serialization

Slide 16

Slide 16 text

Pluggable client and serialization builder.setClient(new UrlConnectionClient()); builder.setClient(new ApacheClient()); builder.setClient(new OkClient());

Slide 17

Slide 17 text

Pluggable client and serialization builder.setClient(new UrlConnectionClient()); builder.setClient(new ApacheClient()); builder.setClient(new OkClient()); builder.setClient(new CustomClient());

Slide 18

Slide 18 text

Pluggable client and serialization interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 19

Slide 19 text

Pluggable client and serialization interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } builder.setConverter(new GsonConverter()); builder.setConverter(new JacksonConverter());

Slide 20

Slide 20 text

Pluggable client and serialization interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 ContributorResponse repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 21

Slide 21 text

Pluggable client and serialization interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 ContributorResponse repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } builder.setConverter(new ProtoConverter()); builder.setConverter(new WireConverter());

Slide 22

Slide 22 text

Pluggable client and serialization interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 ContributorResponse repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } builder.setConverter(new ProtoConverter()); builder.setConverter(new WireConverter()); builder.setConverter(new SimpleXMLConverter());

Slide 23

Slide 23 text

Pluggable client and serialization interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 ContributorResponse repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } builder.setConverter(new ProtoConverter()); builder.setConverter(new WireConverter()); builder.setConverter(new SimpleXMLConverter()); builder.setConverter(new CustomConverter());

Slide 24

Slide 24 text

The Good • Interface service declarations • Method and parameter annotations customize request • Pluggable HTTP client and serialization • Synchronous, asynchronous, and RxJava execution

Slide 25

Slide 25 text

Sync, async, and RxJava interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } List contributors = gitHubService.repoContributors("square", "retrofit");

Slide 26

Slide 26 text

Sync, async, and RxJava interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 void repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo,
 Callback> cb);
 } service.repoContributors("square", "retrofit", new Callback>() {
 @Override void success(List contributors, Response response) {
 // ...
 }
 
 @Override void failure(RetrofitError error) {
 // ...
 }
 });

Slide 27

Slide 27 text

Sync, async, and RxJava interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } gitHubService.repoContributors("square", "retrofit")
 .subscribe(new Action1>() {
 @Override public void call(List contributors) {
 // ...
 }
 });

Slide 28

Slide 28 text

The Good • Interface service declarations • Method and parameter annotations customize request • Pluggable HTTP client and serialization • Synchronous, asynchronous, and RxJava execution

Slide 29

Slide 29 text

The Not-So-Good

Slide 30

Slide 30 text

The Not-So-Good • Request/Response (and friends) model classes

Slide 31

Slide 31 text

Request/Response model classes

Slide 32

Slide 32 text

The Not-So-Good • Request/Response (and friends) model classes • No access to serialized body and response data

Slide 33

Slide 33 text

No access to body and response interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 34

Slide 34 text

No access to body and response interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 @GET("/repos/{owner}/{repo}/contributors")
 Response repoContributors2(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 35

Slide 35 text

The Not-So-Good • Request/Response (and friends) model classes • No access to serialized body and response data • Rigid execution mechanisms

Slide 36

Slide 36 text

Rigid execution mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo); @GET("/repos/{owner}/{repo}/contributors")
 void repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo,
 Callback> cb);
 }

Slide 37

Slide 37 text

Rigid execution mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 38

Slide 38 text

Rigid execution mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 ListenableFuture> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 39

Slide 39 text

Rigid execution mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 CompletableFuture> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 40

Slide 40 text

The Not-So-Good • Request/Response (and friends) model classes • No access to serialized body and response data • Rigid execution mechanisms • Inefficient converter usage

Slide 41

Slide 41 text

Inefficient converter usage interface Converter {
 Object fromBody(TypedInput body, Type type);
 TypedOutput toBody(Object object);
 }

Slide 42

Slide 42 text

Inefficient converter usage interface Converter {
 Object fromBody(TypedInput body, Type type);
 TypedOutput toBody(Object object);
 } Type TypeAdapter TypedInput/Output JsonAdapter ObjectReader/Writer Parser ProtoAdapter

Slide 43

Slide 43 text

Inefficient converter usage interface Converter {
 Object fromBody(TypedInput body, Type type);
 TypedOutput toBody(Object object);
 } Type TypeAdapter TypedInput/Output JsonAdapter ObjectReader/Writer Parser ProtoAdapter

Slide 44

Slide 44 text

The Not-So-Good • Request/Response (and friends) model classes • No access to serialized body and response data • Rigid execution mechanisms • Inefficient converter usage • Simple custom parameter types support

Slide 45

Slide 45 text

Simple custom parameter types interface GitHubService {
 @GET("/search/repositories")
 RepositoriesResponse searchRepos(
 @Query("q") String query,
 @Query("since") Date since);
 }X

Slide 46

Slide 46 text

Simple custom parameter types interface GitHubService {
 @GET("/search/repositories")
 RepositoriesResponse searchRepos(
 @Query("q") String query,
 @Query("since") Date since);
 }X /search/repositories?q=retrofit&since=2015-08-27

Slide 47

Slide 47 text

Simple custom parameter types interface GitHubService {
 @GET("/search/repositories")
 RepositoriesResponse searchRepos(
 @Query("q") String query,
 @Query("since") Date since);
 }X /search/repositories?q=retrofit&since=2015-08-27 /search/repositories?q=retrofit&since=20150827

Slide 48

Slide 48 text

The Not-So-Good • Request/Response (and friends) model classes • No access to serialized body and response data • Rigid execution mechanisms • Inefficient converter usage • Simple custom parameter types support

Slide 49

Slide 49 text

Retrofit 2

Slide 50

Slide 50 text

Retrofit 2 • Call encapsulates single request/response interaction

Slide 51

Slide 51 text

Call • Models a single request/response pair

Slide 52

Slide 52 text

Call • Models a single request/response pair • Separates request creation from response handling

Slide 53

Slide 53 text

Call • Models a single request/response pair • Separates request creation from response handling • Each instance can only be used once...

Slide 54

Slide 54 text

Call • Models a single request/response pair • Separates request creation from response handling • Each instance can only be used once... • ...instances can be cloned

Slide 55

Slide 55 text

Call • Models a single request/response pair • Separates request creation from response handling • Each instance can only be used once... • ...instances can be cloned • Supports both synchronous and asynchronous execution.

Slide 56

Slide 56 text

Call • Models a single request/response pair • Separates request creation from response handling • Each instance can only be used once... • ...instances can be cloned • Supports both synchronous and asynchronous execution. • Can be (actually) canceled

Slide 57

Slide 57 text

Call interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 List repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo); }X

Slide 58

Slide 58 text

Call interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 59

Slide 59 text

Call interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 60

Slide 60 text

Call interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } Call> call = gitHubService.repoContributors("square", "retrofit");

Slide 61

Slide 61 text

Call Call> call = gitHubService.repoContributors("square", "retrofit");

Slide 62

Slide 62 text

Call Call> call = gitHubService.repoContributors("square", "retrofit"); 
 response = call.execute();

Slide 63

Slide 63 text

Call Call> call = gitHubService.repoContributors("square", "retrofit"); 
 response = call.execute(); // This will throw IllegalStateException:
 response = call.execute();

Slide 64

Slide 64 text

Call Call> call = gitHubService.repoContributors("square", "retrofit"); 
 response = call.execute(); // This will throw IllegalStateException:
 response = call.execute(); Call> call2 = call.clone();
 // This will not throw:
 response = call2.execute();

Slide 65

Slide 65 text

Call Call> call = gitHubService.repoContributors("square", "retrofit");

Slide 66

Slide 66 text

Call Call> call = gitHubService.repoContributors("square", "retrofit"); 
 call.enqueue(new Callback>() {
 @Override void onResponse(/* ... */) {
 // ...
 }
 
 @Override void onFailure(Throwable t) {
 // ...
 }
 });

Slide 67

Slide 67 text

Call Call> call = gitHubService.repoContributors("square", "retrofit"); call.enqueue( ); // or... call.execute();

Slide 68

Slide 68 text

Call Call> call = gitHubService.repoContributors("square", "retrofit"); call.enqueue( ); // or... call.execute(); // later... call.cancel();

Slide 69

Slide 69 text

Retrofit 2 • Call encapsulates single request/response interaction • Parameterized Response object

Slide 70

Slide 70 text

Response Call> call = gitHubService.repoContributors("square", "retrofit"); response = call.execute();

Slide 71

Slide 71 text

Response Call> call = gitHubService.repoContributors("square", "retrofit"); Response> response = call.execute();

Slide 72

Slide 72 text

Response Call> call = gitHubService.repoContributors("square", "retrofit"); Response> response = call.execute();

Slide 73

Slide 73 text

Response Call> call = gitHubService.repoContributors("square", "retrofit"); call.enqueue(new Callback>() {
 @Override void onResponse(/* ... */) {
 // ...
 }X
 
 @Override void failure(Throwable t) {
 // ...
 }X
 });

Slide 74

Slide 74 text

Response Call> call = gitHubService.repoContributors("square", "retrofit"); call.enqueue(new Callback>() {
 @Override void onResponse(Response> response) {
 // ...
 }X
 
 @Override void failure(Throwable t) {
 // ...
 }X
 });

Slide 75

Slide 75 text

Response Call> call = gitHubService.repoContributors("square", "retrofit"); call.enqueue(new Callback>() {
 @Override void onResponse(Response> response) {
 // ...
 }
 
 @Override void failure(Throwable t) {
 // ...
 }
 });

Slide 76

Slide 76 text

Response class Response {
 }X

Slide 77

Slide 77 text

Response class Response {
 int code();
 String message(); Headers headers();
 }X

Slide 78

Slide 78 text

Response class Response {
 int code();
 String message(); Headers headers();
 
 boolean isSuccess();
 }X

Slide 79

Slide 79 text

Response class Response {
 int code();
 String message(); Headers headers();
 
 boolean isSuccess(); T body();
 ResponseBody errorBody();
 }X

Slide 80

Slide 80 text

Response class Response {
 int code();
 String message(); Headers headers();
 
 boolean isSuccess(); T body();
 ResponseBody errorBody(); com.squareup.okhttp.Response raw();
 }X

Slide 81

Slide 81 text

Retrofit 2 • Call encapsulates single request/response interaction • Parameterized Response object

Slide 82

Slide 82 text

If it isn't broken...

Slide 83

Slide 83 text

Fixed Query Param interface SomeService {
 @GET("/some/endpoint?fixed=query")
 Call someEndpoint();
 } someService.someEndpoint(); // GET /some/endpoint?fixed=query HTTP/1.1

Slide 84

Slide 84 text

Dynamic Query Param interface SomeService {
 @GET("/some/endpoint")
 Call someEndpoint(
 @Query("dynamic") String dynamic);
 } someService.someEndpoint("query"); // GET /some/endpoint?dynamic=query HTTP/1.1

Slide 85

Slide 85 text

Dynamic Query Param Map interface SomeService {
 @GET("/some/endpoint")
 Call someEndpoint(
 @QueryMap Map dynamic);
 } someService.someEndpoint( Collections.singletonMap("dynamic", "query")); // GET /some/endpoint?dynamic=query HTTP/1.1

Slide 86

Slide 86 text

Omit Dynamic Query Param interface SomeService {
 @GET("/some/endpoint")
 Call someEndpoint(
 @Query("dynamic") String dynamic);
 } someService.someEndpoint(null); // GET /some/endpoint HTTP/1.1

Slide 87

Slide 87 text

Fixed+Dynamic Query Params interface SomeService {
 @GET("/some/endpoint?fixed=query")
 Call someEndpoint(
 @Query("dynamic") String dynamic);
 } someService.someEndpoint("query"); // GET /some/endpoint?fixed=query&dynamic=query HTTP/1.1

Slide 88

Slide 88 text

Path Replacement interface SomeService {
 @GET("/some/endpoint/{foo}")
 Call someEndpoint(
 @Path("thing") String thing);
 } someService.someEndpoint("bar"); // GET /some/endpoint/bar HTTP/1.1

Slide 89

Slide 89 text

Fixed Header interface SomeService {
 @GET("/some/endpoint") @Headers("Accept-Encoding: application/json")
 Call someEndpoint();
 } someService.someEndpoint(); // GET /some/endpoint HTTP/1.1 // Accept-Encoding: application/json

Slide 90

Slide 90 text

Dynamic Header interface SomeService {
 @GET("/some/endpoint")
 Call someEndpoint( @Header("Location") String location);
 } someService.someEndpoint("Droidcon NYC 2015"); // GET /some/endpoint HTTP/1.1 // Location: Droidcon NYC 2015

Slide 91

Slide 91 text

Omit Dynamic Header interface SomeService {
 @GET("/some/endpoint")
 Call someEndpoint( @Header("Location") String location);
 } someService.someEndpoint(null); // GET /some/endpoint HTTP/1.1

Slide 92

Slide 92 text

Fixed+Dynamic Header interface SomeService {
 @GET("/some/endpoint") @Headers("Accept-Encoding: application/json")
 Call someEndpoint( @Header("Location") String location);
 } someService.someEndpoint("Droidcon NYC 2015"); // GET /some/endpoint HTTP/1.1 // Accept-Encoding: application/json // Location: Droidcon NYC 2015

Slide 93

Slide 93 text

Post Without Body interface SomeService {
 @POST("/some/endpoint")
 Call someEndpoint();
 } someService.someEndpoint(); // POST /some/endpoint?fixed=query HTTP/1.1 // Content-Length: 0

Slide 94

Slide 94 text

Post With Body interface SomeService {
 @POST("/some/endpoint")
 Call someEndpoint( @Body SomeRequest body);
 } someService.someEndpoint(); // POST /some/endpoint HTTP/1.1 // Content-Length: 3 // Content-Type: greeting // // Hi!

Slide 95

Slide 95 text

Form Encoded Fields interface SomeService {
 @FormUrlEncoded @POST("/some/endpoint")
 Call someEndpoint( @Field("name1") String name1, @Field("name2") String name2);
 } someService.someEndpoint("value1", "value2"); // POST /some/endpoint HTTP/1.1 // Content-Length: 25 // Content-Type: application/x-www-form-urlencoded // // name1=value1&name2=value2

Slide 96

Slide 96 text

Omit Form Encoded Field interface SomeService {
 @FormUrlEncoded @POST("/some/endpoint")
 Call someEndpoint( @Field("name1") String name1, @Field("name2") String name2);
 } someService.someEndpoint("value1", null); // POST /some/endpoint HTTP/1.1 // Content-Length: 12 // Content-Type: application/x-www-form-urlencoded // // name1=value1

Slide 97

Slide 97 text

Form Encoded Field Map interface SomeService {
 @FormUrlEncoded @POST("/some/endpoint")
 Call someEndpoint( @FieldMap Map names);
 } someService.someEndpoint( ImmutableMap.of("name1", "value1", "name2", "value2")); // POST /some/endpoint HTTP/1.1 // Content-Length: 25 // Content-Type: application/x-www-form-urlencoded // // name1=value1&name2=value2

Slide 98

Slide 98 text

Multipart Parts interface SomeService {
 @Multipart @POST("/some/endpoint")
 Call someEndpoint( @Part("name1") String name1, @Part("name2") String name2);
 } someService.someEndpoint("value1", "value2"); // POST /some/endpoint HTTP/1.1 // Content-Length: 102 // Content-Type: application/form-data // // ...

Slide 99

Slide 99 text

Omit Multipart Part interface SomeService {
 @Multipart @POST("/some/endpoint")
 Call someEndpoint( @Part("name1") String name1, @Part("name2") String name2);
 } someService.someEndpoint("value1", null); // POST /some/endpoint HTTP/1.1 // Content-Length: 56 // Content-Type: application/form-data // // ...

Slide 100

Slide 100 text

Multipart Part Map interface SomeService {
 @Multipart @POST("/some/endpoint")
 Call someEndpoint( @PartMap Map names);
 } someService.someEndpoint( ImmutableMap.of("name1", "value1", "name2", "value2")); // POST /some/endpoint HTTP/1.1 // Content-Length: 102 // Content-Type: application/form-data // // ...

Slide 101

Slide 101 text

If it isn't broken...

Slide 102

Slide 102 text

Retrofit 2 • Call encapsulates single request/response interaction • Parameterized Response object • Dynamic URL parameter

Slide 103

Slide 103 text

Dynamic URL interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 104

Slide 104 text

Dynamic URL interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } Call> call = gitHubService.repoContributors("square", "retrofit"); Response> response = call.execute();

Slide 105

Slide 105 text

Dynamic URL interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } Call> call = gitHubService.repoContributors("square", "retrofit"); Response> response = call.execute(); // HTTP/1.1 200 OK // Link: ; rel="next", ; rel="last" // ...

Slide 106

Slide 106 text

Dynamic URL Response> response = call.execute(); // HTTP/1.1 200 OK // Link: ; rel="next", ; rel="last" // ...

Slide 107

Slide 107 text

Dynamic URL Response> response = call.execute(); // HTTP/1.1 200 OK // Link: ; rel="next", ; rel="last" // ... String links = response.headers().get("Link");

Slide 108

Slide 108 text

Dynamic URL Response> response = call.execute(); // HTTP/1.1 200 OK // Link: ; rel="next", ; rel="last" // ... String links = response.headers().get("Link"); String nextLink = nextFromGitHubLinks(links);

Slide 109

Slide 109 text

Dynamic URL Response> response = call.execute(); // HTTP/1.1 200 OK // Link: ; rel="next", ; rel="last" // ... String links = response.headers().get("Link"); String nextLink = nextFromGitHubLinks(links); // https://api.github.com/repositories/892275/contributors?page=2

Slide 110

Slide 110 text

Dynamic URL interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 111

Slide 111 text

Dynamic URL interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo); 
 @GET
 Call> repoContributorsPaginate(
 @Url String url);
 }X

Slide 112

Slide 112 text

Dynamic URL String nextLink = nextFromGitHubLinks(links); // https://api.github.com/repositories/892275/contributors?page=2

Slide 113

Slide 113 text

Dynamic URL String nextLink = nextFromGitHubLinks(links); // https://api.github.com/repositories/892275/contributors?page=2 Call> nextCall = gitHubService.repoContributorsPaginate(nextLink);

Slide 114

Slide 114 text

Retrofit 2 • Call encapsulates single request/response interaction • Parameterized Response object • Dynamic URL parameter • Multiple, efficient converters

Slide 115

Slide 115 text

Converters interface SomeProtoService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); }X interface SomeJsonService {
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X

Slide 116

Slide 116 text

Converters interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X 
 
 SomeProtoResponse

Slide 117

Slide 117 text

Converters interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X SomeProtoResponse

Slide 118

Slide 118 text

Converters interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X SomeProtoResponse Proto? Yes!

Slide 119

Slide 119 text

Converters interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X SomeJsonResponse

Slide 120

Slide 120 text

Converters interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X SomeJsonResponse Proto? No!

Slide 121

Slide 121 text

Converters interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X SomeJsonResponse Proto? No! JSON? Yes!

Slide 122

Slide 122 text

Retrofit 2 • Call encapsulates single request/response interaction • Parameterized Response object • Dynamic URL parameter • Multiple, efficient converters • Multiple, pluggable execution mechanisms

Slide 123

Slide 123 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 124

Slide 124 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(
 @Path("owner") String owner,
 @Path("repo") String repo); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 125

Slide 125 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Call

Slide 126

Slide 126 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Call

Slide 127

Slide 127 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Call RxJava? No!

Slide 128

Slide 128 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Call RxJava? No! Call? Yes!

Slide 129

Slide 129 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Observable

Slide 130

Slide 130 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Observable RxJava? Yes!

Slide 131

Slide 131 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Future

Slide 132

Slide 132 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Future RxJava? No!

Slide 133

Slide 133 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Future RxJava? No! Call? No!

Slide 134

Slide 134 text

Execution Mechanisms interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Future> repoContributors3(..);
 }X Future RxJava? No! Call? No! Throw!

Slide 135

Slide 135 text

Retrofit 2 • Call encapsulates single request/response interaction • Parameterized Response object • Dynamic URL parameter • Multiple, efficient converters • Multiple, pluggable execution mechanisms

Slide 136

Slide 136 text

Powered by OkHttp

Slide 137

Slide 137 text

Powered by OkHttp • In 2012 we needed client abstractions.

Slide 138

Slide 138 text

Powered by OkHttp • In 2012 we needed client abstractions. • In 2012 we needed request/response abstractions.

Slide 139

Slide 139 text

Powered by OkHttp • In 2012 we needed client abstractions. • In 2012 we needed request/response abstractions. • In 2012 we needed header abstractions.

Slide 140

Slide 140 text

Powered by OkHttp • In 2012 we needed client abstractions. • In 2012 we needed request/response abstractions. • In 2012 we needed header abstractions. • It's 2015. OkHttp is small, lean, focused, and full-featured.

Slide 141

Slide 141 text

Powered by OkHttp

Slide 142

Slide 142 text

Powered by OkHttp & Okio bit.ly/ok-libs

Slide 143

Slide 143 text

Retrofit

Slide 144

Slide 144 text

Retrofit OkHttp

Slide 145

Slide 145 text

Retrofit OkHttp Socket

Slide 146

Slide 146 text

Retrofit OkHttp BufferedSource BufferedSink Socket

Slide 147

Slide 147 text

Retrofit OkHttp BufferedSource BufferedSink RequestBody ResponseBody Socket

Slide 148

Slide 148 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody Socket

Slide 149

Slide 149 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody Socket Moshi

Slide 150

Slide 150 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody Socket Moshi BufferedSink BufferedSource

Slide 151

Slide 151 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody RequestBody ResponseBody Socket Moshi BufferedSink BufferedSource

Slide 152

Slide 152 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket Moshi BufferedSink BufferedSource

Slide 153

Slide 153 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket myEndpoint() Moshi BufferedSink BufferedSource

Slide 154

Slide 154 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 155

Slide 155 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 156

Slide 156 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 157

Slide 157 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 158

Slide 158 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 159

Slide 159 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 160

Slide 160 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 161

Slide 161 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 162

Slide 162 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 163

Slide 163 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 164

Slide 164 text

Retrofit OkHttp MoshiConverter BufferedSource BufferedSink RequestBody ResponseBody MyService RequestBody ResponseBody Socket execute() myEndpoint() Moshi BufferedSink BufferedSource

Slide 165

Slide 165 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build();

Slide 166

Slide 166 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 167

Slide 167 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } GitHubService gitHubService = retrofit.create(GitHubService.class);

Slide 168

Slide 168 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } // https://api.github.com/repos/square/retrofit/contributors

Slide 169

Slide 169 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } // https://api.github.com/repos/square/retrofit/contributors HttpUrl

Slide 170

Slide 170 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } // https://api.github.com/repos/square/retrofit/contributors HttpUrl .resolve()

Slide 171

Slide 171 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 172

Slide 172 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 173

Slide 173 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 174

Slide 174 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } // https://api.github.com/repos/square/retrofit/contributors

Slide 175

Slide 175 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } // https://api.github.com/repos/square/retrofit/contributors HttpUrl .resolve()

Slide 176

Slide 176 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 177

Slide 177 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }X

Slide 178

Slide 178 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 }

Slide 179

Slide 179 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com/v3/") .build(); interface GitHubService {
 @GET("repos/{owner}/{repo}/contributors")
 Call> repoContributors(
 @Path("owner") String owner,
 @Path("repo") String repo);
 } // https://api.github.com/v3/repos/square/retrofit/contributors

Slide 180

Slide 180 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build();

Slide 181

Slide 181 text

Setup OkHttpClient client = new OkHttpClient(); Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .client(client) .build();

Slide 182

Slide 182 text

Setup OkHttpClient client = new OkHttpClient(); client.interceptors().add(..); Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .client(client) .build();

Slide 183

Slide 183 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .build();

Slide 184

Slide 184 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .addConverterFactory(GsonConverterFactory.create()) .build();

Slide 185

Slide 185 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .addConverterFactory(GsonConverterFactory.create()) .addConverterFactory(ProtoConverterFactory.create()) .build();

Slide 186

Slide 186 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .addConverterFactory(ProtoConverterFactory.create()) .addConverterFactory(GsonConverterFactory.create()) .build();

Slide 187

Slide 187 text

Setup Retrofit retrofit = new Retrofit.Builder() .baseUrl("https://api.github.com") .addConverterFactory(ProtoConverterFactory.create()) .addConverterFactory(GsonConverterFactory.create()) .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) .build();

Slide 188

Slide 188 text

Extensibility • Converter.Factory • CallAdapter.Factory

Slide 189

Slide 189 text

Converter.Factory interface SomeService {
 @GET("/some/proto/endpoint")
 Call someProtoEndpoint(); 
 @GET("/some/json/endpoint")
 Call someJsonEndpoint();
 }X SomeJsonResponse Proto? No! JSON? Yes!

Slide 190

Slide 190 text

Converter.Factory interface Converter { interface Factory { Converter> create(Type type); } }X SomeJsonResponse Proto? No! JSON? Yes!

Slide 191

Slide 191 text

Converter.Factory SomeJsonResponse Proto? No! JSON? Yes!

Slide 192

Slide 192 text

Converter.Factory class ProtoConverterFactory { Converter> create(Type type); }X SomeJsonResponse null No! JSON? Yes!

Slide 193

Slide 193 text

JSON Converter.Factory class ProtoConverterFactory { Converter> create(Type type); }X SomeJsonResponse null No! Converter> Yes! class GsonConverterFactory { Converter> create(Type type); }X

Slide 194

Slide 194 text

Converter.Factory interface Converter { interface Factory { Converter> create(Type type); }X }X

Slide 195

Slide 195 text

Converter.Factory interface Converter { interface Factory { Converter> create(Type type); }X T fromBody(ResponseBody body); RequestBody toBody(T value); }X

Slide 196

Slide 196 text

Extensibility • Converter.Factory • CallAdapter.Factory

Slide 197

Slide 197 text

CallAdapter.Factory interface GitHubService {
 @GET("/repos/{owner}/{repo}/contributors")
 Call> repoContributors(..); 
 @GET("/repos/{owner}/{repo}/contributors")
 Observable> repoContributors2(..);
 }X Call RxJava? No! Call? Yes!

Slide 198

Slide 198 text

CallAdapter.Factory interface CallAdapter { interface Factory { CallAdapter> create(Type type); }
 }X Call RxJava? No! Call? Yes!

Slide 199

Slide 199 text

CallAdapter.Factory Call RxJava? No! Call? Yes!

Slide 200

Slide 200 text

CallAdapter.Factory Call Call? Yes! class RxJavaCallAdapterFactory { CallAdapter> create(Type type); }X null No!

Slide 201

Slide 201 text

CallAdapter.Factory Call class RxJavaCallAdapterFactory { CallAdapter> create(Type type); }X null No! JSON CallAdapter> Yes! class CallAdapterFactory { CallAdapter> create(Type type); }X

Slide 202

Slide 202 text

CallAdapter.Factory interface CallAdapter { interface Factory { CallAdapter> create(Type type); }X }X

Slide 203

Slide 203 text

CallAdapter.Factory interface CallAdapter { interface Factory { CallAdapter> create(Type type); }X Type responseType(); Object adapt(Call value); }X

Slide 204

Slide 204 text

Extensibility • Converter.Factory • CallAdapter.Factory

Slide 205

Slide 205 text

Under Construction

Slide 206

Slide 206 text

Under Construction • Parameter handlers

Slide 207

Slide 207 text

Under Construction • Parameter handlers • Logging?

Slide 208

Slide 208 text

Under Construction • Parameter handlers • Logging? • Finalizing mock module

Slide 209

Slide 209 text

Under Construction • Parameter handlers • Logging? • Finalizing mock module • Documentation

Slide 210

Slide 210 text

Under Construction • Parameter handlers • Logging? • Finalizing mock module • Documentation • WebSockets! (in v2.1)

Slide 211

Slide 211 text

Release?

Slide 212

Slide 212 text

Release? dependencies {
 compile 'com.squareup.retrofit:retrofit:2.0.0-beta1' compile 'com.squareup.retrofit:converter-gson:2.0.0-beta1' compile 'com.squareup.retrofit:adapter-rxjava:2.0.0-beta1' }

Slide 213

Slide 213 text

jakewharton jakewharton twitter.com/ google.com/+ .com Retrofit Two jakewharton