Android ContentProvider的实现

  当Android中的应用需要访问其他应用的数据时，用ContentProvider可以很好的解决这个问题。今天介绍一下ContentProvider的用法。

  首先开发ContentProvider有两个步骤：

  1、开发一个ContentProvider的子类，该子类需要实现增、删、改、查等方法。

  2、在AndroidManifest.xml文件中注册该ContentProvider。

  下面通过一个实例来介绍一下ContentProvider到底怎么实现的。首先，我们也像系统一样把ContentProvider的Uri、数据列等信息以常量的形式公开出来、方便访问。为此，定义一个工具类，该类中只是包含一个public static的常量，该工具类的代码如下：

public final class Words
{
    // 定义该ContentProvider的Authority
    public static final String AUTHORITY 
        = "org.crazyit.providers.dictprovider";
    //定义一个静态内部类
    public static final class Word implements BaseColumns
    {
        // 定义Content所允许操作的3个数据列
        public final static String _ID = "_id";
        public final static String WORD = "word";
        public final static String DETAIL = "detail";
        // 定义该Content提供服务的两个Uri
        public final static Uri DICT_CONTENT_URI = 
            Uri.parse("content://" +  AUTHORITY + "/words");
        public final static Uri WORD_CONTENT_URI = 
            Uri.parse("content://" +  AUTHORITY + "/word");        
    }
}

  上面的工具类只是定义了一些简单的常量的工具类，这个工具类的作用就是告诉其他应用访问该ContentProvider的一些常用的入口。
  接下来开发一个ContentProvider的子类，并重写其中的增、删、改、查等方法，代码如下：

public class DictProvider extends ContentProvider
{
    private static UriMatcher matcher
        = new UriMatcher(UriMatcher.NO_MATCH);
    private static final int WORDS = 1;
    private static final int WORD = 2;
    private MyDatabaseHelper dbOpenHelper;
    static
    {
        // 为UriMatcher注册两个Uri
        matcher.addURI(Words.AUTHORITY, "words", WORDS);
        matcher.addURI(Words.AUTHORITY, "word/#", WORD);
    }
    // 第一次调用该DictProvider时，系统先创建DictProvider对象，并回调该方法
    @Override
    public boolean onCreate()
    {
        dbOpenHelper = new MyDatabaseHelper(this.getContext(), "myDict.db3", 1);
        return true;
    }
    // 插入数据方法
    @Override
    public Uri insert(Uri uri, ContentValues values)
    {
        // 获得数据库实例
        SQLiteDatabase db = dbOpenHelper.getReadableDatabase();
        // 插入数据，返回行ID
        long rowId = db.insert("dict", Words.Word._ID, values);
        // 如果插入成功返回uri
        if (rowId > 0)
        {
            // 在已有的 Uri的后面追加ID数据
            Uri wordUri = ContentUris.withAppendedId(uri, rowId);
            // 通知数据已经改变
            getContext().getContentResolver().notifyChange(wordUri, null);
            return wordUri;
        }
        return null;
    }
    // 删除数据的方法
    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs)
    {
        SQLiteDatabase db = dbOpenHelper.getReadableDatabase();
        // 记录所删除的记录数
        int num = 0;
        // 对于uri进行匹配。
        switch (matcher.match(uri))
        {
            case WORDS:
                num = db.delete("dict", selection, selectionArgs);
                break;
            case WORD:
                // 解析出所需要删除的记录ID
                long id = ContentUris.parseId(uri);
                String where = Words.Word._ID + "=" + id;
                // 如果原来的where子句存在，拼接where子句
                if (selection != null && !selection.equals(""))
                {
                    where = where + " and " + selection;
                }
                num = db.delete("dict", where, selectionArgs);
                break;
            default:
                throw new IllegalArgumentException("未知Uri:" + uri);
        }
        // 通知数据已经改变
        getContext().getContentResolver().notifyChange(uri, null);
        return num;
    }
    // 修改数据的方法
    @Override
    public int update(Uri uri, ContentValues values, String selection,
        String[] selectionArgs)
    {
        SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
        // 记录所修改的记录数
        int num = 0;
        switch (matcher.match(uri))
        {
            case WORDS:
                num = db.update("dict", values, selection, selectionArgs);
                break;
            case WORD:
                // 解析出想修改的记录ID
                long id = ContentUris.parseId(uri);
                String where = Words.Word._ID + "=" + id;
                // 如果原来的where子句存在，拼接where子句
                if (selection != null && !selection.equals(""))
                {
                    where = where + " and " + selection;
                }
                num = db.update("dict", values, where, selectionArgs);
                break;
            default:
                throw new IllegalArgumentException("未知Uri:" + uri);
        }
        // 通知数据已经改变
        getContext().getContentResolver().notifyChange(uri, null);
        return num;
    }
    // 查询数据的方法
    @Override
    public Cursor query(Uri uri, String[] projection, String selection,
        String[] selectionArgs, String sortOrder)
    {
        SQLiteDatabase db = dbOpenHelper.getReadableDatabase();
        switch (matcher.match(uri))
        {
            case WORDS:
                // 执行查询
                return db.query("dict", projection, selection, selectionArgs,
                    null, null, sortOrder);
            case WORD:
                // 解析出想查询的记录ID
                long id = ContentUris.parseId(uri);
                String where = Words.Word._ID + "=" + id;
                // 如果原来的where子句存在，拼接where子句
                if (selection != null && !"".equals(selection))
                {
                    where = where + " and " + selection;
                }
                return db.query("dict", projection, where, selectionArgs, null,
                    null, sortOrder);
            default:
                throw new IllegalArgumentException("未知Uri:" + uri);
        }
    }
    // 返回指定uri参数对应的数据的MIME类型
    @Override
    public String getType(Uri uri)
    {
        switch (matcher.match(uri))
        {
            // 如果操作的数据是多项记录
            case WORDS:
                return "vnd.android.cursor.dir/org.crazyit.dict";
                // 如果操作的数据是单项记录
            case WORD:
                return "vnd.android.cursor.item/org.crazyit.dict";
            default:
                throw new IllegalArgumentException("未知Uri:" + uri);
        }
    }
}

上面的DictProvider类继承了ContentProvider，并实现了操作数据的增、删、改、查等方法。接下来需要在AndroidManitest.xml文件中注册该ContentProvider，代码：

<!-- 注册一个ContentProvider -->
        <provider android:name=".DictProvider" 
            android:authorities="org.crazyit.providers.dictprovider"/>

  至此，整个ContentProvider开发完成，为了测试它，我们需要新建一个工程。
  在新的工程里，我们需要把上面创建的工具类拷贝到新工程里，下面的是使用ContentProvider的代码：

public class DictResolver extends Activity
{
    ContentResolver contentResolver;
    Button insert = null;
    Button search = null;
    @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        // 获取系统的ContentResolver对象
        contentResolver = getContentResolver();
        insert = (Button)findViewById(R.id.insert);
        search = (Button)findViewById(R.id.search);    
        // 为insert按钮的单击事件绑定事件监听器
        insert.setOnClickListener(new OnClickListener()
        {
            @Override
            public void onClick(View source)
            {
                //获取用户输入
                String word = ((EditText)findViewById(R.id.word))
                    .getText().toString();
                String detail = ((EditText)findViewById(R.id.detail))
                    .getText().toString();
                //插入生词记录
                ContentValues values = new ContentValues();
                values.put(Words.Word.WORD , word);
                values.put(Words.Word.DETAIL , detail);
                contentResolver.insert(Words.Word.DICT_CONTENT_URI , values);
                //显示提示信息
                Toast.makeText(DictResolver.this, "添加生词成功！" , 8000)
                    .show();
            }            
        });
        // 为search按钮的单击事件绑定事件监听器
        search.setOnClickListener(new OnClickListener()
        {
            @Override
            public void onClick(View source)
            {
                // 获取用户输入
                String key = ((EditText) findViewById(R.id.key)).getText()
                    .toString();
                // 执行查询
                Cursor cursor = contentResolver.query(
47                     Words.Word.DICT_CONTENT_URI, null 
48                     , "word like ? or detail like ?"
49                     , new String[]{"%" + key + "%" , "%" + key + "%"} 
50                     , null);
                //创建一个Bundle对象
                Bundle data = new Bundle();
                data.putSerializable("data", converCursorToList(cursor));
                //创建一个Intent
                Intent intent = new Intent(DictResolver.this
                    , ResultActivity.class);
                intent.putExtras(data);
                //启动Activity
                startActivity(intent);
            }
        });
    }

    private ArrayList<Map<String, String>> converCursorToList(
        Cursor cursor)
    {
        ArrayList<Map<String, String>> result 
            = new ArrayList<Map<String, String>>();
        // 遍历Cursor结果集
        while (cursor.moveToNext())
        {
            // 将结果集中的数据存入ArrayList中
            Map<String, String> map = new HashMap<String, String>();
            // 取出查询记录中第2列、第3列的值
            map.put(Words.Word.WORD, cursor.getString(1));
            map.put(Words.Word.DETAIL, cursor.getString(2));
            result.add(map);
        }
        return result;
    }
}

至此，测试ContentProvider的关键代码已经给出了，希望能够帮助大家，在此也希望大家多多关注本人。