The question:
I am using Data Binding in my project, when using <layout>
and <data>
in my xml binding class is not generated.
For example i have activity_main.xml
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data> </data>
<RelativeLayout
android:layout_width="match_parent"
android:layout_height="match_parent">
</RelativeLayout>
</layout>
Now if i am writing ActivityMainBinding
in my activity/fragment it shows error that class is not available. But after including <variable>
in my xml file, it is able to generate ActivityMainBinding
class.
Android Studio : 2.1.3
Classpath : com.android.tools.build:gradle:2.1.3
minSdkVersion 16
targetSdkVersion 24
buildToolsVersion 24.0.0
The Solutions:
Below are the methods you can try. The first solution is probably the best. Try others if the first one doesn’t work. Senior developers aren’t just copying/pasting – they read the methods carefully & apply them wisely to each case.
Method 1
I did not get any satisfying answers. So here are the tips which are summary of my data binding knowledge.
Tips For Solving DataBinding Issues
Update
To get more accurate errors and suggestions, I strongly recommend to update Android Studio and Gradle plugin version to the latest. Because I am not facing many issues after AS 3.2 version.
See Latest Android Studio, and Latest Gradle Plugin.
Orignal Solution
After reading this answer, you will not get stuck in data binding auto generation issues for both Classes and Data Variables.
Check these points one by one. Any of these can make your work done. Point 3 to last are really important, so don’t miss them.
1. Check if data-binding enabled
You should have data binding enabled in build.gradle
. If not then add this and Sync.
android {
...
buildFeatures {
dataBinding true
}
}
2. Check layout is converted in binding layout
Now if you want data binding class to be generated then you should wrap xml layout
with data binding (<layout
tag). Something like this.
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<android.support.constraint.ConstraintLayout
android:layout_width="match_parent"
android:layout_height="match_parent">
</android.support.constraint.ConstraintLayout>
</layout>
Along with this check whether the binding variable names are correct as in the view model class
3. Auto-generated Binding class name?
Your data binding class should be generated after creating binding layout.
If your layout name is in snake case
activity_main.xml
then data binding class
will be generated in camel case likeActivityMainBinding
.
4. Can’t See Import Suggestion?
Sometimes when you type ActivityMai...
, then it does not show suggestion, in that case import manually.
import <yourpackage>databinding.ActivityMainBinding;
5. Read Build Fail Logcat
Your binding class and new variables in layout will not be generated if your build fails. So first Make project by Ctrl + F9 (Build > Make project).
- If a build fails then see what is an error, usually we have errors in layout fields. Error logs will point out the error line number with the issue.
- Binding may fail cause some stupid error, like syntax error or missing import. In that case, you will get logcat full of errors of binding classes. But you should read complete logcat to find appropriate issue.
6. Close and open project from recent
I always do this because it takes much less time than Rebuild
/ Make
project.
- Close project from File > Close Project
- Open again from recent
Note that I prefer Close and Open from Recent because it takes much less time than Rebuild / Restart IDE.
7. Rebuild Project
If still your class is not generated. (Some time when we paste layout file, then it happens). Then Rebuild Project from Build> Rebuild
(Not Build or Make project). It will generate your data binding class. (Rebuild does Magic for me.)
8. Have latest Android Studio
After updating AS to Android Studio 3.2, I felt many bugs fix in data binding auto generation. So you should also have the latest AS.
#Solution for <variables
<data>
<variable
name="item"
type="com.package.Model"/>
</data>
Usually, when we put a variable in layout, it creates a getter and setter of it. And we can use binding.setItem(item);
and binding.getItem();
, but if you can’t see those methods then read the below information.
1. Close and open project from recent
If you have created a data variable – <variable
in your layout and it does not show up its setter and getter in data binding class, then Close and Open from Recent your project.
2. Clean project after changing the type
If you changed the type of some <variable
in your layout and getter setter type is not changing then Clean project (Build> Clean Project
)
Final words
Finally if still your binding class is not generated, then we have our most powerful weapon. – Restart Android Studio
- First, try just restart, this always generates variables of my binding layout after restart.
- If it does not work then Invalidate Cache & Restart.
This is all that i do to solve my data binding errors. If you get any further issues, you can comment here.
Method 2
DataBinding class generated automatically.
if your xml name is activity_test then the Binding class will be ActivityTestBinding.
but,
dataBinding {
enabled = true
}
layout should have layout as root
<layout xmlns:android="http://schemas.android.com/apk/res/android">
</layout>
Method 3
I had the same issue. After reading over the android sdk docs, there is only the expected file name to be created but nothing about what to do if it does not happen. I noticed after some more research that after removing the namespace to the layout element like below (using your example), it worked for me.
<?xml version="1.0" encoding="utf-8"?>
<layout>
<data> </data>
<RelativeLayout
xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
</RelativeLayout>
</layout>
Method 4
In my case, the Binding class was generated and in place ( but I thought it wasn’t) … but it does not automatically add import of said class to the activity/fragment import section… so… OPTION + ENTER 🙂
Method 5
if you do base job, for enable databainding in your project, like use enable in gradle and use layout tag in xml, when you change xml code and did not generat new databinding class for those xml you can use a fast way for generation only data binding class in gradle->other->databindinggenbaseclassesDebug it fast more than bulid whole project. its generate only databinding class.
Method 6
After having set up it properly (including xml namespace and wrapping everything into <layout>
), the one which worked for me was doing Build -> Make project. Nor Clean Project or Rebuild Project did. I’m in Android Studio 2.3.1, using 26.0.2 build tools. There’s no need for <data>
tags.
Method 7
dataBinding {
enabled = true
}
To enable the new data binding compiler, add the following option to your gradle.properties file:
android.databinding.enableV2=true
Update:
To enable databinding please use,
android {
...
buildFeatures {
dataBinding true
}
}
Please follow this link:
https://developer.android.com/jetpack/androidx/releases/databinding
Method 8
My solution was to take as a suffix FragmentBinding in the class name.
A binding class is generated for each layout file. By default, the name of the class is based on the name of the layout file, converting it to Pascal case and adding the Binding suffix to it. The above layout filename is activity_main.xml so the corresponding generated class is ActivityMainBinding. This class holds all the bindings from the layout properties (for example, the user variable) to the layout’s views and knows how to assign values for the binding expressions.
The nomenclature of the name of the activity or fragment class may vary in terms of prefixes. Because the suffix is always Binding.
After following the response of Khemraj and Invalidate Caches / Restart, you should rewrite ActivityBinding or FragmentBinding to get the IDE suggestions of the classes that were already generated and DO NOT hardcode the import.
In my case I was trying to import the name of the class backwards be FragmentCompetitionsBinding
instead of CompetitionsFragmentBinding
.
GL
Method 9
Data binding classes are generated during the build so after you enable data binding in the Gradle build of the app and surround your xml with the layout tag you should rebuild your app. If that doesn’t help, delete your build folder and do it again.
Method 10
I do not know it will work for you or not. Just rename the layout XML file name. Like suppose your layout name is activity_main.xml just change rename it to anything like main.xml and again rename it to activity_main.xml. Then you can able to see the import option on ActivityMainBinding.
Hope it works for you.
Method 11
Thanks to this answer here – it looks like the “layout namespace” needs to either be cleared out, or you need a new unique name.
Here are the options that worked for me:
-
Create a fresh name for the layout to make sure it can be generated. This solved my issue, where I had a layout that was first created, without data binding – let’s call it
fragment_abc.xml
. When I tried to add data binding to it, it was not recognized – even after multiple clear cache & restart calls. However, soon as I made a copy of the layoutfragment_abc2.xml
, immediately I got the generated data-binding .java/.class object. -
After seeing the above work, I tried to just remove the /build folder from the module, and rebuilt the project – this worked to get data binding for the original layout.
Method 12
I had the same problem. I made a mistake while I refactored.
The autogen binding class has its name from the xml layout file.
fragment_name.xml -> FragmentNameBinding
Method 13
When you work with a multimodule Android application check your binding class path. Maybe you should use:
import com.yourcompany.app.android.modulename.databinding.FragmentABCtBinding
insted of:
import com.yourcompany.app.android.databinding.FragmentABCtBinding
Method 14
In my case, I thought that generated class had to appear with my usual classes in src
folder. In addition, I thought that the name of the generated class should be slightly different. It all was my mistake. The generated class can be found in build
folder, build -> generated -> ...
path. If there is no import of the generated class in your activity, add the import
import com.yourcompany.app.databinding.ActivityMainBinding;"
Method 15
Delete layouts and undo, and make sure the generated binding classes are imported correctly after that.
Method 16
Make sure data binding enabled
android {
...
dataBinding {
enabled = true
}
...
}
dan click the button (Sync project with Gradle)
Method 17
If answer did not work for you, then my recommendation is simple but effective.
The idea is to determine which is the component that is generating the problem. To do this, comment on all the lines of your custom_fragment.xml
and its uses in the CustomFragment.kt
and leave something minimalist like the following.
<layout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools">
<androidx.constraintlayout.widget.ConstraintLayout
android:id="@+id/test"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
</layout>
Then run the app and add component to component while you Apply Code Changes
(Ctrl+Alt+F10) to the execution of the app until the app crashes, that is when you found the fault.
Data binding logs are sometimes not so descriptive and this is a generic strategy to find the faulty component.
GL
Method 18
The only thing I can imagine if possible is if you don’t have
dataBinding {
enabled true
}
in your gradle file. If not just add it to the gradle file.
i.e
android {
......
dataBinding {
enabled true
}
}
then sync your project. If it still fail, you may need to do Invalidate/Restart of your android studio
Method 19
I had same problem. Everything you done correct. Thing is you need add variable inside data tag in xml. For that you should create a sample model class and add it as variable in data tag.
Until that you won’t get to see generated ActivityMainBinding.
Method 20
I had a similar issue where I had the layout wrapped and my data binding enabled in the gradle file. Main activity still couldn’t intellisense or see my classes. What fixed it for me was adding the binding variable and importing the binding anyway. From there I just built the solution and then it seemed to know what the class was. From there I was able to import my camel case classes that were generated.
Method 21
I got the issue and the problem was in the layout the field used was not a String, it was a Date.
Looks that all field got to be text to work, at least with the TexView component.
If you build with the command
./gradlew build –stacktrace
This show better the errors.
Method 22
In case you get the following error in DataBindingUtil.setContentView
Unresolved reference: activity_main
all you need to do is remove the following import statement
import android.R
I found the solution on another forum. Source
Method 23
If Recently any one migrated existing project into androidx then you need to replace your import from
import com.yourpackagename.BR;
to
import androidx.databinding.library.baseAdapters.BR;
After Google 2 days finally got solution, which one work for me.
Method 24
There are cases when you won’t see a file under generated directory, you might be binding a property that is not declared in viewmodel. It doesn’t essentially give you a lint error if you do so in xml.
Method 25
If you are implement the Serializable -> you must implement the Serializable
else you will get this error. Hope it will help someone in future
In my case I use the Parcel library. I missed to annotate @Parcel in my sub class
Method 26
In addition to the above steps, you can also check the variable type. Make sure it’s String for TextView or the same as defined in the BindingAdapter
.
For example:
data class MyDataObject(val name: String, val age: Int)
and in XML:
android:text="@{dataobject.age}"
This will cause the above error. To fix you can either make the age variable of type String or you can import String in your XML and use String.valueOf(age)
as following:
<data>
<import type="String" />
...
</data>
And in your TextView:
android:text="@{String.valueOf(dataobject.age)}"
Method 27
In my case, data binding classes were not generated because I had deleted the mipmap Android Resource Directory. I recreated the res/mipmap/ directory and the data binding classes were reinstated.
Method 28
I encountered a similar issue where DataBinding failed to generate the BindingImpl class.
In my case was an issue from a method in the data class where the name was used wrong:
The model contained a method onSignInCliked() and in the layout I used onSigninCliked(). Notice the SignIn vs Signin.
The error message wasn’t enough and I discovered the issue only when I used the build script with the stack-trace option.
Method 29
If there is an issue with your XML file, the Databinding class would not be generated. A quick fix would be to run through the XML file and check for syntax errors (which are usually highlighted in red). The errors might come in the form of non-existing or wrong references, typographical errors, etc.
In essence, just make sure there is no red-underlined line in your XML code. When you are done, rebuild and your Databinding class would have been generated.
Method 30
After you check all the reasons in the accepted answer, make sure to match to the exact naming in the file.xml. In my case I had a tiny typo in my layout name.
All methods was sourced from stackoverflow.com or stackexchange.com, is licensed under cc by-sa 2.5, cc by-sa 3.0 and cc by-sa 4.0