Android Volley常见错误类型剖析与终极解决方案(13)

Android小码蜂
8 阅读8分钟

一文吃透！Android Volley常见错误类型剖析与终极解决方案

一、引言

在Android开发领域，Volley作为经典的网络请求库，以其轻量级、高效性和易用性深受开发者青睐。然而，在实际项目中使用Volley进行网络请求时，难免会遇到各种各样的错误。这些错误不仅影响应用的正常运行，还会严重降低用户体验。因此，深入了解Volley常见错误类型及其产生原因，并掌握对应的解决方案，对开发者来说至关重要。本文将从源码级别详细分析Volley的常见错误类型，并给出全面且实用的解决方案。

二、Volley错误体系概述

2.1 Volley错误类结构

Volley的错误体系以VolleyError类为基类，它继承自Exception，是所有Volley错误的根源。其他具体的错误类型均继承自VolleyError，形成了一个完整的错误类层次结构。

// Volley错误的基类，继承自Exception
public class VolleyError extends Exception {
    // 网络响应数据，如果有则包含状态码、响应头等信息
    public final NetworkResponse networkResponse; 
    // 网络请求耗时，单位为毫秒
    private long networkTimeMs; 

    // 无参构造函数
    public VolleyError() {
        networkResponse = null;
    }

    // 带消息的构造函数
    public VolleyError(String exceptionMessage) {
        super(exceptionMessage);
        networkResponse = null;
    }

    // 带消息和原因的构造函数
    public VolleyError(String exceptionMessage, Throwable reason) {
        super(exceptionMessage, reason);
        networkResponse = null;
    }

    // 带原因的构造函数
    public VolleyError(Throwable cause) {
        super(cause);
        networkResponse = null;
    }

    // 带网络响应的构造函数
    public VolleyError(NetworkResponse response) {
        networkResponse = response;
    }

    // 带网络响应和原因的构造函数
    public VolleyError(NetworkResponse response, Throwable cause) {
        super(cause);
        networkResponse = response;
    }

    // 设置网络请求耗时
    public void setNetworkTimeMs(long networkTimeMs) {
        this.networkTimeMs = networkTimeMs;
    }

    // 获取网络请求耗时
    public long getNetworkTimeMs() {
        return networkTimeMs;
    }
}

2.2 常见错误类型分类

Volley常见的错误类型包括认证失败错误（AuthFailureError）、网络连接错误（NetworkError）、无连接错误（NoConnectionError）、解析错误（ParseError）、服务器错误（ServerError）、超时错误（TimeoutError）等。每种错误类型都对应着不同的错误场景和产生原因。

三、认证失败错误（AuthFailureError）

3.1 错误产生原因

AuthFailureError通常在请求需要认证信息（如API密钥、OAuth令牌等），但请求中没有包含这些信息，或者提供的认证信息无效、过期，又或者服务器要求重新认证时出现。服务器一般会返回401（未授权）或403（禁止访问）HTTP状态码，Volley将此类响应封装为AuthFailureError。

3.2 源码分析

// 继承自VolleyError，表示认证失败错误
public class AuthFailureError extends VolleyError {
    // 无参构造函数
    public AuthFailureError() {
        super();
    }

    // 带消息的构造函数
    public AuthFailureError(String message) {
        super(message);
    }

    // 带网络响应的构造函数
    public AuthFailureError(NetworkResponse response) {
        super(response);
    }

    // 带原因的构造函数
    public AuthFailureError(Throwable cause) {
        super(cause);
    }

    // 获取用于认证的请求头，若实现此方法，Volley会自动添加到请求中
    public Map<String, String> getResponseHeaders() {
        return null;
    }

    // 获取用于认证的请求体，若实现此方法，Volley会自动添加到请求中
    public byte[] getBody() {
        return null;
    }
}

3.3 解决方案

  1. 检查认证信息：确保在请求中正确设置了认证所需的信息，如API密钥、令牌等。
// 自定义请求类，重写getHeaders方法添加认证信息
public class CustomRequest extends StringRequest {
    private String apiKey;

    public CustomRequest(int method, String url, String apiKey, Response.Listener<String> listener, Response.ErrorListener errorListener) {
        super(method, url, listener, errorListener);
        this.apiKey = apiKey;
    }

    @Override
    public Map<String, String> getHeaders() throws AuthFailureError {
        Map<String, String> headers = new HashMap<>();
        headers.put("Authorization", "Bearer " + apiKey); // 示例设置Bearer令牌
        return headers;
    }
}
  1. 处理认证信息过期：在错误监听器中检测到AuthFailureError时，提示用户重新登录或更新认证信息。
StringRequest request = new CustomRequest(Request.Method.GET, url, apiKey,
    new Response.Listener<String>() {
        @Override
        public void onResponse(String response) {
            // 处理成功响应
        }
    },
    new Response.ErrorListener() {
        @Override
        public void onErrorResponse(VolleyError error) {
            if (error instanceof AuthFailureError) {
                // 提示用户重新登录
                Toast.makeText(context, "认证信息过期，请重新登录", Toast.LENGTH_SHORT).show();
            }
        }
    });

四、网络连接错误（NetworkError）

4.1 错误产生原因

NetworkError通常在设备没有网络连接、网络连接不稳定或中断、服务器不可达、DNS解析失败等情况下出现。此时一般没有服务器响应，NetworkError的networkResponse成员变量可能为null。

4.2 源码分析

// 继承自VolleyError，表示网络连接错误
public class NetworkError extends VolleyError {
    // 无参构造函数
    public NetworkError() {
        super();
    }

    // 带原因的构造函数
    public NetworkError(Throwable cause) {
        super(cause);
    }

    // 带网络响应的构造函数，通常网络响应为null
    public NetworkError(NetworkResponse networkResponse) {
        super(networkResponse);
    }
}

4.3 解决方案

  1. 检查网络连接状态：在发起请求前，先检查设备的网络连接状态。
// 检查网络连接状态的工具方法
public boolean isNetworkConnected(Context context) {
    ConnectivityManager connectivityManager = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
    NetworkInfo networkInfo = connectivityManager.getActiveNetworkInfo();
    return networkInfo != null && networkInfo.isConnected();
}

// 发起请求前检查网络连接
if (isNetworkConnected(context)) {
    // 发起Volley请求
    StringRequest request = new StringRequest(Request.Method.GET, url,
        new Response.Listener<String>() {
            @Override
            public void onResponse(String response) {
                // 处理成功响应
            }
        },
        new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                if (error instanceof NetworkError) {
                    Toast.makeText(context, "网络连接错误，请检查网络", Toast.LENGTH_SHORT).show();
                }
            }
        });
} else {
    Toast.makeText(context, "当前无网络连接", Toast.LENGTH_SHORT).show();
}
  1. 重试机制：为请求设置重试策略，在网络连接错误时自动重试。
StringRequest request = new StringRequest(Request.Method.GET, url,
    new Response.Listener<String>() {
        @Override
        public void onResponse(String response) {
            // 处理成功响应
        }
    },
    new Response.ErrorListener() {
        @Override
        public void onErrorResponse(VolleyError error) {
            if (error instanceof NetworkError) {
                // 设置重试策略
                request.setRetryPolicy(new DefaultRetryPolicy(
                    3000, // 超时时间3秒
                    DefaultRetryPolicy.DEFAULT_MAX_RETRIES, // 最大重试次数
                    DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
                // 重新加入请求队列
                requestQueue.add(request);
            }
        }
    });

五、无连接错误（NoConnectionError）

5.1 错误产生原因

NoConnectionError是NetworkError的子类，通常在设备的Wi-Fi和移动数据都关闭、设备处于飞行模式、设备在没有网络覆盖的区域时出现，即应用无法建立任何网络连接的场景。

5.2 源码分析

// 继承自NetworkError，表示无连接错误
public class NoConnectionError extends NetworkError {
    // 无参构造函数
    public NoConnectionError() {
        super();
    }

    // 带原因的构造函数
    public NoConnectionError(Throwable reason) {
        super(reason);
    }
}

5.3 解决方案

与网络连接错误类似，可通过检查网络连接状态并提示用户打开网络，同时在错误监听器中针对性处理。

Response.ErrorListener errorListener = new Response.ErrorListener() {
    @Override
    public void onErrorResponse(VolleyError error) {
        if (error instanceof NoConnectionError) {
            Toast.makeText(context, "当前无网络连接，请打开网络", Toast.LENGTH_SHORT).show();
        }
    }
};

六、解析错误（ParseError）

6.1 错误产生原因

ParseError通常在响应数据格式不符合预期（如JSON格式不正确）、响应数据使用不支持的编码、响应数据不完整或损坏时出现。

6.2 源码分析

// 继承自VolleyError，表示解析错误
public class ParseError extends VolleyError {
    // 无参构造函数
    public ParseError() {
        super();
    }

    // 带网络响应的构造函数
    public ParseError(NetworkResponse response) {
        super(response);
    }

    // 带原因的构造函数
    public ParseError(Throwable cause) {
        super(cause);
    }
}

6.3 解决方案

  1. 检查数据格式：确保服务器返回的数据格式与预期一致。以JSON解析为例，可先进行格式校验。
// 检查JSON字符串格式是否正确
public boolean isJsonValid(String json) {
    try {
        new JSONObject(json);
        return true;
    } catch (JSONException e) {
        return false;
    }
}

// 在解析前检查格式
StringRequest request = new StringRequest(Request.Method.GET, url,
    new Response.Listener<String>() {
        @Override
        public void onResponse(String response) {
            if (isJsonValid(response)) {
                try {
                    JSONObject jsonObject = new JSONObject(response);
                    // 进行后续解析处理
                } catch (JSONException e) {
                    e.printStackTrace();
                }
            } else {
                Toast.makeText(context, "数据格式错误", Toast.LENGTH_SHORT).show();
            }
        }
    },
    new Response.ErrorListener() {
        @Override
        public void onErrorResponse(VolleyError error) {
            if (error instanceof ParseError) {
                Toast.makeText(context, "数据解析错误，请检查数据格式", Toast.LENGTH_SHORT).show();
            }
        }
    });
  1. 处理编码问题：指定正确的字符编码，避免因编码不匹配导致解析错误。
// 自定义请求类，重写parseNetworkResponse方法指定编码
public class CustomStringRequest extends StringRequest {
    public CustomStringRequest(int method, String url, Response.Listener<String> listener, Response.ErrorListener errorListener) {
        super(method, url, listener, errorListener);
    }

    @Override
    protected Response<String> parseNetworkResponse(NetworkResponse response) {
        String parsed;
        try {
            // 强制指定UTF-8编码
            parsed = new String(response.data, "UTF-8"); 
        } catch (UnsupportedEncodingException e) {
            parsed = new String(response.data);
        }
        return Response.success(parsed, HttpHeaderParser.parseCacheHeaders(response));
    }
}

七、服务器错误（ServerError）

7.1 错误产生原因

ServerError通常在服务器返回500系列状态码（如500、502、503、504等）、服务器遇到内部错误无法处理请求、服务器暂时不可用或过载时出现。

7.2 源码分析

// 继承自VolleyError，表示服务器错误
public class ServerError extends VolleyError {
    // 无参构造函数
    public ServerError() {
        super();
    }

    // 带网络响应的构造函数
    public ServerError(NetworkResponse response) {
        super(response);
    }

    // 带原因的构造函数
    public ServerError(Throwable cause) {
        super(cause);
    }
}

7.3 解决方案

  1. 提示用户稍后重试：在错误监听器中检测到ServerError时，提示用户服务器繁忙，稍后重试。
Response.ErrorListener errorListener = new Response.ErrorListener() {
    @Override
    public void onErrorResponse(VolleyError error) {
        if (error instanceof ServerError) {
            Toast.makeText(context, "服务器错误，请稍后再试", Toast.LENGTH_SHORT).show();
        }
    }
};
  1. 记录错误信息：获取服务器返回的状态码和错误信息，记录日志以便排查问题。
Response.ErrorListener errorListener = new Response.ErrorListener() {
    @Override
    public void onErrorResponse(VolleyError error) {
        if (error instanceof ServerError) {
            if (error.networkResponse != null) {
                int statusCode = error.networkResponse.statusCode;
                String errorData = "";
                try {
                    errorData = new String(error.networkResponse.data, "UTF-8");
                } catch (UnsupportedEncodingException e) {
                    e.printStackTrace();
                }
                Log.e("ServerError", "状态码: " + statusCode + ", 错误信息: " + errorData);
            }
            Toast.makeText(context, "服务器错误，请稍后再试", Toast.LENGTH_SHORT).show();
        }
    }
};

八、超时错误（TimeoutError）

8.1 错误产生原因

TimeoutError通常在网络连接缓慢，请求在超时时间内没有得到响应、服务器负载过高，无法及时处理请求、请求的数据量过大，传输时间超过超时时间时出现 。

8.2 源码分析

// 继承自VolleyError，表示请求超时错误
public class TimeoutError extends VolleyError {
    // 无参构造函数
    public TimeoutError() {
        super();
    }

    // 带原因的构造函数
    public TimeoutError(Throwable cause) {
        super(cause);
    }
}

8.3 解决方案

  1. 调整超时时间：通过setRetryPolicy方法设置合适的超时时间。
StringRequest request = new StringRequest(Request.Method.GET, url,
    new Response.Listener<String>() {
        @Override
        public void onResponse(String response) {
            // 处理成功响应
        }
    },
    new Response.ErrorListener() {
        @Override
        public void onErrorResponse(VolleyError error) {
            if (error instanceof TimeoutError) {
                // 延长超时时间为5秒
                request.setRetryPolicy(new DefaultRetryPolicy(
                    5000, 
                    DefaultRetryPolicy.DEFAULT_MAX_RETRIES, 
                    DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
                // 重新加入请求队列
                requestQueue.add(request);
            }
        }
    });
  1. 增加重试次数：合理设置重试次数，提高请求成功的概率。
request.setRetryPolicy(new DefaultRetryPolicy(
    3000, 
    3, // 增加重试次数为3次
    DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));

九、其他常见错误及解决方案

9.1 MalformedURLException（URL格式错误）

当请求的URL格式不正确时会抛出此异常，如缺少协议头（http/https）、URL字符串包含非法字符等。

try {
    String url = "example.com"; // 错误的URL，缺少协议头
    StringRequest request = new StringRequest(Request.Method.GET, url,
        new Response.Listener<String>() {
            @Override
            public void onResponse(String response) {
                // 处理成功响应
            }
        },
        new Response.ErrorListener() {
            @Override
            public void onErrorResponse(VolleyError error) {
                // 处理错误
            }
        });
} catch (MalformedURLException e) {
    e.printStackTrace();
    // 提示用户URL格式错误
    Toast.makeText(context, "URL格式错误", Toast.LENGTH_SHORT).show();
}

解决方案：检查并确保URL格式正确，添加完整的协议头，对URL

avatar
文章
阅读
粉丝