什么是合约类以及如何使用它

android java android-contentprovider

2022-09-01 13:05:26

在最近更新的 Android 开发人员指南中，内容提供程序的文档包含一个标题为“合同类”的部分。虽然有一个指向“联系人”示例的链接，但并不清楚什么是合同类以及如何为我的自定义内容提供程序创建一个合同类。

希望能在这方面得到一些帮助。

谢谢！

答案 1

什么是合约类？

协定类是一个类，它包含 URI 的常量定义、列名、MIME 类型以及有关的其他元数据。它还可以包含用于操作 URI 的帮助器方法。publicfinalContentProviderstatic

为什么使用它？

协定类在内容提供程序和其他应用程序之间建立协定。它确保即使 URI、列名称等的实际值发生更改，也可以正确访问您的内容提供商。
由于它为其常量提供助记符名称，因此开发人员不太可能对列名或 URI 使用不正确的值。
将 Javadoc 文档提供给想要使用您的内容提供程序的客户端很容易。

如何使用？

下面是为包含两个表的天气应用设计的示例 Contract 类代码段：天气表和位置表。跳过注释和一些方法以使其保持较小。一般来说，它应该被很好地评论。

public class WeatherContract {

    public static final String CONTENT_AUTHORITY = 
            "com.example.android.sunshine.app";
    public static final Uri BASE_CONTENT_URI = 
            Uri.parse("content://" + CONTENT_AUTHORITY);
    public static final String PATH_WEATHER = "weather";
    public static final String PATH_LOCATION = "location";

    /**Inner class that defines the table contents of the location table. */
    public static final class LocationEntry implements BaseColumns {
        public static final String TABLE_NAME = "location";
        public static final String COLUMN_LOCATION_SETTING = "location_setting";
        public static final String COLUMN_CITY_NAME = "city_name";
        public static final String COLUMN_COORD_LAT = "coord_lat";
        public static final String COLUMN_COORD_LONG = "coord_long";

        public static final Uri CONTENT_URI =
                BASE_CONTENT_URI.buildUpon().appendPath(PATH_LOCATION).build();

        // Custom MIME types
        public static final String CONTENT_TYPE =
                ContentResolver.CURSOR_DIR_BASE_TYPE +
                        "/" + CONTENT_AUTHORITY + "/" + PATH_LOCATION;

        public static final String CONTENT_ITEM_TYPE =
                ContentResolver.CURSOR_ITEM_BASE_TYPE +
                        "/" + CONTENT_AUTHORITY + "/" + PATH_LOCATION;

        // Helper method
        public static Uri buildLocationUri(long id) {
            return ContentUris.withAppendedId(CONTENT_URI, id);
        }
    }


    /** Inner class that defines the table contents of the weather table. */
    public static final class WeatherEntry implements BaseColumns {

        public static final String TABLE_NAME = "weather";

        public static final String COLUMN_LOC_KEY = "location_id";
        public static final String COLUMN_DATE = "date";
        public static final String COLUMN_WEATHER_ID = "weather_id";
        public static final String COLUMN_SHORT_DESC = "short_desc";
        public static final String COLUMN_MIN_TEMP = "min";
        public static final String COLUMN_MAX_TEMP = "max";
        public static final String COLUMN_HUMIDITY = "humidity";
        public static final String COLUMN_PRESSURE = "pressure";
        public static final String COLUMN_WIND_SPEED = "wind";
        public static final String COLUMN_DEGREES = "degrees";

        public static final Uri CONTENT_URI =
                BASE_CONTENT_URI.buildUpon().appendPath(PATH_WEATHER).build();

        public static final String CONTENT_TYPE =
                ContentResolver.CURSOR_DIR_BASE_TYPE + "/" + CONTENT_AUTHORITY + 
                        "/" + PATH_WEATHER;

        public static final String CONTENT_ITEM_TYPE =
                ContentResolver.CURSOR_ITEM_BASE_TYPE + "/" + CONTENT_AUTHORITY + 
                        "/" + PATH_WEATHER;

        // Helper method.
        public static Uri buildWeatherUri(long id) {
            return ContentUris.withAppendedId(CONTENT_URI, id);
        }

        .
        .
        .
    }
}

答案 2

协定类定义可帮助应用程序使用内容 URI、列名、目的操作和内容提供程序的其他功能的常量。合约类不会自动包含在提供程序中;提供程序的开发人员必须定义它们，然后将其提供给其他开发人员。

您可以创建自己的 Contract 类，并在那里定义一些常量。例如，稍后可以在对数据库进行查询的代码中调用的列名等。

如何使用合约类的好例子看到这个线程Android - 我如何加载联系人照片？