Android contentprovider 提供者

学习如何实现 Android ContentProvider

在 Android 开发中，ContentProvider（内容提供者）是一种重要的组件，用于不同应用间的数据共享。本文将带领你逐步实现一个简单的 ContentProvider，并解释每一步骤。

实现步骤流程

以下是实现 ContentProvider 的关键步骤：

步骤	说明
1	创建一个新的 Android 项目
2	定义数据模型
3	创建数据库与表结构
4	实现 ContentProvider 类
5	注册 ContentProvider
6	在 Activity 中访问 ContentProvider
7	测试与调试

接下来我们逐步深入每个步骤。

步骤详解

1. 创建一个新的 Android 项目

在 Android Studio 中，新建一个项目，选择空白活动。这是我们实现 ContentProvider 的基础。

2. 定义数据模型

首先定义一个简单的数据模型，比如创建一个名为 User 的类，包含用户ID和名字。

public class User {
    private int id;
    private String name;

    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public String getName() {
        return name;
    }
}

• User 类代表我们的数据模型，包含 ID 和名称。

3. 创建数据库与表结构

使用 SQLite 数据库来存储数据。创建一个名为 DatabaseHelper 的类来管理数据库。

import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;

public class DatabaseHelper extends SQLiteOpenHelper {
    private static final String DATABASE_NAME = "mydatabase.db";
    private static final int DATABASE_VERSION = 1;

    public static final String TABLE_USERS = "users";
    public static final String COLUMN_ID = "id";
    public static final String COLUMN_NAME = "name";

    private static final String TABLE_CREATE =
            "CREATE TABLE " + TABLE_USERS + " (" +
            COLUMN_ID + " INTEGER PRIMARY KEY AUTOINCREMENT, " +
            COLUMN_NAME + " TEXT);";

    public DatabaseHelper(Context context) {
        super(context, DATABASE_NAME, null, DATABASE_VERSION);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL(TABLE_CREATE);
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        db.execSQL("DROP TABLE IF EXISTS " + TABLE_USERS);
        onCreate(db);
    }
}

• DatabaseHelper 继承于 SQLiteOpenHelper，用于创建与管理数据库。
• onCreate 方法创建“用户”表。

4. 实现 ContentProvider 类

接下来，创建一个继承自 ContentProvider 的类 UserProvider。

import android.content.ContentProvider;
import android.content.ContentValues;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.SQLException;
import android.net.Uri;
import android.util.Log;

public class UserProvider extends ContentProvider {
    private static final String AUTHORITY = "com.example.app.provider";
    private static final String BASE_PATH = "users";
    public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/" + BASE_PATH);

    private static final int USERS = 1;
    private static final UriMatcher uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
    static {
        uriMatcher.addURI(AUTHORITY, BASE_PATH, USERS);
    }

    private DatabaseHelper databaseHelper;

    @Override
    public boolean onCreate() {
        databaseHelper = new DatabaseHelper(getContext());
        return true;
    }

    @Override
    public Cursor query(Uri uri, String[] projection, String selection,
                        String[] selectionArgs, String sortOrder) {
        // TODO: 查询数据的代码
    }

    @Override
    public Uri insert(Uri uri, ContentValues values) {
        // TODO: 插入数据的代码
    }

    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        // TODO: 删除数据的代码
    }

    @Override
    public int update(Uri uri, ContentValues values, String selection,
                      String[] selectionArgs) {
        // TODO: 更新数据的代码
    }

    @Override
    public String getType(Uri uri) {
        return null; // 返回 MIME 类型
    }
}

• UserProvider 实现了内容提供者的基本方法。
• S_QUERY, insert, delete, update 等方法需要按照逻辑实现细节。

5. 注册 ContentProvider

在 AndroidManifest.xml 中注册你的 ContentProvider。

<provider
    android:name=".UserProvider"
    android:authorities="com.example.app.provider"
    android:exported="true" />

• authorities 字段定义了提供者的标识。

6. 在 Activity 中访问 ContentProvider

以下是如何在 Activity 中插入和查询数据的示例。

ContentValues values = new ContentValues();
values.put("name", "John Doe");
Uri newUri = getContentResolver().insert(UserProvider.CONTENT_URI, values);

// 查询用户
Cursor cursor = getContentResolver().query(UserProvider.CONTENT_URI, null, null, null, null);

• 使用 insert 方法向 ContentProvider 添加新用户。

7. 测试与调试

至此，你已经实现了一个基本的 ContentProvider。运行应用并进行测试，确保数据插入与查询功能正常。

关系图

下图展示了我们实现的 ContentProvider 中的关系。

erDiagram
    User {
        int id 
        String name
    }
    UserProvider {
        String authority 
        String basePath  
    }

旅行图

以下是实现 ContentProvider 的步骤旅行图。

journey
    title 实现 Android ContentProvider
    section 创建项目
      创建 Android 项目: 5:  1: 用户
    section 定义数据模型
      创建 User 类: 5:  1: 用户
    section 创建数据库
      创建 DatabaseHelper 类: 5:  1: 用户
    section 实现 ContentProvider
      创建 UserProvider 类: 5:  1: 用户
    section 注册 Provider
      在 AndroidManifest.xml 中注册: 5:  1: 用户
    section 访问 Provider
      在 Activity 中插入和查询: 5:  1: 用户
    section 测试与调试
      运行与调试应用: 5:  1: 用户

结尾

通过本文的讲解，你已经学会了如何在 Android 应用中实现一个简单的 ContentProvider。虽然最开始看起来可能有些复杂，但随着实践的深入，你一定能够熟练掌握这个重要的组件。希望这篇文章能帮助你在 Android 开发的旅程中更进一步！如果有任何问题，欢迎随时提问。