安卓怎么解析json文件格式

安卓开发中如何解析JSON文件格式：从基础到实践

在安卓开发中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，因其易读、易解析以及与语言的高兼容性，成为客户端与服务器通信、本地数据存储的首选格式，无论是从API接口获取数据，还是解析本地缓存的JSON文件，JSON解析都是安卓开发者的必备技能，本文将详细介绍在安卓平台解析JSON文件的核心方法，包括原生API的使用、第三方库的集成,以及实践中的注意事项。

JSON基础：在解析前需要了解什么？

在解析之前，我们先简单回顾JSON的核心结构，这是后续代码实现的基础，JSON数据主要由两种结构组成：

对象（Object）

以 包裹，表示无序的键值对集合，键（key）必须是字符串（需用双引号包裹），值（value）可以是字符串、数字、布尔值、数组、对象或null。

{
  "name": "张三",
  "age": 25,
  "isStudent": false,
  "address": {
    "city": "北京",
    "district": "海淀区"
  }
}

数组（Array）

以 [] 包裹，表示有序的值列表，值可以是任意JSON支持的类型。

[
  {"id": 1, "product": "手机", "price": 2999},
  {"id": 2, "product": "电脑", "price": 5999}
]

理解了这两种结构后，我们就可以针对安卓中的JSON文件（通常位于assets目录、res/raw目录或应用私有存储空间）选择合适的解析方式。

原生解析：使用Android SDK内置的JSONObject与JSONArray

安卓SDK提供了org.json包（需导入implementation 'org.json:json:20231013'），支持通过JSONObject和JSONArray类手动解析JSON数据，这种方式无需额外依赖,适合轻量级解析场景。

解析本地JSON文件

假设我们有一个user.json文件存放在assets目录下，内容如下：

{
  "userId": 1001,
  "username": "android_user",
  "hobbies": ["编程", "阅读", "运动"],
  "info": {
    "level": "中级",
    "joinDate": "2023-01-15"
  }
}

步骤1：从assets读取JSON文件

安卓应用无法直接访问assets目录下的文件路径，需通过AssetManager读取文件内容为字符串：

private String loadJsonFromAssets(Context context, String fileName) {
    try {
        InputStream is = context.getAssets().open(fileName);
        int size = is.available();
        byte[] buffer = new byte[size];
        is.read(buffer);
        is.close();
        return new String(buffer, StandardCharsets.UTF_8);
    } catch (IOException e) {
        e.printStackTrace();
        return null;
    }
}

步骤2：使用JSONObject解析字符串

读取到JSON字符串后，通过JSONObject解析数据：

String jsonStr = loadJsonFromAssets(context, "user.json");
if (jsonStr != null) {
    try {
        JSONObject jsonObject = new JSONObject(jsonStr);
        // 解析基本类型字段
        int userId = jsonObject.getInt("userId");
        String username = jsonObject.getString("username");
        // 解析数组
        JSONArray hobbiesArray = jsonObject.getJSONArray("hobbies");
        List<String> hobbies = new ArrayList<>();
        for (int i = 0; i < hobbiesArray.length(); i++) {
            hobbies.add(hobbiesArray.getString(i));
        }
        // 解析嵌套对象
        JSONObject infoObject = jsonObject.getJSONObject("info");
        String level = infoObject.getString("level");
        String joinDate = infoObject.getString("joinDate");
        // 输出结果
        Log.d("JSON解析", "用户ID: " + userId);
        Log.d("JSON解析", "用户名: " + username);
        Log.d("JSON解析", "爱好: " + hobbies.toString());
        Log.d("JSON解析", "等级: " + level + ", 加入日期: " + joinDate);
    } catch (JSONException e) {
        e.printStackTrace();
    }
}

解析JSON数组文件

若JSON文件是数组格式（如products.json）：

[
  {"id": 1, "name": "耳机", "price": 199},
  {"id": 2, "name": "键盘", "price": 299}
]

解析逻辑类似，只需将JSONObject替换为JSONArray，并通过循环遍历每个元素：

String jsonStr = loadJsonFromAssets(context, "products.json");
if (jsonStr != null) {
    try {
        JSONArray jsonArray = new JSONArray(jsonStr);
        List<Product> productList = new ArrayList<>();
        for (int i = 0; i < jsonArray.length(); i++) {
            JSONObject productObject = jsonArray.getJSONObject(i);
            int id = productObject.getInt("id");
            String name = productObject.getString("name");
            double price = productObject.getDouble("price");
            Product product = new Product(id, name, price);
            productList.add(product);
        }
        // 使用productList...
    } catch (JSONException e) {
        e.printStackTrace();
    }
}

第三方库解析：Gson与Moshi的优雅实践

原生org.json需要手动逐层解析，代码冗长且易出错，对于复杂JSON结构，第三方库（如Google的Gson、Square的Moshi）能通过自动映射（如将JSON直接转为Java对象）大幅提升开发效率。

使用Gson解析

Gson是Google推出的JSON库，支持将JSON字符串直接转换为Java对象（序列化/反序列化）。

步骤1：添加依赖

在app/build.gradle中添加：

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

步骤2：定义实体类

根据JSON结构创建对应的Java类（字段名需与JSON的key一致，支持注解修改映射关系）：

// 对应嵌套的info对象
public class Info {
    private String level;
    private String joinDate;
    // 必须提供无参构造方法
    public Info() {}
    // getter和setter
    public String getLevel() { return level; }
    public void setLevel(String level) { this.level = level; }
    public String getJoinDate() { return joinDate; }
    public void setJoinDate(String joinDate) { this.joinDate = joinDate; }
    @Override
    public String toString() {
        return "Info{level='" + level + "', joinDate='" + joinDate + "'}";
    }
}
// 对应整个user.json
public class User {
    private int userId;
    private String username;
    private List<String> hobbies;
    private Info info;
    // 无参构造方法、getter、setter
    public User() {}
    public int getUserId() { return userId; }
    public void setUserId(int userId) { this.userId = userId; }
    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }
    public List<String> getHobbies() { return hobbies; }
    public void setHobbies(List<String> hobbies) { this.hobbies = hobbies; }
    public Info getInfo() { return info; }
    public void setInfo(Info info) { this.info = info; }
    @Override
    public String toString() {
        return "User{userId=" + userId + ", username='" + username + "', hobbies=" + hobbies + ", info=" + info + "}";
    }
}

步骤3：执行解析

直接通过Gson实例将JSON字符串转为对象：

String jsonStr = loadJsonFromAssets(context, "user.json");
Gson gson = new Gson();
User user = gson.fromJson(jsonStr, User.class);
// 输出结果（需在实体类中重写toString方法）
Log.d("Gson解析", user.toString());

进阶：注解优化

若JSON的key与Java字段名不一致，可通过@SerializedName注解映射：

public class User {
    @SerializedName("user_id")  // 映射JSON中的"user_id"字段
    private int userId;
    // 其他字段...
}

使用Moshi解析

Moshi是Square推出的JSON库，基于注解和动态代理，性能优于Gson，且支持Kotlin的默认参数等功能,适合Java和Kotlin项目。

步骤1：添加依赖

implementation 'com.squareup.moshi:moshi:1.15.0'
// Kotlin支持（可选）
implementation 'com.squareup.moshi:moshi-kotlin:1.15.0'

步骤2：定义实体类（与Gson类似）

public class Info {
    private String level;