How to Read Metadata from AndriodManifest File

Metadata tags are key-value pairs and one of the decent ways to access the API keys from the libraries. They are added to the AndroidManifest.xml under the application tag and are available through the PackageManager
.
If you have worked with third-party libraries or even with App shortcuts, Downloadable Fonts, Firebase MLKit, you may have come across metadata tags.

In the article, let’s add the metadata tags to the app module’s Manifest file and read the metadata key-values and the key-resource from a library module both in kotlin and java.

Add meta-data:

Add metadata to the app module's AndroidManifest.xml file under the application tag. You can add as many metadata elements as you want and you can also add metadata under the activity, service, broadcast receiver, content provider tags.

<meta-data

    android:name="com.gsrikar.library.LIBRARY_ACCESS_KEY"

    android:value="masndfiu4er9funwikesd" />

<meta-data

    android:name="com.gsrikar.library.LIBRARY_RESOURCE_KEY"

    android:resource="@array/cities"/>

The metadata tag has name, value, and resource. name should be unique and value or the resource is associated with the name. For simple data like strings, integers, float, booleans use value attribute and for XML resource ids use resource attribute.

In the first metadata, value is a string and in the second metadata, resource has reference to an array in the arrays.xml

Read the value from the meta-data tag:

Create a Library Module and an entry class for the library. Using the PackageManager we will try to read the metadata specified for the application. This object will be a bundle, so getting a string from it should be a familiar process.

Java:


@Nullable ApplicationInfo applicationInfo = null;

try {

    applicationInfo = context.getPackageManager()

            .getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
} catch (PackageManager.NameNotFoundException e) {

    e.printStackTrace();

}



@Nullable String apiKey = null;

if (applicationInfo != null) {

    // Get the value from the key

    apiKey = applicationInfo.metaData.getString("com.gsrikar.library.LIBRARY_ACCESS_KEY");

}



if (apiKey != null) {

    if (DBG) Log.d(TAG, "Api Key: " + apiKey);

}

Kotlin:

context.packageManager

    .getApplicationInfo(context.packageName, PackageManager.GET_META_DATA)

    .apply {

        val apiKey = metaData.getString("com.gsrikar.library.LIBRARY_ACCESS_KEY")

        if (DBG) Log.d(TAG, "Api Key: $apiKey")

    }

Read the resource from the meta-data tag

Add the cities array to arrays.xml

<array name="cities">
    <item>Bangalore</item>
    <item>Hyderabad</item>
    <item>Chennai</item>
    <item>New York</item>
    <item>Los Angeles</item>
    <item>London</item>
</array>

When reading the resource from a bundle we have to look for the integer id first and then using it to get the resource. Since the resource id has a reference string array, we can get it using getStringArray().

Java:

// Get the resource id

final int resourceId = metaData.getInt("com.gsrikar.library.LIBRARY_RESOURCE_KEY");

// Get the list of cities

final String[] cityArray = context.getResources().getStringArray(resourceId);

// Print the list of cities to logcat

for (final String city : cityArray) {

    Log.d(TAG, "City Name: " + city);

}

Kotlin:

// Get the list of cities

val resourceId = metaData.getInt("com.gsrikar.library.LIBRARY_RESOURCE_KEY")

val cities = context.resources.getStringArray(resourceId)

cities.forEach { Log.d(TAG, "City: $it") }

If you are having trouble understanding the article or want to explore the code yourself, feel free to clone the Read Manifest project on Github.

Popular posts from this blog

How to Change Material Chip Text Size, Text Style and Font

Chips in Android is a Material Design Component used primarily for actions or choice or during filters or as an input. The attributes like textColor , textStyle and fontFamily are ignored when added to the Material Chips directly. We need to modify these values using textAppearance . <com.google.android.material.chip.Chip android:id="@+id/maleChip" style="@style/Widget.MaterialComponents.Chip.Choice" android:layout_width="wrap_content" android:layout_height="wrap_content" android:checkable="true" android:layoutDirection="locale" android:text="@string/chip_text_male" android:textAppearance="@style/AppTheme.GenderChip" android:textColor="@color/colorWhiteText" app:chipBackgroundColor="@drawable/select_chip" app:chipEndPadding="@dimen/chip_horizontal_margin" app:chipStartPadding="@dimen/chip_horizontal_margin&quo
Read more

Create Assets Folder, Add Files and Read Data From It

Image
Sometimes, we need to read the data stored in the files during runtime and want to make sure the data is not tampered by the Android build system. In this article, we will take a look at how to create the assets folder using Android Studio and read the stored data from it. First, Right-click on the module name or the package name. This opens an option window where we need to select the Assets Folder option by hovering over New and then on the Folder option. Now, we will see a window where we change the folder location and the source set. Change the values if necessary otherwise keep the defaults and click Finish. It may trigger a Gradle Sync. Irrespective of the sync, the Assets folder is created and is visible in the module. Now, Right-click on the Assets folder and click on the File option by hovering over the New option. Enter the name of the file name and click Enter to create the file. The file with the name user_details.json is created under the assets folder. Add some JSON
Read more

Add Spacing to Recycler View Linear Layout Manager Using Item Decoration

Image
In this article we will learn about, item decoration in Android and how we can use it to add even spacing between the child items. A RecyclerView without spacing will look like the image below but in most cases, we want to add spacing between the items. [You can see there are no margins between the views and only elevation] A more traditional option is adding margins in the list item xml file. If we take this route, we will soon end up with uneven spacing issues with vertical margins. [There are even left, right, top, bottom margins for all the rows except the last item in the first image and in the subsequent image, the top margin for the first item is half of the other items] The best way is to add the ItemDecoration to the RecyclerView as it affects the individual items and you can have more control over them. Kotlin: /** * Add vertical, horizontal spacing to the recycler view */ class DefaultItemDecorator(private val horizontalSpacing: Int,
Read more

Change Snackbar Position When Bottom App Bar or Bottom Navigation View Is Present

Image
The SnackBar is mainly used to provide feedback to the user and it is shown at the bottom of the screen. This UI element is used alongside Toast or as a replacement in some application. We typically show snack message as follows. // Show snack message Snackbar.make(binding.coordinatorLayout, message, LENGTH_SHORT) .show(); This works well as long as the screen does not contain the Bottom App Bar or the Bottom Navigation View. When we have the specified elements the Snack Message overlaps on the Bottom App Bar or ends up behind the Bottom Navigation View. This behavior is shown in the images below. To avoid such behavior we need to use setAnchorView method and pass id of a view. The Snack Message is shown on top of the view element with the specified id. // Show snack message Snackbar.make(binding.coordinatorLayout, message, LENGTH_SHORT) .setAnchorView(binding.fab) .show(); Similarly, when Bottom Navigation View or Floating Action Bu
Read more