DataStore लाइब्रेरी, डेटा को एसिंक्रोनस तरीके से, लगातार, और ट्रांज़ैक्शन के हिसाब से सेव करती है. इससे SharedPreferences की कुछ कमियों को दूर किया जा सकता है. इस पेज पर, Kotlin Multiplatform (केएमपी) प्रोजेक्ट में DataStore बनाने के बारे में बताया गया है. DataStore के बारे में ज़्यादा जानकारी के लिए, DataStore का मुख्य दस्तावेज़ देखें.
डिपेंडेंसी सेट अप करना
अपने केएमपी प्रोजेक्ट में DataStore सेट अप करने के लिए, अपने मॉड्यूल की build.gradle.kts फ़ाइल में आर्टफ़ैक्ट की डिपेंडेंसी जोड़ें:
commonMain.dependencies {
// DataStore library
implementation("androidx.datastore:datastore-core:1.3.0")
// The Preferences DataStore library
implementation("androidx.datastore:datastore-preferences-core:1.3.0")
}
DataStore क्लास तय करना
शेयर किए गए केएमपी मॉड्यूल के कॉमन सोर्स में, DataStoreFactory के साथ DataStore क्लास को तय किया जा सकता है. इन क्लास को सामान्य सोर्स में रखने से, इन्हें सभी टारगेट प्लैटफ़ॉर्म पर शेयर किया जा सकता है. actual और expect डिक्लेरेशन का इस्तेमाल करके, प्लैटफ़ॉर्म के हिसाब से लागू किए जाने वाले कोड बनाए जा सकते हैं.
DataStore इंस्टेंस बनाना
आपको यह तय करना होगा कि हर प्लैटफ़ॉर्म पर DataStore ऑब्जेक्ट को कैसे इंस्टैंशिएट किया जाए. एपीआई का सिर्फ़ यही हिस्सा, प्लैटफ़ॉर्म के हिसाब से सोर्स सेट में होना ज़रूरी है. ऐसा इसलिए, क्योंकि फ़ाइल सिस्टम एपीआई में अंतर होता है.
सामान्य
// shared/src/commonMain/kotlin/createDataStore.kt /** * Gets the singleton DataStore instance, creating it if necessary. */ fun createDataStore(storage: Storage<Preferences>): DataStore<Preferences> = DataStoreFactory.create(storage = storage) internal const val dataStoreFileName = "dice.preferences_pb"
Android
Android पर DataStore इंस्टेंस बनाने के लिए, आपको पाथ के साथ-साथ Context की ज़रूरत होगी.
// shared/src/androidMain/kotlin/createDataStore.android.kt fun createDataStore(context: Context): DataStore<Preferences> = createDataStore( storage = FileStorage( serializer = PreferencesFileSerializer, produceFile = { context.filesDir.resolve(dataStoreFileName) } ) )
iOS
iOS पर, NSDocumentDirectory से पाथ को वापस पाया जा सकता है:
// shared/src/iosMain/kotlin/createDataStore.ios.kt @OptIn(ExperimentalForeignApi::class) fun createDataStore(): DataStore<Preferences> = createDataStore( storage = OkioStorage( fileSystem = FileSystem.SYSTEM, serializer = PreferencesSerializer, producePath = { val documentDirectory: NSURL? = NSFileManager.defaultManager.URLForDirectory( directory = NSDocumentDirectory, inDomain = NSUserDomainMask, appropriateForURL = null, create = false, error = null, ) (requireNotNull(documentDirectory).path + "/$dataStoreFileName").toPath() } ) )
वेब
वेब पर DataStore इंस्टेंस बनाने के लिए, WebLocalStorage या WebSessionStorage का इस्तेमाल किया जा सकता है:
// shared/src/jsMain/kotlin/createDataStore.web.kt (also works for wasmJsMain)
fun createDataStore(): DataStore<Preferences> = createDataStore(
storage = WebLocalStorage(
serializer = PreferencesSerializer,
name = dataStoreFileName
)
)
JVM (डेस्कटॉप)
जेवीएम (डेस्कटॉप) पर DataStore इंस्टेंस बनाने के लिए, Java या Kotlin एपीआई का इस्तेमाल करके पाथ दें:
// shared/src/jvmMain/kotlin/createDataStore.desktop.kt
fun createDataStore(): DataStore<Preferences> = createDataStore(
storage = FileStorage(
serializer = PreferencesFileSerializer,
produceFile = { File(System.getProperty("java.io.tmpdir"), dataStoreFileName) }
)
)