राज्य संरक्षण और स्थायी मेमोरी

Jetpack Compose

Jetpack Compose में, यूज़र इंटरफ़ेस की स्थिति को आम तौर पर remember और rememberSaveable का इस्तेमाल करके मैनेज किया जाता है. rememberSaveable, कॉन्फ़िगरेशन में होने वाले बदलावों के दौरान, स्टेटस को अपने-आप सेव रखने की सुविधा देता है. हालांकि, इसकी पहले से मौजूद सुविधाएं, प्राइमिटिव डेटा टाइप और उन ऑब्जेक्ट तक ही सीमित हैं जो Parcelable या Serializable को लागू करते हैं.

Brush जैसे कस्टम ऑब्जेक्ट के लिए, साफ़ तौर पर सीरियलाइज़ेशन और डिसीरियलाइज़ेशन करने के तरीके ज़रूरी हैं. इन ऑब्जेक्ट में, नेस्ट किए गए जटिल स्ट्रक्चर और प्रॉपर्टी शामिल हो सकती हैं. यहां कस्टम स्टेटस सेवर का इस्तेमाल करना फ़ायदेमंद होता है. Brush ऑब्जेक्ट के लिए कस्टम Saver तय करके, ब्रश के ज़रूरी ऐट्रिब्यूट को बनाए रखने की गारंटी दी जा सकती है. ऐसा तब भी किया जा सकता है, जब कॉन्फ़िगरेशन में बदलाव हो. इसके लिए, Converters क्लास के उदाहरण का इस्तेमाल करके brushStateSaver के साथ दिए गए उदाहरण को देखें.

fun brushStateSaver(converters: Converters): Saver<MutableState<Brush>, String> = Saver(
    save = { state ->
        converters.brushToString(state.value)
    },
    restore = { jsonString ->
        val brush = converters.stringToBrush(jsonString)
        mutableStateOf(brush)
    }
)

इसके बाद, उपयोगकर्ता के चुने गए ब्रश की स्थिति को बनाए रखने के लिए, कस्टम Saver का इस्तेमाल किया जा सकता है. ऐसा करने के लिए, यह तरीका अपनाएं:

val converters = Converters()
val currentBrush = rememberSaveable(saver = brushStateSaver(converters)) { mutableStateOf(defaultBrush) }

पर्सिस्टेंट स्टोरेज

दस्तावेज़ सेव करने, लोड करने, और रीयल-टाइम में साथ मिलकर काम करने जैसी सुविधाओं को चालू करने के लिए, स्ट्रोक और उससे जुड़े डेटा को क्रम से लगाए गए फ़ॉर्मैट में सेव करें. Ink API के लिए, मैन्युअल तरीके से सीरियलाइज़ेशन और डीसीरियलाइज़ेशन करना ज़रूरी है.

किसी स्ट्रोक को सटीक तरीके से वापस लाने के लिए, उसकाBrush और [StrokeInputBatch] सेव करें.

  • Brush: इसमें संख्या वाले फ़ील्ड (साइज़, epsilon), रंग, और BrushFamily शामिल हैं.
  • StrokeInputBatch: यह संख्या वाले फ़ील्ड के साथ इनपुट पॉइंट की सूची होती है.

सीरियलाइज़ेशन का बुनियादी तरीका

सीरियलाइज़ेशन ऑब्जेक्ट का ऐसा स्ट्रक्चर तय करें जो Ink लाइब्रेरी ऑब्जेक्ट को दिखाता हो.

Gson, Moshi, Protobuf वगैरह जैसे अपने पसंदीदा फ़्रेमवर्क का इस्तेमाल करके, सीरियलाइज़ किए गए डेटा को कोड में बदलें. साथ ही, ऑप्टिमाइज़ेशन के लिए कंप्रेसन का इस्तेमाल करें.

data class SerializedStroke(
  val inputs: SerializedStrokeInputBatch,
  val brush: SerializedBrush
)

data class SerializedBrush(
  val size: Float,
  val color: Long,
  val epsilon: Float,
  val stockBrush: SerializedStockBrush
)

enum class SerializedStockBrush {
  MARKER_V1,
  PRESSURE_PEN_V1,
  HIGHLIGHTER_V1
}

data class SerializedStrokeInputBatch(
  val toolType: SerializedToolType,
  val strokeUnitLengthCm: Float,
  val inputs: List<SerializedStrokeInput>
)

data class SerializedStrokeInput(
  val x: Float,
  val y: Float,
  val timeMillis: Float,
  val pressure: Float,
  val tiltRadians: Float,
  val orientationRadians: Float,
  val strokeUnitLengthCm: Float
)

enum class SerializedToolType {
  STYLUS,
  TOUCH,
  MOUSE,
  UNKNOWN
}
class Converters {

  private val gson: Gson = GsonBuilder().create()

  companion object {
    private val stockBrushToEnumValues =
      mapOf(
        StockBrushes.markerV1 to SerializedStockBrush.MARKER_V1,
        StockBrushes.pressurePenV1 to SerializedStockBrush.PRESSURE_PEN_V1,
        StockBrushes.highlighterV1 to SerializedStockBrush.HIGHLIGHTER_V1,
      )

    private val enumToStockBrush =
      stockBrushToEnumValues.entries.associate { (key, value) -> value to key }
  }

  private fun serializeBrush(brush: Brush): SerializedBrush {
    return SerializedBrush(
      size = brush.size,
      color = brush.colorLong,
      epsilon = brush.epsilon,
      stockBrush = stockBrushToEnumValues[brush.family] ?: SerializedStockBrush.MARKER_V1,
    )
  }

  private fun serializeStrokeInputBatch(inputs: StrokeInputBatch): SerializedStrokeInputBatch {
    val serializedInputs = mutableListOf<SerializedStrokeInput>()
    val scratchInput = StrokeInput()

    for (i in 0 until inputs.size) {
      inputs.populate(i, scratchInput)
      serializedInputs.add(
        SerializedStrokeInput(
          x = scratchInput.x,
          y = scratchInput.y,
          timeMillis = scratchInput.elapsedTimeMillis.toFloat(),
          pressure = scratchInput.pressure,
          tiltRadians = scratchInput.tiltRadians,
          orientationRadians = scratchInput.orientationRadians,
          strokeUnitLengthCm = scratchInput.strokeUnitLengthCm,
        )
      )
    }

    val toolType =
      when (inputs.getToolType()) {
        InputToolType.STYLUS -> SerializedToolType.STYLUS
        InputToolType.TOUCH -> SerializedToolType.TOUCH
        InputToolType.MOUSE -> SerializedToolType.MOUSE
        else -> SerializedToolType.UNKNOWN
      }

    return SerializedStrokeInputBatch(
      toolType = toolType,
      strokeUnitLengthCm = inputs.getStrokeUnitLengthCm(),
      inputs = serializedInputs,
    )
  }

  private fun deserializeStroke(serializedStroke: SerializedStroke): Stroke? {
    val inputs = deserializeStrokeInputBatch(serializedStroke.inputs) ?: return null
    val brush = deserializeBrush(serializedStroke.brush) ?: return null
    return Stroke(brush = brush, inputs = inputs)
  }

  private fun deserializeBrush(serializedBrush: SerializedBrush): Brush {
    val stockBrushFamily = enumToStockBrush[serializedBrush.stockBrush] ?: StockBrushes.markerV1

    return Brush.createWithColorLong(
      family = stockBrushFamily,
      colorLong = serializedBrush.color,
      size = serializedBrush.size,
      epsilon = serializedBrush.epsilon,
    )
  }

  private fun deserializeStrokeInputBatch(
    serializedBatch: SerializedStrokeInputBatch
  ): StrokeInputBatch {
    val toolType =
      when (serializedBatch.toolType) {
        SerializedToolType.STYLUS -> InputToolType.STYLUS
        SerializedToolType.TOUCH -> InputToolType.TOUCH
        SerializedToolType.MOUSE -> InputToolType.MOUSE
        else -> InputToolType.UNKNOWN
      }

    val batch = MutableStrokeInputBatch()

    serializedBatch.inputs.forEach { input ->
      batch.addOrThrow(
        type = toolType,
        x = input.x,
        y = input.y,
        elapsedTimeMillis = input.timeMillis.toLong(),
        pressure = input.pressure,
        tiltRadians = input.tiltRadians,
        orientationRadians = input.orientationRadians,
      )
    }

    return batch
  }

  fun serializeStrokeToEntity(stroke: Stroke): StrokeEntity {
    val serializedBrush = serializeBrush(stroke.brush)
    val serializedInputs = serializeStrokeInputBatch(stroke.inputs)
    return StrokeEntity(
      brushSize = serializedBrush.size,
      brushColor = serializedBrush.color,
      brushEpsilon = serializedBrush.epsilon,
      stockBrush = serializedBrush.stockBrush,
      strokeInputs = gson.toJson(serializedInputs),
    )
  }

  fun deserializeEntityToStroke(entity: StrokeEntity): Stroke {
    val serializedBrush =
      SerializedBrush(
        size = entity.brushSize,
        color = entity.brushColor,
        epsilon = entity.brushEpsilon,
        stockBrush = entity.stockBrush,
      )

    val serializedInputs =
      gson.fromJson(entity.strokeInputs, SerializedStrokeInputBatch::class.java)

    val brush = deserializeBrush(serializedBrush)
    val inputs = deserializeStrokeInputBatch(serializedInputs)

    return Stroke(brush = brush, inputs = inputs)
  }

  fun brushToString(brush: Brush): String {
        val serializedBrush = serializeBrush(brush)
        return gson.toJson(serializedBrush)
    }

  fun stringToBrush(jsonString: String): Brush {
        val serializedBrush = gson.fromJson(jsonString, SerializedBrush::class.java)
        return deserializeBrush(serializedBrush)
    }

}