Android客户端与服务器JSON数据交互完整Demo

本文还有配套的精品资源，点击获取

简介：本demo演示了Android手机客户端如何通过WiFi连接服务器端获取JSON数据。介绍了网络访问权限的设置、使用HttpURLConnection发起HTTP请求、采用Gson库进行JSON解析，并以Servlet技术在服务器端响应请求。通过这个示例，开发者可以学习Android与后端服务之间数据交换的过程，了解如何使用现代编程语言解析JSON，以及如何在Android客户端处理和显示解析后的数据。

1. Android客户端获取JSON数据流程

在移动应用开发的世界中，数据是驱动应用运行的核心。对于Android开发者来说，掌握如何有效地与服务器交换数据是至关重要的。JSON作为一种轻量级的数据交换格式，在移动互联网应用中被广泛使用。它易于阅读和编写，同时也易于机器解析和生成。在本章中，我们将探讨Android客户端如何获取JSON数据的流程，这涉及与服务器进行通信、解析返回的数据，以及最终将数据展示给用户。我们将从JSON数据格式的重要性开始，了解它为什么成为Android应用中数据交换的首选格式，并且通过实例演示如何在Android客户端发起数据请求，为后文中的网络请求细节与数据解析打下基础。

2. 网络权限设置与网络请求发起

2.1 Android网络权限配置

2.1.1 权限请求的必要性与配置方法

Android应用在进行网络通信时，需要声明相应的网络权限，以允许应用访问网络资源。从Android 6.0（API级别23）开始，对于敏感权限，Android引入了运行时权限模型，要求应用在运行时动态请求权限。这意味着，除了在 AndroidManifest.xml 文件中声明权限之外，应用还需要在代码中请求这些权限，并处理用户授权或拒绝的情况。

以下是如何在 AndroidManifest.xml 文件中声明互联网访问权限的示例：

<uses-permission android:name="android.permission.INTERNET" />

对于Android 6.0以上版本，还需要在运行时请求该权限，可以通过以下代码进行：

if (ContextCompat.checkSelfPermission(thisActivity, Manifest.permission.INTERNET) != PackageManager.PERMISSION_GRANTED) {
ActivityCompat.requestPermissions(thisActivity, new String[]{Manifest.permission.INTERNET}, MY_PERMISSIONS_REQUEST_INTERNET);
}

用户对于权限请求的响应将通过 onRequestPermissionsResult 回调方法返回，应用需要根据用户的响应做出相应的处理。

2.1.2 动态权限请求与用户交互

动态权限请求涉及与用户的直接交互，应用必须在用户界面中明确告知用户请求权限的原因。以下是一个简单的用户交互示例，用于请求网络权限：

private void requestInternetPermission() {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
if (shouldShowRequestPermissionRationale(Manifest.permission.INTERNET)) {
// 提供用户权限被请求的理由
// 可以使用Toast提示用户，或者弹出对话框说明原因
}
requestPermissions(new String[]{Manifest.permission.INTERNET}, MY_PERMISSIONS_REQUEST_INTERNET);
} else {
// 对于低于Android 6.0的设备，直接声明权限即可
}
}

@Override
public void onRequestPermissionsResult(int requestCode, String permissions[], int[] grantResults) {
switch (requestCode) {
case MY_PERMISSIONS_REQUEST_INTERNET: {
// 如果请求被取消，则结果数组为空
if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
// 权限被授予，可以继续进行网络请求操作
} else {
// 权限被拒绝，可以向用户解释为什么需要这些权限
// 并且告知用户没有权限将无法完成某些操作
}
return;
}
}
}

通过以上代码，当应用需要发起网络请求时，如果用户尚未授予互联网权限，应用会首先提示用户为何需要该权限，并在用户作出选择后，根据用户的决定来执行相应的操作。

2.2 网络请求的发起与管理

2.2.1 使用AsyncTask发起网络请求

AsyncTask 是Android提供的一个用于处理后台任务与UI交互的辅助类。尽管从Android 11开始已被官方弃用，但对于理解网络请求的基本概念仍然有帮助。以下是使用 AsyncTask 发起网络请求的一个简单示例：

private class DownloadWebpageTask extends AsyncTask<String, Void, String> {
@Override
protected String doInBackground(String… urls) {
String response = null;
try {
URL url = new URL(urls[0]);
HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
try {
InputStream in = new BufferedInputStream(urlConnection.getInputStream());
response = readStream(in);
} finally {
urlConnection.disconnect();
}
} catch (IOException e) {
Log.e("AsyncTask", "Error ", e);
}
return response;
}

@Override
protected void onPostExecute(String result) {
// 更新UI元素，例如显示结果在TextView中
textView.setText(result);
}
}

在实际应用中，我们应当使用 Executor 来替代 AsyncTask ，并且确保遵守Android 6.0以后的运行时权限模型。

2.2.2 使用Volley和Retrofit框架进行网络请求

在现代Android开发中，Volley和Retrofit是两个非常流行的网络请求库，它们提供了更加高效和便捷的方式来处理网络请求。使用这些库可以避免直接处理HTTP请求的复杂性，同时还能够简化网络层的代码。

Volley：

Volley是Android官方提供的一种网络通信库，它能有效管理网络请求队列，支持图像和字符串的自动解析，并提供了自定义请求类型和响应处理的能力。使用Volley发起网络请求的一个基础示例：

StringRequest stringRequest = 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) {
// 处理请求错误
}
});

通过创建 StringRequest 实例，配置请求的URL、响应监听器以及错误监听器，可以完成一个网络请求的构建。

Retrofit：

Retrofit将网络请求抽象为接口方法，并利用注解来描述这些方法如何映射到HTTP请求。它支持异步调用，并且能够自动将服务器返回的数据转换成Java对象。以下是使用Retrofit进行网络请求的基本步骤：

// 定义一个接口描述HTTP请求
public interface ApiService {
@GET("users/{user}/repos")
Call<List<Repository>> listRepos(@Path("user") String user);
}

// 初始化Retrofit对象，设置基础URL和转换器
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.addConverterFactory(GsonConverterFactory.create())
.build();

// 创建接口实例并执行请求
ApiService service = retrofit.create(ApiService.class);
Call<List<Repository>> call = service.listRepos("octocat");
call.enqueue(new Callback<List<Repository>>() {
@Override
public void onResponse(Call<List<Repository>> call, Response<List<Repository>> response) {
// 处理返回的列表数据
}

@Override
public void onFailure(Call<List<Repository>> call, Throwable t) {
// 处理请求失败的情况
}
});

Retrofit通过接口注解简化了网络请求的构建，并允许开发者使用同步或异步的方式来发起请求。

2.3 错误处理与资源管理

2.3.1 常见错误处理方法

网络请求过程中可能会遇到多种错误，例如网络连接问题、服务器错误响应、超时等。正确的错误处理方法可以提升用户体验和应用的稳定性。以下是常见的错误处理方法：

2.3.2 关闭连接与资源释放

网络请求结束后，应立即关闭和释放所有相关资源，包括关闭输入流、输出流、连接等。这是网络编程中的一个基本准则，可以防止资源泄露，确保应用的性能。在使用 HttpURLConnection 发起请求时，通常会这样做：

// 假设urlConnection是一个已经打开的HttpURLConnection实例
InputStream in = urlConnection.getInputStream();
// 使用完毕后关闭输入流
in.close();
// 关闭连接
urlConnection.disconnect();

务必记得在请求结束后调用 disconnect() 方法来关闭连接，避免资源泄露。此外，如果使用了连接池，应在适当的时候关闭连接池，以释放系统资源。

以上内容展示了如何在Android应用中正确配置网络权限，发起网络请求，并进行错误处理和资源管理。这些知识点对于构建一个高效、稳定和用户友好的应用至关重要。

3. 使用HttpURLConnection进行HTTP请求

3.1 HttpURLConnection基础

3.1.1 HttpURLConnection的工作原理

HttpURLConnection是Java在java.net包下提供的一个用于发起HTTP请求的工具类。它通过底层的Socket连接，实现客户端与服务器之间的HTTP通信。这个类支持HTTP 1.1协议，包括常见的GET、POST等请求方法，并提供了对请求头、响应头的处理以及对数据流的读写操作。

使用HttpURLConnection进行网络请求的基本流程通常包括以下几个步骤： 1. 创建URL对象，并打开连接。 2. 设置连接参数，如请求方法、超时、内容类型等。 3. 发送请求和读取响应。 4. 关闭连接。

3.1.2 HttpURLConnection的初始化和配置

初始化HttpURLConnection对象需要先通过URL对象创建一个新的HttpURLConnection实例。然后，可以通过一系列方法对连接进行配置，包括设置请求方式、请求头、连接超时时间等。例如，设置请求方法为GET的代码如下：

URL url = new URL("http://example.com/api/data");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setConnectTimeout(5000);
connection.setReadTimeout(5000);

在初始化和配置阶段，开发者需要特别注意处理请求头和响应头。设置正确的请求头可以告诉服务器我们期望的响应类型、内容编码等信息，而读取响应头则可以帮助我们了解服务器返回数据的详细信息，例如内容类型、内容长度等。

3.2 HTTP请求的发送与接收

3.2.1 构建HTTP请求

构建一个HTTP请求需要明确请求的URL、请求方法（GET、POST、PUT等）、请求头、请求体等。例如，创建一个POST请求需要指定URL和设置请求方法为POST。此外，如果请求需要发送数据（如表单数据或JSON数据），则需要设置 Content-Type 请求头，并准备请求体。

以下是一个发送POST请求的代码示例：

String urlParameters = "param1=value1&param2=value2";
URL url = new URL("http://example.com/api/data");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setDoOutput(true);
conn.setRequestMethod("POST");
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
conn.setRequestProperty("Content-Length", String.valueOf(urlParameters.getBytes().length));
DataOutputStream wr = new DataOutputStream(conn.getOutputStream());
wr.writeBytes(urlParameters);
wr.flush();
wr.close();

3.2.2 获取服务器响应数据

当HTTP请求成功发送后，服务器会处理请求并返回响应。通过HttpURLConnection对象，我们可以读取响应的状态码、响应头和响应体。获取服务器返回的数据一般通过输入流（InputStream）来完成，如下例所示：

BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()));
String inputLine;
StringBuilder response = new StringBuilder();

while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();

// 此时response变量中存储的就是服务器返回的响应数据

3.3 错误处理与资源管理

3.3.1 常见错误处理方法

网络请求过程中可能会遇到多种错误，例如网络不可达、服务器无响应、请求数据格式错误等。正确的错误处理方法是保证应用稳定运行的关键。使用HttpURLConnection时，可以通过检查响应码来判断请求是否成功。例如，HTTP状态码2xx表示成功，4xx表示客户端错误，5xx表示服务器错误。

if (conn.getResponseCode() == HttpURLConnection.HTTP_OK) {
// 请求成功处理
} else {
// 请求失败处理，可以根据具体的响应码进行不同的异常处理逻辑
}

3.3.2 关闭连接与资源释放

资源管理是网络编程中的一项重要工作。为了防止资源泄露，必须确保所有的网络资源在使用后都被正确关闭。HttpURLConnection提供了 disconnect() 方法来关闭连接和释放相关资源。

conn.disconnect();

在实际开发中，通常会将网络请求操作放在单独的线程中执行，并在操作完成后关闭所有打开的流和连接。使用try-with-resources语句可以在Java 7及以上版本中自动关闭实现了AutoCloseable接口的资源。

try (BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream()))) {
String inputLine;
StringBuilder response = new StringBuilder();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
// 处理response
} catch (IOException e) {
// 处理异常
}
// 连接已自动关闭

至此，我们已经详细介绍了使用HttpURLConnection进行HTTP请求的基础知识，包括如何发起请求、接收响应以及错误处理。在后续章节中，我们将探讨如何使用Gson库来解析JSON数据，进一步提升Android客户端的数据处理能力。

4. 使用Gson库解析JSON数据

4.1 Gson库介绍

4.1.1 Gson库的基本功能与优势

Gson库由Google开发，用于在Java对象与JSON数据格式之间进行转换。它的功能不仅限于将JSON字符串解析成Java对象，也能将Java对象序列化成JSON字符串。Gson的优势在于其简洁易用的API，强大的转换能力，以及不需要额外的注解或配置，使得开发人员能够快速实现数据的序列化和反序列化。

4.1.2 Gson库与JSON数据格式

由于JSON是轻量级的数据交换格式，Gson库在Android开发中被广泛使用，特别是在客户端与服务器交互时，经常需要处理JSON格式的数据。Gson库提供了一种直接且高效的方法来转换JSON到Java对象，或者反之，而不需要手动编写解析JSON字符串的复杂代码。

4.2 Gson解析流程

4.2.1 将JSON数据转换为Java对象

为了将JSON数据转换为Java对象，Gson库提供了一个非常直接的方法： fromJson() 。此方法需要两个参数，第一个是JSON格式的字符串，第二个是要转换成的目标Java类的类型。

// 示例代码：将JSON字符串转换为Java对象
String json = "{\\"name\\":\\"John\\", \\"age\\":30}";
Type type = new TypeToken<User>() {}.getType();
User user = gson.fromJson(json, type);

在这个例子中，我们首先定义了一个JSON格式的字符串 json 。然后我们定义了一个 TypeToken 来获取泛型信息，这允许Gson准确地知道我们想要将JSON字符串转换成的Java类类型。最后，我们调用 fromJson 方法将JSON字符串转换成一个 User 对象。

4.2.2 将Java对象序列化为JSON字符串

将Java对象转换成JSON字符串的过程与上述过程相反。Gson库提供了一个 toJson() 方法来完成这个操作，它同样需要两个参数：一个是Java对象，另一个是 JsonWriter ， PrintWriter 或者 OutputStream 。

// 示例代码：将Java对象转换为JSON字符串
User user = new User("John", 30);
String json = gson.toJson(user);

在这个简单的例子中，我们创建了一个 User 对象，并使用Gson的 toJson 方法将其转换成JSON字符串。这个过程避免了手动拼接JSON字符串的繁琐和错误。

4.3 Gson高级特性

4.3.1 自定义类型转换器

Gson库允许开发者通过自定义 TypeAdapter 或者 TypeConverter 来实现复杂的类型转换逻辑。这样，开发者可以控制如何将特定的Java类型转换为JSON，以及如何将JSON解析回Java类型。

4.3.2 使用Gson处理复杂JSON结构

当处理复杂的JSON结构时，比如嵌套的JSON对象或数组，Gson允许通过注解如 @SerializedName 来解决Java字段名和JSON属性名不匹配的问题。此外， @Expose 注解可以用来标记哪些字段需要被序列化或反序列化。

public class User {
@SerializedName("full_name")
@Expose
private String fullName;

@SerializedName("age")
@Expose
private int age;
// getter and setter methods
}

在上述代码中， User 类的 fullName 字段通过 @SerializedName 注解与JSON对象中的 full_name 属性关联起来。 @Expose 注解则表明这些字段将参与序列化和反序列化过程。

Gson库的高级特性，使得在处理复杂的JSON数据结构时，开发人员能够更加灵活地控制数据的转换过程。在本章的后续部分，我们将深入探讨Gson的这些高级特性，包括如何自定义类型转换器，以及如何解决JSON数据结构与Java对象映射之间的问题。

5. Servlet技术服务器端响应

在本章节中，我们将深入了解Servlet技术在服务器端处理HTTP请求并响应JSON数据的过程。Servlet作为一种Java语言编写的服务器端程序，其主要功能在于扩展服务器的性能，特别是在执行基于客户端请求动态生成响应的应用中。我们会详细探讨Servlet的基本工作原理、生命周期，以及如何构建Servlet来返回JSON格式数据。

5.1 Servlet技术概览

5.1.1 Servlet技术的组成与工作原理

Servlet技术主要由Servlet接口和Servlet容器（也称为Web服务器）组成。其工作原理可以简单概括为：当客户端发送一个HTTP请求到服务器时，服务器将请求转发给相应的Servlet，Servlet处理完请求后生成响应并返回给服务器，最后服务器将响应发送回客户端。

Servlet接口定义了Java程序和Web服务器之间交互的协议。Servlet容器负责管理Servlet的生命周期，包括加载、实例化、初始化、处理请求以及服务终止。常见的Servlet容器有Tomcat、Jetty等。

5.1.2 Servlet生命周期的理解

Servlet生命周期由以下几个阶段组成： – 加载和实例化 ：Servlet容器负责加载Servlet类，并实例化Servlet对象。 – 初始化 ：通过调用 init() 方法完成Servlet初始化。在此阶段通常执行一些只应执行一次的初始化操作。 – 请求处理 ：对于客户端的每一个请求，容器创建一个新的线程，调用 service() 方法来处理请求。 service() 方法会根据请求类型（GET、POST等）调用 doGet() , doPost() 等方法。 – 销毁 ：当需要释放Servlet所占用资源时，容器会调用 destroy() 方法。在这个方法中执行必要的清理工作。

5.2 构建Servlet响应JSON数据

5.2.1 创建基本的Servlet类

import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;
import java.io.PrintWriter;
import com.google.gson.Gson;

public class JsonServlet extends HttpServlet {
private Gson gson = new Gson();

@Override
public void init() throws ServletException {
// 初始化操作
}

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 处理GET请求
resp.setContentType("application/json");
resp.setCharacterEncoding("UTF-8");
PrintWriter out = resp.getWriter();
String jsonResponse = gson.toJson(buildSomeData());
out.print(jsonResponse);
out.flush();
}

private Object buildSomeData() {
// 构建一些数据
return new Object(); // 示例对象
}

@Override
public void destroy() {
// 销毁操作
}
}

在这个基本的Servlet类中，我们重写了 doGet 方法来处理GET请求，并使用 Gson 库将数据对象序列化成JSON字符串。

5.2.2 编写方法返回JSON格式数据

在 doGet 方法中，我们通过设置响应的内容类型为 application/json ，表明我们发送的数据是JSON格式。之后，使用 PrintWriter 将序列化后的JSON字符串写入输出流中。

5.3 服务器端的异常处理与日志记录

5.3.1 异常处理机制

异常处理在Servlet中是必不可少的，以确保应用程序的健壮性和可靠性。Servlet提供 doGet 、 doPost 等方法允许抛出 ServletException ，并且可以在这些方法中使用try-catch语句块来捕获和处理异常。

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
try {
// 正常的处理逻辑
} catch (SomeBusinessException e) {
resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR, e.getMessage());
} catch (Exception e) {
resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
}
}

5.3.2 日志记录的最佳实践

日志记录对于调试和监控服务器应用程序至关重要。建议使用日志框架（如Log4j、SLF4J）进行日志记录，而不是使用原生的 System.out.println 或 System.err.println 。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class JsonServlet extends HttpServlet {
private static final Logger logger = LoggerFactory.getLogger(JsonServlet.class);

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
try {
// 正常处理逻辑
logger.info("处理请求并成功返回JSON数据");
} catch (Exception e) {
logger.error("处理请求时发生错误", e);
resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
}
}
}

在本章节中，我们详细讨论了Servlet技术的基本组成、工作原理以及其生命周期。随后，通过实际代码示例，展示了如何创建一个基本的Servlet类以及如何在其中构建JSON响应。最后，强调了异常处理和日志记录在服务器端开发中的重要性，并提供了相应的最佳实践代码示例。这样的内容结构不仅帮助开发者建立起对Servlet技术的系统认识，还提供了可以立即应用到实际开发中的实用技巧。

本文还有配套的精品资源，点击获取

简介：本demo演示了Android手机客户端如何通过WiFi连接服务器端获取JSON数据。介绍了网络访问权限的设置、使用HttpURLConnection发起HTTP请求、采用Gson库进行JSON解析，并以Servlet技术在服务器端响应请求。通过这个示例，开发者可以学习Android与后端服务之间数据交换的过程，了解如何使用现代编程语言解析JSON，以及如何在Android客户端处理和显示解析后的数据。

本文还有配套的精品资源，点击获取