جت‌پک کامپوز در اندروید: نگهداری داده ها در State به همراه مثال

جت‌پک کامپوز در اندروید: نگهداری داده ها در State به همراه مثال

بررسی State

State یعنی وضعیت؛ در جت‌پک کامپوز زمانی که مقدار یک متغیر یا داده تغییر کنه، کلاس State به Composable مورد نظر اطلاع میده که مقدار داده تغییر کرده و با داده ی جدید دوباره ترسیم شو! که به ترسیم دوباره ی Composable ها Recomposition گفته میشه.

برای ایجاد State توابع مختلفی در جت‌پک کامپوز تعریف شدن که در جدول زیر به بعضی از این توابع می‌پردازیم.

<<Functions>>
State
mutableStateOf(): MutableState<T> یک نمونه از MutableState رو بر میگردونه که داده ای از نوع T رو نگهداری می‌کنه.
mutableIntStateOf(): MutableIntState یک نمونه از MutableIntState رو برای نگهداری Int بر میگردونه.
mutableDoubleStateOf(): MutableDoubleState یک نمونه از MutableDoubleState رو برای نگهداری Double بر می‌گردونه.
mutableLongStateOf(): MutableLongState یک نمونه از MutableLongState رو برای نگهداری Long بر میگردونه.
mutableFloatStateOf(): MutableFloatState یک نمونه از MutableFloatState رو برای نگهداری Float بر میگردونه.
mutableStateListOf(): SnapshotStateList<T> یک نمونه از SnapshotStateList رو برای نگهداری MutableList<T> بر میگردونه.
mutableStateSetOf(): SnapshotStateSet<T> یک نمونه از SnapshotStateSet رو برای نگهداری MutableSet<T> بر میگردونه.
mutableStateMapOf(): SnapshotStateMap<K, V> یک نمونه از SnapshotStateMap رو برای نگهداری MutableMap<K, V> بر میگردونه.

ذخیره State هنگام Recomposition

هنگامی که مقدار متغیر در State تغییر کنه، Recomposition اتفاق می‌افته به عبارتی تابع Composable دوباره صدا زده میشه، در این حالت یک State جدید ایجاد و جایگزین State قبلی میشه و مقدار State ریست میشه، بنابراین برای ذخیره State باید از تابع remember یا rememberSaveable استفاده کنیم.

تابع remember

همانطور که گفتیم وظیفه این تابع ذخیره State و جلوگیری از جایگزینی آن با State جدید هنگام Recomposition است.

برای استفاده از remember کافیه یکی از توابع State رو داخل تابع remember صدا بزنیم.

@Composable
fun Counter(modifier: Modifier = Modifier){
    var count by remember {
        mutableIntStateOf(0)
    }

    //Other parts of code
}
                    

تابع rememberSaveable

تابع remember فقط مقادیر رو در طول Recomposition ذخیره میکنه و با از بین رفتن Composition یا بازسازی Activity (مثل چرخش صفحه) ممکنه State از بین بره بنابراین برای ذخیره State در این شرایط باید از rememberSaveable به‌جای remember استفاده کنیم.

@Composable
fun Counter(modifier: Modifier = Modifier){
    var count by rememberSaveable{
        mutableIntStateOf(0)
    }

    //Other parts of code
}
                    

در مثال زیر میخوایم برنامه با هربار کلیک کاربر یک واحد به مقدار count اضافه کنه و نمایش بده.

@Composable
fun Counter(modifier: Modifier = Modifier){
    var count by rememberSaveable{
        mutableIntStateOf(0)
    }

    Column(modifier = modifier.fillMaxSize(), horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.Center){
        Button(onClick = {
            count++
        }){
            Text("Increment")
        }

        Text(text = count.toString())
    }
}
                

الگوی State Hoisting

زمانی که یک تابع Composable رو داخل تابع Composable دیگه ای صدا میزنیم به تابعی که صدا زدیم فرزند (Child) و به اون یکی پدر (Parent) میگیم.

@Composable
fun Parent(){
    //ToDo something
    Child()
}

@Composable
fun Child(){
    //ToDo something
}
                

گاهی در برنامه لازمه State رو بجای Child در Parent تعریف کنیم، به این کار State Hoisting میگیم یعنی بالا بردن State و به Child اصطلاحا Stateless Composable میگیم.

در الگوی State Hoisting، وضعیت (State) داخل Parent ایجاد میشه، سپس توسط Child تغییر میکنه و در نهایت از Parent به Child برای نمایش ارسال میشه؛ در الگوی State Hoisting یک رابطه یک سویی (Unidirectional) بین Parent و Child وجود داره.

در زیر رابطه بین Parent و Child هنگام پیاده‌سازی State Hoisting آورده شده است.

رابطه بین Parent و Child هنگام پیاده‌سازی State Hoisting
رابطه بین Parent و Child هنگام پیاده‌سازی State Hoisting

فرض کنید میخوایم مثال Counter رو به صورت State Hoisting تعریف کنیم.

@Composable
fun CounterScreen(){
    var count by rememberSaveable{
        mutableIntStateOf(0)
    }

    Counter(count = count){
        count++
    }
}

@Composable
fun Counter(modifier: Modifier = Modifier, count: Int, onIncrement: () -> Unit){


    Column(modifier = modifier.fillMaxSize(), horizontalAlignment = Alignment.CenterHorizontally, verticalArrangement = Arrangement.Center){
        Button(onClick = onIncrement){
            Text("Increment")
        }

        Text(text = count.toString())
    }
}
                

قوانین استفاده از State Hoisting

  1. باید State در پایین ترین Composable تعریف بشه و حتی از الگوی State Hoisting استفاده نکنیم.
  2. اگه هردو Child و Parent به State نیاز داشته باشن State رو به سمت Parent بالا می بریم (در Parent تعریف می‌کنیم).
  3. اگه چند Composable به یک State نیاز داشته باشن باید State رو در پایین ترین Composable که Parent همه ی این چندتا Composable است تعریف کنیم.

مورد مطالعه (مثال) ها

میخوایم یک برنامه بنویسیم که کاربر با هربار تاس انداختن یک طرف تاس نمایش داده بشه؛ این برنامه در واقع یکی از مثال های وبسایت رسمی اندروید است که در اینجا به عنوان مثال پیادش میکنیم.

عکس تاس ها رو میتونید از اینجا دانلود کنید و همینطور برای یادگیری نحوه اضافه کردن عکس به منابع پروژه و استفاده از تابع Image به مطلب تابع Image در کامپوز مراجعه کنید.

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()
        setContent {
            DiceRollerTheme {
                Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
                    DiceRollerApp(modifier = Modifier.padding(innerPadding))
                }
            }
        }
    }
}

@Composable
fun DiceRollerApp(modifier: Modifier = Modifier) {
    DiceButtonWithImage(modifier)
}

@Composable
fun DiceButtonWithImage(modifier: Modifier) {
    var result by remember {
        mutableIntStateOf(roll())
    }
    val imageResource = when (result) {
        1 -> R.drawable.dice_1
        2 -> R.drawable.dice_2
        3 -> R.drawable.dice_3
        4 -> R.drawable.dice_4
        5 -> R.drawable.dice_5
        else -> R.drawable.dice_6
    }

    Column(
        horizontalAlignment = Alignment.CenterHorizontally,
        modifier = modifier
            .fillMaxSize()
            .wrapContentSize(Alignment.Center)
    ) {
        Image(
            painterResource(imageResource),
            contentDescription = result.toString()
        )
        Spacer(Modifier.height(16.dp))
        Button(
            onClick = {
                result = roll()
            },
            border = BorderStroke(1.dp, Color.Red),
            contentPadding = PaddingValues(32.dp),
        ) {
            Text(stringResource(R.string.roll), fontSize = 24.sp)
        }

    }
}

private fun roll(): Int {
    return (1..6).random()
}


@Preview
@Composable
fun DiceRollerAppPreview() {
    DiceRollerTheme {
        DiceRollerApp()
    }
}
                

سورس کد های برنامه رو میتونید در google-developer-training دانلود کنید.

خلاصه

  • با استفاده از State میتونیم Composable ها رو از تغییر مقدار داده باخبر کنیم.
  • برای حفظ تغییرات در State هنگام Recomposition از تابع remember یا rememberSaveable استفاده می کنیم.
  • زمانی که اکتیویتی به صورت موقت متوقف میشه (مثلا صفحه نمایش بچرخه) اگه بخوایم State رو حفظ کنیم بجای remember از rememberSaveable استفاده میکنیم.
  • به تعریف State در Parent و استفاده ازش در Child میگیم State Hoisting و به Child مورد نظر Stateless میگیم.
  • بهتره که State در پایین ترین Composable تعریف بشه و تا جای ممکن از State Hoisting استفاده نکنیم.

بازخورد و دیدگاه‌ ها

اولین نفری باشید که در این صفحه نظر می‌دهید

notifications برای اطلاع از جدیدترین مطالب و پست های مرتبط، عضو کانال تلگرام ما بشید.

arrow_drop_up
کپی شد!