现在的位置: 首页 > 综合 > 正文

Android ContactsProvider源码分析

2018年04月21日 ⁄ 综合 ⁄ 共 8210字 ⁄ 字号 小 中 大 ⁄ 评论关闭

  Android源码目录packages\providers下的应用是下载，通话等内置基本应用提供数据存储和操作的provider应用，本文章将针对ContactsProvider源码的架构和实现展开分析。（注：本文使用使用android4.0版本进行分析）

1、架构设计

      ContactsProvider中数据操作基类是AbstractContactsProvider.java（参见frameworks\ex\common\java\com\android\common\content\SQLiteContentProvider.java），它继承ContentProvider.java实现SQLiteTransactionListener.java，类结构如下图所示：

图 1 provider结构图

        该类是抽象基类，在里面实现了父类的insert、delete和update三个抽象方法，在这三个方法中在其中使用了事务对数据库进行操作。该类设计时，使用了模板模式模板方法为insertInTransaction，updateInTransaction和deleteInTransaction。该类在对数据库进行事务操作的同时，对子类开放了onRollback，onCommit等事物回调方法，子类可以根据自己的业务特点进行扩展。增删改查的调用过程如下图2
3 4所示：

图2  插入操作

图 3 更新操作

图 4 删除操作

  在整个设计中有两个类继承了AbstractContactsProvider.java，一个是ContactsProvider2.java，我们在调用系统的联系人数据时基本都是调用该类，里面封装了所有联系人的数据操作。第二个是ProfileProvider.java，该类是ContactsProvider2.java的委托类。这三个类的类间关系如下图5所示：

图 5 类间关系图

  类ContactsTransaction.java是对事务的管理类，主要对进行的事务进行管理，类似一个事务池。是AbstractContactsProvider.java中事务处理的核心类。

         DataRowHandler.java是数据处理抽象类，实现了对数据的增删改操作，子类有如下几个：

[java] view
plaincopy

  1. DataRowHandlerForCommonDataKind.java  
  2. DataRowHandlerForCustomMimetype.java  
  3. DataRowHandlerForEmail.java  
  4. DataRowHandlerForGroupMembership.java  
  5. DataRowHandlerForIm.java  
  6. DataRowHandlerForNickname.java  
  7. DataRowHandlerForNote.java  
  8. DataRowHandlerForOrganization.java  
  9. DataRowHandlerForPhoneNumber.java  
  10. DataRowHandlerForPhoto.java  
  11. DataRowHandlerForStructuredName.java  
  12. DataRowHandlerForStructuredPostal.java  

这些子类在ContactsProvider2#initDataRowHandlers中初始化

[java] view
plaincopy

  1. private void initDataRowHandlers(Map<String, DataRowHandler> handlerMap,  
  2.         ContactsDatabaseHelper dbHelper, ContactAggregator contactAggregator,  
  3.         PhotoStore photoStore) {  
  4.     Context context = getContext();  
  5.     handlerMap.put(Email.CONTENT_ITEM_TYPE,  
  6.             new DataRowHandlerForEmail(context, dbHelper, contactAggregator));  
  7.     handlerMap.put(Im.CONTENT_ITEM_TYPE,  
  8.             new DataRowHandlerForIm(context, dbHelper, contactAggregator));  
  9.     handlerMap.put(Organization.CONTENT_ITEM_TYPE,  
  10.             new DataRowHandlerForOrganization(context, dbHelper, contactAggregator));  
  11.     handlerMap.put(Phone.CONTENT_ITEM_TYPE,  
  12.             new DataRowHandlerForPhoneNumber(context, dbHelper, contactAggregator));  
  13.     handlerMap.put(Nickname.CONTENT_ITEM_TYPE,  
  14.             new DataRowHandlerForNickname(context, dbHelper, contactAggregator));  
  15.     handlerMap.put(StructuredName.CONTENT_ITEM_TYPE,  
  16.             new DataRowHandlerForStructuredName(context, dbHelper, contactAggregator,  
  17.                     mNameSplitter, mNameLookupBuilder));  
  18.     handlerMap.put(StructuredPostal.CONTENT_ITEM_TYPE,  
  19.             new DataRowHandlerForStructuredPostal(context, dbHelper, contactAggregator,  
  20.                     mPostalSplitter));  
  21.     handlerMap.put(GroupMembership.CONTENT_ITEM_TYPE,  
  22.             new DataRowHandlerForGroupMembership(context, dbHelper, contactAggregator,  
  23.                     mGroupIdCache));  
  24.     handlerMap.put(Photo.CONTENT_ITEM_TYPE,  
  25.             new DataRowHandlerForPhoto(context, dbHelper, contactAggregator, photoStore));  
  26.     handlerMap.put(Note.CONTENT_ITEM_TYPE,  
  27.             new DataRowHandlerForNote(context, dbHelper, contactAggregator));  
  28. }  

这些子类在getDataRowHandler方法中中通过mimetype进行调用：

[java] view
plaincopy

  1. public DataRowHandler getDataRowHandler(final String mimeType) {  
  2.     if (inProfileMode()) {  
  3.         return getDataRowHandlerForProfile(mimeType);  
  4.     }  
  5.     DataRowHandler handler = mDataRowHandlers.get(mimeType);  
  6.     if (handler == null) {  
  7.         handler = new DataRowHandlerForCustomMimetype(  
  8.                 getContext(), mContactsHelper, mContactAggregator, mimeType);  
  9.         mDataRowHandlers.put(mimeType, handler);  
  10.     }  
  11.     return handler;  
  12. }  

getDataRowHandler方法在insertData，deleteData和updateData方法中被调用。

[java] view
plaincopy

  1. /** 
  2.     * Inserts an item in the data table 
  3.     * 
  4.     * @param values the values for the new row 
  5.     * @return the row ID of the newly created row 
  6.     */  
  7.    private long insertData(ContentValues values, boolean callerIsSyncAdapter) {  
  8.        long id = 0;  
  9.        mValues.clear();  
  10.        mValues.putAll(values);  
  11.   
  12.        long rawContactId = mValues.getAsLong(Data.RAW_CONTACT_ID);  
  13.   
  14.        // Replace package with internal mapping  
  15.        final String packageName = mValues.getAsString(Data.RES_PACKAGE);  
  16.        if (packageName != null) {  
  17.            mValues.put(DataColumns.PACKAGE_ID, mDbHelper.get().getPackageId(packageName));  
  18.        }  
  19.        mValues.remove(Data.RES_PACKAGE);  
  20.   
  21.        // Replace mimetype with internal mapping  
  22.        final String mimeType = mValues.getAsString(Data.MIMETYPE);  
  23.        if (TextUtils.isEmpty(mimeType)) {  
  24.            throw new IllegalArgumentException(Data.MIMETYPE + " is required");  
  25.        }  
  26.   
  27.        mValues.put(DataColumns.MIMETYPE_ID, mDbHelper.get().getMimeTypeId(mimeType));  
  28.        mValues.remove(Data.MIMETYPE);  
  29.   
  30.        DataRowHandler rowHandler = <span style="color: rgb(102, 102, 204);">getDataRowHandler(mimeType)</span>;  
  31.        id = rowHandler.insert(mActiveDb.get(), mTransactionContext.get(), rawContactId, mValues);  
  32.        if (!callerIsSyncAdapter) {  
  33.            mTransactionContext.get().markRawContactDirty(rawContactId);  
  34.        }  
  35.        mTransactionContext.get().rawContactUpdated(rawContactId);  
  36.        return id;  
  37.    }  

所有数据的mimetype都被存储在表Tables.MIMETYPES中，该只有两个字段_id和mimetype。

[java] view
plaincopy

  1. db.execSQL("CREATE TABLE " + Tables.MIMETYPES + " ("  
  2.               + MimetypesColumns._ID + " INTEGER PRIMARY KEY AUTOINCREMENT,"  
  3.               + MimetypesColumns.MIMETYPE + " TEXT NOT NULL" + ");");  

Tables.MIMETYPES表数据的存储是在ContactsDatabaseHelper#lookupAndCacheId中进行的，具体调用过程如下图 6 所示：

图 6 mimetype数据调用流程图

2、表结构

        ContactsProvider 中共创建了25张表，

[java] view
plaincopy

  1. public static final String CONTACTS = "contacts";  
  2. public static final String RAW_CONTACTS = "raw_contacts";  
  3. public static final String STREAM_ITEMS = "stream_items";  
  4. public static final String STREAM_ITEM_PHOTOS = "stream_item_photos";  
  5. public static final String PHOTO_FILES = "photo_files";  
  6. public static final String PACKAGES = "packages";  
  7. public static final String MIMETYPES = "mimetypes";  
  8. public static final String PHONE_LOOKUP = "phone_lookup";  
  9. public static final String NAME_LOOKUP = "name_lookup";  
  10. public static final String AGGREGATION_EXCEPTIONS = "agg_exceptions";  
  11. public static final String SETTINGS = "settings";  
  12. public static final String DATA = "data";  
  13. public static final String GROUPS = "groups";  
  14. public static final String PRESENCE = "presence";  
  15. public static final String AGGREGATED_PRESENCE = "agg_presence";  
  16. public static final String NICKNAME_LOOKUP = "nickname_lookup";  
  17. public static final String CALLS = "calls";  
  18. public static final String STATUS_UPDATES = "status_updates";  
  19. public static final String PROPERTIES = "properties";  
  20. public static final String ACCOUNTS = "accounts";  
  21. public static final String VISIBLE_CONTACTS = "visible_contacts";  
  22. public static final String DIRECTORIES = "directories";  
  23. public static final String DEFAULT_DIRECTORY = "default_directory";  
  24. public static final String SEARCH_INDEX = "search_index";  
  25. public static final String VOICEMAIL_STATUS = "voicemail_status";  


这些表数据对开发者开放的api在 \frameworks\base\core\java\android\provider\文件夹下，

[java] view
plaincopy

  1. CallLog.java  
  2. Contacts.java  
  3. ContactsContract.java  
  4. SocialContract.java  
  5. SyncConstValue.java  
  6. VoicemailContract.java  

由于数据查询涉及多个表间关系，大量数据的查询都是通过视图来完成的，创建了如下8个视图，而这几个视图是大家在调用api进行查询时显示的数据：

[java] view
plaincopy

  1. public interface Views {  
  2.     public static final String DATA = "view_data";  
  3.     public static final String RAW_CONTACTS = "view_raw_contacts";  
  4.     public static final String CONTACTS = "view_contacts";  
  5.     public static final String ENTITIES = "view_entities";  
  6.     public static final String RAW_ENTITIES = "view_raw_entities";  
  7.     public static final String GROUPS = "view_groups";  
  8.     public static final String DATA_USAGE_STAT = "view_data_usage_stat";  
  9.     public static final String STREAM_ITEMS = "view_stream_items";  
  10. }  

4、总结

      ContactsProvder是provider源码中数据处理和架构比较全面的一个应用，可以将它的架构核心抽离出来供大家参考和借鉴，以下类构成了整个架构的核心类，可以重点研究：

[java] view
plaincopy

  1. AbstractContactsProvider.java  
  2. ContactAggregator.java  
  3. ContactsDatabaseHelper.java  
  4. ContactsProvider2.java  
  5. ContactsTransaction.java  
  6. TransactionContext.java 
返回
【上篇】
【下篇】

作者:

抱歉!评论已关闭.

返回首页

Copyright © 2013-2018 学步园  保留所有权利.
软文销售 QQ客服：2265327166 点击这里给我发消息（其他合作也可洽谈）
必威体育
必威电竞