콘텐츠 제공자 기본 사항

콘텐츠 제공자는 중앙 저장소로의 데이터 액세스를 관리합니다. 제공자는 Android 애플리케이션의 일부이며, 대개 데이터 작업을 위한 고유의 UI를 제공합니다. 그러나 콘텐츠 제공자는 주로 다른 애플리케이션에서 사용하도록 설계되며, 이러한 애플리케이션은 제공자 클라이언트 객체를 사용하여 제공자에 액세스합니다. 제공자와 제공자 클라이언트는 함께 데이터에 일관된 표준 인터페이스를 제공하고, 여기에서는 프로세스 간 통신과 보안 데이터 액세스도 처리합니다.

일반적으로 다음과 같은 두 가지 시나리오 중 하나에서 콘텐츠 제공자를 사용하게 됩니다. 다른 애플리케이션에서 기존 콘텐츠 제공자에 액세스하기 위한 코드를 구현하거나, 내 애플리케이션에서 새로운 콘텐츠 제공자를 생성하여 다른 애플리케이션과 데이터를 공유하고자 할 수 있습니다. 이 주제에서는 기존 콘텐츠 제공자를 사용하는 방법과 관련된 기본 사항을 설명합니다. 내 애플리케이션에서 콘텐츠 제공자를 구현하는 방법을 자세히 알아보려면 콘텐츠 제공자 만들기를 참고하세요.

이 주제에서는 다음의 내용을 설명합니다.

• 콘텐츠 제공자의 작동 원리
• 콘텐츠 제공자에서 데이터를 검색할 때 사용하는 API
• 콘텐츠 제공자 내의 데이터를 삽입, 업데이트 및 삭제하는 데 사용하는 API
• 제공자를 다루는 데 도움이 되는 기타 API 기능

개요

콘텐츠 제공자는 외부 애플리케이션에 데이터를 표시하며, 이때 데이터는 관계형 데이터베이스에서 찾을 수 있는 테이블과 유사한 하나 이상의 테이블로 표시됩니다. 행은 제공자가 수집하는 특정 데이터 유형의 인스턴스를 나타내고, 행의 각 열은 인스턴스에 대해 수집된 개별 데이터를 나타냅니다.

콘텐츠 제공자는 다음을 포함하여 그림 1에서와 같이 여러 가지 API 및 구성요소에 관해 애플리케이션의 데이터 저장소 레이어 액세스를 조정합니다.

• 다른 애플리케이션과 내 애플리케이션 데이터에 대한 액세스 공유
• 위젯에 데이터 전송
• SearchRecentSuggestionsProvider를 사용하여 검색 프레임워크를 통해 애플리케이션의 맞춤 추천 검색어 반환
• AbstractThreadedSyncAdapter를 구현하여 서버와 애플리케이션 데이터 동기화
• CursorLoader를 사용하여 UI에서 데이터 로드

그림 1. 콘텐츠 제공자와 기타 구성요소 간의 관계

제공자 액세스

콘텐츠 제공자 내의 데이터에 액세스하고자 하는 경우, 애플리케이션의 Context에 있는 ContentResolver 객체를 사용하여 클라이언트로서 제공자와 통신을 주고받으면 됩니다. ContentResolver 객체가 제공자 객체와 통신하며, 이 객체는 ContentProvider를 구현하는 클래스의 인스턴스입니다. 제공자 객체가 클라이언트로부터 데이터 요청을 받아 요청된 작업을 실행하고 결과를 반환합니다. 이 객체에는 제공자 객체 내의 같은 이름을 가진 메서드를 호출하는 메서드가 있습니다. 이는 ContentProvider의 구체적인 서브클래스 중 하나에 있는 인스턴스입니다. ContentResolver 메서드는 영구 저장소의 기본적인 'CRUD'(생성, 검색, 업데이트 및 삭제) 기능을 제공합니다.

UI에서 ContentProvider에 액세스하기 위한 일반적인 패턴에서는 CursorLoader를 사용하여 백그라운드에서 비동기식 쿼리를 실행합니다. UI의 Activity 또는 Fragment가 쿼리에 대해 CursorLoader를 호출하고 ContentResolver를 사용하여 ContentProvider를 가져옵니다. 이렇게 하면 쿼리를 실행하는 동안 사용자에게 UI를 계속 제공할 수 있습니다. 이 패턴에는 그림 2에서와 같이 기본 저장소 메커니즘과 함께 여러 가지 다른 객체의 상호작용이 포함됩니다.

그림 2. 콘텐츠 제공자, 기타 클래스 및 저장소 간의 상호작용

참고: 제공자에 액세스하려면 일반적으로 애플리케이션이 제공자의 매니페스트 파일에 있는 특정 권한을 요청해야 합니다. 이러한 개발 패턴은 콘텐츠 제공자 권한 섹션에서 더 자세히 설명합니다.

예를 들어 Android 플랫폼에 내장된 여러 제공자 중 사용자 사전은 사용자가 보관하고 싶어 하는 비표준 단어의 철자를 저장합니다. 표 1은 이 제공자의 테이블에서 데이터가 어떤 형태를 띨 수 있는지를 보여줍니다.

표 1: 샘플 사용자 사전 테이블

표 1에서 각 행은 일반 사전에 나오지 않는 단어의 인스턴스를 나타냅니다. 각 열은 해당 단어의 일부 데이터(예: 그 단어가 처음 등장한 언어)를 나타냅니다. 열 헤더는 제공자에 저장된 열 이름입니다. 행의 언어를 참고하려면 그 행의 locale 열을 참고합니다. 이 제공자의 경우 _ID 열은 제공자가 자동으로 유지하는 '기본 키' 열 역할을 합니다.

사용자 사전 제공자로부터 단어와 그에 해당하는 언어 목록을 가져오려면 ContentResolver.query()를 호출합니다. query() 메서드는 사용자 사전 제공자가 정의한 ContentProvider.query() 메서드를 호출합니다. 다음 코드는 ContentResolver.query() 호출을 보여줍니다.

// Queries the user dictionary and returns results
cursor = contentResolver.query(
        UserDictionary.Words.CONTENT_URI,   // The content URI of the words table
        projection,                        // The columns to return for each row
        selectionClause,                   // Selection criteria
        selectionArgs.toTypedArray(),      // Selection criteria
        sortOrder                          // The sort order for the returned rows
)

// Queries the user dictionary and returns results
cursor = getContentResolver().query(
    UserDictionary.Words.CONTENT_URI,   // The content URI of the words table
    projection,                        // The columns to return for each row
    selectionClause,                   // Selection criteria
    selectionArgs,                     // Selection criteria
    sortOrder);                        // The sort order for the returned rows

표 2는 query(Uri,projection,selection,selectionArgs,sortOrder)의 인수가 SQL SELECT 문과 일치하는 방식을 나타낸 것입니다.

표 2: Query()와 SQL 쿼리의 비교

콘텐츠 URI

콘텐츠 URI는 제공자에서 데이터를 식별하는 URI입니다. 콘텐츠 URI에는 전체 제공자의 상징적인 이름(제공자의 권한)과 테이블을 가리키는 이름(경로)이 포함됩니다. 제공자 내의 테이블에 액세스하기 위해 클라이언트 메서드를 호출하는 경우, 테이블의 콘텐츠 URI는 인수 중 하나가 됩니다.

앞의 코드에는 상수 CONTENT_URI에 사용자 사전 '단어' 테이블의 콘텐츠 URI가 포함되어 있습니다. ContentResolver 객체가 이 URI의 권한을 파싱한 다음, 이를 이용해 제공자를 '확인'합니다. 즉 이 권한을 알려진 제공자로 이루어진 시스템 테이블과 비교하는 것입니다. 그러면 ContentResolver가 쿼리 인수를 올바른 제공자에게 발송할 수 있습니다.

ContentProvider는 콘텐츠 URI의 경로 부분을 사용하여 액세스할 테이블을 선택합니다. 일반적으로 제공자에는 제공자가 노출하는 테이블마다 경로가 있습니다.

이전의 코드에서 '단어' 테이블의 전체 URI는 다음과 같습니다.

content://user_dictionary/words

여기에서 user_dictionary 문자열은 제공자의 권한이고 words 문자열은 테이블의 경로입니다. 문자열 content://(구성표)는 항상 표시되며, 이를 콘텐츠 URI로 식별합니다.

대다수의 제공자에서는 URI의 맨 끝에 ID 값을 추가하면 테이블 내 하나의 행에 액세스할 수 있습니다. 예를 들어 사용자 사전에서 _ID가 4인 행을 검색하려면 이 콘텐츠 URI를 사용하면 됩니다.

val singleUri: Uri = ContentUris.withAppendedId(UserDictionary.Words.CONTENT_URI, 4)

Uri singleUri = ContentUris.withAppendedId(UserDictionary.Words.CONTENT_URI,4);

일련의 행을 검색한 다음, 그중 하나를 업데이트하거나 삭제하고자 하는 경우 종종 ID 값을 사용합니다.

참고: Uri 및 Uri.Builder 클래스에는 문자열에서 올바른 형식의 URI 객체를 구성하기 위한 편의 메서드가 포함되어 있습니다. ContentUris 클래스에는 URI에 ID 값을 추가하는 편의 메서드가 포함되어 있습니다. 이전의 스니펫은 withAppendedId()를 사용하여 사용자 사전 콘텐츠 URI에 ID를 추가합니다.

제공자에서 데이터 검색

이 섹션에서는 사용자 사전 제공자를 예시로 사용하여 제공자에서 데이터를 검색하는 방법을 설명합니다.

명확한 이해를 돕기 위해 이 섹션의 코드 스니펫은 'UI 스레드'에서 ContentResolver.query()를 호출합니다. 그러나 실제 코드에서는 별도의 스레드에서 비동기식으로 쿼리를 실행해야 합니다. 이를 위한 한 가지 방식으로 CursorLoader 클래스를 사용하는 방식이 있습니다. 이 내용은 로더 가이드에서 더 자세히 설명합니다. 또한 이 코드는 스니펫일 뿐이며 애플리케이션을 전체적으로 표시한 것이 아닙니다.

제공자에서 데이터를 검색하려면 다음과 같은 기본 단계를 따르세요.

1. 제공자에 대한 읽기 권한을 요청합니다.
2. 제공자에게 쿼리를 보내는 코드를 정의합니다.

읽기 권한 요청

제공자에서 데이터를 검색하려면 애플리케이션에 해당 제공자에 대한 '읽기 권한'이 필요합니다. 런타임에는 이 권한을 요청할 수 없습니다. 대신 이 권한이 필요하다는 것을 매니페스트에 나타내야 합니다. 이때 <uses-permission> 요소와 제공자가 정의한 정확한 권한 이름을 사용하면 됩니다. 매니페스트에서 이 요소를 지정하는 것은 애플리케이션에 이 권한을 '요청'하는 것과 같습니다. 사용자가 애플리케이션을 설치하면 이 요청을 암시적으로 허용하게 됩니다.

사용 중인 제공자에 대한 읽기 권한의 정확한 이름과 해당 제공자가 사용하는 다른 액세스 권한의 이름을 찾아보려면 제공자의 문서를 살펴보세요.

제공자에 액세스하는 데 권한이 어떤 역할을 하는지는 콘텐츠 제공자 권한 섹션에서 더욱 자세하게 설명합니다.

사용자 사전 제공자는 android.permission.READ_USER_DICTIONARY 권한을 매니페스트 파일에 정의하므로 제공자에서 읽기 작업을 하고자 하는 애플리케이션은 반드시 이 권한을 요청해야 합니다.

쿼리 구성

제공자에서 데이터를 검색할 때 다음 단계는 쿼리를 구성하는 것입니다. 다음의 첫 번째 스니펫은 사용자 사전 제공자에 액세스하는 데 필요한 몇 가지 변수를 정의합니다.

// A "projection" defines the columns that will be returned for each row
private val mProjection: Array<String> = arrayOf(
        UserDictionary.Words._ID,    // Contract class constant for the _ID column name
        UserDictionary.Words.WORD,   // Contract class constant for the word column name
        UserDictionary.Words.LOCALE  // Contract class constant for the locale column name
)

// Defines a string to contain the selection clause
private var selectionClause: String? = null

// Declares an array to contain selection arguments
private lateinit var selectionArgs: Array<String>

// A "projection" defines the columns that will be returned for each row
String[] mProjection =
{
    UserDictionary.Words._ID,    // Contract class constant for the _ID column name
    UserDictionary.Words.WORD,   // Contract class constant for the word column name
    UserDictionary.Words.LOCALE  // Contract class constant for the locale column name
};

// Defines a string to contain the selection clause
String selectionClause = null;

// Initializes an array to contain selection arguments
String[] selectionArgs = {""};

다음 스니펫은 사용자 사전 제공자를 예시로 사용하여 ContentResolver.query()를 사용하는 방법을 보여줍니다. 제공자 클라이언트 쿼리는 SQL 쿼리와 비슷하며 반환할 열 집합과 선택 기준 집합 및 정렬 순서가 이 안에 들어 있습니다.

쿼리가 반환해야 할 열의 집합을 프로젝션(변수 mProjection)이라고 합니다.

검색할 행을 나타내는 표현식은 선택 절과 선택 인수로 분할되어 있습니다. 선택 절은 논리와 부울 표현식, 열 이름, 값(mSelectionClause 변수)의 조합입니다. 값 대신 대체 가능한 매개변수 ?를 지정하면 쿼리 메서드는 선택 인수 배열(mSelectionArgs 변수)에서 값을 검색합니다.

다음 스니펫의 경우 사용자가 단어를 입력하지 않으면 선택 절이 null로 설정되고, 쿼리는 제공자 안의 모든 단어를 반환합니다. 사용자가 단어를 입력하면 선택 절은 UserDictionary.Words.WORD + " = ?"로 설정되며 선택 인수의 첫 번째 요소가 사용자가 입력한 단어로 설정됩니다.

/*
 * This declares String array to contain the selection arguments.
 */
private lateinit var selectionArgs: Array<String>

// Gets a word from the UI
searchString = searchWord.text.toString()

// Remember to insert code here to check for invalid or malicious input.

// If the word is the empty string, gets everything
selectionArgs = searchString?.takeIf { it.isNotEmpty() }?.let {
    selectionClause = "${UserDictionary.Words.WORD} = ?"
    arrayOf(it)
} ?: run {
    selectionClause = null
    emptyArray<String>()
}

// Does a query against the table and returns a Cursor object
mCursor = contentResolver.query(
        UserDictionary.Words.CONTENT_URI,  // The content URI of the words table
        projection,                       // The columns to return for each row
        selectionClause,                  // Either null, or the word the user entered
        selectionArgs,                    // Either empty, or the string the user entered
        sortOrder                         // The sort order for the returned rows
)

// Some providers return null if an error occurs, others throw an exception
when (mCursor?.count) {
    null -> {
        /*
         * Insert code here to handle the error. Be sure not to use the cursor!
         * You may want to call android.util.Log.e() to log this error.
         *
         */
    }
    0 -> {
        /*
         * Insert code here to notify the user that the search was unsuccessful. This isn't
         * necessarily an error. You may want to offer the user the option to insert a new
         * row, or re-type the search term.
         */
    }
    else -> {
        // Insert code here to do something with the results
    }
}

/*
 * This defines a one-element String array to contain the selection argument.
 */
String[] selectionArgs = {""};

// Gets a word from the UI
searchString = searchWord.getText().toString();

// Remember to insert code here to check for invalid or malicious input.

// If the word is the empty string, gets everything
if (TextUtils.isEmpty(searchString)) {
    // Setting the selection clause to null will return all words
    selectionClause = null;
    selectionArgs[0] = "";

} else {
    // Constructs a selection clause that matches the word that the user entered.
    selectionClause = UserDictionary.Words.WORD + " = ?";

    // Moves the user's input string to the selection arguments.
    selectionArgs[0] = searchString;

}

// Does a query against the table and returns a Cursor object
mCursor = getContentResolver().query(
    UserDictionary.Words.CONTENT_URI,  // The content URI of the words table
    projection,                       // The columns to return for each row
    selectionClause,                  // Either null, or the word the user entered
    selectionArgs,                    // Either empty, or the string the user entered
    sortOrder);                       // The sort order for the returned rows

// Some providers return null if an error occurs, others throw an exception
if (null == mCursor) {
    /*
     * Insert code here to handle the error. Be sure not to use the cursor! You may want to
     * call android.util.Log.e() to log this error.
     *
     */
// If the Cursor is empty, the provider found no matches
} else if (mCursor.getCount() < 1) {

    /*
     * Insert code here to notify the user that the search was unsuccessful. This isn't necessarily
     * an error. You may want to offer the user the option to insert a new row, or re-type the
     * search term.
     */

} else {
    // Insert code here to do something with the results

}

이 쿼리는 SQL 문과 유사합니다.

SELECT _ID, word, locale FROM words WHERE word = <userinput> ORDER BY word ASC;

이 SQL 문에서는 계약 클래스 상수 대신 실제 열 이름을 사용했습니다.

악의적인 입력에 대한 보호

SQL 데이터베이스에 콘텐츠 제공자가 관리하는 데이터가 있을 경우, 외부의 신뢰할 수 없는 데이터를 원시 SQL 문에 포함하면 SQL 주입 공격을 초래할 수 있습니다.

다음의 선택 절 예를 보세요.

// Constructs a selection clause by concatenating the user's input to the column name
var selectionClause = "var = $mUserInput"

// Constructs a selection clause by concatenating the user's input to the column name
String selectionClause = "var = " + userInput;

이렇게 하면 사용자가 여러분의 SQL 문에 악의적인 SQL을 연결할 수 있게 됩니다. 예를 들어 사용자가 mUserInput에 'nothing; DROP TABLE *;"을 입력할 수 있습니다. 그러면 선택 절의 결과가 var = nothing; DROP TABLE *;이 됩니다. 선택 절이 일종의 SQL 문으로 취급되었기 때문에 제공자가 기본 SQLite 데이터베이스에서 테이블을 모두 삭제하는 결과를 낳을 수도 있습니다(제공자가 SQL 주입 공격 시도를 잡아내도록 설정된 경우는 예외).

이 문제를 피하려면 ?를 대체 가능한 매개변수로 사용하는 선택 절과 별도의 선택 인수 배열을 사용하면 됩니다. 이렇게 하면 사용자 입력이 SQL 문의 일부로 해석되는 대신 쿼리에 직접 바인딩되며, SQL로 취급되지 않기 때문에 사용자 입력이 악의적인 SQL을 주입할 수 없습니다. 사용자 입력을 포함하기 위해 문자열을 연결하는 대신 다음 선택 절을 사용하세요.

// Constructs a selection clause with a replaceable parameter
var selectionClause = "var = ?"

// Constructs a selection clause with a replaceable parameter
String selectionClause =  "var = ?";

그리고 다음과 같이 선택 인수를 배열하세요.

// Defines a mutable list to contain the selection arguments
var selectionArgs: MutableList<String> = mutableListOf()

// Defines an array to contain the selection arguments
String[] selectionArgs = {""};

선택 인수 배열에 값을 입력할 때는 이렇게 합니다.

// Adds the user's input to the selection argument
selectionArgs += userInput

// Sets the selection argument to the user's input
selectionArgs[0] = userInput;

?를 대체 가능한 매개변수로 사용하는 선택 절과 선택 인수 배열을 사용하는 것이 선택을 지정하는 데 선호되는 방법입니다. 이는 제공자가 SQL 데이터베이스 기반이 아닐 때도 마찬가지입니다.

쿼리 결과 표시

ContentResolver.query() 클라이언트 메서드는 언제나 쿼리 선택 기준과 일치하는 행에 대해 쿼리 프로젝션이 지정한 열을 포함하는 Cursor를 반환합니다. Cursor 객체가 자신이 포함한 행과 열에 무작위 읽기 액세스를 제공합니다. Cursor 메서드를 사용하면 행을 결과에서 반복할 수 있고, 각 열의 데이터 유형을 결정하며 열에서 데이터를 꺼내거나 결과의 다른 속성을 검토할 수도 있습니다. 일부 Cursor 구현은 제공자의 데이터가 변경될 경우, Cursor가 변경될 때 관찰자 객체 내의 메서드를 트리거하는 경우 또는 두 가지가 한 번에 발생할 경우 자동으로 객체를 업데이트합니다.

참고: 제공자는 쿼리를 실행하는 객체의 특성에 따라 열에 대한 액세스를 제한할 수 있습니다. 예를 들어 연락처 제공자는 동기화 어댑터로의 일부 열에 대한 액세스를 제한합니다. 이렇게 해야 활동 또는 서비스에 열을 반환하지 않기 때문입니다.

선택 기준에 일치하는 행이 없으면 제공자는 Cursor 객체를 반환합니다. 이 객체의 Cursor.getCount()는 0(빈 커서)입니다.

내부 오류가 발생하는 경우, 쿼리 결과는 특정 제공자에 따라 달라집니다. null을 반환하기로 선택할 수도 있고, Exception을 발생시킬 수도 있습니다.

Cursor는 행의 '목록'이므로 Cursor의 콘텐츠를 표시하는 방법으로는 SimpleCursorAdapter를 통해 ListView에 연결하는 것이 좋습니다.

다음 스니펫은 이전 스니펫의 코드에서 계속된 것입니다. 쿼리에서 검색한 Cursor가 들어 있는 SimpleCursorAdapter 객체를 생성하며, 이 객체를 ListView에 대한 어댑터로 설정합니다.

// Defines a list of columns to retrieve from the Cursor and load into an output row
val wordListColumns : Array<String> = arrayOf(
        UserDictionary.Words.WORD,      // Contract class constant containing the word column name
        UserDictionary.Words.LOCALE     // Contract class constant containing the locale column name
)

// Defines a list of View IDs that will receive the Cursor columns for each row
val wordListItems = intArrayOf(R.id.dictWord, R.id.locale)

// Creates a new SimpleCursorAdapter
cursorAdapter = SimpleCursorAdapter(
        applicationContext,             // The application's Context object
        R.layout.wordlistrow,           // A layout in XML for one row in the ListView
        mCursor,                        // The result from the query
        wordListColumns,               // A string array of column names in the cursor
        wordListItems,                 // An integer array of view IDs in the row layout
        0                               // Flags (usually none are needed)
)

// Sets the adapter for the ListView
wordList.setAdapter(cursorAdapter)

// Defines a list of columns to retrieve from the Cursor and load into an output row
String[] wordListColumns =
{
    UserDictionary.Words.WORD,   // Contract class constant containing the word column name
    UserDictionary.Words.LOCALE  // Contract class constant containing the locale column name
};

// Defines a list of View IDs that will receive the Cursor columns for each row
int[] wordListItems = { R.id.dictWord, R.id.locale};

// Creates a new SimpleCursorAdapter
cursorAdapter = new SimpleCursorAdapter(
    getApplicationContext(),               // The application's Context object
    R.layout.wordlistrow,                  // A layout in XML for one row in the ListView
    mCursor,                               // The result from the query
    wordListColumns,                      // A string array of column names in the cursor
    wordListItems,                        // An integer array of view IDs in the row layout
    0);                                    // Flags (usually none are needed)

// Sets the adapter for the ListView
wordList.setAdapter(cursorAdapter);

참고: ListView를 Cursor와 함께 사용하려면 커서에 _ID라는 열이 포함되어야 합니다. 이러한 이유로 이전에 표시된 쿼리는 ListView가 표시하지 않더라도 '단어' 테이블의 _ID 열을 검색합니다. 이 제한은 대부분의 제공자에 각 테이블에 관한 _ID 열이 있는 이유를 설명해 주기도 합니다.

쿼리 결과에서 데이터 가져오기

쿼리 결과를 단순히 표시만 하지 않고 이를 다른 작업에 사용할 수 있습니다. 예를 들어 사용자 사전에서 철자를 검색한 다음 다른 제공자 내에서 찾아볼 수 있습니다. 이렇게 하려면 Cursor에서 행을 계속 반복하면 됩니다.

/*
* Only executes if the cursor is valid. The User Dictionary Provider returns null if
* an internal error occurs. Other providers may throw an Exception instead of returning null.
*/
mCursor?.apply {
    // Determine the column index of the column named "word"
    val index: Int = getColumnIndex(UserDictionary.Words.WORD)

    /*
     * Moves to the next row in the cursor. Before the first movement in the cursor, the
     * "row pointer" is -1, and if you try to retrieve data at that position you will get an
     * exception.
     */
    while (moveToNext()) {
        // Gets the value from the column.
        newWord = getString(index)

        // Insert code here to process the retrieved word.

        ...

        // end of while loop
    }
}

// Determine the column index of the column named "word"
int index = mCursor.getColumnIndex(UserDictionary.Words.WORD);

/*
 * Only executes if the cursor is valid. The User Dictionary Provider returns null if
 * an internal error occurs. Other providers may throw an Exception instead of returning null.
 */

if (mCursor != null) {
    /*
     * Moves to the next row in the cursor. Before the first movement in the cursor, the
     * "row pointer" is -1, and if you try to retrieve data at that position you will get an
     * exception.
     */
    while (mCursor.moveToNext()) {

        // Gets the value from the column.
        newWord = mCursor.getString(index);

        // Insert code here to process the retrieved word.

        ...

        // end of while loop
    }
} else {

    // Insert code here to report an error if the cursor is null or the provider threw an exception.
}

Cursor 구현에는 객체에서 다양한 유형의 데이터를 검색하기 위한 여러 'get' 메서드가 포함되어 있습니다. 예를 들어 이전 스니펫에서는 getString()을 사용합니다. 여기에는 열의 데이터 유형을 나타내는 값을 반환하는 getType() 메서드도 있습니다.

콘텐츠 제공자 권한

제공자의 애플리케이션은 해당 제공자의 데이터에 액세스하려면 다른 애플리케이션이 반드시 가지고 있어야 하는 권한을 지정할 수 있습니다. 이러한 권한을 통해 사용자는 애플리케이션이 액세스하려는 데이터가 무엇인지 알 수 있습니다. 다른 애플리케이션은 제공자의 요구사항을 근거로 해당 제공자에 액세스하기 위해 필요한 권한을 요청합니다. 최종 사용자는 애플리케이션을 설치할 때 요청된 권한을 보게 됩니다.

제공자의 애플리케이션이 아무 권한도 지정하지 않은 경우, 다른 애플리케이션은 해당 제공자의 데이터에 액세스할 수 없습니다. 그러나 제공자의 애플리케이션 내에 있는 구성요소는 지정된 권한과 무관하게 항상 읽기 및 쓰기 권한을 모두 가지고 있습니다.

이전에 언급한 것과 같이 사용자 사전 제공자에서 데이터를 검색하려면 android.permission.READ_USER_DICTIONARY 권한이 필요합니다. 이 제공자에게는 데이터 삽입, 업데이트 또는 삭제에 각각 별도의 android.permission.WRITE_USER_DICTIONARY 권한이 있습니다.

제공자에 액세스하는 데 필요한 권한을 얻으려면 애플리케이션은 자신의 매니페스트 파일에 있는 <uses-permission>으로 권한을 요청합니다. Android 패키지 관리자가 애플리케이션을 설치하는 경우, 사용자는 애플리케이션이 요청하는 권한을 모두 승인해야 합니다. 사용자가 이를 모두 승인하면 패키지 관리자가 설치를 계속하지만, 사용자가 이를 승인하지 않으면 패키지 관리자는 설치를 중단합니다.

다음 <uses-permission> 요소는 사용자 사전 제공자에 읽기 권한을 요청합니다.

<uses-permission android:name="android.permission.READ_USER_DICTIONARY">

제공자 액세스 권한이 미치는 영향은 보안 및 권한 가이드에서 더 자세히 설명합니다.

데이터 삽입, 업데이트 및 삭제

제공자로부터 데이터를 검색하는 것과 같은 방식으로 데이터를 수정할 때도 제공자 클라이언트와 제공자의 ContentProvider 간 상호작용을 사용합니다. ContentProvider의 해당하는 메서드에 전달된 인수로 ContentResolver 메서드를 호출합니다. 제공자와 제공자 클라이언트는 보안 및 프로세스 간 통신을 자동으로 처리합니다.

데이터 삽입

데이터를 제공자에 삽입하려면 ContentResolver.insert() 메서드를 호출합니다. 이 메서드는 제공자에 새로운 행을 삽입하고 해당 열에 대한 콘텐츠 URI를 반환합니다. 이 스니펫은 사용자 사전 제공자에 새 단어를 삽입하는 방법을 보여줍니다.

// Defines a new Uri object that receives the result of the insertion
lateinit var newUri: Uri

...

// Defines an object to contain the new values to insert
val newValues = ContentValues().apply {
    /*
     * Sets the values of each column and inserts the word. The arguments to the "put"
     * method are "column name" and "value"
     */
    put(UserDictionary.Words.APP_ID, "example.user")
    put(UserDictionary.Words.LOCALE, "en_US")
    put(UserDictionary.Words.WORD, "insert")
    put(UserDictionary.Words.FREQUENCY, "100")

}

newUri = contentResolver.insert(
        UserDictionary.Words.CONTENT_URI,   // the user dictionary content URI
        newValues                          // the values to insert
)

// Defines a new Uri object that receives the result of the insertion
Uri newUri;

...

// Defines an object to contain the new values to insert
ContentValues newValues = new ContentValues();

/*
 * Sets the values of each column and inserts the word. The arguments to the "put"
 * method are "column name" and "value"
 */
newValues.put(UserDictionary.Words.APP_ID, "example.user");
newValues.put(UserDictionary.Words.LOCALE, "en_US");
newValues.put(UserDictionary.Words.WORD, "insert");
newValues.put(UserDictionary.Words.FREQUENCY, "100");

newUri = getContentResolver().insert(
    UserDictionary.Words.CONTENT_URI,   // the user dictionary content URI
    newValues                          // the values to insert
);

새로운 행의 데이터는 단일 행 커서와 형태가 유사한 단일 ContentValues 객체로 이동합니다. 이 객체 내의 열은 모두 같은 데이터 유형을 가지지 않아도 됩니다. 또한 값을 지정하고 싶지 않은 경우라면 ContentValues.putNull()을 사용하여 열을 null로 설정할 수 있습니다.

_ID 열은 자동으로 유지관리되므로 스니펫에서 이 열을 추가하지 않습니다. 제공자는 추가된 모든 열마다 고유한 _ID 값을 할당합니다. 제공자는 보통 이 값을 테이블의 기본 키로 사용합니다.

newUri에 반환된 콘텐츠 URI는 다음과 같은 형식으로 새로 추가된 행을 식별합니다.

content://user_dictionary/words/<id_value>

<id_value>는 새로운 행에 대한 _ID의 콘텐츠입니다. 대부분의 제공자는 이런 형태의 콘텐츠 URI를 자동으로 감지할 수 있으며, 그런 다음 해당 행에서 요청된 작업을 실행합니다.

반환된 Uri에서 _ID 값을 가져오려면 ContentUris.parseId()를 호출합니다.

데이터 업데이트

행을 업데이트하려면 업데이트된 값과 함께 ContentValues 객체를 사용합니다. 이때 값은 삽입할 때와 똑같고, 선택 기준은 쿼리할 때와 같습니다. 사용하는 클라이언트 메서드는 ContentResolver.update()입니다. 값은 업데이트하는 열의 ContentValues 객체에만 추가하면 됩니다. 열의 콘텐츠를 삭제하려면 값을 null로 설정하세요.

다음 스니펫은 언어가 'en'인 모든 행을 null로 변경합니다. 반환 값은 업데이트된 행의 수입니다.

// Defines an object to contain the updated values
val updateValues = ContentValues().apply {
    /*
     * Sets the updated value and updates the selected words.
     */
    putNull(UserDictionary.Words.LOCALE)
}

// Defines selection criteria for the rows you want to update
val selectionClause: String = UserDictionary.Words.LOCALE + "LIKE ?"
val selectionArgs: Array<String> = arrayOf("en_%")

// Defines a variable to contain the number of updated rows
var rowsUpdated: Int = 0

...

rowsUpdated = contentResolver.update(
        UserDictionary.Words.CONTENT_URI,   // the user dictionary content URI
        updateValues,                      // the columns to update
        selectionClause,                   // the column to select on
        selectionArgs                      // the value to compare to
)

// Defines an object to contain the updated values
ContentValues updateValues = new ContentValues();

// Defines selection criteria for the rows you want to update
String selectionClause = UserDictionary.Words.LOCALE +  " LIKE ?";
String[] selectionArgs = {"en_%"};

// Defines a variable to contain the number of updated rows
int rowsUpdated = 0;

...

/*
 * Sets the updated value and updates the selected words.
 */
updateValues.putNull(UserDictionary.Words.LOCALE);

rowsUpdated = getContentResolver().update(
    UserDictionary.Words.CONTENT_URI,   // the user dictionary content URI
    updateValues,                      // the columns to update
    selectionClause,                   // the column to select on
    selectionArgs                      // the value to compare to
);

ContentResolver.update()를 호출하는 경우에는 사용자 입력도 삭제해야 합니다. 이에 관해 자세히 알아보려면 악의적인 입력에 대한 보호 섹션을 읽어 보세요.

데이터 삭제

행을 삭제하는 것은 행 데이터를 검색하는 것과 비슷합니다. 즉, 삭제하고자 하는 행에 대한 선택 기준을 지정하면 클라이언트 메서드가 삭제된 행 수를 반환하는 방식입니다. 다음 스니펫은 appid가 'user'와 일치하는 행을 삭제합니다. 메서드는 삭제된 행 수를 반환합니다.

// Defines selection criteria for the rows you want to delete
val selectionClause = "${UserDictionary.Words.LOCALE} LIKE ?"
val selectionArgs: Array<String> = arrayOf("user")

// Defines a variable to contain the number of rows deleted
var rowsDeleted: Int = 0

...

// Deletes the words that match the selection criteria
rowsDeleted = contentResolver.delete(
        UserDictionary.Words.CONTENT_URI,   // the user dictionary content URI
        selectionClause,                   // the column to select on
        selectionArgs                      // the value to compare to
)

// Defines selection criteria for the rows you want to delete
String selectionClause = UserDictionary.Words.APP_ID + " LIKE ?";
String[] selectionArgs = {"user"};

// Defines a variable to contain the number of rows deleted
int rowsDeleted = 0;

...

// Deletes the words that match the selection criteria
rowsDeleted = getContentResolver().delete(
    UserDictionary.Words.CONTENT_URI,   // the user dictionary content URI
    selectionClause,                   // the column to select on
    selectionArgs                      // the value to compare to
);

ContentResolver.delete()를 호출하는 경우에는 사용자 입력도 삭제해야 합니다. 이에 관해 자세히 알아보려면 악의적인 입력에 관한 보호 섹션을 읽어 보세요.

제공자 데이터 유형

콘텐츠 제공자는 아주 다양한 데이터 유형을 제공할 수 있습니다. 사용자 사전 제공자는 텍스트만 제공하지만, 제공자는 다음과 같은 형식도 제공할 수 있습니다.

• 정수
• 긴 정수(long)
• 부동 소수점
• 긴 부동 소수점(double)

제공자가 흔히 사용하는 또 다른 데이터 유형은 64KB 바이트 배열로 구현되는 BLOB(Binary Large OBject)입니다. Cursor 클래스 'get' 메서드를 살펴보면 사용 가능한 데이터 유형을 확인할 수 있습니다.

제공자 내의 각 열에 대한 데이터 유형은 대개 제공자 문서에 나열되어 있습니다. 사용자 사전 제공자의 데이터 유형은 제공자의 계약 클래스 UserDictionary.Words의 참고 문서에 나열되어 있습니다(계약 클래스는 계약 클래스 섹션에서 설명). Cursor.getType()을 호출하여 데이터 유형을 확인할 수도 있습니다.

제공자는 스스로 정의하는 각 콘텐츠 URI의 MIME 데이터 유형 정보도 유지관리합니다. MIME 유형 정보를 사용하면 애플리케이션이 제공자가 제공하는 데이터를 처리할 수 있을지 알아낼 수도 있고, MIME 유형을 근거로 처리 유형을 선택할 수도 있습니다. MIME 유형이 필요한 시점은 주로 복잡한 데이터 구조 또는 파일이 들어 있는 제공자를 다룰 때입니다. 예를 들어 연락처 제공자 내의 ContactsContract.Data 테이블은 MIME 유형을 사용하여 각 행에 저장된 연락처 데이터의 유형에 라벨을 지정합니다. 콘텐츠 URI에 상응하는 MIME 유형을 가져오려면 ContentResolver.getType()을 호출하세요.

MIME 유형 참고 섹션에서는 표준 및 맞춤 MIME 유형의 구문을 모두 설명합니다.

제공자 액세스의 대체 형식

애플리케이션 개발에 있어 중요한 제공자 액세스의 대체 형식에는 다음과 같은 세 가지가 있습니다.

• 일괄 액세스: ContentProviderOperation 클래스에 있는 메서드로 일괄 액세스 호출을 생성하고 ContentResolver.applyBatch()로 이를 적용할 수 있습니다.
• 비동기 쿼리: 별도의 스레드에서 쿼리를 실행해야 합니다. 이 작업을 실행하는 한 가지 방법은 CursorLoader 객체를 사용하는 것입니다. 사용 방법은 로더 가이드에 있는 예시에서 설명합니다.
• 인텐트를 통한 데이터 액세스: 인텐트를 제공자에 직접 보낼 수는 없지만, 인텐트를 제공자의 애플리케이션에 보낼 수는 있습니다. 보통은 이 방법이 제공자의 데이터를 수정하기에 가장 좋습니다.

일괄 액세스와 인텐트를 통한 수정은 다음 섹션에서 설명합니다.

일괄 액세스

제공자에 일괄 액세스하면 많은 수의 행을 삽입할 때, 같은 메서드 호출 내에서 여러 개의 테이블에 여러 행을 삽입할 때 또는 모든 프로세스 경계에서 일련의 작업을 실행하는 경우(원자성 작업) 유용합니다.

'일괄 모드'로 제공자에 액세스하려면 ContentProviderOperation 객체의 배열을 생성한 다음 ContentResolver.applyBatch()를 사용하여 콘텐츠 제공자에게 전달합니다. 이 메서드에는 특정 콘텐츠 URI가 아니라 콘텐츠 제공자의 권한을 전달합니다. 이렇게 하면 배열 내의 각 ContentProviderOperation 객체가 서로 다른 테이블에 작용하도록 할 수 있습니다. ContentResolver.applyBatch() 호출은 결과 배열을 반환합니다.

ContactsContract.RawContacts 계약 클래스의 설명에 일괄 삽입을 설명하는 코드 스니펫이 포함되어 있습니다. 연락처 관리자 샘플 애플리케이션에는 ContactAdder.java 소스 파일의 일괄 액세스 예시가 포함되어 있습니다.

인텐트를 통한 데이터 액세스

인텐트는 콘텐츠 제공자에 간접 액세스를 제공할 수 있습니다. 애플리케이션에 액세스 권한이 없는데도 사용자에게 제공자 내의 데이터에 액세스 권한을 허가하려면, 권한을 가지고 있는 애플리케이션에서 결과 인텐트를 다시 가져오거나 권한이 있는 애플리케이션을 활성화한 다음 사용자에게 그 애플리케이션에서 작업하도록 하면 됩니다.

임시 권한으로 액세스하기

적절한 액세스 권한이 없더라도 콘텐츠 제공자 내의 데이터에 액세스할 수는 있습니다. 권한을 가지고 있는 애플리케이션에 인텐트를 보내 'URI' 권한이 포함된 결과 인텐트를 돌려받으면 됩니다. 이들 권한은 특정 콘텐츠 URI에 대한 권한으로, 이를 수신하는 활동이 완료될 때까지 유지됩니다. 영구 권한을 가지고 있는 애플리케이션은 결과 인텐트에 다음과 같이 플래그를 설정하여 임시 권한을 허가합니다.

• 읽기 권한: FLAG_GRANT_READ_URI_PERMISSION
• 쓰기 권한: FLAG_GRANT_WRITE_URI_PERMISSION

참고: 이와 같은 플래그는 콘텐츠 URI에 권한이 들어 있는 제공자에 일반적인 읽기 또는 쓰기 액세스 권한을 부여하지는 않습니다. 이 액세스는 URI 자체에만 해당됩니다.

제공자는 매니페스트 내의 콘텐츠 URI에 대한 URI 권한을 정의합니다. 이때 <provider> 요소의 android:grantUriPermission 속성과 <provider> 요소의 <grant-uri-permission> 하위 요소를 사용합니다. URI 권한 메커니즘은 권한 개요 가이드에서 더욱 자세히 설명합니다.

예를 들어 READ_CONTACTS 권한이 없더라도 연락처 제공자 내의 연락처에 대한 데이터를 검색할 수 있습니다. 이 작업을 하면 좋은 예로, 연락처에 기재된 사람의 생일에 전자 축하 카드를 보내주는 애플리케이션을 들 수 있습니다. READ_CONTACTS를 요청하면 사용자의 모든 연락처와 해당 정보에 대한 액세스를 부여하므로, 그 대신 애플리케이션에서 어느 연락처를 사용할지 사용자가 직접 제어하도록 하는 것이 좋습니다. 이렇게 하려면 다음 절차를 사용합니다.

1. 애플리케이션이 startActivityForResult() 메서드를 사용하여 작업 ACTION_PICK 및 'contacts' MIME 유형 CONTENT_ITEM_TYPE이 포함된 인 텐트를 전송합니다.
2. 이 인텐트는 피플 앱의 '선택' 활동에 대한 인텐트 필터와 일치하므로 이 활동이 포그라운드로 나옵니다.
3. 선택 활동에서 사용자가 업데이트할 연락처를 선택합니다. 이렇게 되면 선택 활동이 setResult(resultcode, intent)를 호출하여 애플리케이션에 돌려줄 인텐트를 설정합니다. 이 인텐트에는 사용자가 선택한 연락처의 콘텐츠 URI와 'extras' 플래그 FLAG_GRANT_READ_URI_PERMISSION이 포함됩니다. 이들 플래그는 앱에 URI 권한을 부여하여 콘텐츠 URI가 가리키는 연락처의 데이터를 읽을 수 있도록 합니다. 그런 다음 선택 활동은 finish()를 호출하여 애플리케이션에 제어를 반환합니다.
4. 활동이 포그라운드로 돌아오고 시스템이 활동의 onActivityResult() 메서드를 호출합니다. 이 메서드가 피플 앱의 선택 활동이 생성한 결과 인텐트를 수신합니다.
5. 결과 인텐트로부터 받은 콘텐츠 URI를 사용하면 연락처 제공자에서 연락처의 데이터를 읽을 수 있습니다. 이것은 매니페스트에서 제공자로의 영구 읽기 권한을 요청하지 않았어도 적용됩니다. 그러면 연락처의 생일 정보나 이메일 주소를 가져와 전자 축하 카드를 보낼 수 있게 됩니다.

다른 애플리케이션 사용

개발자에게 액세스 권한이 없는 데이터를 사용자가 수정할 수 있도록 허용하는 간단한 방법은 해당 권한을 가지고 있는 애플리케이션을 활성화한 다음 사용자가 그곳에서 작업하도록 하게 하는 것입니다.

예를 들어 캘린더 애플리케이션은 애플리케이션의 삽입 UI를 활성화하는 ACTION_INSERT 인텐트를 허용합니다. 이 인텐트에 'extras' 데이터를 전달할 수 있습니다. 이 데이터는 애플리케이션이 UI를 미리 채우는 데 사용됩니다. 반복적인 이벤트의 구문은 복잡하므로 캘린더 제공자에 이벤트를 삽입하려면 ACTION_INSERT로 캘린더 앱을 활성화하고 사용자에게 그곳에서 이벤트를 삽입하게 하는 것이 좋습니다.

도우미 앱을 사용한 데이터 표시

애플리케이션에 액세스 권한이 있더라도 다른 애플리케이션에 데이터를 표시할 인텐트를 사용하고자 할 수 있습니다. 예를 들어 캘린더 애플리케이션은 특정 날짜나 이벤트를 표시하는 ACTION_VIEW를 허용합니다. 따라서 UI를 직접 생성하지 않고도 캘린더 정보를 표시할 수 있습니다. 이 기능을 자세히 알아보려면 캘린더 제공자 가이드를 참고하세요.

인텐트를 보낼 목적지인 애플리케이션은 제공자와 연관된 애플리케이션이 아니어도 됩니다. 예를 들어 연락처 제공자에서 연락처를 검색한 다음, 해당 연락처의 이미지에 대한 콘텐츠 URI가 들어 있는 ACTION_VIEW 인텐트를 이미지 뷰어로 보낼 수 있습니다.

계약 클래스

계약 클래스는 애플리케이션이 콘텐츠 URI, 열 이름, 인텐트 작업 및 콘텐츠 제공자의 다른 기능과 작업할 수 있게 도와주는 상수를 정의합니다. 계약 클래스는 제공자와 함께 자동으로 포함되지 않습니다. 제공자의 개발자가 이를 정의한 다음 다른 개발자가 사용할 수 있도록 해야 합니다. Android 플랫폼 내에 포함된 제공자는 대부분 패키지 android.provider 안에 상응하는 계약 클래스를 가지고 있습니다.

예를 들어 사용자 사전 제공자에는 콘텐츠 URI와 열 이름 상수가 들어 있는 UserDictionary 계약 클래스가 있습니다. '단어' 테이블의 콘텐츠 URI는 상수 UserDictionary.Words.CONTENT_URI에 정의됩니다. UserDictionary.Words 클래스에도 열 이름 상수가 들어 있으며, 이는 이 가이드의 예시 스니펫에서 사용됩니다. 예를 들어 쿼리 프로젝션은 다음과 같이 정의될 수 있습니다.

val projection : Array<String> = arrayOf(
        UserDictionary.Words._ID,
        UserDictionary.Words.WORD,
        UserDictionary.Words.LOCALE
)

String[] projection =
{
    UserDictionary.Words._ID,
    UserDictionary.Words.WORD,
    UserDictionary.Words.LOCALE
};

또 다른 계약 클래스는 연락처 제공자의 ContactsContract입니다. 이 클래스의 참고 문서에는 예시 스니펫이 포함되어 있습니다. 서브클래스 중 하나인 ContactsContract.Intents.Insert는 인텐트와 인텐트 데이터의 상수가 들어 있는 계약 클래스입니다.

MIME 유형 참고

콘텐츠 제공자는 표준 MIME 미디어 유형이나 맞춤 MIME 유형 문자열 또는 그 두 가지를 모두 반환할 수 있습니다.

MIME 유형의 형식은 다음과 같습니다.

type/subtype

예를 들어 잘 알려진 MIME 유형 text/html에는 text 유형과 html 하위유형이 있습니다. 제공자가 URI에 대해 이 유형을 반환하면, 해당 URI를 사용하는 쿼리가 HTML 태그가 들어 있는 텍스트를 반환할 것이라는 뜻입니다.

'공급업체별' MIME 유형이라고도 하는 맞춤 MIME 유형 문자열은 더 복잡한 type 및 subtype 값을 가집니다. type 값은 경우에 따라 항상 다음과 같습니다.

vnd.android.cursor.dir

(여러 행의 경우)

vnd.android.cursor.item

(하나의 행의 경우)

subtype은 제공자별로 다릅니다. Android 내장 제공자는 보통 단순한 하위유형을 가지고 있습니다. 예를 들어 주소록 애플리케이션이 전화번호 행을 생성하는 경우 애플리케이션은 해당 행에 다음과 같은 MIME 유형을 설정합니다.

vnd.android.cursor.item/phone_v2

참고로 하위유형 값은 단순히 phone_v2입니다.

다른 제공자 개발자도 해당 제공자의 권한과 테이블 이름을 근거로 나름의 하위유형 패턴을 만들 수 있습니다. 예를 들어 기차 시간표가 들어 있는 제공자가 있다고 생각해 보세요. 제공자의 권한은 com.example.trains이고 그 안에 테이블 Line1, Line2, Line3이 들어 있습니다. 콘텐츠 URI에 대한 응답으로

content://com.example.trains/Line1

제공자는 테이블 Line1에 대해 다음과 같은 MIME 유형을 반환합니다.

vnd.android.cursor.dir/vnd.example.line1

콘텐츠 URI에 대한 응답으로

content://com.example.trains/Line2/5

테이블 Line2의 행 5에 대해 제공자가 반환하는 MIME 유형은 다음과 같습니다.

vnd.android.cursor.item/vnd.example.line2

대부분의 콘텐츠 제공자는 자신이 사용하는 MIME 유형에 관한 계약 클래스 상수를 정의합니다. 예를 들어 연락처 제공자 계약 클래스 ContactsContract.RawContacts는 단일 연락처 행의 MIME 유행에 관한 상수 CONTENT_ITEM_TYPE을 정의합니다.

한 행에 대한 콘텐츠 URI는 콘텐츠 URI 섹션에서 설명합니다.