Sự kiện giao diện người dùng (Khung hiển thị)

Các khái niệm và cách triển khai Jetpack Compose

Sự kiện giao diện người dùng là các hành động cần được giao diện người dùng hoặc ViewModel xử lý trong lớp giao diện người dùng. Loại sự kiện phổ biến nhất là sự kiện của người dùng. Người dùng tạo sự kiện của người dùng bằng cách tương tác với ứng dụng, ví dụ: bằng cách nhấn vào màn hình hoặc tạo cử chỉ. Sau đó, giao diện người dùng sẽ xử lý các sự kiện này bằng các lệnh gọi lại, chẳng hạn như trình nghe onClick().

ViewModel thường chịu trách nhiệm xử lý logic kinh doanh của một sự kiện của người dùng cụ thể—ví dụ: người dùng nhấp vào một nút để làm mới một số dữ liệu. Thông thường, ViewModel xử lý vấn đề này bằng cách hiển thị các hàm mà giao diện người dùng có thể gọi. Sự kiện của người dùng cũng có thể có logic của hoạt động trên giao diện người dùng mà giao diện người dùng có thể xử lý trực tiếp—ví dụ: chuyển đến một màn hình khác hoặc hiển thị Snackbar.

Mặc dù logic nghiệp vụ vẫn giữ nguyên cho cùng một ứng dụng trên nhiều kiểu dáng hoặc nền tảng thiết bị di động, nhưng logic của hành vi trên giao diện người dùng là các nội dung chi tiết triển khai có thể khác nhau giữa những trường hợp đó. Trang lớp giao diện người dùng xác định các loại logic sau:

  • Logic nghiệp vụ cho biết việc nên làm với những thay đổi về trạng thái, chẳng hạn như thanh toán hoặc lưu trữ các lựa chọn ưu tiên của người dùng. Các lớp miền và lớp dữ liệu thường xử lý logic này. Xuyên suốt hướng dẫn này, lớp Các thành phần cấu trúc ViewModel được dùng làm giải pháp quan trọng cho các lớp xử lý logic kinh doanh.
  • Logic của hoạt động giao diện người dùng hoặc logic giao diện người dùng đề cập đến cách hiển thị các thay đổi về trạng thái—ví dụ: logic điều hướng hoặc cách hiển thị thông báo cho người dùng. Giao diện người dùng xử lý logic này.

Xử lý sự kiện của người dùng

Giao diện người dùng có thể trực tiếp xử lý các sự kiện của người dùng nếu những sự kiện đó liên quan đến việc sửa đổi trạng thái của một thành phần trên giao diện người dùng—ví dụ: trạng thái của một mục có thể mở rộng. Nếu sự kiện yêu cầu thực hiện logic kinh doanh, chẳng hạn như làm mới dữ liệu trên màn hình, thì sự kiện này sẽ do ViewModel xử lý.

Ví dụ sau đây cho thấy cách các nút khác nhau được dùng để mở rộng thành phần trên giao diện người dùng (logic giao dịch người dùng) và làm mới dữ liệu trên màn hình (logic kinh doanh):

class LatestNewsActivity : AppCompatActivity() {

    private lateinit var binding: ActivityLatestNewsBinding
    private val viewModel: LatestNewsViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        /* ... */

        // The expand details event is processed by the UI that
        // modifies a View's internal state.
        binding.expandButton.setOnClickListener {
            binding.expandedSection.visibility = View.VISIBLE
        }

        // The refresh event is processed by the ViewModel that is in charge
        // of the business logic.
        binding.refreshButton.setOnClickListener {
            viewModel.refreshNews()
        }
    }
}

Sự kiện của người dùng trong RecyclerViews

Nếu hành động được tạo tiếp theo trong cây giao diện người dùng, chẳng hạn như trong mục RecyclerView hoặc View tuỳ chỉnh, thì ViewModel vẫn phải là mã xử lý các sự kiện của người dùng.

Ví dụ: giả sử tất cả các mục tin tức từ NewsActivity đều chứa một nút đánh dấu trang. ViewModel cần biết mã nhận dạng của mục tin tức được đánh dấu. Khi người dùng đánh dấu một mục tin tức, trình chuyển đổi RecyclerView không gọi hàm addBookmark(newsId) hiển thị từ ViewModel. Việc này sẽ yêu cầu phần phụ thuộc vào ViewModel. Thay vào đó, ViewModel hiển thị một đối tượng trạng thái có tên là NewsItemUiState chứa nội dung triển khai để xử lý sự kiện:

data class NewsItemUiState(
    val title: String,
    val body: String,
    val bookmarked: Boolean = false,
    val publicationDate: String,
    val onBookmark: () -> Unit
)

class LatestNewsViewModel(
    private val formatDateUseCase: FormatDateUseCase,
    private val repository: NewsRepository
)
    val newsListUiItems = repository.latestNews.map { news ->
        NewsItemUiState(
            title = news.title,
            body = news.body,
            bookmarked = news.bookmarked,
            publicationDate = formatDateUseCase(news.publicationDate),
            // Business logic is passed as a lambda function that the
            // UI calls on click events.
            onBookmark = {
                repository.addBookmark(news.id)
            }
        )
    }
}

Bằng cách này, trình chuyển đổi RecyclerView chỉ hoạt động với dữ liệu cần thiết: danh sách các đối tượng NewsItemUiState. Trình chuyển đổi không có quyền truy cập vào toàn bộ ViewModel, nên ít có khả năng bộ lọc sẽ sử dụng sai chức năng mà ViewModel hiển thị. Khi bạn chỉ cho phép lớp hoạt động làm việc với ViewModel, thì bạn tách riêng các trách nhiệm. Điều này đảm bảo rằng các đối tượng dành riêng cho giao diện người dùng như chế độ xem hoặc trình chuyển đổi RecyclerView không tương tác trực tiếp với ViewModel.

Quy ước đặt tên cho các hàm sự kiện của người dùng

Trong hướng dẫn này, các hàm ViewModel xử lý các sự kiện của người dùng được đặt tên bằng một động từ dựa trên hành động mà các hàm đó xử lý–ví dụ: addBookmark(id) hoặc logIn(username, password).

Xử lý sự kiện ViewModel

Các hành động trên giao diện người dùng bắt nguồn từ ViewModel–sự kiện ViewModel phải–luôn dẫn đến việc cập nhật trạng thái giao diện người dùng. Điều này tuân thủ các nguyên tắc về Luồng dữ liệu một chiều. Điều này giúp các sự kiện có thể tái tạo sau khi thay đổi cấu hình và đảm bảo rằng các hành động trên giao diện người dùng sẽ không bị mất. Nếu muốn, bạn cũng có thể tạo các sự kiện có thể tái tạo sau quá trình bị gián đoạn nếu sử dụng mô-đun trạng thái đã lưu.

Việc liên kết các hành động trên giao diện người dùng với trạng thái giao diện người dùng không phải lúc nào cũng là một quy trình đơn giản, nhưng quy trình này sẽ dẫn đến logic đơn giản hơn. Ví dụ: Quy trình tư duy của bạn không nên kết thúc bằng việc xác định cách giao diện người dùng điều hướng trên một màn hình cụ thể. Bạn cần suy nghĩ thêm và xem xét cách thể hiện luồng người dùng đó trong trạng thái giao diện người dùng. Nói cách khác, đừng nghĩ về những hành động mà giao diện người dùng cần thực hiện, hãy nghĩ về các hành động đó ảnh hưởng như thế nào đến trạng thái giao diện người dùng.

Ví dụ: hãy xem xét trường hợp điều hướng đến màn hình chính khi người dùng đăng nhập trên màn hình đăng nhập. Bạn có thể thiết lập dữ liệu này ở trạng thái giao diện người dùng như sau:

data class LoginUiState(
    val isLoading: Boolean = false,
    val errorMessage: String? = null,
    val isUserLoggedIn: Boolean = false
)

Giao diện người dùng này phản ứng với các thay đổi của trạng thái isUserLoggedIn và chuyển đến đúng đích đến nếu cần:

class LoginViewModel : ViewModel() {
    private val _uiState = MutableStateFlow(LoginUiState())
    val uiState: StateFlow<LoginUiState> = _uiState.asStateFlow()
    /* ... */
}

class LoginActivity : AppCompatActivity() {
    private val viewModel: LoginViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        /* ... */

        lifecycleScope.launch {
            repeatOnLifecycle(Lifecycle.State.STARTED) {
                viewModel.uiState.collect { uiState ->
                    if (uiState.isUserLoggedIn) {
                        // Navigate to the Home screen.
                    }
                    ...
                }
            }
        }
    }
}

Việc sử dụng các sự kiện có thể kích hoạt cập nhật trạng thái

Việc sử dụng một số sự kiện ViewModel trong giao diện người dùng có thể dẫn đến các lần cập nhật trạng thái giao diện người dùng khác. Ví dụ: khi hiển thị các thông báo tạm thời trên màn hình để người dùng biết rằng đã có sự kiện xảy ra, thì giao diện người dùng cần phải thông báo cho ViewModel để kích hoạt một nội dung cập nhật trạng thái khác khi thông báo đã hiển thị trên màn hình. Sự kiện xảy ra khi người dùng sử dụng thông báo (bằng cách loại bỏ thông báo hoặc sau khi hết thời gian chờ) có thể được coi là "dữ liệu do người dùng nhập" và do đó, ViewModel cần biết điều đó. Trong trường hợp này, trạng thái giao diện người dùng có thể được lập mô hình như sau:

// Models the UI state for the Latest news screen.
data class LatestNewsUiState(
    val news: List<News> = emptyList(),
    val isLoading: Boolean = false,
    val userMessage: String? = null
)

ViewModel sẽ cập nhật trạng thái giao diện người dùng như sau khi logic nghiệp vụ yêu cầu hiển thị một thông báo tạm thời mới cho người dùng:

class LatestNewsViewModel(/* ... */) : ViewModel() {

    private val _uiState = MutableStateFlow(LatestNewsUiState(isLoading = true))
    val uiState: StateFlow<LatestNewsUiState> = _uiState

    fun refreshNews() {
        viewModelScope.launch {
            // If there isn't internet connection, show a new message on the screen.
            if (!internetConnection()) {
                _uiState.update { currentUiState ->
                    currentUiState.copy(userMessage = "No Internet connection")
                }
                return@launch
            }

            // Do something else.
        }
    }

    fun userMessageShown() {
        _uiState.update { currentUiState ->
            currentUiState.copy(userMessage = null)
        }
    }
}

ViewModel không cần phải biết cách giao diện người dùng hiển thị thông báo trên màn hình mà chỉ biết rằng cần phải hiển thị một thông báo cho người dùng. Sau khi thông báo tạm thời hiển thị, giao diện người dùng cần thông báo cho ViewModel về điều đó, dẫn đến việc cập nhật trạng thái giao diện người dùng khác để xoá thuộc tính userMessage:

class LatestNewsActivity : AppCompatActivity() {
    private val viewModel: LatestNewsViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        /* ... */

        lifecycleScope.launch {
            repeatOnLifecycle(Lifecycle.State.STARTED) {
                viewModel.uiState.collect { uiState ->
                    uiState.userMessage?.let {
                        // TODO: Show Snackbar with userMessage.

                        // Once the message is displayed and
                        // dismissed, notify the ViewModel.
                        viewModel.userMessageShown()
                    }
                    ...
                }
            }
        }
    }
}

Mặc dù thông báo chỉ mang tính tạm thời, nhưng trạng thái giao diện người dùng phản ánh chính xác nội dung hiển thị trên màn hình tại mỗi thời điểm. Thông báo cho người dùng sẽ hiển thị hoặc không.

Phần Việc sử dụng các sự kiện có thể kích hoạt nội dung cập nhật trạng thái nêu chi tiết cách bạn dùng trạng thái giao diện người dùng để hiển thị thông báo cho người dùng trên màn hình. Sự kiện điều hướng cũng là một loại sự kiện phổ biến trong ứng dụng Android.

Nếu sự kiện đó được kích hoạt trong giao diện người dùng do người dùng nhấn vào một nút, thì giao diện người dùng sẽ xử lý vấn đề đó bằng cách gọi trình điều khiển hoạt động điều hướng.

class LoginActivity : AppCompatActivity() {

    private lateinit var binding: ActivityLoginBinding
    private val viewModel: LoginViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        /* ... */

        binding.helpButton.setOnClickListener {
            navController.navigate(...) // Open help screen
        }
    }
}

Nếu việc nhập dữ liệu yêu cầu xác thực logic kinh doanh trước khi điều hướng, ViewModel cần hiển thị trạng thái đó cho giao diện người dùng. Giao diện người dùng sẽ phản ứng với sự thay đổi về trạng thái đó và điều hướng cho phù hợp. Phần Xử lý các sự kiện ViewModel trình bày về trường hợp sử dụng này. Dưới đây là mã tương tự:

class LoginActivity : AppCompatActivity() {
    private val viewModel: LoginViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        /* ... */

        lifecycleScope.launch {
            repeatOnLifecycle(Lifecycle.State.STARTED) {
                viewModel.uiState.collect { uiState ->
                    if (uiState.isUserLoggedIn) {
                        // Navigate to the Home screen.
                    }
                    ...
                }
            }
        }
    }
}

Trong ví dụ trên, ứng dụng hoạt động như mong đợi vì đích đến hiện tại, Login (Đăng nhập), sẽ không được lưu giữ trong ngăn xếp lui. Người dùng không thể quay lại nếu nhấn vào nút Quay lại. Tuy nhiên, trong trường hợp điều đó có thể xảy ra, giải pháp sẽ yêu cầu thêm logic.

Khi ViewModel đặt trạng thái để tạo sự kiện điều hướng từ màn hình A sang màn hình B và màn hình A được giữ lại trong ngăn xếp lui điều hướng, bạn có thể cần thêm logic để không tự động chuyển sang B. Để triển khai việc này, bạn phải đặt trạng thái bổ sung để cho biết giao diện người dùng có nên cân nhắc chuyển sang màn hình khác hay không. Thông thường, trạng thái đó được lưu giữ trong giao diện người dùng vì logic Điều hướng liên quan đến giao diện người dùng, chứ không phải ViewModel. Để minh hoạ điều này, hãy xem xét trường hợp sử dụng sau.

Giả sử bạn đang thực hiện quy trình đăng ký trong ứng dụng. Trên màn hình xác thực ngày sinh, khi người dùng nhập một ngày, ViewModel sẽ xác thực ngày đó khi người dùng nhấn vào nút "Tiếp tục". ViewModel uỷ quyền logic xác thực cho lớp dữ liệu. Nếu ngày này hợp lệ, người dùng sẽ chuyển sang màn hình tiếp theo. Ngoài ra, người dùng cũng có thể quay lại và chuyển giữa các màn hình đăng ký nếu muốn thay đổi một số dữ liệu. Do đó, tất cả các đích đến trong quy trình đăng ký đều được lưu giữ trong cùng một ngăn xếp lui. Với các yêu cầu này, bạn có thể triển khai màn hình này như sau:

// Key that identifies the `validationInProgress` state in the Bundle
private const val DOB_VALIDATION_KEY = "dobValidationKey"

class DobValidationFragment : Fragment() {

    private var validationInProgress: Boolean = false
    private val viewModel: DobValidationViewModel by viewModels()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        val binding = // ...
        validationInProgress = savedInstanceState?.getBoolean(DOB_VALIDATION_KEY) ?: false

        binding.continueButton.setOnClickListener {
            viewModel.validateDob()
            validationInProgress = true
        }

        viewLifecycleOwner.lifecycleScope.launch {
            viewModel.uiState
                .flowWithLifecycle(viewLifecycleOwner.lifecycle)
                .collect { uiState ->
                    // Update other parts of the UI ...

                    // If the input is valid and the user wants
                    // to navigate, navigate to the next screen
                    // and reset `validationInProgress` flag
                    if (uiState.isDobValid && validationInProgress) {
                        validationInProgress = false
                        navController.navigate(...) // Navigate to next screen
                    }
                }
        }

        return binding
    }

    override fun onSaveInstanceState(outState: Bundle) {
        super.onSaveInstanceState(outState)
        outState.putBoolean(DOB_VALIDATION_KEY, validationInProgress)
    }
}

Ngày xác thực ngày sinh là logic kinh doanh do ViewModel chịu trách nhiệm. Trong hầu hết các trường hợp, ViewModel sẽ uỷ quyền logic đó cho lớp dữ liệu. Logic để điều hướng người dùng đến màn hình tiếp theo là logic giao diện người dùng vì các yêu cầu này có thể thay đổi tuỳ thuộc vào cấu hình giao diện người dùng. Ví dụ: bạn có thể không muốn tự động chuyển sang một màn hình khác trong máy tính bảng nếu đang hiển thị nhiều bước đăng ký cùng một lúc. Biến validationInProgress trong mã ở trên sẽ triển khai chức năng này và xử lý xem giao diện người dùng có tự động điều hướng bất cứ khi nào ngày sinh hợp lệ hay không và người dùng muốn chuyển sang bước đăng ký tiếp theo.