安卓怎么解析json数据文件

安卓怎么解析JSON数据文件：从基础到实战

在安卓开发中,JSON（JavaScript Object Notation）因其轻量级、易读、跨语言的特点，成为数据交换的主流格式，无论是从服务器获取数据，还是读取本地配置文件，解析JSON都是必备技能，本文将详细介绍安卓中解析JSON数据文件的多种方法，从官方库到第三方库，结合代码示例带你核心技巧。

JSON数据文件是什么？

JSON数据文件是一种以.json为扩展名的文本文件，用于存储结构化数据，其格式类似于JavaScript对象，通过键值对（key-value）的方式组织数据，支持嵌套结构，一个用户信息的JSON文件可能如下：

{
  "name": "张三",
  "age": 25,
  "isStudent": false,
  "courses": [
    {"id": 1, "title": "数学", "score": 90},
    {"id": 2, "title": "英语", "score": 85}
  ],
  "address": {
    "city": "北京",
    "district": "海淀区"
  }
}

在安卓中,我们可能需要从assets目录、res/raw目录或手机存储中读取这类文件，并将其解析为Java对象以便在应用中使用。

安卓解析JSON的常见方法

安卓解析JSON主要有三种方式：

官方库：org.json（安卓SDK内置，无需额外依赖）
第三方库：Gson（Google开发，自动映射对象）
第三方库：Moshi（Square开发，支持Kotlin协程）

下面分别介绍这三种方法的具体实现。

使用官方`org.json`库（基础解析）

org.json是安卓SDK内置的轻量级JSON解析库，适合处理简单的JSON数据，但需要手动解析嵌套结构，代码量稍多。

添加依赖（无需额外添加，已内置）

安卓项目默认已包含org.json库，无需在build.gradle中添加依赖。

解析步骤

假设我们有一个user.json文件存放在assets目录下，解析步骤如下：

（1）读取JSON文件

通过AssetManager读取assets目录下的JSON文件，将其转换为字符串：

private String readJsonFromAssets(Context context, String fileName) {
    try {
        InputStream is = context.getAssets().open(fileName);
        byte[] buffer = new byte[is.available()];
        is.read(buffer);
        is.close();
        return new String(buffer, "UTF-8");
    } catch (IOException e) {
        e.printStackTrace();
        return "";
    }
}

（2）解析JSON字符串

使用JSONObject和JSONArray逐层解析JSON数据：

public User parseJsonWithOrgJson(String jsonString) {
    try {
        JSONObject jsonObject = new JSONObject(jsonString);
        User user = new User();
        // 解析基本字段
        user.setName(jsonObject.getString("name"));
        user.setAge(jsonObject.getInt("age"));
        user.setStudent(jsonObject.getBoolean("isStudent"));
        // 解析嵌套的数组（courses）
        JSONArray coursesArray = jsonObject.getJSONArray("courses");
        List<Course> courses = new ArrayList<>();
        for (int i = 0; i < coursesArray.length(); i++) {
            JSONObject courseObject = coursesArray.getJSONObject(i);
            Course course = new Course();
            course.setId(courseObject.getInt("id"));
            course.setTitle(courseObject.getString("title"));
            course.setScore(courseObject.getInt("score"));
            courses.add(course);
        }
        user.setCourses(courses);
        // 解析嵌套的对象（address）
        JSONObject addressObject = jsonObject.getJSONObject("address");
        Address address = new Address();
        address.setCity(addressObject.getString("city"));
        address.setDistrict(addressObject.getString("district"));
        user.setAddress(address);
        return user;
    } catch (JSONException e) {
        e.printStackTrace();
        return null;
    }
}

（3）定义实体类

提前定义与JSON结构对应的Java类（如User、Course、Address），用于存储解析后的数据：

public class User {
    private String name;
    private int age;
    private boolean isStudent;
    private List<Course> courses;
    private Address address;
    // 省略getter和setter
}
public class Course {
    private int id;
    private String title;
    private int score;
    // 省略getter和setter
}
public class Address {
    private String city;
    private String district;
    // 省略getter和setter
}

使用示例

在Activity或Fragment中调用上述方法：

String jsonStr = readJsonFromAssets(this, "user.json");
User user = parseJsonWithOrgJson(jsonStr);
if (user != null) {
    Log.d("JSON解析", "用户名：" + user.getName());
    Log.d("JSON解析", "年龄：" + user.getAge());
}

优缺点

优点：无需额外依赖，轻量级，适合简单JSON结构。
缺点：手动解析嵌套结构代码繁琐，容易出错；不支持直接映射对象。

使用Gson库（自动映射对象）

Gson是Google开发的JSON库,支持将JSON字符串直接转换为Java对象（反序列化），也可将Java对象转换为JSON字符串（序列化），极大简化解析代码。

添加依赖

在app/build.gradle的dependencies中添加：

implementation 'com.google.code.gson:gson:2.10.1'

解析步骤

（1）定义实体类

与方法一类似,确保实体类的字段名与JSON的key一致（可通过@SerializedName注解解决不一致问题）：

public class User {
    @SerializedName("name")
    private String userName; // 如果JSON中key是"name"，但Java字段是"userName"，用注解映射
    private int age;
    private boolean isStudent;
    @SerializedName("courses")
    private List<Course> courseList; // 字段名可自定义，通过注解关联JSON的key
    private Address address;
    // 省略getter和setter
}

（2）解析JSON字符串

使用Gson的fromJson()方法直接转换：

public User parseJsonWithGson(String jsonString) {
    Gson gson = new Gson();
    return gson.fromJson(jsonString, User.class);
}

如果是JSON数组（如[{...}, {...}]），则使用：

Type listType = new TypeToken<List<Course>>() {}.getType();
List<Course> courses = gson.fromJson(jsonString, listType);

（3）使用示例

与方法一类似,直接调用Gson解析：

String jsonStr = readJsonFromAssets(this, "user.json");
User user = parseJsonWithGson(jsonStr);
if (user != null) {
    Log.d("Gson解析", "用户名：" + user.getUserName());
}

优缺点

优点：代码简洁，支持自动映射，可处理复杂嵌套结构；支持注解自定义映射规则。
缺点：需要额外依赖；对于超大JSON文件，内存占用较高。

使用Moshi库（Kotlin友好）

Moshi是Square开发的JSON库,专注于性能和易用性，尤其对Kotlin支持友好（支持默认参数、密封类等），同时支持Java。

添加依赖

在app/build.gradle中添加：

implementation 'com.squareup.moshi:moshi:1.15.0'
// 如果使用Kotlin，添加kotlin-codegen插件（新版本Moshi已内置）
implementation 'com.squareup.moshi:moshi-kotlin:1.15.0'

解析步骤（以Kotlin为例）

（1）定义实体类（使用`data class`）

通过@Json注解映射JSON的key：

data class User(
    @Json(name = "name") val userName: String,
    val age: Int,
    val isStudent: Boolean,
    @Json(name = "courses") val courses: List<Course>,
    val address: Address
)
data class Course(
    @Json(name = "id") val courseId: Int,
    val title: String,
    val score: Int
)
data class Address(
    val city: String,
    val district: String
)

（2）解析JSON字符串

使用Moshi的Adapter进行解析：

fun parseJsonWithMoshi(jsonString: String): User? {
    val moshi = Moshi.Builder().build()
    val jsonAdapter = moshi.adapter(User::class.java)
    return jsonAdapter.fromJson(jsonString)
}

（3）使用示例

val jsonStr = readJsonFromAssets(this, "user.json")
val user = parseJsonWithMoshi(jsonStr)
user?.let {
    Log.d("Moshi解析", "用户名：${it.userName}")
}

企鹅直播企鹅直播足球直播爱奇艺直播爱奇艺足球直播足球直播足球直播

正文

安卓怎么解析json数据文件