Android（安卓）内容提供器

内容提供器组件根据请求将数据从一个应用程序提供给其他应用程序。此类请求由 ContentResolver 类的方法处理。内容提供器可以使用不同的方式存储其数据，数据可以存储在数据库、文件甚至网络中。

有时需要跨应用程序共享数据。这就是内容提供器变得非常有用的地方。

内容提供器让您可以将内容集中在一个地方，并让许多不同的应用程序根据需要访问它。内容提供程序的行为非常类似于数据库，您可以在其中使用 insert()、update()、delete() 和 query() 方法查询内容、编辑内容以及添加或删除内容。在大多数情况下，这些数据存储在 SQlite 数据库中。

内容提供器是作为 ContentProvider 类的子类实现的，必须实现一组标准的 API，使其他应用程序能够执行事务。

public class My Application extends ContentProvider {
}

内容 URI

要查询内容提供器，请以 URI 的形式指定查询字符串，其格式如下：

<prefix>://<authority>/<data_type>/<id>

以下是 URI 各个部分的详细信息：

编号	部分 & 描述
1	prefix 这始终设置为内容://
2	authority 这将指定内容提供器的名称，例如联系人、浏览器等对于第三方内容提供器，这可以是完全限定的名称，例如 `com.cankaoshouce.statusprovider`
3	data_type 这表示此特定提供器的数据类型例如，比如您要从 "联系人" 内容提供器获取所有联系人，那么数据路径将是 people，URI 将类似于 `iscontent://contacts/people`
4	id 这将指定请求的特定记录例如，如果您正在 "联系人" 内容提供器中查找联系人编号 5，则 URI 将如下所示 `content://contacts/people/5..`

创建内容提供器

创建内容提供商的一些简单步骤：

首先，您需要创建一个扩展 ContentProviderbase 类的 ContentProvider 类。
其次，您需要定义将用于访问内容的内容提供器 URI 地址。
接下来，您需要创建自己的数据库来保存内容。通常，Android 使用 SQLite 数据库，框架需要覆盖 onCreate() 方法，该方法将使用 SQLite Open Helper 方法创建或打开提供器的数据库。启动应用程序时，将在主应用程序线程上调用其每个内容提供器的 onCreate() 处理程序。
接下来，您必须实现内容提供器查询以执行不同的数据库特定操作。
最后，使用 <Provider> 标记在 activity 文件中注册内容提供器。

以下是您需要在 ContentProvider 类中重写的方法列表，以使内容提供器正常工作：

onCreate() - 此方法在启动提供器时调用。
query() - 此方法接收来自客户端的请求。结果作为 Cursor 对象返回。
insert() - 此方法将新记录插入内容提供器。
delete() - 此方法从内容提供器中删除现有记录。
update() - 此方法更新内容提供器中的现有记录。
getType() - 此方法返回给定 URI 处数据的 MIME 类型。

实例

这个例子将解释如何创建自己的内容提供器。因此，让我们按照以下步骤来创建 Hello World 实例：

步骤	描述
1	您将使用 Android Studio IDE 创建一个 Android 应用程序，并在 `com.example.helloworld` 包下将其命名为 HelloWrold，Activity 为空。
2	修改主 activity 文件 MainActivity.java 以添加两个新方法 `onClickAddName()` 和 `onClickRetrieveStudents()`。
3	在 `com.example.helloworld` 包下创建一个名为 StudentsProvider.java 的新 Java 文件，以定义您的实际提供器和相关方法。。
4	使用 `<provider … />` 标记在 AndroidManifest.xml 文件中注册内容提供者
5	修改 `res/layout/activity_main.xml` 文件的默认内容，以包括一个小的 GUI 图形界面以添加学生记录。
6	无需更改 string.xml。Android Studio 负责字符串 xml 文件。
7	运行应用程序以启动 Android 模拟器，并验证应用程序中所做更改的结果。

以下是修改后的主 activity 文件 src/com.example.MyApplication/MainActivity.java 的内容。该文件可以包括每个基本生命周期方法。我们添加了两个新方法 onClickAddName() 和 onClickRetrieveStudents() 来处理用户与应用程序的交互。

package com.example.MyApplication;
import android.net.Uri;
import android.os.Bundle;
import android.app.Activity;
import android.content.ContentValues;
import android.content.CursorLoader;
import android.database.Cursor;
import android.view.Menu;
import android.view.View;
import android.widget.EditText;
import android.widget.Toast;
public class MainActivity extends Activity {
  @Override
  protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.activity_main);
  }
  public void onClickAddName(View view) {
   // Add a new student record
   ContentValues values = new ContentValues();
   values.put(StudentsProvider.NAME,
     ((EditText)findViewById(R.id.editText2)).getText().toString());
   values.put(StudentsProvider.GRADE,
     ((EditText)findViewById(R.id.editText3)).getText().toString());
   Uri uri = getContentResolver().insert(
     StudentsProvider.CONTENT_URI, values);
   Toast.makeText(getBaseContext(),
     uri.toString(), Toast.LENGTH_LONG).show();
  }
  public void onClickRetrieveStudents(View view) {
   // Retrieve student records
   String URL = "content://com.example.MyApplication.StudentsProvider";
   Uri students = Uri.parse(URL);
   Cursor c = managedQuery(students, null, null, null, "name");
   if (c.moveToFirst()) {
     do{
      Toast.makeText(this,
        c.getString(c.getColumnIndex(StudentsProvider._ID)) +
         ", " + c.getString(c.getColumnIndex( StudentsProvider.NAME)) +
           ", " + c.getString(c.getColumnIndex( StudentsProvider.GRADE)),
      Toast.LENGTH_SHORT).show();
     } while (c.moveToNext());
   }
  }
}

在 com.example.MyApplication 包下创建新文件 StudentsProvider.java，以下是 src/com.example.MyApplication/StudentsProvider.java 的内容

package com.example.MyApplication;
import java.util.HashMap;
import android.content.ContentProvider;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.Context;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.SQLException;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
import android.database.sqlite.SQLiteQueryBuilder;
import android.net.Uri;
import android.text.TextUtils;
public class StudentsProvider extends ContentProvider {
  static final String PROVIDER_NAME = "com.example.MyApplication.StudentsProvider";
  static final String URL = "content://" + PROVIDER_NAME + "/students";
  static final Uri CONTENT_URI = Uri.parse(URL);
  static final String _ID = "_id";
  static final String NAME = "name";
  static final String GRADE = "grade";
  private static HashMap<String, String> STUDENTS_PROJECTION_MAP;
  static final int STUDENTS = 1;
  static final int STUDENT_ID = 2;
  static final UriMatcher uriMatcher;
  static{
   uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
   uriMatcher.addURI(PROVIDER_NAME, "students", STUDENTS);
   uriMatcher.addURI(PROVIDER_NAME, "students/#", STUDENT_ID);
  }
  /**
   * Database specific constant declarations
  */
  private SQLiteDatabase db;
  static final String DATABASE_NAME = "College";
  static final String STUDENTS_TABLE_NAME = "students";
  static final int DATABASE_VERSION = 1;
  static final String CREATE_DB_TABLE =
   " CREATE TABLE " + STUDENTS_TABLE_NAME +
     " (_id INTEGER PRIMARY KEY AUTOINCREMENT, " +
     " name TEXT NOT NULL, " +
     " grade TEXT NOT NULL);";
  /**
   * Helper class that actually creates and manages
   * the provider's underlying data repository.
  */
  private static class DatabaseHelper extends SQLiteOpenHelper {
   DatabaseHelper(Context context){
     super(context, DATABASE_NAME, null, DATABASE_VERSION);
   }
   @Override
   public void onCreate(SQLiteDatabase db) {
     db.execSQL(CREATE_DB_TABLE);
   }
   @Override
   public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
     db.execSQL("DROP TABLE IF EXISTS " + STUDENTS_TABLE_NAME);
     onCreate(db);
   }
  }
  @Override
  public boolean onCreate() {
   Context context = getContext();
   DatabaseHelper dbHelper = new DatabaseHelper(context);
   /**
     * Create a write able database which will trigger its
     * creation if it doesn't already exist.
   */
   db = dbHelper.getWritableDatabase();
   return (db == null)? false:true;
  }
  @Override
  public Uri insert(Uri uri, ContentValues values) {
   /**
     * Add a new student record
   */
   long rowID = db.insert(STUDENTS_TABLE_NAME, "", values);
   /**
     * If record is added successfully
   */
   if (rowID > 0) {
     Uri _uri = ContentUris.withAppendedId(CONTENT_URI, rowID);
     getContext().getContentResolver().notifyChange(_uri, null);
     return _uri;
   }
   throw new SQLException("Failed to add a record into " + uri);
  }
  @Override
  public Cursor query(Uri uri, String[] projection,
   String selection,String[] selectionArgs, String sortOrder) {
   SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
   qb.setTables(STUDENTS_TABLE_NAME);
   switch (uriMatcher.match(uri)) {
     case STUDENTS:
      qb.setProjectionMap(STUDENTS_PROJECTION_MAP);
     break;
     case STUDENT_ID:
      qb.appendWhere( _ID + "=" + uri.getPathSegments().get(1));
     break;
     default:
   }
   if (sortOrder == null || sortOrder == ""){
     /**
      * By default sort on student names
     */
     sortOrder = NAME;
   }
   Cursor c = qb.query(db,projection,selection, 
     selectionArgs,null, null, sortOrder);
   /**
     * register to watch a content URI for changes
   */
   c.setNotificationUri(getContext().getContentResolver(), uri);
   return c;
  }
  @Override
  public int delete(Uri uri, String selection, String[] selectionArgs) {
   int count = 0;
   switch (uriMatcher.match(uri)){
     case STUDENTS:
      count = db.delete(STUDENTS_TABLE_NAME, selection, selectionArgs);
     break;
     case STUDENT_ID:
      String id = uri.getPathSegments().get(1);
      count = db.delete( STUDENTS_TABLE_NAME, _ID + " = " + id +
        (!TextUtils.isEmpty(selection) ? "
        AND (" + selection + ')' : ""), selectionArgs);
      break;
     default:
      throw new IllegalArgumentException("Unknown URI " + uri);
   }
   getContext().getContentResolver().notifyChange(uri, null);
   return count;
  }
  @Override
  public int update(Uri uri, ContentValues values,
   String selection, String[] selectionArgs) {
   int count = 0;
   switch (uriMatcher.match(uri)) {
     case STUDENTS:
      count = db.update(STUDENTS_TABLE_NAME, values, selection, selectionArgs);
     break;
     case STUDENT_ID:
      count = db.update(STUDENTS_TABLE_NAME, values,
        _ID + " = " + uri.getPathSegments().get(1) +
        (!TextUtils.isEmpty(selection) ? "
        AND (" +selection + ')' : ""), selectionArgs);
      break;
     default:
      throw new IllegalArgumentException("Unknown URI " + uri );
   }
   getContext().getContentResolver().notifyChange(uri, null);
   return count;
  }
  @Override
  public String getType(Uri uri) {
   switch (uriMatcher.match(uri)){
     /**
      * Get all student records
     */
     case STUDENTS:
      return "vnd.android.cursor.dir/vnd.example.students";
     /**
      * Get a particular student
     */
     case STUDENT_ID:
      return "vnd.android.cursor.item/vnd.example.students";
     default:
      throw new IllegalArgumentException("Unsupported URI: " + uri);
   }
  }
}

以下将修改 AndroidManifest.xml 文件的内容。在这里，我们添加了 <provider … /> 标签以包括我们的内容提供器：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  package="com.example.MyApplication">
  <application
   android:allowBackup="true"
   android:icon="@mipmap/ic_launcher"
   android:label="@string/app_name"
   android:supportsRtl="true"
   android:theme="@style/AppTheme">
     <activity android:name=".MainActivity">
      <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
      </intent-filter>
     </activity>
   <provider android:name="StudentsProvider"
     android:authorities="com.example.MyApplication.StudentsProvider"/>
  </application>
</manifest>

以下是 res/layout/activity_main.xml 文件的内容;

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:tools="http://schemas.android.com/tools"
  android:layout_width="match_parent"
  android:layout_height="match_parent"
  android:paddingBottom="@dimen/activity_vertical_margin"
  android:paddingLeft="@dimen/activity_horizontal_margin"
  android:paddingRight="@dimen/activity_horizontal_margin"
  android:paddingTop="@dimen/activity_vertical_margin"
  tools:context="com.example.MyApplication.MainActivity">
  <TextView
   android:id="@+id/textView1"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:text="Content provider"
   android:layout_alignParentTop="true"
   android:layout_centerHorizontal="true"
   android:textSize="30dp" />
  <TextView
   android:id="@+id/textView2"
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:text="Cankaoshouce "
   android:textColor="#ff87ff09"
   android:textSize="30dp"
   android:layout_below="@+id/textView1"
   android:layout_centerHorizontal="true" />
  <ImageButton
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:id="@+id/imageButton"
   android:src="@drawable/abc"
   android:layout_below="@+id/textView2"
   android:layout_centerHorizontal="true" />
  <Button
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:id="@+id/button2"
   android:text="Add Name"
   android:layout_below="@+id/editText3"
   android:layout_alignRight="@+id/textView2"
   android:layout_alignEnd="@+id/textView2"
   android:layout_alignLeft="@+id/textView2"
   android:layout_alignStart="@+id/textView2"
   android:onClick="onClickAddName"/>
  <EditText
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:id="@+id/editText"
   android:layout_below="@+id/imageButton"
   android:layout_alignRight="@+id/imageButton"
   android:layout_alignEnd="@+id/imageButton" />
  <EditText
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:id="@+id/editText2"
   android:layout_alignTop="@+id/editText"
   android:layout_alignLeft="@+id/textView1"
   android:layout_alignStart="@+id/textView1"
   android:layout_alignRight="@+id/textView1"
   android:layout_alignEnd="@+id/textView1"
   android:hint="Name"
   android:textColorHint="@android:color/holo_blue_light" />
  <EditText
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:id="@+id/editText3"
   android:layout_below="@+id/editText"
   android:layout_alignLeft="@+id/editText2"
   android:layout_alignStart="@+id/editText2"
   android:layout_alignRight="@+id/editText2"
   android:layout_alignEnd="@+id/editText2"
   android:hint="Grade"
   android:textColorHint="@android:color/holo_blue_bright" />
  <Button
   android:layout_width="wrap_content"
   android:layout_height="wrap_content"
   android:text="Retrive student"
   android:id="@+id/button"
   android:layout_below="@+id/button2"
   android:layout_alignRight="@+id/editText3"
   android:layout_alignEnd="@+id/editText3"
   android:layout_alignLeft="@+id/button2"
   android:layout_alignStart="@+id/button2"
   android:onClick="onClickRetrieveStudents"/>
</RelativeLayout>

确保您的 res/values/strings.xml 文件内容如下:

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string name="app_name">My Application</string>
</resources>;

让我们尝试运行我们刚刚创建的修改过的 My Application 应用程序。我假设您在进行环境设置时创建了 AVD。要从 Android Studio IDE 运行应用程序，请打开项目的 activity 文件之一，然后从工具栏中单击运行 Android Studio Eclipse Run Icon 图标。Android Studio 在您的 AVD 上安装应用程序并启动它，如果您的设置和应用程序一切正常，它将显示在模拟器窗口后，请耐心等待，因为根据您的计算机速度，可能需要一些时间。

现在，让我们输入学生的 Name 和 Grade，最后单击 Add Name 按钮，这将在数据库中添加学生记录，并在底部闪烁一条消息，显示 ContentProvider URI 以及数据库中添加的记录编号。此操作使用我们的 insert() 方法。让我们重复这个过程，在内容提供器的数据库中添加更多的学生。

在数据库中添加完记录后，现在是时候让内容提供器将这些记录返回给我们了，所以让我们单击 Retrieve Students 按钮，它将根据 query() 方法的实现一个接一个地获取并显示所有记录。

通过在 MainActivity.java 文件中提供回调函数，可以针对更新和删除操作编写活动。然后修改用户界面，使其具有更新和删除操作的按钮，方法与添加和读取操作相同。

通过这种方式，您可以使用现有的内容提供者（如通讯簿），也可以使用内容提供器（Content Provider）概念开发漂亮的面向数据库的应用程序，在这些应用程序中，您可以执行所有类型的数据库操作，如读、写、更新和删除。

Android（安卓）内容提供器

内容 URI

创建内容提供器

实例

分类导航