安卓如何读取json文件内容

Android开发指南：轻松读取JSON文件内容的多种方法

在Android应用开发中，JSON（JavaScript Object Notation）因其轻量级、易读易写的特性，成为了数据交换的主流格式之一，我们常常需要将配置信息、静态数据或从服务器获取的数据以JSON文件的形式存储在应用本地，然后在运行时读取这些数据，本文将详细介绍在Android项目中如何读取JSON文件内容，涵盖从assets目录和res/raw目录读取,以及处理JSON数组和对象的不同场景。

准备工作：JSON文件存放位置

在Android项目中,通常推荐将需要读取的JSON文件放在以下两个位置：

assets目录：
- 位置：app/src/main/assets/
- 特点：这个目录下的文件在编译时会被原封不动地打包到APK中，不会生成资源ID,适合存放较大的文件或需要灵活命名的文件。
- 如果assets目录不存在,需要手动创建。
res/raw目录：
- 位置：app/src/main/res/raw/
- 特点：这个目录下的文件也会被打包到APK中，但系统会为每个文件生成一个唯一的资源ID（格式为R.raw.filename，不带扩展名），适合存放较小的、需要通过资源ID直接访问的文件。
- 如果res/raw目录不存在,需要手动创建。

示例JSON文件 (data.json)： 假设我们有一个名为data.json的文件,内容如下：

{
  "name": "Android JSON Demo",
  "version": "1.0",
  "features": ["JSON Parsing", "File Reading", "Data Binding"],
  "author": {
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
}

我们将这个文件分别放到assets目录和res/raw目录下进行演示。

读取JSON文件内容的核心步骤

无论是从哪个目录读取,基本步骤都相似：

获取文件的输入流（InputStream）：根据文件所在位置,使用不同的方法获取InputStream。
将InputStream转换为字符串（可选，但常用）：许多JSON解析库可以直接从InputStream读取,但转换为字符串更通用。
使用JSON解析库解析字符串：Android系统本身不提供内置的JSON解析器（较旧版本有JSONObject和JSONArray，但已不推荐），我们通常使用第三方库如Gson（Google）或Moshi（Square），它们更强大、易用,本文以Gson为例。
解析后的数据使用：将解析得到的Java对象或Map/List等用于业务逻辑。

添加Gson依赖

确保在项目的build.gradle (Module: app)文件中添加Gson依赖：

dependencies {
    implementation 'com.google.code.gson:gson:2.10.1' // 使用最新版本
}

添加完成后，点击Sync Now同步项目。

具体读取方法

从assets目录读取JSON文件

步骤：

使用AssetManager获取assets目录下的文件输入流。
将输入流转换为字符串。
使用Gson解析字符串。

代码示例：

import android.content.Context;
import android.content.res.AssetManager;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;
public class AssetJsonReader {
    public static Map<String, Object> getJsonDataFromAsset(Context context, String fileName) {
        AssetManager assetManager = context.getAssets();
        Gson gson = new Gson();
        Map<String, Object> dataMap = null;
        try {
            InputStream inputStream = assetManager.open(fileName);
            int size = inputStream.available();
            byte[] buffer = new byte[size];
            inputStream.read(buffer);
            inputStream.close();
            String json = new String(buffer, "UTF-8");
            // 将JSON字符串解析为Map对象
            Type type = new TypeToken<Map<String, Object>>() {}.getType();
            dataMap = gson.fromJson(json, type);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return dataMap;
    }
    // 如果已知要解析为特定Java对象，可以定义一个类
    public static AppData getAppDataFromAsset(Context context, String fileName) {
        AssetManager assetManager = context.getAssets();
        Gson gson = new Gson();
        AppData appData = null;
        try {
            InputStream inputStream = assetManager.open(fileName);
            int size = inputStream.available();
            byte[] buffer = new byte[size];
            inputStream.read(buffer);
            inputStream.close();
            String json = new String(buffer, "UTF-8");
            // 解析为具体的Java对象
            appData = gson.fromJson(json, AppData.class);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return appData;
    }
    // 定义一个与JSON结构对应的Java类（POJO）
    public static class AppData {
        public String name;
        public String version;
        public List<String> features;
        public Author author;
        public static class Author {
            public String name;
            public String email;
        }
    }
}

使用方法：

// 在Activity或Fragment中调用
Map<String, Object> data = AssetJsonReader.getJsonDataFromAsset(this, "data.json");
if (data != null) {
    String name = (String) data.get("name");
    Log.d("JSON_ASSET_MAP", "Name: " + name);
}
AppData appData = AssetJsonReader.getAppDataFromAsset(this, "data.json");
if (appData != null) {
    String appName = appData.name;
    List<String> features = appData.features;
    Log.d("JSON_ASSET_POJO", "App Name: " + appName + ", Features: " + features);
}

从res/raw目录读取JSON文件

步骤：

使用Resources.openRawResource(int id)方法，传入R.raw.filename（不带扩展名）获取输入流。
将输入流转换为字符串。
使用Gson解析字符串。

代码示例：

import android.content.Context;
import android.content.res.Resources;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
import java.util.Map;
public class RawJsonReader {
    public static Map<String, Object> getJsonDataFromRaw(Context context, int rawResourceId) {
        Resources resources = context.getResources();
        Gson gson = new Gson();
        Map<String, Object> dataMap = null;
        try {
            InputStream inputStream = resources.openRawResource(rawResourceId);
            int size = inputStream.available();
            byte[] buffer = new byte[size];
            inputStream.read(buffer);
            inputStream.close();
            String json = new String(buffer, "UTF-8");
            Type type = new TypeToken<Map<String, Object>>() {}.getType();
            dataMap = gson.fromJson(json, type);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return dataMap;
    }
    // 同样可以解析为特定POJO对象，复用上面的AppData类
    public static AppData getAppDataFromRaw(Context context, int rawResourceId) {
        Resources resources = context.getResources();
        Gson gson = new Gson();
        AppData appData = null;
        try {
            InputStream inputStream = resources.openRawResource(rawResourceId);
            int size = inputStream.available();
            byte[] buffer = new byte[size];
            inputStream.read(buffer);
            inputStream.close();
            String json = new String(buffer, "UTF-8");
            appData = gson.fromJson(json, AppData.class);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return appData;
    }
}

使用方法：

// 在Activity或Fragment中调用
// 假设data.json放在res/raw下，资源ID为R.raw.data
Map<String, Object> data = RawJsonReader.getJsonDataFromRaw(this, R.raw.data);
if (data != null) {
    String version = (String) data.get("version");
    Log.d("JSON_RAW_MAP", "Version: " + version);
}
AppData appData = RawJsonReader.getAppDataFromRaw(this, R.raw.data);
if (appData != null) {
    String authorName = appData.author.name;
    Log.d("JSON_RAW_POJO", "Author Name: " + authorName);
}

注意事项

异常处理：文件读取和JSON解析都可能抛出异常（IOException, JsonSyntaxException等），务必做好异常处理,避免应用崩溃。
文件大小：对于非常大的JSON文件，一次性读取到内存可能会导致内存溢出（OOM），此时可以考虑使用流式JSON解析器（如Moshi的流式API，或Gson的JsonReader）逐个解析元素，或者考虑使用数据库（如Room）来存储和管理数据。
字符编码：确保JSON文件的编码格式为UTF-8，