Maîtriser le contexte Android

Le contexte dans Android est l'un des objets les plus utilisés et les plus maltraités. Mais la plupart des articles sur le Web se concentrent sur la définition de ce que c'est. Je n'ai pas pu trouver une bonne ressource qui m'a donné un aperçu et m'a aidé à comprendre la situation dans son ensemble. J'ai donc essayé de simplifier les choses avec cet article.

Préface

Ma mission pour cet article est de vous aider à maîtriser le contexte Android. C'est l'un des thèmes centraux du développement Android, et pratiquement aucun développeur n'utilise complètement le contexte et de la manière dont il a été conçu.

J'ai initialement publié cet article comme une série de quatre articles sur mon site Web. Si vous souhaitez lire chapitre par chapitre, n'hésitez pas à y lire.

Commencer

Avez - vous déjà rencontré cette question: Quelle est la différence entre getContext(), this, getBaseContext()et getApplicationContext()? Si oui, cet article vous aidera à clarifier la plupart de votre confusion.

Remarque: vous devez connaître les bases du développement Android, telles que l'activité, les fragments, le récepteur de diffusion et d'autres blocs de construction. Si vous êtes un nouveau développeur qui ne fait que commencer votre voyage dans le monde Android, ce n'est peut-être pas le meilleur endroit pour commencer.

Qu'est-ce que le contexte?

Avouons-le, le contexte est l'une des fonctionnalités les plus mal conçues de l'API Android. Vous pouvez l'appeler l'objet «Dieu».

Une application Android ou un kit de package d'application (APK) est un ensemble de composants. Ces composants sont définis dans le manifeste et consistent principalement en activité (UI), service (arrière-plan), BroadcastReceiver (action), ContentProvider (données) et ressources (images, chaînes, etc.).

Le développeur peut choisir d'exposer ces composants à un système à l'aide d'un filtre d'intention. Par exemple: envoyer un e-mail ou partager une photo. Ils peuvent également choisir d'exposer les composants uniquement à d'autres composants de leur application.

De même, le système d'exploitation Android a également été conçu pour exposer des composants. Quelques-uns bien connus sont WifiManager, Vibrator et PackageManager.

Le contexte est le pont entre les composants. Vous l'utilisez pour communiquer entre les composants, instancier des composants et accéder aux composants.

Vos propres composants

Nous utilisons le contexte pour instancier nos composants avec Activity, Content Provider, BroadcastReceiver, etc. Nous l'utilisons également pour accéder aux ressources et aux systèmes de fichiers.

Votre composant et un composant système

Le contexte agit comme un point d'entrée vers le système Android. Certains composants système bien utilisés sont WifiManager, Vibrator et PackageManager. Vous pouvez accéder à WifiManager en utilisant context.getSystemService(Context.WIFI_SERVICE).

De la même manière, vous pouvez utiliser le contexte pour accéder au système de fichiers dédié à votre application en tant qu'utilisateur dans OS.

Votre propre composant et un autre composant de l'application

La communication entre vos propres composants et les autres composants de l'application est presque identique si vous utilisez l'approche du filtre d'intention. Après tout, chaque composant est un citoyen égal dans Android.

Un exemple d'intention utilisée pour envoyer un e-mail est présenté ci-dessous. Tous les composants qui offrent cette action d'intention seront servis à l'utilisateur qui peut choisir quoi utiliser.

Intent emailIntent = new Intent(android.content.Intent.ACTION_SEND);

Sommaire

Admettons que tout dans Android est un composant. Le contexte est le pont entre les composants. Vous l'utilisez pour communiquer entre les composants, instancier des composants et accéder aux composants. J'espère que la définition est maintenant claire.

Différents types de contexte

Il existe de nombreuses façons de saisir le contexte ( mauvaise conception repérée ).

La plupart du temps, nous utilisons l'un des éléments suivants lorsque nous avons besoin de contexte:

- Application instance as context- Activity - Instance of your activity (this) - getApplicationContext() in Activity - getBaseContext() in Activity- Fragment - getContext() in Fragment- View - getContext() in View- Broadcast Receiver - Context received in broadcast receiver- Service - Instance of your service (this) - getApplicationContext() in Service- Context - getApplicationContext() in Context instance

Je divise les types de contexte en deux catégories: Contexte d'interface utilisateur et Contexte non d'interface utilisateur . Cette distinction vous aidera à comprendre n-waysun peu mieux.

Contexte de l'interface utilisateur

En réalité, seul le ContextThemeWrapper est le contexte de l'interface utilisateur - ce qui signifie le contexte + votre thème .

L'activité s'étend ContextThemeWrapper. C'est la raison pour laquelle, lorsque vous gonflez du XML, vos vues sont thématiques. Si vous gonflez votre mise en page avec un contexte non-UI, votre mise en page ne sera pas thématisée. Allez-y, essayez-le.

Lorsque vous utilisez Activity comme espace réservé pour le contexte, vous êtes assuré d'utiliser le contexte de l'interface utilisateur. Si vous utilisez la méthode getContext de Fragment, vous utilisez indirectement Activity (si vous avez attaché Fragment via fragmentManager en activité).

Mais il view.getContext()n'est pas garanti que ce soit le contexte de l'interface utilisateur.

Si View a été instancié à l'aide de Layout Inflater et passé le contexte d'interface utilisateur, vous récupérez le contexte d'interface utilisateur. Mais s'il a été instancié en ne passant pas le contexte d'interface utilisateur, vous récupérez l'autre contexte.

UI Context- Activity - Instance of your activity (this)- Fragment - getContext() in Fragment- View - getContext() in View (if View was constructed using UI-Context)

Contexte non-UI

Anything except UI Context is Non-UI Context. Technically, anything which is not ContextThemeWrapper is Non-UI Context.

Non-UI Context is allowed do almost everything UI-Context can do (bad design spotted). But as we pointed out above, you lose theming.

Non-UI Context- Application instance as context- Activity - getApplicationContext() in Activity- Broadcast Receiver - Context received in broadcast receiver- Service - Instance of your service (this) - getApplicationContext() in Service- Context - getApplicationContext() in Context instance

Tip: All context types are supposed to be short lived except Application context. This is the one you get from your application class or from using the getApplicationContext() method when you have context access.

Summary

We have simplified it a little bit by putting Context in two buckets. UI Context is Context + Theming, and technically any class which is a subclass of ContextThemeWrapper comes in this bucket. Non-UI Context is all other types of Context.

Where to use what

The question arises: what will go wrong if you use context in the wrong place? Following are a few scenarios:

Scenario 1

Lets say you are inflating a layout and you use Non-UI Context. What may go wrong? You can guess in this case: you will not get a themed layout. Not so bad, hmm? It’s bearable.

Scenario 2

You pass UI-Context to someplace where all it needs is resource access or file system access. What can no wrong? Short Answer: Nothing. Remember, UI-Context = Context + Theme. It will gladly serve as context for you.

Scenario 3

You pass UI-Context to someplace where all it needs is resource access or file system access but it is a long operation in the background. Say downloading a file. Now what can go wrong? Short Answer: Memory leak.

If you are lucky and download completes quickly, the object is released and everything is fine. Sun is shining and birds are chirping. This is one of the most common mistakes developers make. They pass the reference of UI-Context to long living objects, and sometimes it has zero side effect.

However, sometimes Android wants to claim memory for either one of your next component’s requirements or another component’s requirements, and woooshhhh!!! You run out of memory in your app. Don’t worry, I will explain.

Memory Leak or Crash! That’s it.

Yes this is the worst case scenario when you use context in the wrong place. If you are new to the app development world, let me share some wisdom. Memory leaks are inversely proportional to your experience. Every Android developer has leaked memory. There is no shame in doing so.

Shame is when you repeat the mistake again and leak it the same way. If you leak memory a different way every time, congrats you are growing. I have explained what a Memory leak is with a short story here.

Okay I get it, but what is the relation of Context here?

Say it aloud, “Bad Design Spotted".

Almost everything in Android needs access to Context. Naive developers pass UI Context, because that’s what they have access to very easily. They pass short-living context (usually Activity context) to long living objects and before the memory/money is returned back to system, they hit a crisis. Woooshhh!!!

The simplest way to deal with this is with Async Task or Broadcast Receiver. But discussing them isn’t in the scope of this article.

Summary

  • Do you need to access UI related stuff? Use UI-Context. Inflating Views and showing dialogue are the two use cases I can think of.
  • Otherwise, Use Non UI Context.
  • Make sure you do not pass short-living context to long-living objects.
  • Pass knowledge, help people, plant trees and invite me for a coffee.

Tips and Tricks

What is the difference between this, getApplicationContext() and getBaseContext()?

This is one question every Android developer have encountered in their lives. I will try to simplify it as much as possible. Let’s take a step back and revisit the basics.

We know there are many factors in mobile devices. For instance, configuration changes all the time, and locale can change explicitly or implicitly.

All of these changes trigger apps to re-create so they can pick the right resources that are the best match to their current configuration. Portrait, Landscape, Tablet, Chinese, German, and so on. Your app needs the best possible resources to deliver the best user experience. It is the Context which is responsible for delivering those best match resources.

Try answering this question:

The user’s configuration is currently in portrait and you want to access landscape resources. Or the user locale is en and you want to access uk resources. How will you do it?

Below are some magical methods from Context:

There are many createX methods, but we are mainly interested in createConfigurationContext. Here is how you can use it:

Configuration configuration = getResources().getConfiguration();configuration.setLocale(your_custom_locale);context = createConfigurationContext(configuration);

You can get a hold of any type of Context you desire. When you call any method on the new Context you just got, you will get access to resources based on the configuration you had set.

I know it is amazing. You can send me thank you card.

Similarly, you can create a Themed Context and use it to inflate views with the theme you want.

ContextThemeWrapper ctw = new ContextThemeWrapper(this, R.style.YOUR_THEME);

Let’s come back to the tricky question we asked above and discuss Activity Context.

What is the difference between this, getApplicationContext()and getBaseContext()?

These are the possible ways you can get a hold on Context when you are in the Activity scope.

thispoints to Activity itself, our UI Context and short life context. getApplicationContext() points to your application instance which is Non-UI and long living context.

baseContext is the base of your Activity Context which you can set using a delegate pattern. You already know you can create Context with any xyz configuration you want. You can combine your xyz configuration knowledge with Base Context and your Activity will load resources as you desire.

Here is the method you can use:

@Overideprotected void attachBaseContext (Context base) {super.attachBaseContext(useYourCustomContext);}

Once BaseContext is attached, your Activity will delegate calls to this object. If you do not attach to Activity, it remains baseContext and you get Activity when you call getBaseContext.

Conclusion

We can say Context is the life of your android app. From Android’s point of view, it is your app. You can do almost nothing without Context. Without it, your app is plain Java code.

Context + Java code => Android

Good or bad, it is the design we have and we have to make the best of it. From the first part of this article, we learned that we use it to communicate between components, instantiate components, and access components.

In the next part, we learned that Context can be UI or NonUI, Short Lived or Long lived.

Following that, we learned that you need to choose context carefully otherwise you have to deal with memory leaks and other UI issues.

Finally, you saw that Context is responsible for loading best match resources for your app and you can configure it as you want. We also learned the difference between this, applicationContext and baseContext.

Many developers will advise you to use only application context. Do not use Application Context everywhere from the fear of a memory leak. Understand the root cause and always use the right Context in the right place.

You, my dear friend, are a master of Android Context now. You can suggest the next topic you want to understand. Click here to suggest.

Below are links from the original Series Mastering Android Contexton my blog.

Chapter 1

What the heck is Context? Why do we need it and what are various use cases in day to day development?

Chapter 2

Simplifying Context. We will discuss how many types of context are there and which ones are you suppose to use.

Chapter 3

Where to use UI Context and where to use Non UI-Context. How using context at wrong place may lead to memory leaks.

Chapter 4

My UI Context also offers me multiple types of context. Let’s answer this question and see how to avoid common pitfalls.

Training

Do you know that many times your app is crashing because your developers are not using Context properly? Let’s learn together. I offer training in Android, Java, and Git.

Want to master Android themes? Check out our series with more than 3k upvotes.

Feel free to share your feedback and questions. Happy Coding.

Follow me on Medium and Twitter for updates.