콘텐츠 제공자 생성

콘텐츠 제공자는 중앙 리포지토리로의 데이터 액세스를 관리합니다. Android 애플리케이션에서는 제공자를 하나 이상의 클래스로, 매니페스트 파일에 있는 요소와 함께 구현합니다. 클래스 중 하나가 하위 클래스 ContentProvider를 구현하며, 이것이 제공자와 다른 애플리케이션 사이의 인터페이스입니다. 콘텐츠 제공자는 다른 애플리케이션이 데이터를 사용할 수 있도록 설계되지만, 물론 애플리케이션 내에서 사용자가 제공자 관리하에 있는 데이터를 쿼리하고 수정할 수 있게 허용하는 액티비티가 있을 수도 있습니다.

이 주제의 나머지 부분은 콘텐츠 제공자를 빌드하기 위한 기본 단계 목록과 사용할 API 목록으로 이루어져 있습니다.

빌드를 시작하기 전에

제공자를 빌드하기 전에 우선 다음 단계를 고려하세요.

콘텐츠 제공자가 필요한지 결정합니다. 다음 기능 중 하나 이상을 제공하려면 콘텐츠 제공자를 빌드해야 합니다.
- 다른 애플리케이션에 복잡한 데이터나 파일을 제공하고자 하는 경우
- 사용자로 하여금 개발자의 앱에서 다른 앱으로 복잡한 데이터를 복사하도록 허용하고자 하는 경우
- 검색 프레임워크를 사용한 사용자 지정 검색 제안을 제공하고자 하는 경우
- 애플리케이션 데이터를 위젯에 노출하고자 하는 경우
- AbstractThreadedSyncAdapter, CursorAdapter 또는 CursorLoader 클래스를 구현하고자 하는 경우
애플리케이션 내에서만 사용하고 위에서 언급한 기능이 필요하지 않은 경우 데이터베이스나 다른 유형의 영구 저장소를 사용하는 데 제공자가 필요하지 않습니다. 대신 앱 데이터 저장 페이지에서 설명한 저장 시스템 중 하나를 사용할 수 있습니다.
아직 사용하지 않고 있다면 콘텐츠 제공자 기본 사항을 읽고 제공자와 제공자의 작동 방식에 대해 자세히 알아보세요.

그런 다음, 다음 단계를 따라 제공자를 빌드하세요.

데이터를 위한 원시 저장소를 설계합니다. 콘텐츠 제공자는 두 가지 방식으로 데이터를 제공합니다.

파일 데이터

일반적으로 사진, 오디오 또는 동영상과 같은 파일에 들어가는 데이터입니다. 애플리케이션의 전용 공간에 파일을 저장합니다. 제공자는 다른 애플리케이션에서 수신한 파일 요청에 응답하여 해당 파일로의 핸들을 제공할 수 있습니다.

"구조화된" 데이터

일반적으로 데이터베이스, 배열 또는 유사 구조에 들어가는 데이터입니다. 이 데이터를 행과 열로 이루어진 테이블과 호환되는 형식으로 저장합니다. 행은 사람이나 인벤토리 항목과 같은 엔터티를 나타냅니다. 열은 해당 엔터티에 대한 일부 데이터, 예를 들어 사람 이름이나 품목 가격 등을 나타냅니다. 이 유형의 데이터를 저장하는 일반적인 방법은 SQLite 데이터베이스 안에 저장하는 것이지만, 모든 유형의 영구 저장소를 사용할 수 있습니다. Android 시스템에서 사용할 수 있는 저장소 유형에 대해 자세히 알아보려면, 데이터 저장소 설계 섹션을 참조하세요.
ContentProvider 클래스와 필수 메서드의 구체적인 구현을 정의합니다. 이 클래스는 데이터와 나머지 Android 시스템을 연결하는 인터페이스입니다. 이 클래스에 관한 자세한 내용은 ContentProvider 클래스 구현 섹션을 참조하세요.
제공자의 권한 문자열, 그 콘텐츠 URI 및 열 이름을 정의합니다. 제공자 애플리케이션이 인텐트를 처리하게 하려면, 인텐트 작업과 엑스트라 데이터 및 플래그도 정의합니다. 데이터에 액세스하기를 원하는 애플리케이션에 요구할 권한도 정의합니다. 이 모든 값은 별도의 계약 클래스에서 상수로 정의하는 것을 고려해보는 것이 좋습니다. 이 클래스를 나중에 다른 개발자에게 노출할 수 있습니다. 콘텐츠 URI에 관한 자세한 내용은 콘텐츠 URI 설계 섹션을 참조하세요. 인텐트에 관한 자세한 내용은 인텐트 및 데이터 액세스 섹션을 참조하세요.
샘플 데이터, 또는 제공자와 클라우드 기반 데이터 사이에서 데이터를 동기화할 수 있는 AbstractThreadedSyncAdapter 구현 등과 같이 다른 선택적 부분을 추가합니다.

데이터 저장소 설계

콘텐츠 제공자는 구조화된 형식으로 저장된 데이터로 연결되는 인터페이스입니다. 인터페이스를 생성하기 전에 우선 데이터 저장 방식부터 결정해야 합니다. 데이터는 원하는 형식 아무 것으로나 저장할 수 있으며 그런 다음에 필요에 따라 해당 데이터를 읽고 쓸 인터페이스를 설계합니다.

다음은 Android에서 사용할 수 있는 몇 가지 데이터 저장소 기술입니다.

구조화된 데이터로 작업하고 있다면 SQLite와 같은 관계형 데이터베이스 또는 LevelDB와 같은 비관계형 키-값 데이터 저장소를 사용하는 방법을 고려해보세요. 오디오, 이미지 또는 동영상 미디어와 같은 비구조화된 데이터로 작업하고 있다면 데이터를 파일로 저장하는 방법을 고려해보세요. 여러 가지 유형의 저장소를 혼합하여 사용하고, 필요한 경우 단일 콘텐츠 제공자를 사용해 노출할 수 있습니다.
Android 시스템은 Room 영구 라이브러리와 상호작용할 수 있습니다. Room 영구 라이브러리는 Android의 자체 제공자가 테이블 지향적 데이터를 저장하는 데 사용하는 SQLite 데이터베이스 API에 대한 액세스 권한을 제공합니다. 라이브러리를 사용하여 데이터베이스를 생성하려면 Room 영구 라이브러리 가이드에서 설명한 대로 RoomDatabase의 하위 클래스를 인스턴스화합니다.
리포지토리를 구현하는 데 데이터베이스를 사용하지 않아도 된다는 점을 기억하세요. 제공자는 외부에 테이블 집합으로 나타나서 관계적 데이터베이스와 비슷해 보이지만, 이것은 제공자의 내부 구현에 필요한 요구사항은 아닙니다.
파일 데이터 저장의 경우, Android에는 다양한 파일 지향적 API가 있습니다. 파일 저장소에 대한 자세한 내용은 데이터 저장소 주제를 참조하세요. 음악이나 동영상 등 미디어 관련 데이터를 제공하는 제공자를 설계하는 경우, 제공자가 테이블 데이터와 파일을 조합할 수 있습니다.
가끔 단일 애플리케이션에서 두 개 이상의 콘텐츠 제공자를 구현하는 방법이 유용할 경우도 있습니다. 예를 들어 하나의 콘텐츠 제공자를 사용하여 위젯으로 일부 데이터를 공유하고, 다른 애플리케이션과 공유할 때는 다른 데이터 세트를 노출하고 싶을 수 있습니다.
네트워크 기반 데이터를 다루는 경우, java.net 및 android.net 내의 클래스를 사용하세요. 네트워크 기반 데이터를 데이터베이스와 같은 로컬 데이터 저장소와 동기화한 다음, 해당 데이터를 테이블이나 파일로 제공할 수도 있습니다. 기본 동기화 어댑터 샘플 애플리케이션에서 이런 유형의 동기화를 볼 수 있습니다.

참고: 이전 버전과 호환되지 않는 리포지토리로 변경할 경우 새로운 버전 번호로 리포지토리를 표시해야 합니다. 새로운 콘텐츠 제공자를 구현하는 앱의 버전 번호도 높여야 합니다. 이렇게 변경하면 호환되지 않는 콘텐츠 제공자가 있는 앱을 다시 설치하려고 시도할 때 시스템 다운그레이드로 인해 시스템이 비정상적으로 종료되지 않습니다.

데이터 설계 시 고려할 사항

다음은 제공자의 데이터 구조를 설계할 때 유용한 몇 가지 팁입니다.

테이블 데이터는 언제나 제공자가 유지관리하는 "기본 키" 열을 각 행의 고유한 숫자 값으로 보유하고 있어야 합니다. 이 값을 사용하여 해당 행을 다른 테이블의 관련 행에 연결시킬 수 있습니다(이를 "외래 키"로 사용). 이 열에는 어느 이름이든 사용할 수 있지만 BaseColumns._ID를 사용하는 것이 가장 좋습니다. 제공자 쿼리 결과를 ListView에 연결하려면 검색된 열 중 하나가 _ID라는 이름을 사용해야 하기 때문입니다.
비트맵 이미지나 파일 지향적 데이터의 매우 큰 조각을 제공하고 싶다면 테이블 안에 직접 저장하기보다는 파일에 데이터를 저장한 뒤 간접적으로 제공합니다. 이렇게 하는 경우, 데이터에 액세스하려면 ContentResolver 파일 메서드를 사용해야 한다고 제공자의 사용자들에게 알려야 합니다.
BLOB(Binary Large OBject) 데이터 유형을 사용하여 크기가 다르거나 구조가 다양한 데이터를 저장합니다. 예를 들어 BLOB 열을 사용하여 프로토콜 버퍼 또는 JSON 구조를 저장할 수 있습니다.
BLOB를 사용하여 스키마에 종속되지 않은 테이블을 구현할 수도 있습니다. 이 유형의 테이블에서는 기본 키 열, MIME 유형 열 및 하나 이상의 일반적인 열을 BLOB로 정의합니다. BLOB 열에 있는 데이터의 의미는 MIME 유형 열에 있는 값으로 나타냅니다. 이렇게 하면 같은 테이블에 여러 가지 행 유형을 저장할 수 있습니다. 연락처 제공자의 "데이터" 테이블 ContactsContract.Data가 스키마에 종속되지 않은 테이블의 예시입니다.

콘텐츠 URI 설계

콘텐츠 URI는 제공자에서 데이터를 식별하는 URI입니다. 콘텐츠 URI에는 제공자 전체의 상징적인 이름(제공자의 권한)과 테이블 또는 파일을 가리키는 이름(경로)이 포함됩니다. 선택적 ID 부분은 테이블 내의 개별적인 행을 가리킵니다. ContentProvider의 모든 데이터 액세스 메서드는 콘텐츠 URI를 인수로 가집니다. 이를 통해 액세스할 테이블, 행 또는 파일을 결정할 수 있습니다.

콘텐츠 URI의 기본 사항은 콘텐츠 제공자 기본 사항에 설명되어 있습니다.

권한 설계

제공자에는 보통 하나의 권한이 있으며, 이것이 Android 내부 이름 역할을 합니다. 다른 제공자와의 충돌을 피하려면 인터넷 도메인 소유권(역방향)을 제공자 권한의 기반으로 사용해야 합니다. 이 권장 사항은 Android 패키지 이름에도 적용되므로, 제공자 권한을 제공자가 들어 있는 패키지의 이름 확장자로 정의해도 됩니다. 예를 들어 Android 패키지 이름이 com.example.<appname>이라면 제공자에게 com.example.<appname>.provider 권한을 부여해야 합니다.

경로 구조 설계

개발자는 일반적으로 권한으로부터 콘텐츠 URI를 생성할 때 개별적인 테이블을 가리키는 경로를 추가하는 방식을 사용합니다. 예를 들어 table1과 table2라는 테이블이 있다면, 이전 예시의 권한을 조합하여 콘텐츠 URI com.example.<appname>.provider/table1과 com.example.<appname>.provider/table2를 도출합니다. 경로는 하나의 세그먼트에 국한되지 않으며 경로의 각 수준에 대한 테이블이 아니어도 됩니다.

콘텐츠 URI ID 처리

제공자는 규칙에 따라 URI 맨 끝에 행에 대한 ID 값이 포함된 콘텐츠 URI를 허용하여 테이블의 단일 행에 대한 액세스를 제공합니다. 또한, 제공자는 규칙에 따라 이 ID 값을 테이블의 _ID 열에 일치시켜야 하며 일치한 행에 대해 요청된 액세스를 수행해야 합니다.

이 규칙은 제공자에 액세스하는 앱을 위한 공통 설계 패턴을 세우는 데 유용합니다. 앱이 제공자에 대한 쿼리를 수행하고, CursorAdapter를 사용하여 그 결과로 나온 Cursor를 ListView에 표시합니다. CursorAdapter의 정의에 따르면, Cursor 안의 열 중 하나는 _ID여야 합니다.

그러면 사용자가 데이터를 살펴보거나 수정하기 위하여 UI에서 표시된 여러 행 중 하나를 선택합니다. 앱은 ListView를 지원하는 Cursor에서 해당하는 열을 가져오고, 해당 열에 대한 _ID 값을 가져와서 콘텐츠 URI에 추가하고, 제공자에 액세스 요청을 전송합니다. 그런 다음 제공자는 사용자가 선택한 바로 그 행에 대해 쿼리 또는 수정 작업을 수행할 수 있습니다.

콘텐츠 URI 패턴

수신되는 콘텐츠 URI에 취할 조치를 선택하는 데 도움이 되도록 제공자 API에 편의 클래스 UriMatcher가 포함되어 있습니다. 이는 콘텐츠 URI "패턴"을 정수값으로 매핑합니다. 이 정수값은 특정 패턴에 일치하는 콘텐츠 URI 또는 여러 URI에 대해 원하는 작업을 선택하는 switch 문에서 사용할 수 있습니다.

콘텐츠 URI 패턴은 와일드카드 문자를 사용하는 콘텐츠 URI와 일치합니다.

*: 모든 길이의 모든 유효한 문자로 구성된 문자열과 일치합니다.
#: 모든 길이의 숫자 문자로 구성된 문자열과 일치합니다.

콘텐츠 URI 처리의 설계와 코딩에 대한 예시로 임의의 제공자가 있다고 생각해 보겠습니다. 이 제공자에는 권한 com.example.app.provider가 있는데, 이 권한은 테이블을 가리키는 다음의 콘텐츠 URI를 인식합니다.

content://com.example.app.provider/table1: table1이라는 테이블입니다.
content://com.example.app.provider/table2/dataset1: dataset1이라는 테이블입니다.
content://com.example.app.provider/table2/dataset2: dataset2라는 테이블입니다.
content://com.example.app.provider/table3: table3이라는 테이블입니다.

제공자는 추가된 행 ID가 있으면 이런 콘텐츠 URI도 인식합니다. 예를 들어 table3에서 1이 식별한 행에 대한 content://com.example.app.provider/table3/1이 이에 해당합니다.

가능한 콘텐츠 URI 패턴은 다음과 같습니다.

content://com.example.app.provider/*: 제공자에 있는 모든 콘텐츠 URI와 일치합니다.
content://com.example.app.provider/table2/*:: 테이블 dataset1과 dataset2의 콘텐츠 URI와 일치하지만 table1이나 table3에 대한 콘텐츠 URI와 일치하지 않습니다.
content://com.example.app.provider/table3/#: table3의 단일 행에 대한 콘텐츠 URI와 일치합니다. 예를 들어 6이 식별한 행에 대한 content://com.example.app.provider/table3/6이 이에 해당합니다.

다음 스니펫은 UriMatcher 작업에서 메서드가 작동하는 방식을 보여줍니다. 이 코드는 테이블에 대한 콘텐츠 URI 패턴 content://<authority>/<path>와 단일 행에 대한 콘텐츠 URI 패턴 content://<authority>/<path>/<id>를 사용하여 단일 행에 대한 URI와 전체 테이블에 대한 URI를 서로 다르게 처리합니다.

addURI() 메서드는 권한과 경로를 정수값으로 매핑합니다. 메서드 match()는 URI에 대한 정수값을 반환합니다. switch 문은 전체 테이블을 쿼리할 것인지, 하나의 레코드를 쿼리할 것인지 선택합니다.

Kotlin

private val sUriMatcher = UriMatcher(UriMatcher.NO_MATCH).apply {
    /*
     * The calls to addURI() go here, for all of the content URI patterns that the provider
     * should recognize. For this snippet, only the calls for table 3 are shown.
     */

    /*
     * Sets the integer value for multiple rows in table 3 to 1. Notice that no wildcard is used
     * in the path
     */
    addURI("com.example.app.provider", "table3", 1)

    /*
     * Sets the code for a single row to 2. In this case, the "#" wildcard is
     * used. "content://com.example.app.provider/table3/3" matches, but
     * "content://com.example.app.provider/table3 doesn't.
     */
    addURI("com.example.app.provider", "table3/#", 2)
}
...
class ExampleProvider : ContentProvider() {
    ...
    // Implements ContentProvider.query()
    override fun query(
            uri: Uri?,
            projection: Array<out String>?,
            selection: String?,
            selectionArgs: Array<out String>?,
            sortOrder: String?
    ): Cursor? {
        var localSortOrder: String = sortOrder ?: ""
        var localSelection: String = selection ?: ""
        when (sUriMatcher.match(uri)) {
            1 -> { // If the incoming URI was for all of table3
                if (localSortOrder.isEmpty()) {
                    localSortOrder = "_ID ASC"
                }
            }
            2 -> {  // If the incoming URI was for a single row
                /*
                 * Because this URI was for a single row, the _ID value part is
                 * present. Get the last path segment from the URI; this is the _ID value.
                 * Then, append the value to the WHERE clause for the query
                 */
                localSelection += "_ID ${uri?.lastPathSegment}"
            }
            else -> { // If the URI is not recognized
                // You should do some error handling here.
            }
        }

        // call the code to actually do the query
    }
}

Java

public class ExampleProvider extends ContentProvider {
...
    // Creates a UriMatcher object.
    private static final UriMatcher uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);

    static {
        /*
         * The calls to addURI() go here, for all of the content URI patterns that the provider
         * should recognize. For this snippet, only the calls for table 3 are shown.
         */

        /*
         * Sets the integer value for multiple rows in table 3 to 1. Notice that no wildcard is used
         * in the path
         */
        uriMatcher.addURI("com.example.app.provider", "table3", 1);

        /*
         * Sets the code for a single row to 2. In this case, the "#" wildcard is
         * used. "content://com.example.app.provider/table3/3" matches, but
         * "content://com.example.app.provider/table3 doesn't.
         */
        uriMatcher.addURI("com.example.app.provider", "table3/#", 2);
    }
...
    // Implements ContentProvider.query()
    public Cursor query(
        Uri uri,
        String[] projection,
        String selection,
        String[] selectionArgs,
        String sortOrder) {
...
        /*
         * Choose the table to query and a sort order based on the code returned for the incoming
         * URI. Here, too, only the statements for table 3 are shown.
         */
        switch (uriMatcher.match(uri)) {


            // If the incoming URI was for all of table3
            case 1:

                if (TextUtils.isEmpty(sortOrder)) sortOrder = "_ID ASC";
                break;

            // If the incoming URI was for a single row
            case 2:

                /*
                 * Because this URI was for a single row, the _ID value part is
                 * present. Get the last path segment from the URI; this is the _ID value.
                 * Then, append the value to the WHERE clause for the query
                 */
                selection = selection + "_ID = " + uri.getLastPathSegment();
                break;

            default:
            ...
                // If the URI is not recognized, you should do some error handling here.
        }
        // call the code to actually do the query
    }

또 다른 클래스, ContentUris가 콘텐츠 URI의 id 부분을 처리하기 위한 편의 메서드를 제공합니다. 클래스 Uri와 Uri.Builder에는 기존 Uri 객체를 파싱하고 새로운 객체를 빌드하기 위한 편의 메서드가 포함되어 있습니다.

ContentProvider 클래스 구현

ContentProvider 인스턴스는 다른 애플리케이션에서 수신한 요청을 처리하여 구조화된 데이터 세트에 대한 액세스를 관리합니다. 최종적으로 모든 형태의 액세스가 ContentResolver를 호출합니다. 그러면 이것이 액세스 권한을 얻기 위해 구체적인 ContentProvider 메서드를 호출합니다.

필수 메서드

추상 클래스 ContentProvider는 개발자가 나름의 구체적인 하위 클래스의 일부로 구현해야 하는 여섯 가지 추상 메서드를 정의합니다. onCreate()를 제외한 이와 같은 메서드는 모두 콘텐츠 제공자에 액세스하려 시도하는 클라이언트 애플리케이션에서 호출됩니다.

query(): 제공자에서 데이터를 검색합니다. 인수를 사용하여 쿼리할 테이블과 반환할 열/행, 결과의 정렬 순서를 선택합니다. 데이터를 Cursor 객체로 반환합니다.
insert(): 제공자에 새로운 행을 삽입합니다. 인수를 사용하여 대상 테이블을 선택하고 사용할 열 값을 가져옵니다. 새로 삽입된 행에 대한 콘텐츠 URI를 반환합니다.
update(): 제공자 내의 기존 행을 업데이트합니다. 인수를 사용하여 업데이트할 테이블과 행을 선택하고 업데이트한 열 값을 가져옵니다. 업데이트한 행 개수를 반환합니다.
delete(): 제공자에서 행을 삭제합니다. 인수를 사용하여 삭제할 테이블과 행을 선택합니다. 삭제한 행 개수를 반환합니다.
getType(): 콘텐츠 URI에 해당하는 MIME 유형을 반환합니다. 이 메서드는 콘텐츠 제공자 MIME 유형 섹션에 더 자세하게 설명되어 있습니다.
onCreate(): 제공자를 초기화합니다. Android 시스템은 제공자를 생성한 직후 이 메서드를 호출합니다. ContentResolver 객체가 제공자에 액세스하려고 시도하기 전까지는 제공자가 생성된 것이 아니라는 점을 유의하세요.

이와 같은 메서드에는 동일하게 이름 붙여진 ContentResolver 메서드와 같은 서명이 있다는 것을 참고하세요.

이러한 메서드를 구현할 때는 다음과 같은 내용을 감안해야 합니다.

이런 메서드는 모두(onCreate()는 예외) 한꺼번에 여러 스레드가 호출할 수 있으므로 스레드로부터 안전해야 합니다. 다중 스레드에 대한 자세한 내용은 프로세스 및 스레드를 참조하세요.
onCreate()에서는 긴 작업을 수행하지 않는 것이 좋습니다. 실제로 필요할 때까지 초기화 작업을 미뤄두세요. 이 내용은 onCreate() 메서드 구현 섹션에서 더욱 자세히 설명합니다.
이와 같은 메서드는 반드시 구현해야 하지만, 코드는 예상되는 데이터 유형을 반환하는 작업만 처리하면 됩니다. 예를 들어 다른 애플리케이션이 데이터를 일부 테이블에 삽입하지 못하게 하려는 경우가 있습니다. 이렇게 하려면 insert()에 대한 호출을 무시하고 0을 반환하면 됩니다.

query() 메서드 구현

ContentProvider.query() 메서드는 Cursor 객체를 반환해야 합니다. 반환에 실패하면 Exception가 발생합니다. SQLite 데이터베이스를 데이터 저장소로 사용하는 경우, SQLiteDatabase 클래스의 query() 메서드 중 하나에서 반환되는 Cursor를 반환하기만 하면 됩니다. 쿼리가 어느 행에도 일치하지 않으면 getCount() 메서드가 0을 반환하는 Cursor 인스턴스를 반환해야 합니다. 쿼리 과정에서 내부 오류가 발생했을 때에만 null을 반환해야 합니다.

SQLite 데이터베이스를 데이터 저장소로 사용하지 않는 경우, Cursor의 구체적인 하위 클래스 중 하나를 사용하세요. 예를 들어 MatrixCursor 클래스는 각 행이 Object의 배열인 커서를 구현합니다. 이 클래스에서 addRow()를 사용하여 새 행을 추가합니다.

Android 시스템이 프로세스 경계를 넘어 Exception을 전달할 수 있어야 한다는 점에 유의하세요. Android는 쿼리 오류 처리에 유용할 만한 다음과 같은 예외에 해당될 경우에 이 작업을 수행할 수 있습니다.

IllegalArgumentException(제공자가 유효하지 않은 콘텐츠 URI를 수신할 경우 이 예외를 발생시킬 수 있습니다)
NullPointerException

insert() 메서드 구현

insert() 메서드는 ContentValues 인수의 값을 이용하여 적절한 테이블에 새 행을 추가합니다. 열 이름이 ContentValues 인수에 없는 경우, 제공자 코드 또는 데이터베이스 스키마 내에 그에 대한 기본값을 제공하는 것이 좋을 수도 있습니다.

이 메서드는 새 행에 대한 콘텐츠 URI를 반환해야 합니다. 이를 구성하기 위해 새 행의 _ID(또는 다른 기본 키) 값을 테이블의 콘텐츠 URI에 추가하는데, 이때 withAppendedId()를 사용합니다.

delete() 메서드 구현

delete() 메서드의 경우 데이터 저장소에서 물리적으로 행을 삭제하지 않아도 됩니다. 제공자와 동기화 어댑터를 함께 사용하고 있는 경우, 삭제된 행을 완전히 제거하기보다는 "삭제" 플래그로 표시하는 방법을 고려해볼 만합니다. 동기화 어댑터가 삭제된 행을 확인한 다음, 이를 제공자에서 삭제하기 전에 우선 서버에서 제거합니다.

update() 메서드 구현

update() 메서드는 insert()에서 사용한 것과 동일한 ContentValues 인수, 그리고 delete() 및 ContentProvider.query()에서 사용한 것과 동일한 selection과 selectionArgs 인수를 사용합니다. 그래서 이런 메서드에서 코드를 다시 사용할 수도 있습니다.

onCreate() 메서드 구현

Android 시스템은 제공자를 시작할 때 onCreate()를 호출합니다. 이 메서드에서는 빠르게 실행되는 초기화만 수행해야 하며, 데이터베이스 생성과 데이터 로딩은 제공자가 실제로 데이터에 대한 요청을 받을 때까지 미뤄두어야 합니다. onCreate()에서 오래 걸리는 작업을 수행하면 제공자의 시작 속도가 느려집니다. 이 때문에 제공자에서 다른 애플리케이션으로 전달되는 응답도 따라서 느려집니다.

다음 두 개의 스니펫은 ContentProvider.onCreate()와 Room.databaseBuilder() 사이의 상호작용을 나타냅니다. 이 스니펫은 ContentProvider.onCreate()를 어떻게 구현하는지 보여주는데, 여기서 데이터베이스 객체가 빌드되고 데이터 액세스 객체에 대한 핸들이 생성됩니다.

Kotlin

// Defines the database name
private const val DBNAME = "mydb"
...
class ExampleProvider : ContentProvider() {

    // Defines a handle to the Room database
    private lateinit var appDatabase: AppDatabase

    // Defines a Data Access Object to perform the database operations
    private var userDao: UserDao? = null

    override fun onCreate(): Boolean {

        // Creates a new database object.
        appDatabase = Room.databaseBuilder(context, AppDatabase::class.java, DBNAME).build()

        // Gets a Data Access Object to perform the database operations
        userDao = appDatabase.userDao

        return true
    }

    ...

    // Implements the provider's insert method
    override fun insert(uri: Uri, values: ContentValues?): Uri? {
        // Insert code here to determine which DAO to use when inserting data, handle error conditions, etc.
    }
}

Java

public class ExampleProvider extends ContentProvider

    // Defines a handle to the Room database
    private AppDatabase appDatabase;

    // Defines a Data Access Object to perform the database operations
    private UserDao userDao;

    // Defines the database name
    private static final String DBNAME = "mydb";

    public boolean onCreate() {

        // Creates a new database object.
        appDatabase = Room.databaseBuilder(getContext(), AppDatabase.class, DBNAME).build();

        // Gets a Data Access Object to perform the database operations
        userDao = appDatabase.getUserDao();

        return true;
    }

    ...

    // Implements the provider's insert method
    public Cursor insert(Uri uri, ContentValues values) {
        // Insert code here to determine which DAO to use when inserting data, handle error conditions, etc.
    }
}

ContentProvider MIME 유형 구현

ContentProvider 클래스에는 MIME 유형을 반환하는 두 가지 메서드가 있습니다.

getType(): 모든 제공자에 대해 구현해야 하는 필수 메서드 중 하나입니다.
getStreamTypes(): 제공자가 파일을 제공하는 경우 구현해야 하는 메서드입니다.

테이블의 MIME 유형

getType() 메서드는 콘텐츠 URI 인수가 반환하는 데이터 유형을 설명하는 String(MIME 형식)을 반환합니다. Uri 인수는 특정 URI가 아니라 어떤 패턴일 수 있습니다. 이 경우, 이 패턴과 일치하는 콘텐츠 URI와 연관된 유형의 데이터를 반환해야 합니다.

텍스트, HTML 또는 JPEG와 같은 보편적인 유형의 데이터라면 getType()이 해당 데이터에 대한 표준 MIME 유형을 반환해야 합니다. 이러한 표준 유형의 전체 목록은 IANA MIME 미디어 유형 웹사이트에서 확인할 수 있습니다.

테이블 데이터의 하나 또는 여러 행을 가리키는 콘텐츠 URI의 경우, getType()이 Android의 공급업체별 MIME 형식으로 MIME 유형을 반환해야 합니다.

유형 부분: vnd
하위 유형 부분:
- URI 패턴이 하나의 행에 대한 것일 경우: android.cursor.item/
- URI 패턴이 하나 이상의 행에 대한 것일 경우: android.cursor.dir/
제공자별 부분: vnd.<name>.<type>
개발자가 <name>과 <type>을 제공합니다. <name> 값은 전체적으로 고유해야 하고, <type> 값은 상응하는 URI 패턴에 고유해야 합니다. <name>으로 회사 이름이나 애플리케이션의 Android 패키지 이름을 사용하는 것이 좋습니다. <type>으로는 URI와 연관된 테이블을 식별하는 문자열을 사용하는 것이 좋습니다.

예를 들어 어떤 제공자의 권한이 com.example.app.provider이고 table1이라는 테이블을 노출하는 경우, table1의 여러 행에 대한 MIME 유형은 다음과 같습니다.

vnd.android.cursor.dir/vnd.com.example.provider.table1

table1의 행 하나에 대한 MIME 유형은 다음과 같습니다.

vnd.android.cursor.item/vnd.com.example.provider.table1

파일의 MIME 유형

제공자가 파일을 제공하는 경우, getStreamTypes()를 구현합니다. 이 메서드는 제공자가 주어진 콘텐츠 URI에 대해 반환할 수 있는 파일의 MIME 유형을 나타낸 String 배열을 반환합니다. 제공하는 MIME 유형을 MIME 유형 필터 인수 기준으로 필터링해야 클라이언트가 처리하고자 하는 MIME 유형만 반환할 수 있습니다.

예를 들어 사진 이미지를 .jpg, .png 및 .gif 형식의 파일로 제공하는 제공자가 있습니다. 애플리케이션이 필터 문자열 image/*("이미지"인 무언가)로 ContentResolver.getStreamTypes()를 호출하면, ContentProvider.getStreamTypes() 메서드가 다음과 같은 배열을 반환해야 합니다.

{ "image/jpeg", "image/png", "image/gif"}

앱에서 .jpg 파일만 원할 경우에는 필터 문자열 *\/jpeg로 ContentResolver.getStreamTypes()를 호출할 수 있습니다. 그러면 ContentProvider.getStreamTypes()가 다음을 반환해야 합니다.

{"image/jpeg"}

제공자가 필터 문자열에서 요청한 MIME 유형 중에서 아무것도 제공하지 않을 경우, getStreamTypes()가 null을 반환해야 합니다.

계약 클래스 구현

계약 클래스는 public final 클래스로, 이 안에 URI, 열 이름, MIME 유형의 상수 정의 및 제공자에 관련된 다른 메타 데이터가 들어 있습니다. 이 클래스는 URI, 열 이름 등의 실제 값에 변경된 내용이 있더라도 제공자에 올바르게 액세스할 수 있도록 보장하여 제공자와 다른 애플리케이션 사이에 계약을 설정합니다.

계약 클래스가 개발자에게 유용한 이유는 또 있습니다. 일반적으로 이 클래스는 상수 이름으로 니모닉 이름을 가지기 때문에 개발자가 열 이름 또는 URI에 잘못된 값을 사용할 가능성이 적습니다. 이것도 일종의 클래스이므로 Javadoc 문서를 포함할 수 있습니다. Android Studio와 같은 통합 개발 환경은 계약 클래스의 상수 이름을 자동 완성하고 해당 상수에 대한 Javadoc을 표시할 수 있습니다.

개발자가 애플리케이션에서 계약 클래스의 클래스 파일에 액세스할 수는 없지만 개발자가 제공하는 .jar 파일에서 해당 클래스 파일을 애플리케이션에 정적으로 컴파일할 수 있습니다.

계약 클래스의 예시로는 ContactsContract 클래스와 이에 중첩된 클래스가 있습니다.

콘텐츠 제공자 권한 구현

Android 시스템의 모든 측면에 대한 권한과 액세스는 보안 및 권한 주제에 설명되어 있습니다. 데이터 저장소 주제에서도 다양한 유형의 저장소에 적용되는 보안 및 권한을 설명합니다. 간략히 말해 요점은 다음과 같습니다.

기본적으로 기기의 내부 저장소에 저장된 데이터 파일은 본인의 애플리케이션과 제공자 전용입니다.
본인이 생성한 SQLiteDatabase 데이터베이스는 본인의 애플리케이션과 제공자만의 비공개 데이터입니다.
기본적으로 외부 저장소에 저장하는 데이터 파일은 공개되고 누구나 읽을 수 있습니다. 외부 저장소에 있는 파일에 대한 액세스를 제한하는 데 콘텐츠 제공자를 사용할 수는 없습니다. 다른 애플리케이션이 다른 API 호출을 사용하여 해당 파일을 읽고 쓸 수 있기 때문입니다.
기기의 내부 저장소에 있는 파일 또는 SQLite 데이터베이스를 열거나 생성하기 위한 메서드 호출은 다른 모든 애플리케이션에 읽기 및 쓰기 액세스 권한을 허가할 가능성이 있습니다. 내부 파일이나 데이터베이스를 제공자의 리포지토리로 사용하고 "누구나 읽을 수 있는" 또는 "누구나 쓸 수 있는" 권한을 부여하면 매니페스트에서 제공자에 대해 설정한 권한은 데이터를 보호하지 않습니다. 내부 저장소 안의 파일과 데이터베이스에 대한 기본 액세스는 "전용"이며, 제공자의 리포지토리가 이를 변경할 수 없습니다.

데이터에 대한 액세스를 제어하기 위해 콘텐츠 제공자 권한을 쓰고자 하는 경우, 데이터를 내부 파일, SQLite 데이터베이스 또는 "클라우드"(예: 원격 서버) 안의 내부 파일로 저장하고 파일과 데이터베이스를 본인의 애플리케이션 전용으로 유지해야 합니다.

권한 구현

기본 데이터가 전용이더라도 모든 애플리케이션은 제공자에서 읽고 제공자에 쓸 수 있습니다. 기본적으로 제공자에는 권한이 설정되어 있지 않기 때문입니다. 이를 변경하려면, <provider> 요소의 특성이나 하위 요소를 사용하여 매니페스트 파일에 있는 제공자의 권한을 설정합니다. 권한은 제공자 전체에 적용되도록 설정할 수도 있고, 특정 테이블에, 또는 심지어 특정 레코드에 적용되게 할 수도 있고 세 가지 모두를 택할 수도 있습니다.

제공자에 대한 권한은 매니페스트 파일에 있는 하나 이상의 <permission> 요소로 정의합니다. 제공자에 고유한 권한을 설정하려면 android:name 특성에 대한 Java 스타일 범위를 사용합니다. 예를 들어 읽기 권한의 이름을 com.example.app.provider.permission.READ_PROVIDER로 지정합니다.

다음 목록은 제공자 권한의 범위를 설명합니다. 제공자 전체에 적용되는 권한부터 시작하여 점차 권한이 세분화됩니다. 보다 세부화된 권한이 범위가 큰 권한보다 우선합니다.

단일 읽기-쓰기 제공자 수준 권한

제공자 전체에 대한 읽기와 쓰기 액세스 모두를 제어하는 하나의 권한으로,


        <provider>

요소의


        android:permission

특성으로 지정됩니다.

별도의 읽기 및 쓰기 제공자 수준 권한

제공자 전체에 대한 읽기 권한과 쓰기 권한입니다. 이들 권한은


        <provider>

요소의


        android:readPermission

과


        android:writePermission

특성으로 지정합니다. 이들이


        android:permission

에서 요구하는 권한보다 우선됩니다.

경로 수준 권한

제공자의 콘텐츠 URI에 대한 읽기, 쓰기 또는 읽기/쓰기 권한입니다. 제어하고자 하는 각 URI를 직접 지정하되, 이때


        <provider>

요소의


        <path-permission>

하위 요소를 사용합니다. 지정하는 콘텐츠 URI마다 읽기/쓰기 권한, 읽기 권한 또는 쓰기 권한을 하나씩 지정하거나 세 가지 모두 지정할 수 있습니다. 읽기 및 쓰기 권한이 읽기/쓰기 권한보다 우선합니다. 또한, 경로 수준 권한이 제공자 수준 권한보다 우선합니다.

임시 권한

애플리케이션에 임시 액세스를 허용하는 권한 수준입니다. 해당 애플리케이션에 일반적으로 요구되는 권한이 없더라도 무관합니다. 임시 액세스 기능은 매니페스트에서 요청해야 하는 권한과 애플리케이션 개수를 줄여줍니다. 임시 권한을 사용하는 경우, 제공자에 대하여 "영구" 권한이 필요한 애플리케이션은 모든 데이터에 지속적으로 액세스하는 것들뿐입니다.

이메일 제공자와 앱을 구현할 때 필요한 권한을 예로 들어 보겠습니다. 외부 이미지 뷰어 애플리케이션이 제공자에서 보낸 사진 첨부 파일을 표시하도록 허용하고자 한다고 가정합니다. 권한을 요구하지 않고 이미지 뷰어에 필수 액세스를 부여하려면, 사진에 대한 콘텐츠 URI에 해당되는 임시 권한을 설정하세요. 사용자가 사진을 표시하기를 원할 때 앱이 사진의 콘텐츠 URI와 권한 플래그를 포함하는 인텐트를 이미지 뷰어에 보내도록 이메일 앱을 설계합니다. 그러면 해당 이미지 뷰어가 이메일 제공자에 사진 검색을 쿼리할 수 있고, 이 뷰어에 제공자에 대한 정상적인 읽기 권한이 없더라도 무방합니다.

임시 권한을 사용하려면, <provider> 요소의 android:grantUriPermissions 특성을 설정하거나 하나 이상의 <grant-uri-permission> 하위 요소를 <provider> 요소에 추가하면 됩니다. 임시 권한을 사용하는 경우, 제공자에서 콘텐츠 URI에 대한 지원을 제거할 때마다 Context.revokeUriPermission()을 호출해야 합니다. 그러면 콘텐츠 URI가 임시 권한과 연결됩니다.

특성의 값에 따라 제공자에 액세스 가능한 정도가 결정됩니다. 특성이 true로 설정되어 있는 경우라면 시스템이 제공자 전체에 임시 권한을 허용하며, 제공자 수준 또는 경로 수준 권한에서 요구하는 다른 모든 권한을 재정의합니다.

이 플래그가 false로 설정되면, 반드시 <grant-uri-permission> 하위 요소를<provider> 요소에 추가해야 합니다. 각 하위 요소는 임시 권한을 허용한 콘텐츠 URI(하나 또는 여러 개)를 나타냅니다.

애플리케이션에 임시 액세스를 위임하려면 인텐트에 FLAG_GRANT_READ_URI_PERMISSION 또는 FLAG_GRANT_WRITE_URI_PERMISSION 플래그, 또는 둘 모두가 들어 있어야 합니다. 이들은 setFlags() 메서드로 설정됩니다.

android:grantUriPermissions 특성이 존재하지 않으면 false인 것으로 가정합니다.

<provider> 요소

Activity 및 Service 구성 요소와 마찬가지로, ContentProvider의 하위 클래스는 <provider> 요소를 사용하여 매니페스트 파일에서 애플리케이션에 대해 정의되어야 합니다. Android 시스템이 해당 요소에서 다음과 같은 정보를 가져옵니다.

권한(android:authorities)

시스템 내에서 제공자 전체를 식별하는 상징적 이름입니다. 이 특성은 콘텐츠 URI 설계 섹션에 자세히 설명합니다.

제공자 클래스 이름(android:name)

ContentProvider를 구현하는 클래스입니다. 이 클래스는 ContentProvider 클래스 구현 섹션에서 자세히 설명합니다.

권한

제공자의 데이터에 액세스하기 위해 다른 애플리케이션이 반드시 가지고 있어야 하는 권한을 나타내는 특성입니다.

android:grantUriPermssions: 임시 권한 플래그입니다.
android:permission: 단일 제공자 전범위 읽기/쓰기 권한입니다.
android:readPermission: 제공자 전범위 읽기 권한입니다.
android:writePermission: 제공자 전범위 쓰기 권한입니다.

각종 권한과 그에 상응하는 특성은 콘텐츠 제공자 권한 구현 섹션에서 자세히 설명합니다.

시작 및 제어 특성

이 특성들은 Android 시스템이 제공자를 시작하는 방법과 그 시점, 제공자의 프로세스 특징과 기타 런타임 설정 등을 결정합니다.

android:enabled: 시스템이 제공자를 시작할 수 있게 해주는 플래그입니다.
android:exported: 다른 애플리케이션이 이 제공자를 사용할 수 있게 해주는 플래그입니다.
android:initOrder: 같은 프로세스 내의 다른 제공자와 비교하여 이 제공자가 시작되어야 하는 순서입니다.
android:multiProcess: 시스템이 클라이언트를 호출하는 것과 동일한 프로세스에서 제공자를 시작할 수 있게 하는 플래그입니다.
android:process: 제공자가 실행해야 하는 프로세스의 이름입니다.
android:syncable: 제공자의 데이터가 서버에 있는 데이터와 동기화될 예정임을 나타내는 플래그입니다.

이 특성은 <provider> 요소에 대한 개발자 가이드 주제에 상세하게 기록되어 있습니다.

정보성 특성

제공자에 대한 선택 항목 아이콘 및 레이블입니다.

android:icon: 제공자의 아이콘이 들어 있는 드로어블 리소스입니다. 이 아이콘은 Settings > Apps > All에 있는 앱 목록에서 제공자의 레이블 옆에 표시됩니다.
android:label: 제공자 또는 그 데이터, 또는 둘 모두를 설명하는 정보 레이블입니다. 이 레이블은 Settings > Apps > All에 있는 앱 목록에 표시됩니다.

이 특성은 <provider> 요소에 대한 개발자 가이드 주제에 상세하게 기록되어 있습니다.

인텐트 및 데이터 액세스

애플리케이션이 콘텐츠 제공자에 간접적으로 액세스하려면 Intent를 사용하면 됩니다. 이 애플리케이션은 ContentResolver 또는 ContentProvider의 메서드 중 어느 하나도 호출하지 않습니다. 그 대신 액티비티를 시작하는 인텐트를 전송합니다. 이 인텐트는 대개 제공자가 소유한 애플리케이션의 일부입니다. 대상 액티비티가 데이터를 자신의 UI에서 검색하고 표시하는 역할을 맡습니다. 인텐트의 동작에 따라 대상 액티비티가 사용자에게 프롬프트를 표시하여 제공자의 데이터를 수정하게 할 수도 있습니다. 인텐트에 대상 액티비티가 UI에 표시하는 "엑스트라" 데이터가 들어 있을 수도 있습니다. 그러면 사용자에게 이 데이터를 변경할 수 있는 옵션이 제공되고, 그런 다음 사용자는 이를 사용하여 제공자 내의 데이터를 수정할 수 있습니다.

데이터 무결성을 보장하는 데 유용한 것을 원하면 인텐트 액세스를 사용하는 것이 좋습니다. 엄격하게 정의된 비즈니스 논리에 따라 데이터가 삽입, 업데이트되고 삭제되는 것이 제공자를 좌우할 수도 있습니다. 이런 경우, 다른 애플리케이션에 데이터를 직접 수정하도록 허용하면 데이터가 잘못되는 결과를 초래할 수 있습니다. 개발자들에게 인텐트 액세스 사용을 허용하려면, 그 내용을 철저히 기록해두어야 합니다. 개발자들에게 자기 애플리케이션의 UI를 사용한 인텐트 액세스가 코드로 데이터를 수정하려 시도하는 것보다 나은 이유를 설명해주세요.

제공자의 데이터를 수정하고자 하는 수신되는 인텐트 처리도 다른 인텐트 처리와 다를 바가 없습니다. 인텐트 사용에 대한 자세한 내용은 인텐트 및 인텐트 필터를 읽으면 확인할 수 있습니다.

이 페이지와 관련된 샘플 코드는 메모장 샘플 애플리케이션을 참조하세요.

자세한 관련 내용은 캘린더 제공자를 참조하세요.

콘텐츠 제공자 기본사항

저장소 액세스 프레임워크를 사용하여 파일 열기