-
Notifications
You must be signed in to change notification settings - Fork 396
Anr snippets #986
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Anr snippets #986
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
e805edd
Add UI threading violation and context switching snippets
huewu b14acd1
Add UI threading violation and context switching snippets
huewu 5183cb8
Apply Spotless
huewu 0583469
Update misc/src/main/java/com/example/snippets/anr/ViewThreadingViola…
huewu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
69 changes: 69 additions & 0 deletions
69
misc/src/main/java/com/example/snippets/anr/ViewThreadingViolationSnippet.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Copyright 2026 The Android Open Source Project | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.snippets.anr | ||
|
|
||
| import android.view.View | ||
| import android.widget.TextView | ||
| import androidx.annotation.RequiresApi | ||
| import androidx.lifecycle.LifecycleOwner | ||
| import androidx.lifecycle.lifecycleScope | ||
| import kotlinx.coroutines.Dispatchers | ||
| import kotlinx.coroutines.launch | ||
| import kotlinx.coroutines.withContext | ||
|
|
||
| // Mock/stub classes so the documentation snippets compile cleanly. | ||
| interface MyData { | ||
| val title: String | ||
| } | ||
|
|
||
| interface MyRepository { | ||
| suspend fun getData(): MyData | ||
| } | ||
|
|
||
| @Suppress("unused") | ||
| object ViewThreadingViolationSnippet { | ||
|
|
||
| fun switchContext( | ||
| lifecycleOwner: LifecycleOwner, | ||
| myRepository: MyRepository, | ||
| myTextView: TextView | ||
| ) { | ||
| // [START android_view_threading_violation_coroutine_kotlin] | ||
| lifecycleOwner.lifecycleScope.launch(Dispatchers.IO) { | ||
| val data = myRepository.getData() | ||
| withContext(Dispatchers.Main) { // Switch context to Main | ||
| myTextView.text = data.title | ||
| } | ||
| } | ||
| // [END android_view_threading_violation_coroutine_kotlin] | ||
| } | ||
|
|
||
| @RequiresApi(37) | ||
|
huewu marked this conversation as resolved.
|
||
| fun checkViewThreadingViolation() { | ||
| // [START android_view_threading_violation_listener_kotlin] | ||
| val listener = object : View.CalledFromWrongThreadListener { | ||
| override fun onCalledFromWrongThread() { | ||
| // Handle the issue, e.g. crash if this is a dev build, or log an event | ||
| // e.g. Log.d(TAG, "CalledFromWrongThread: ${Exception().stackTraceToString()}") | ||
| // Unregister the listener to avoid redundant notifications for the same issue | ||
| View.unregisterCalledFromWrongThreadListener(this) | ||
| } | ||
| } | ||
| View.registerCalledFromWrongThreadListener(listener) | ||
| // [END android_view_threading_violation_listener_kotlin] | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Chansuk! Thanks for adding new snippets!
One comment: We're actually discouraging folks from adding to the misc module (because it's getting quite big as a catch-all for everything), and directing people to add to other more-specific modules instead.
What do you think about moving this to the existing "view" module in the snippets repo? you can add a new "anr" folder under there if you'd like.
https://github.com/android/snippets/tree/main/views/src/main/java
Other than that, the change looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SGTM. Will move to view module and send a new PR : )