Android 内容提供器（Content Provider）

一、简介

　　Content Provider主要提供数据对外共享，通过内容提供器（Content Provider）可以将应用中的数据提供给其它应用共享（存储与读取）。也可以通过内容提供器（Content Provider）对其它应用的数据进行存储与读取。

　　简单的说就是在Android里内置了一个包含数据的数据库，通常是SQLite形式的数据库，由Android OS内置的功能进行驱动。

　　通过Android内容提供器（Content Provider），可以访问可共享的数据结构，称为数据库（Database）。基本的操作步骤如下：

• 获取打开数据库的权限。
• 查询数据。
• 访问数据。

　　在访问数据库时，可对数据进行添、删、改、查操作，这些操作的权限及级别，都存储于工程的清单（AndroidManifest.xml）文件中。

二、数据库与数据库管理系统

　　内容提供器通过数据库管理系统（DBMS）为Android应用程序提供数据结构的。DBMS可以管理数据库，并为用户提供创建数据库的途径，为读写操作提供数据的。

　　在Android中，使用SQLite数据库，其数据库管理系统为RDBMS，SQLite是关系型数据库。在数据库中，表中存储的二维数据称为记录（Record）。

三、Android 内置的内容提供器

1. 联系人数据库内容提供器
2. Android MediaStore内容提供器

四、定义内容提供器

　　在使用内容提供器前，必须在Android应用程序中进行注册。这个操作可以通过AndroidManifest.xml文件的<provider>标签指定。<provider>标签的定义是在应用启动时，需要访问哪些内容提供器。例如：一个用于Images内容提供器的<provider>标签：

<provider android:name="MediaStore.Images.ImageColumns" />

　　所有的内容提供器都针对一个数据库，为开发者提供一个可进行公用访问的唯一引用，或者说一个地址，这个地址称为URI。在Android中，数据库表中指向数据的位置常量通常是CONTENT_URI。

　　数据库中包含多个表，会为每一个表提供一个唯一的URI。例如：

android.provider.Contacts.Phones.CONTENT_URI

1. 第一个词android代表Android OS。
2. 第二个词provider代表组件类型。
3. 第三个词Contents代表数据库。
4. 第四个词Phones代表数据库中的一个表。
5. 第五个词CONTENT_URI代表表中指向数据位置的常量。

　　看似很复杂，其实理解起来就一句话：在Android OS中某个组件类型中的数据库的一个表，数据在表中的位置。

五、定义安全权限　　

　　在AndroidManifest.xml文件定义读取数据库的安全权限，定义读取联系人安全权限示例如下：

<uses-permission android:name="android.permission.READ_CONTACTS" />

 六、自定义内容提供器示例

　　定义一个ContentProvider需要以下必个步骤：

1. 创建一个类，继承于ContentProvider基类；
2. 定义一个CONTENT_URI静态常量，以public static final修饰，初始值最好以类名全名。比如：

   public static final String CONTENT_URI = "naray.myproviderdemo.userprovider"

   此变量用于指定数据库在外访问的唯一地址。

3. 定义数据库表的数据列，如果，使用的是android的内部数据，必须定义一个为_id的列为主键；
4. 创建数据存储系统，Content Provider可以使用Sqlite数据库，或者Android的文件系统存储。也可以是其它的存储方式。
5. 覆盖实现基类Content Provider类的抽象方法。
6. 在AndroidManifest.xml清单文件中，添加provider标签，指定Content Provider。

　　下面自定义一个Content Provider，存储数据为姓名与电话：

　　UserInfo类，用于声名数据库表的数据结构与声名指定此数据库的唯一引用：

public class UserInfo implements BaseColumns
{
    public static final String AUTHORITY = "naray.myproviderdemo.UserProvider";

    public static final class User
    {
        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY);
        public static final String NAME = "NAME";
        public static final String PHONE = "PHONE";
    }
}

　　PS：CONTENT_URI是为使用者提供一个公用的数据库的唯一引用，一般以类名为初始值。

　　UserProvider使用Sqlite存储数据（DataBaseHelper）：

public class DataBaseHelper extends SQLiteOpenHelper
{
    // local member var
    private String mDBName;
    private String mTableName;
    private SQLiteDatabase.CursorFactory mFactory;
    private int mVersion;


    // construceor
    public DataBaseHelper(Context context, String name, String tableName,
                          SQLiteDatabase.CursorFactory factory, int version)
    {
        super(context, name, factory, version);
        mDBName = name;
        mTableName = tableName;
        mFactory = factory;
        mVersion = version;
    }

    // inherit baseclass member method
    @Override
    public void onCreate(SQLiteDatabase db)
    {
        String sql = "create table " + mTableName + " ( _id INTEGER PRIMARY KEY AUTOINCREMENT, " +
                "NAME TEXT, PHONE TEXT);";
        db.execSQL(sql);
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion)
    {

    }
}

　　UserProvider类，是继承于Content Provider类，定义一个内容提供器：

public class UserProvider extends ContentProvider
{
    // local member var
    private DataBaseHelper mDBHelper;
    private SQLiteDatabase mSqlDB;
    private static final String sDataBaseName = "user.db";
    private static final String sTableName = "user";
    private static final int sVersion = 1;

    // inherit baseclass member method
    @Override
    public boolean onCreate()
    {
        mDBHelper = new DataBaseHelper(getContext(), sDataBaseName, sTableName, null, sVersion);
        return false;
    }

    @Nullable
    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
    {
        SQLiteQueryBuilder sqLiteQueryBuilder = new SQLiteQueryBuilder();
        SQLiteDatabase db = mDBHelper.getReadableDatabase();
        sqLiteQueryBuilder.setTables(sTableName);
        Cursor cursor = db.query(sTableName, projection, selection, selectionArgs, null, null, sortOrder);
        cursor.setNotificationUri(getContext().getContentResolver(), uri);

        return cursor;
    }

    @Nullable
    @Override
    public String getType(Uri uri)
    {
        return null;
    }

    @Nullable
    @Override
    public Uri insert(Uri uri, ContentValues values)
    {
        mSqlDB = mDBHelper.getWritableDatabase();
        long rowId = mSqlDB.insert(sTableName, null, values);
        if (0 < rowId)
        {
            Uri rowUri = ContentUris.appendId(UserInfo.User.CONTENT_URI.buildUpon(), rowId).build();
            getContext().getContentResolver().notifyChange(rowUri, null);
            return rowUri;
        }
        return null;
    }

    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs)
    {
        return 0;
    }

    @Override
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
    {
        return 0;
    }
}

　　下面是显示UI元素的界面，MainActivity:

public class MainActivity extends FragmentActivity
{
    @Override
    public void onCreate(Bundle savedInstanceStata)
    {
        super.onCreate(savedInstanceStata);
        setContentView(R.layout.activity_fragment);

        // fragment manager
        FragmentManager fm = getSupportFragmentManager();
        Fragment fragment = fm.findFragmentById(R.id.fragmentContainter);
        if (null == fragment)
        {
            fragment = new MainFragment();
            fm.beginTransaction().add(R.id.fragmentContainter, fragment).commit();
        }
    }
}

　　MainActivity委托MainFragment构建界面（MainFragment）：

public class MainFragment extends Fragment implements View.OnClickListener
{
    // local member var
    private EditText mNameEditText;
    private EditText mTelEditText;
    private final ContentValues mContentVals = new ContentValues();

    // constructor
    public MainFragment()
    {
    }

    // inherit baseclass member method
    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup containter, Bundle savedInstanceState)
    {
        View view = inflater.inflate(R.layout.fragment_main, null);

        // 存储UI元素
        mNameEditText = (EditText) view.findViewById(R.id.name);
        mTelEditText = (EditText) view.findViewById(R.id.tel);

        // 添加事件代理的UI元素
        Button insert = (Button) view.findViewById(R.id.insert);
        insert.setOnClickListener(this);

        Button query = (Button) view.findViewById(R.id.query);
        query.setOnClickListener(this);

        return view;
    }

    // inherit View.OnClickListener interface member method
    @Override
    public void onClick(View view)
    {
        switch (view.getId())
        {
            case R.id.insert:
            {
                mContentVals.put(UserInfo.User.NAME, mNameEditText.getText().toString());
                mContentVals.put(UserInfo.User.PHONE, mTelEditText.getText().toString());
                Uri resUri = getActivity().getContentResolver().insert(UserInfo.User.CONTENT_URI, mContentVals);
                if (null != resUri)
                {
                    Toast.makeText(getActivity(), "添加数据成功", Toast.LENGTH_SHORT).show();
                }
                else
                {
                    Toast.makeText(getActivity(), "添加数据失败", Toast.LENGTH_SHORT).show();
                }
                break;
            }
            case R.id.query:
            {
                ArrayList<String> data = new ArrayList<>();
                Cursor cursor = getActivity().getContentResolver().query(UserInfo.User.CONTENT_URI, null, null, null, null);
                if (null != cursor)
                {
                    if (cursor.moveToFirst())
                    {
                        do
                        {
                            String name = cursor.getString(cursor.getColumnIndex(UserInfo.User.NAME));
                            data.add(name);
                        } while (cursor.moveToNext());
                    }
                    cursor.close();
                }
                // 获取Fragment管理系统对象
                FragmentManager fm = getFragmentManager();
                // 创建一个fragment对象
                UserListFragment userListFragment = UserListFragment.newInstance(data);
                // 通过Fragment管理器，将新创建的fragment对象添加到指定的布局容器中
                fm.beginTransaction().add(R.id.user_list, userListFragment).commit();
                Toast.makeText(getActivity(), "查询数据", Toast.LENGTH_SHORT).show();
                break;
            }
            default:
                Toast.makeText(getActivity(), "Without event in element.", Toast.LENGTH_SHORT).show();
        }
    }
}

　　显示数据数据的列表数据界面（UserListFragment）：

public class UserListFragment extends ListFragment
{
    public static final String sExtra_Users_Key = "users";

    // member method
    public static UserListFragment newInstance(ArrayList<String> data)
    {
        Bundle args = new Bundle();
        args.putStringArrayList(sExtra_Users_Key, data);
        UserListFragment userListFragment = new UserListFragment();
        userListFragment.setArguments(args);

        return userListFragment;
    }

    // inherit baseclass member method
    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        ArrayList<String> data = getArguments().getStringArrayList(sExtra_Users_Key);
        if (null != data)
        {
            ArrayAdapter<String> adapter = new ArrayAdapter<>(getActivity(),
                    android.R.layout.simple_list_item_1, data);
            setListAdapter(adapter);
        }
    }
}

　　MianFramgent界面容器（activity_fragment）：

<FrameLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/fragmentContainter"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

</FrameLayout>

　　主界面显示UI样式（fragment_main）：

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@string/main_name"
            android:textColor="#000"
            android:textSize="14sp"/>

        <EditText
            android:id="@+id/name"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:textSize="14sp"
            android:textColor="#000"/>

    </LinearLayout>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@string/main_tel"
            android:textColor="#000"
            android:textSize="14sp"/>

        <EditText
            android:id="@+id/tel"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:textSize="14sp"
            android:textColor="#000"/>

    </LinearLayout>

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal"
        android:gravity="center">

        <Button
            android:id="@+id/insert"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@string/main_insert"
            android:textColor="#000"/>

        <Button
            android:id="@+id/query"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@string/main_query"
            android:textColor="#000"/>

    </LinearLayout>

    <FrameLayout
        android:id="@+id/user_list"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

        </FrameLayout>

</LinearLayout>

　　在主界面布局XML文件中，有这样一段代码：

<FrameLayout
        android:id="@+id/user_list"
        android:layout_width="match_parent"
        android:layout_height="wrap_content">

        </FrameLayout>

　　使用FrameLayout在界面内部再嵌入一个fragment，用于显示列表数据的UI元素，动态载入UserListFragment：

// 获取Fragment管理系统对象
FragmentManager fm = getFragmentManager();
// 创建一个fragment对象
UserListFragment userListFragment = UserListFragment.newInstance(data);
// 通过Fragment管理器，将新创建的fragment对象添加到指定的布局容器中
fm.beginTransaction().add(R.id.user_list, userListFragment).commit();