修改演示界面，优化文档，增加说明

Author: ysmintor

README.md

@@ -2,11 +2,6 @@
 [![Build Status](https://travis-ci.org/ysmintor/Retrofit2RxjavaDemo.svg?branch=master)](https://travis-ci.org/ysmintor/Retrofit2RxjavaDemo)
 ***
 
-## English Version
-[please click here to see English version.](language/README-EN.md)
-To explain how to retrieve data from non restful response to get the right data(I don't have much time to finish English version, please wait for more detail coverage).
-
----
 
 ## 中文版
 
@@ -16,34 +11,31 @@ To explain how to retrieve data from non restful response to get the right data(
 ![rx](screenshots/rx.gif)
 ![common](screenshots/common.gif)
 
-本文主要介绍了使用Retrofit2配合Rxjava[这里指Rxjava1, 暂时未适配Rxjava2] 来处理非restful的网络请求结果。一般而言请求的非REST结果如下：
+本文主要介绍了使用Retrofit2配合Rxjava[这里指Rxjava1, 暂时未适配Rxjava2] 来处理非restful的网络请求结果。一般而言请求的非REST结果如下,包括一个code代表结果的状态和msg表示描述，以及data对应的真实的数据。我们的目的就是直接取`data`对应的数据，如果是数组那么取的也是数组`list<databean>`类型的，如果有错误，那么就会调用onError()方法。更多演示效果请查看video目录下的视频。
+
 ```json
 {
-	"status": 1,    //请求返回状态码
+	"code": 0,    //请求返回状态码 0表示成功，其它则为对应的错误类型
 	"msg": "请求成功",    //请求返回状态
-	"result": {    //返回结果
-		"npage": 1,   //当前页
-		"pageSize": 10,   //每页信息条数
-		"total": 1,    //查询到的信息条数
-		"data": [{
+	"data": {    //返回结果
 			"phone": "010-62770334;010-62782051",    //电话
 			"website": "www.tsinghua.edu.cn",    //官网
 			"email": "[email protected]",    //邮箱
 			"address": "北京市海淀区清华大学",    //地址
-			"zipcode": "",    //邮编
+			"zipcode": "0102770334",    //邮编
 			"name": "清华大学",    //学校名称
 			"img": "http://img.jidichong.com/school/3.png",    //学校logo图片
 			"parent": "教育部",    //隶属部门
 			"type": " 211 985",    //学校类型
-			"profile": "",   //简介
+			"profile": "xasd",   //简介
 			"info": "院士：68人 博士点：198个 硕士点：181个",    //说明
 			"city": "北京"   //所在省市
-		}]
+		}
 	}
 }
 ```
 
-而Retrofit2 请求的结果一般都分为Header 和Body。当然使用使用Rxjava后，则可以实现获取这个result的结果。当是单个实体的时候，在onNext中就直接得到这个结果，如果是一个数组的时候，则是返回List<Entity> 这种形式。
+而Retrofit2 请求的结果一般都分为Header 和Body。在获取这些数据后再在Rxjava subscriber 中的onNext()来处理比较麻烦。所以这个demo介绍了如何结果Retrofit2与Rxjava1来处理数据并在成功时得到data字段的数据，服务端返回有错误是进入onError(),当是单个实体的时候，在onNext中就直接得到这个结果，如果是一个数组的时候，则是返回List<Entity> 这种形式。同时也简化了定义gson实体不用每次都加code， msg这样一层。
 
 
 
@@ -52,61 +44,76 @@ To explain how to retrieve data from non restful response to get the right data(
 
 使用方法：
 
-1. 配置对应的外层实体，例如下面。开发中一般都非标准的REST都是一个数据(百度开放平台的接口就基本都是这种形式)，一个状态码和一个消息。其中data的类型是泛型，可以在生成请求的api指定实际返回的类型，如果为空的情况可以使用String。 而code 和message是对应于服务端定义的代码code和返回的错误信息。Demo里有初始值是因为找的接口没有使用这两个字段，但我想模拟这类情形而设置的。如果你的后台后台字段不同，你可以按需要修改这个HttpResult的相应字段。
+1. 配置对应的外层实体，例如下面。开发中一般都非标准的REST都是一个数据(百度开放平台的接口就基本都是这种形式)，一个状态码和一个消息。其中data的类型是泛型，可以在生成请求的api指定实际返回的类型，如果为空的情况可以使用String。 而code 和message是对应于服务端定义的代码code和返回的错误信息。如果你的后台后台字段不同，你可以按需要修改这个HttpResult的相应字段。
+
 	```java
-	{
-			// code 为返回的状态码, message 为返回的消息, 演示的没有这两个字段，考虑到真实的环境中基本包含就在这里写定值
-		    private int code = 0;
-				private String message = "OK";
-
-		    //用来模仿Data
-		    @SerializedName(value = "subjects")
-		    private T data;
-	}
+		{
+				// code 为返回的状态码, message 为返回的消息, 演示的没有这两个字段，考虑到真实的环境中基本包含就在这里写定值
+			    private int code = 0;
+					private String message = "OK";
+
+			    //用来模仿Data
+			    @SerializedName(value = "subjects")
+			    private T data;
+		}
 	```
 
-2. 同Retrofit2一样要定义接口，如下。这里仅仅是有get的接口在demo里，其它的Put, Delete, Query等都是一样的。
+2. 同Retrofit2一样要定义接口，如下。这里仅仅是有GET的接口在demo里，POST, PUT, DELETE, QUERY等都是一样的。
 
-	`HttpResult`里的类型就是指定泛型data的具体类型。可以使用String， JSONObject，定义的实体等等。
+	`HttpResult`里T的类型就是指定泛型data的具体类型。可以使用String， JSONObject，定义的实体等等。
 
 	另外有朋友问题访问参数是JSON对象怎么办 _(Body Paramter JSON Object)_？这其实就是将你的参数设置成一个已经定义的实体，我也给出一个项目中的接口。下面的post就是这种方式。关于请求的REST方式我会在文章后面放出详细的参考，若你不熟悉请参考这些文章。
 	```java
 
-			@GET("top250")
-	    Observable<HttpResult<List<ContentBean>>> getTopMovie(@Query("start") int start, @Query("count") int count);
+	@GET("mock3")
+	Observable<HttpResult<MockBean>> getMock3();
 
-			@POST("user/login")
-	    Observable<HttpResult<UserLoginBean>> postLogin(@Body UserLoginRequest request);
+	@GET("mock1")
+	Observable<HttpResult<List<MockBean>>> getMock1();
+
+	@GET("mock4")
+	Observable<HttpResult<MockBean>> getMock4();
+
+	@GET("mock2")
+	Observable<HttpResult<MockBean>> getMock2();
 	```
 
 3. 请求网络。
 
 	直接调用
 	```java
-						ServiceFactory.movieApi()
-	                        .getTopMovie(1, 10)
+	public static MockApi mockApi() {
+		return ServiceFactory.createService(MockApi.class);
+	}
 	```
 
-	使用一个默认的`.compose(new DefaultTransformer<List<ContentBean>>())`可以非常方便地进行转化成了需要的`Observable`。
+	使用一个默认的`.compose(new DefaultTransformer<List<MockBean>>())`可以非常方便地进行转化成了需要的`Observable`。如下代码中那样进行了线程的转换，错误的处理在这个transformer，可以自定义自己的transformer。
+	```java
+	return observable
+                .subscribeOn(Schedulers.io())
+                .observeOn(Schedulers.newThread())
+                .compose(ErrorTransformer.<T>getInstance())
+                .observeOn(AndroidSchedulers.mainThread());
+	```
 
 	另外准备了常用的subscriber，包含了网络连接的错误处理，例如非200状态，另外是服务端（业务）错误的处理，默认是将错误编码和错误信息在控制台和手机上输出。
-	正确的情况下则必须实现。
+	提供的`RxSubscriber`和 `CommonScriber`中的`onNext()`必须实现。
 
-	建议使用Rxlifecycle防止使用Rxjava内存泄露。
+	建议使用`RxLifecycle`防止使用`RxJava`内存泄露。其它方面使用同RxJava与Retrofit2结合的使用是相同的，所以得到结果您若有若要对数据进行处理仍然是链式调用。
 
 ---
 
-错误方面
+#关于错误处理方面介绍
+
+主要使用了RxJava中的`onErrorResumeNext`，遇到错误后将错误通过`ExceptionEngine.handleException(throwable)`进行处理。
 
-定义了服务器错误和连接错误等。主要使用了RxJava中的`onErrorResumeNext`，遇到错误后将错误通过`ExceptionEngine.handleException(throwable)`进行处理。
 ```java
 @Override
     public Observable<T> call(Observable<HttpResult<T>> responseObservable) {
         return responseObservable.map(new Func1<HttpResult<T>, T>() {
             @Override
             public T call(HttpResult<T> httpResult) {
                 // 通过对返回码进行业务判断决定是返回错误还是正常取数据
-//                if (httpResult.getCode() != 200) throw new RuntimeException(httpResult.getMessage());
                 if (httpResult.getCode() != ErrorType.SUCCESS) throw new ServerException(httpResult.getMessage(), httpResult.getCode());
                 return httpResult.getData();
             }
@@ -120,7 +127,7 @@ To explain how to retrieve data from non restful response to get the right data(
         });
     }
 ```
-其中的ApiException
+其中的ApiException包括code和错误的详情
 ```java
 public class ApiException extends Exception {
     // 异常处理，为速度，不必要设置getter和setter
@@ -134,7 +141,7 @@ public class ApiException extends Exception {
 }
 ```
 
-重点在于下面这个处理。你可以再定义自己的业务相关的错误，目前常用的都已经有了，而业相关的错误大部分通过接收的数据直接显示了。若不是直接显示的情况，你完全可以在提供的subscriber里去实现。
+__重点在于下面这个处理。你可以再定义自己的业务相关的错误，目前常用的都已经有了，而业相关的错误大部分通过接收的数据直接显示了。若不是直接显示的情况，你完全可以在提供的subscriber里去实现。__
 ```java
 public class ExceptionEngine {
     //对应HTTP的状态码
@@ -208,46 +215,85 @@ public class ExceptionEngine {
 }
 ```
 
+#关于处理服务器在错误时将错误信息直接放在data字段，即data字段在结果成功和失败对应的类型不定。处理思路是自定义GsonConverter，可以查看Demo里的`MockDataActivity`去看使用方法，其实就修改Retofit2初始化传入的GsonConverter。关键是对于`CustomGsonResponseBodyConverter`的修改。
+```java
+		@Override
+    public T convert(ResponseBody value) throws IOException {
+        String response = value.string();
+        JsonElement jsonElement = jsonParser.parse(response);
+        int parseCode = jsonElement.getAsJsonObject().get("code").getAsInt();
+        //
+        if (parseCode != ErrorType.SUCCESS) {
+            value.close();
+            String msg = jsonElement.getAsJsonObject().get("data").getAsString();
+            throw new ServerException(msg, parseCode);
+        } else {
+
+            MediaType contentType = value.contentType();
+            Charset charset = contentType != null ? contentType.charset(UTF_8) : UTF_8;
+            InputStream inputStream = new ByteArrayInputStream(response.getBytes());
+            Reader reader = new InputStreamReader(inputStream, charset);
+            JsonReader jsonReader = gson.newJsonReader(reader);
+
+            try {
+                return adapter.read(jsonReader);
+            } finally {
+                value.close();
+            }
+        }
+    }
+```
+
+这里先解析code字段再进行判断，所以处理这种服务器返回的话，是需要将上面的`"code"`和`"data"`替换成你服务端具体的字段。
+-------------------
+
+
+
+
 ## Update
+### 2017-03-27
+更新文档，增加短视频说明，增加错误信息放在data字段的说明。
+### 2017-03-07
 
+添加处理非REST接口在token失效时或code异常时，错误信息放在data字段的解析办法处理。
 
-   2017-03-07
-	 添加处理非REST接口在token失效时或code异常时，错误信息放在data字段的解析办法处理。
-	 >```json
-	     {
-			  code:-1
-				data:"token失效"
-		   }
+```json
+   {
+	  code:-1
+		data:"token失效"
+   }
+```
+```json
+	 {
+	  code:0
+		data:{name:"xiaoming", age:23}
+   }
+```
 
-			 {
-			  code:0
-				data:{name:"xiaoming", age:23}
-		   }
-	  ````
-		、
+针对上面的JSON都要在同一个接口里处理，解决办法都是两次解析的办法，第一次取到code并且判断，不是期望的值进行处理。期望的值可按原路处理。这里采用了修改GsonConverter的办法。
 
-    针对上面的JSON都要在同一个接口里处理，解决办法都是两次解析的办法，第一次取到code并且判断，不是期望的值进行处理。期望的值可按原路处理。这里采用了修改GsonConverter的办法。
----
+--------------------
 
-  2016-12-26
+### 2016-12-26
 	解决了执行onCompleted()之后执行onError()的问题
-  >```java
+```java
 	if (!isUnsubscribed())
 	    {
       unsubscribe();
       }
-	```
+```
 
 
----
+-----------------
+
 
+### 2016-10-13
 
-	2016-10-13
 	修正了服务端code没有处理，返回为错误时认为是json实体解析问题。
 
-   >``` java
+``` java
 		if (httpResult.getCode() != ErrorType.SUCCESS || httpResult.getCode() != ErrorType.SUCCESS)
-	```
+```
 
 
 ## Thanks

app/src/main/AndroidManifest.xml

@@ -7,6 +7,7 @@
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 
     <application
+        android:name=".MyApplication"
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"

app/src/main/java/york/com/retrofit2rxjavademo/activity/MainActivity.java

@@ -101,7 +101,7 @@ private void withDialog() {
                     @Override
                     public void onNext(MockBean mockBean) {
                         Toast.makeText(mContext, "onNext", Toast.LENGTH_SHORT).show();
-                        resultOne.setText("Single bean begin >>>>>>>>>>>>>>>>." + mockBean);
+                        resultOne.setText("Single bean begin >>>>>>>>>>>>>>>>.\n" + mockBean);
                         Log.d("main", "onNext: " + mockBean);
                     }
                 });

app/src/main/java/york/com/retrofit2rxjavademo/activity/MockDataActivity.java

@@ -8,17 +8,24 @@
 import android.widget.Button;
 import android.widget.TextView;
 
+import retrofit2.Retrofit;
+import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;
 import york.com.retrofit2rxjavademo.R;
 import york.com.retrofit2rxjavademo.entity.MockBean;
+import york.com.retrofit2rxjavademo.gsonconverter.CustomGsonConverterFactory;
 import york.com.retrofit2rxjavademo.http.ServiceFactory;
 import york.com.retrofit2rxjavademo.subscribers.RxSubscriber;
 import york.com.retrofit2rxjavademo.transformer.DefaultTransformer;
 
+import static york.com.retrofit2rxjavademo.http.ServiceFactory.BASE_URL;
+
 public class MockDataActivity extends AppCompatActivity {
     private TextView mTv;
     private Button mBtn1;
     private Button mBtn2;
     private Context mContext;
+    private Retrofit sRetrefit;
+
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
@@ -28,11 +35,21 @@ protected void onCreate(Bundle savedInstanceState) {
         mBtn1 = (Button) findViewById(R.id.button);
         mBtn2 = (Button) findViewById(R.id.button2);
 
+
+        // 使用自定义Converter处理message在错误时返回在data字段
+        sRetrefit = new Retrofit.Builder()
+                .client(ServiceFactory.getsClient())
+                .baseUrl(BASE_URL)
+                // 使用自定义Converter处理message在错误时返回在data字段
+                .addConverterFactory(CustomGsonConverterFactory.create())
+                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
+                .build();
+
         mBtn1.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
-                ServiceFactory.mockApi()
-                        .getMock()
+                ServiceFactory.mockApi2(sRetrefit)
+                        .getMock3()
                         .compose(new DefaultTransformer<MockBean>())
                         .subscribe(new RxSubscriber<MockBean>(mContext) {
                             @Override
@@ -46,8 +63,8 @@ public void onNext(MockBean mockBean) {
         mBtn2.setOnClickListener(new View.OnClickListener() {
             @Override
             public void onClick(View v) {
-                ServiceFactory.mockApi()
-                        .getMock2()
+                ServiceFactory.mockApi2(sRetrefit)
+                        .getMock4()
                         .compose(new DefaultTransformer<MockBean>())
                         .subscribe(new RxSubscriber<MockBean>(mContext) {
                             @Override

app/src/main/java/york/com/retrofit2rxjavademo/gsonconverter/CustomGsonResponseBodyConverter.java

@@ -17,6 +17,7 @@
 import okhttp3.MediaType;
 import okhttp3.ResponseBody;
 import retrofit2.Converter;
+import york.com.retrofit2rxjavademo.http.exception.ErrorType;
 import york.com.retrofit2rxjavademo.http.exception.ServerException;
 
 import static okhttp3.internal.Util.UTF_8;
@@ -44,10 +45,11 @@ public T convert(ResponseBody value) throws IOException {
         String response = value.string();
         JsonElement jsonElement = jsonParser.parse(response);
         int parseCode = jsonElement.getAsJsonObject().get("code").getAsInt();
-
-        if (parseCode == -1) {
+        //
+        if (parseCode != ErrorType.SUCCESS) {
             value.close();
-            throw new ServerException("原因", -1);
+            String msg = jsonElement.getAsJsonObject().get("data").getAsString();
+            throw new ServerException(msg, parseCode);
         } else {
 
             MediaType contentType = value.contentType();

app/src/main/java/york/com/retrofit2rxjavademo/http/MockApi.java

@@ -16,11 +16,8 @@
  * @time 2017/3/7 15:38
  */
 public interface MockApi {
-    @GET("test")
-    Observable<HttpResult<MockBean>> getMock();
-//
-//    @GET("user/login")
-//    Observable<HttpResult<MockBean>> getMock2();
+    @GET("mock3")
+    Observable<HttpResult<MockBean>> getMock3();
 
     @GET("mock1")
     Observable<HttpResult<List<MockBean>>> getMock1();