网上已经有很多很优秀的Retrofit教程了,但是再怎么也是别人的。
要想自己在需要的时候,可以找出来傻瓜式按着上面的来抄就可以了的文章,恐怕必须要自己写一个了。
而且还有一个朋友也需要,所以正好是自己动手写一个的时候了。
开始:
(1)既然是网络框架,那么首先就要添加网络权限
<uses-permission android:name="android.permission.INTERNET" />
(2)添加依赖
compile 'com.squareup.retrofit2:retrofit:2.1.0' compile 'com.squareup.retrofit2:converter-gson:2.1.0' compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0' compile 'io.reactivex:rxandroid:1.0.1'
(3)定义一个用来调用接口的类(有一个地方需要修改)
public class Api { /** * 填写服务器主机ip地址(这个文件中只有这个需要改成自己的,其他的东西可以不用修改) */ public static String BASE_URL = "http://192.168.1.135:8080/"; private static HttpService httpService; private static Api apiInstance; public static Api getInstance() { if (apiInstance == null) apiInstance = new Api(); return apiInstance; } private Api() { OkHttpClient okHttpClient = new OkHttpClient().newBuilder().readTimeout(10, TimeUnit.SECONDS).build(); if (Api.BASE_URL == "") return; Retrofit retrofit = new Retrofit.Builder() .baseUrl(Api.BASE_URL) .addCallAdapterFactory(RxJavaCallAdapterFactory.create())//网络请求适配器 支持RxJava平台 .addConverterFactory(new DataConverterFactory())//设置数据解析器 .addConverterFactory(GsonConverterFactory.create())//设置数据解析器 .client(okHttpClient) .build(); this.httpService = retrofit.create(HttpService.class); } public HttpService getPaiduiService() { return httpService; } }
上面只有一个地方需要修改,就是服务器的主机地址。将BASE_URL的值换成自己服务器的主机ip地址即可。
(4)进行数据转化的类(不需要修改,直接用)。
1、这个类可以将向后台发送的数据转成Json,且将后台返回来的Json数据转成对象,分别对应下面两个方法。
public class DataConverterFactory extends Converter.Factory { @Override public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) { //根据type判断是否是自己能处理的类型,不能的话,return null ,交给后面的Converter.Factory return new DataResponseConverter<>(type); } @Override public Converter<?, RequestBody> requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) { return new DataRequestBodyConverter<>(); } }
public class DataRequestBodyConverter<T> implements Converter<T, RequestBody> { private Gson mGson = new Gson(); @Override public RequestBody convert(T value) throws IOException { String string = mGson.toJson(value); //在这里断点,可以看到自己往后台发送的Json数据 return RequestBody.create(MediaType.parse("application/json; charset=UTF-8"), string); } }
public class DataResponseConverter<T> implements Converter<ResponseBody, T> { private Type type; Gson gson = new Gson(); public DataResponseConverter(Type type) { this.type = type; } @Override public T convert(ResponseBody responseBody) throws IOException { String result = responseBody.string(); T data = gson.fromJson(result, type); //在这里断点可以看到返回来的Json数据 return data; } }
(5)进行网络请求的接口类(这个类要根据后台给的接口去写了,能够看的就是传什么字段给后台,对应着要使用的注解是什么,也是整个文章对本人最重要的一点了)
最重要的是,接口一定要有返回值
1、比如要从后台获取一个数组数据,但是我们不需要传递任何参数到后台
接口地址:http://192.168.1.135:8080/user/data
Retrofit是将地址进行拼接的,所以上文中的BASE_URL+这里的注解上面的地址,就构成了真正的地址,如下
BASE_URL+user/data 构成了http://192.168.1.135:8080/user/data
@GET("user/data") Observable<List<Data>> getData();
2、比如登录的,要将账号密码作为参数链接到url上
http://192.168.1.135:8080/user/login?name=name&&password=password
@GET("user/login") Observable<Data> login(@Query("name") String name, @Query("password") String password);
3、比如根据id查询数据,id作为url的一部分
http://192.168.1.135:8080/user/data/id
@GET("user/data/{id}") Observable<List<Data>> getDataById(@Path("id") Long id);
参数中的id,将会替代url中的id,比如id如果为22,那么最后的url就是
http://192.168.1.135:8080/user/data/22
4、要将好几个数据作为body传递到后台,那么将这几个数据放在一个类中就好。
http://192.168.1.135:8080/user/body
@POST("user/body") Observable<Data> userBody(@Body Info info);
这里的对象中也可以包含数组成员,例如这样的数据,红框的是Json数组
5、如果是将一个数组作为body传递到后台,同样先将数组中的数据构造成一个类,然后将这个类的数组传给后台
http://192.168.1.135:8080/user/bodys
@POST("user/bodys") Observable<Boolean> userBodys(@Body List<Info> info);
暂时想起这么多,想来应该也够用了吧,如果今后遇到复杂的再往上面添加。
主要就是传递参数到后台,因为如果是后台返回的数据的话,无非就是一个Json对象或者Json数组,或者Json对象中包含Json数组,这些用一个类,或者类中包含数组成员,List<Info>等来接收就可以了,应该没什么的。
噢,忘了要把这个类放上去了
public interface HttpService { @GET("user/data") Observable<List<Data>> getData(); @GET("user/login") Observable<Data> login(@Query("name") String name, @Query("password") String password); @GET("user/data/{id}") Observable<List<Data>> getDataById(@Path("id") Long id); @POST("user/body") Observable<Data> userBody(@Body Info info); @POST("user/bodys") Observable<Boolean> userBodys(@Body List<Info> info); }
(6)如何调用接口
findViewById(R.id.login).setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { Api.getInstance().getPaiduiService().login("123","123") .subscribeOn(Schedulers.io()) .observeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribe(new Observer<Data>() { @Override public void onCompleted() { Log.e("TAG", "loginonCompleted: "); } @Override public void onError(Throwable e) { Log.e("TAG", "loginonError: " + e); } @Override public void onNext(Data result) { Log.e("TAG", "result: " + result); } }); } });还是截个图,将需要修改的地方圈起来吧
就是上面三处需要修改,第一处是修改请求的接口了,第二处是,接口的返回值是什么,最后第三处也是一样是接口的返回值
最后在第三处的onNext方法中编写你进行网络访问后,需要些的逻辑。
时间仓促,先暂时记录到这里,欢迎留言一起探讨(我也只是实现了自己需要的业务,并没有对retrofit进行深究)