封装http请求返回统一json格式数据的网络操作

在开发android app时候,总会需要封装一些网络操作。
比如:如果服务器返回的是一个json格式数据,格式满足:{“ErrorCode”:XX, “ErrorMessage”:XXX,”Data”:XXXX}。其中XX是int类型数据,XXX是string类型数据,XXXX是一个满足json格式的字符串。
对于这样的需求,按照下面的思路来封装http请求是个不错的思路。

首先定义一个请求结果的封装类。

public class HttpResponse<T> {

    public static final int RESPONSE_UNDEFINED = -1;

    public static final int RESPONSE_OK = 0;

    public int mErrorCode;
    public String mErrorMessage;
    public T mData;

    public HttpResponse() {
        mErrorCode = RESPONSE_UNDEFINED;
        mErrorMessage = null;
        mData = null;
    }

    public HttpResponse(int errorCode, Exception exception, String errorMessage) {
        mErrorCode = errorCode;
        mErrorMessage = errorMessage;
        mData = null;
    } 

    public HttpResponse(T data) {
        mErrorCode = RESPONSE_OK;
        mErrorMessage = null;
        mData = data;
    } 

    public boolean isSuccess() {
        return RESPONSE_OK == mErrorCode;
    }
}

然后定义处理http返回的json格式数据。

public class HttpJsonParser {

    public static <T> HttpResponse<T> httpGetV1(final String url,
                                                 final List<NameValuePair> params, final JSONParser<T> parser) {
        HttpRequest request = new HttpRequest() {

            @Override
            public String request() throws IOException {
                // 具体的Get网络操作
                return HttpHelper.doGet(context, url, params);
            }
        };
        return httpRequest(request, parser);
    }

    public static <T> HttpResponse<T> httpPostV1(final String url,
                                                  final List<NameValuePair> params, final JSONParser<T> parser) {
        HttpRequest request = new HttpRequest() {

            @Override
            public String request() throws IOException {
                // 具体的Post网络操作
                return HttpHelper.doPost(context, url, params);
            }
        };
        return httpRequest(request, parser);
    }

    private static <T> HttpResponse<T> httpRequest(HttpRequest request,
                                                   JSONParser<T> parser) {
        HttpResponse<T> response = new HttpResponse<T>();
        try {
            String result = request.request();
            parseResult(result, response, parser);
        } catch (IOException e) {
            MyLog.e(e);
            response.mErrorCode = -1;
        } catch (JSONException e) {
            MyLog.e(e);
            // json 错误一般是解析出错了,标记成错误
            response.mErrorCode = -2;
        } catch (NullPointerException e) {
            MyLog.e(e);
            response.mErrorCode = -3;
        }
        return response;
    }

    public static <T> void parseResult(String result, HttpResponse<T> response,                         JSONParser<T> parser) throws JSONException {
        if (!TextUtils.isEmpty(result)) {
            JSONObject json = new JSONObject(result);
            response.mErrorCode = json.getInt("ErrorCode");
            response.mErrorMessage = json.optString("ErrorMessage");
            if (!TextUtils.isEmpty(json.optString("Data")) && parser != null) {
                response.mData = parser.parse(json.optString("Data"));
            }
            if (!response.isSuccess()) {
                MyLog.v("Http request fail. " + result);
            }
        }
    }

    public static interface HttpRequest {
        public String request() throws IOException;
    }

    public static interface JSONParser<T> {
        /**
         * @param response
         *            此部分是api中需要解析的部分。
         * @return
         */
        public T parse(String response) throws JSONException;
    }
}

最后定义跟业务相关的的http接口。

public class HttpApi {

    public static HttpResponse<Object> http1() {
        List<NameValuePair> params = new ArrayList<NameValuePair>();
        // 添加相应的request param到list中
        //.....
        return HttpJsonParser.httpPostV1("http url1", params, null);
    }

    public static HttpResponse<String> http2() {
        List<NameValuePair> params = new ArrayList<NameValuePair>();
        // 添加相应的request param到list中
        //.....
        HttpJsonParser.JSONParser<String> parser = new HttpJsonParser.JSONParser<String>() {
            @Override
            public String parse(String response) throws JSONException {
                // 解析Data对应的json数据
                return null;
            }
        };
        return HttpJsonParser.httpGetV1("http url2", params, parser);
    }

    public static HttpResponse<ArrayList<String>> http3() {
        List<NameValuePair> params = new ArrayList<NameValuePair>();
        // 添加相应的request param到list中
        //.....
        HttpJsonParser.JSONParser<ArrayList<String>> parser = new HttpJsonParser.JSONParser<ArrayList<String>>() {
            @Override
            public ArrayList<String> parse(String response) throws JSONException {
                // 解析Data对应的json数据
                return null;
            }
        };
        return HttpJsonParser.httpGetV1("http url3", params, parser);
    }
}
SpringBoot通过使用统一数据返回格式可以提高开发效率和代码的可维护性。返回统一JSON数据格式可以统一前后端之间的数据交互方式,减少沟通成本,并且提高了代码的可读性和可维护性。 在SpringBoot中,可以定义一个全局异常处理器(GlobalExceptionHandler),用于捕获和处理全局的异常。在异常处理器中,可以定义一个统一数据返回格式,包括状态码、提示信息和返回数据。当发生异常时,异常处理器会将异常信息封装统一JSON数据格式返回给前端,以便前端进行处理。 为了实现统一数据返回格式,可以定义一个响应对象(ResponseObject),包含对应的状态码、提示信息和返回数据。在业务逻辑处理中,统一使用ResponseObject来封装返回数据,然后再返回给前端。 在控制器层中,可以使用ResponseEntity对象来返回统一JSON数据格式。通过使用ResponseEntity.ok()方法可以返回一个状态码为200的成功响应,然后将ResponseObject对象作为响应的数据。这样,无论是成功还是失败,都能以统一JSON数据格式返回给前端。 在返回数据时,可以添加一些通用的字段,如请求ID、访问时间等,以便用于日志记录和跟踪。 通过采用统一JSON数据返回格式,可以提高代码的可读性、可维护性和规范性,方便前后端的协作和沟通。同时,也可以方便后期的维护和扩展,减少了代码的冗余和重复编写。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值