Show some ❤️ and star the repo to support the project
Featured in
Also included in
Cheatsheet about tips and tricks for Android Development
This is a simple set of tips and tricks regarding Android Development which I have gathered from various sources. It helps me direct other android devs in my community regarding stuff each android dev should know about. Its also there for me to keep track of anything I either learn on my own or from other sources now and then when browsing the internet.
Contributions are always welcome, hoping people will help me in growing this. To contribute, simply open up a PR with the changes.
###Know Your Tools
####Android Studio
-
Code faster by using keyboard shortcuts
Description Mac Linux/Win Lookup IDE commands Cmd
+Shift
+A
Ctrl
+Shift
+A
Open Class Cmd
+O
Ctrl
+O
Open File Cmd
+Shift
+O
Ctrl
+Shift
+N
Open recently edited file Cmd
+Shift
+E
Ctrl
+Shift
+E
Lookup Actions Cmd
+Shift
+A
Ctrl
+Shift
+A
Open Symbol Cmd
+Opt
+O
Alt
+Shift
+N
Open recently used file Cmd
+E
Ctrl
+E
Last Edited Location Cmd
+Shift
+Backspace
Ctrl
+Shift
+Backspace
Find Usage in persistent window Opt
+F7
Alt
+F7
Find Usage in floating window Cmd
+Opt
+F7
Ctrl
+Alt
+F7
Format the code with proper Indentation Cmd
+Opt
+L
Ctrl
+Alt
+L
Surround With Opt
+Cmd
+T
Alt
+Ctrl
+T
Open Terminal Opt
+F12
Alt
+F12
Generate Setter/Getters/ Cmd
+N
Alt
+Ins
Find Class CMD
+O
Ctrl
+N
Refactor/Rename Shift
+F6
Shift
+F6
Quick Fix Opt
+Enter
Alt
+Enter
Goto Definition Cmd
+B
Ctrl
+B
Show parameters for selected method Cmd
+P
Ctrl
+P
Refactor This Ctrl
+T
Ctrl
+Alt
+Shift
+T
Stop Process Cmd
+F2
Ctrl
+F2
Search Everywhere Shift
+Shift
Shift
+Shift
Select Methods to Override Ctrl
+O
Ctrl
+O
Delete Line Cmd
+Backspace
Ctrl
+Y
Duplicate Line Cmd
+D
Ctrl
+D
Grow/Shrink selection from cursor Opt
+Up/Down Arrow key
Shift
+Ctrl
+W
Multicursor Selection Ctrl
+G
Alt
+J
-
Use plugins to become more efficient
The plugin basically will annoy the hell out of you by showing you a big screen overlay with the key combination you should have used , if you used your mouse to execute some command to a level when you basically would start using the key combination just to avoid KeyPromoter annoying you all the time. Its also is useful features, like it will prompt you to create a key binding for a command which does not have a key binding and you have used it 3 times.
Provides actions for text manipulation such as Toggle case, encode/decode, sorting,
Add Sort Lines action in Edit menu to sort selected lines or whole file if selection is empty.
Provides static byte code analysis to look for bugs in Java code from within Android Studio
Plugin that provides on-the-fly feedback to developers on new bugs and quality issues injected into Java, JavaScript and PHP code.
Plugin provides both real-time and on-demand scanning of Java files from within Android Studio.
Plugin that adds ADB commands to Android Studio and Intellij such as ADB Uninstall App, ADB Kill App, ADB Restart App, etc
Plugin which helps you find and implement the code you require in an instant.
-
The Dagger IntelliJ plugin creates visual connections between a @Inject object and the @Provides method that creates it.
This plugin extends the built-in JVM debugger with capabilities to explore objects in the JVM heap during a debug session.
-
-
Use Live Templates in Android Studio
newInstance
- Generates the staticnewInstance
function inside a FragmentToast
- GeneratesToast.makeText(context, "", Toast.LENGTH_SHORT).show();
fbc
- findViewById with castconst
- Define a android style int constantlogd
- GeneratesLog.d(TAG, "");
logm
- Log current method name and its arguments.logr
- Log result of the current methodlogt
- static logtaf with current classnamepsf
- public static finalsout
- Prints a string to System.outsoutm
- Prints current class and method names to System.outsoutp
- Prints method parameter names and values to System.outvisible
- Set view visibility to VISIBLEgone
- Set view visibility to GONEnoInstance
- private empty constructor to prohibit instance creation
-
Postfix code completion in Android Studio
Android Studio/IntelliJ havea special kind of code completion which allows you to write code specific to a field
<expr>.null
will auto complete toif(<expr> == null)
<expr>.nootnull
will auto complete toif(<expr> != null)
<expr>.var
will auto complete toT name = <expr>
<expr>.field
will auto complete to create a global field variablefield = <expr>
<ArrayExpr>.for
will auto complete tofor(T item : <Arrayexpr>)
<ArrayExpr>.fori
will auto complete tofor(int i = 0; i < <Arrayexpr>.length; i++)
<ArrayExpr>.forr
will auto complete tofor(int i = <Arrayexpr>.length - 1; i > 0 ; i--)
Complete list of available postfix code completion can be found at Settings → Editor → Postfix Templates
-
Use the Darcula Theme in Android Studio
Ok, I know its more like a preference , but trust me using that keeps your eyes less strained as they would be if you used the Default Light theme.
-
Don't use a small font
Preferably use a font in Android Studio thats easy to read and is at a font size which doesnot forces you to strain your eyes. I use Menlo font.
-
Use a code style
You should use a standard codestyle, so possible contenders can be
-
Use the Memory/Network/CPU Monitor inside Android Studio to profile your code/app
####Emulator Apart from using physical devices , one should use emulators as they are as of now easy to manage and equivalently powerful.
####Vysor This one needs special mention due to how useful it is. It basically is a window to your device i.e it streams and allows you to interact with your physical device on your laptop. Very useful when you are demo-ing your app during a presentation. You can interact with your physical device and it will be shown right in your laptop screen. It has a paid/free version , paid version is totally worth buying.
####DeskDock Yes, vysor was great, but if you want to share your keyboard and mouse directly to your Android device, then this app is for you. It enables you to control your Android device as if it was part of your desktop computer. The FREE version includes use of computer mouse, while the PRO version includes features such as use of keyboard. This is useful where you can test your app without your hands ever leaving your keyboard.
###Make better choices while coding
-
Use OkHttp over HttpUrlConnect
HttpUrlConnect suffers from quite some bugs. Okhttp solves them in a more elegant manner. [Reference Link]
-
Reference local
aar
files as below [Stackoverflow Ref]dependencies { compile(name:'nameOfYourAARFileWithoutExtension', ext:'aar') } repositories{ flatDir{ dirs 'libs' } }
-
Use Pidcat for a better log reading experience
-
Use some Version Control System(VCS) like Git
-
Use ClassyShark
Its a standalone tool for Android Devs used to browse any Android executable and show important info such as class interfaces and members, dex counts and dependencies
-
Use Stetho
Debug your android apps using Chrome Dev Tools. Includes tools like Network Monitor, Shared Preference explorer etc.
-
A tool to analyze battery consumers using Android "bugreport" files.
-
Always use a constant version value like "24.2.0"
Avoid using
+
when specifying the version of dependencies.- Keeps one secured from unexpected API changes in the dependency.
- Avoids doing an extra network call for the checking latest version of each dependency on every build.
-
Do not use your own personal email for Google Play Developer Account
-
Use Vectors instead of PNG
If you do have to use png, compress them. Take a look at TinyPNG.
-
Use proguard
android { ... buildTypes { release { minifyEnabled true proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' } }
}
+ **Use shrinkResources**
```gradle
android {
...
buildTypes {
release {
shrinkResources true
minifyEnabled true
...
}
}
}
-
Simulating Android killing your app in the background, run in terminal
adb shell am kill
-
Follow the below rule to have faster gradle builds
Gradle memory >= Dex memory + 1Gb
-
Split your apk using gradle when using Native code, do not bundle all of em together and ship!.. coz that will make you evil
defaultConfig { ... ndk { abiFilters "armeabi", "armeabi-v7a", "mips", "x86" } } //Split into platform dependent APK splits { abi { enable true reset() include 'armeabi', 'armeabi-v7a', 'mips', 'x86' //select ABIs to build APKs for universalApk false //generate an additional APK that contains all the ABIs } } // map for the version code project.ext.versionCodes = ['armeabi': 1, 'armeabi-v7a': 2, 'mips': 5, 'x86': 8] // Rename with proper versioning android.applicationVariants.all { variant -> // assign different version code for each output variant.outputs.each { output -> output.versionCodeOverride = project.ext.versionCodes.get(output.getFilter(com.android.build.OutputFile.ABI), 0) * 1000000 + android.defaultConfig.versionCode } }
-
Learn about some architecture such as MVP or Clean
-
Try to understand and follow TDD (Test Driven Development)
-
To force re-download of dependencies
./gradlew --refresh-dependencies
-
To exclude a certain task from being run by gradle
Suppose you want to exclude the task
javaDoc
then use-x
option followed by the task name, i.ejavaDoc
in this case../gradlew clean build -x javaDoc
-
To have the each subproject script name match that of the project name
Then add this line in settings.gradle
rootProject.children.each{ it.buildFileName = it.name + '.gradle' }
-
Follow the DRY principle DRY = Do not Repeat Yourself
-
Learn about Dependency Resolution
With the speed android dependencies update, sooner or later you are going to encounter some sort of dependency conflict. Solution is making use of Dependency Resoultion. Official Reference
-
Use different package name for non-release builds
android { buildTypes { debug { applicationIdSuffix '.debug' versionNameSuffix '-DEBUG' } release { // ... } } }
-
Make use of custom gradle tasks in your build.gradle files
Android uses Gradle as its build system, which actually allows one to make a lot of things easy by creating tasks to automate things. This reddit post enlists a lot of such useful gradle scripts
-
Use a proper .gitignore in your Android Projects, Check it here
-
Use LeakCanary to detect memory leaks in your app - Its a memory leak detection library for Android and Java.
-
Speed up your gradle builds in Android Studio 2.3+
-
Switch to gradle 3.3
Run this inside your project folder to update your gradle wrapper
./gradlew wrapper --gradle-version 3.3 --distribution-type all
-
Set the below property in your global
gradle.properties
fileandroid.enableBuildCache=true
-
-
Stop a running gradle build process
./gradlew -stop
-
Enable gradle to automatically download missing platforms in android sdk
Set the below property in your global
gradle.properties
fileandroid.builder.sdkDownload=true
This is an experimental option and it only downloads build tools and platforms, but doesn't actually update Google or Support repository [Bug Ref]
-
Donot include both
jcenter()
&mavenCentral()
in yourbuild.gradle
fileJCenter is a superset of MavenCentral. [Ref tweet]
-
Clear your gradle cache if you think that bundled support and google play services lib in android sdk are inconsistent
- Goto
~/.gradle/caches/
and delete everything inside thecache
folder. - Open SDK Manager and resync all support libs and google play services
- Next re-sync your project
- Everything should become consistent and functional.
- Goto
-
Setup handy
adb
aliases for your terminal [Ref Link]Append the below Aliases to your
~/.bashrc
or~/.zshrc
file, save and restart the terminal. Once saved , use them as show in Usage columnAlias Usage alias screenshot="adb exec-out screencap -p > screen-$(date -j "+%s").png"
screenshot
`alias startintent="adb devices tail -n +2 `alias apkinstall="adb devices tail -n +2 `alias rmapp="adb devices tail -n +2 `alias clearapp="adb devices tail -n +2 -
Setup Android Studio to fail build if code contains
//STOPSHIP
[Ref Link]To enable the
//STOPSHIP
lint check, in yourbuild.gradle
android { ... lintOptions { abortOnError true fatal 'StopShip' } }
If you have a
//STOPSHIP
comment in your code, this will cause an error to be thrown when a release apk is generated.You can turn on //STOPSHIP highlighting in Android Studio (isn't enabled by default) in
Preferences
>Editor
>Code Style
>Inspections
.Search for STOPSHIP to find the correct setting.
-
Use
adb install -g
to grant all permissions listed in the manifest [More Info] -
Use
alfi
to find the gradle dependency statement for a libraryIts basically the commandline version of Gradle, Please which is a web hosted.
-
Run
alfi name_of_library
-
Copy the desired library
-
Paste in your build.gradle
-
-
Use
dryrun
to test a library directly-
Just Run
dryrun REMOTE_GIT_URL
-
-
Output unit tests directly to the console [Ref Link]
A small neat trick to see Android unit tests logging results as they happen in the terminal.
android { ... testOptions.unitTests.all { testLogging { events 'passed', 'skipped', 'failed', 'standardOut', 'standardError' outputs.upToDateWhen { false } showStandardStreams = true } } }
-
Make your builds faster by building offline [Ref Link]
The
--offline
flag tells gradle to always use dependency modules from the cache, regardless if they are due to be checked again. When running offline, gradle will never attempt to access the network to perform dependency resolution. If required modules are not present in the dependency cache, build execution will fail.-
Assembling develop debug at full speed:
./gradlew assembleDevelopDebug --offline
-
Running your unit tests at full speed:
./gradlew test --offline
-
-
Use an abtracted Logger class
-
If you want to automatically initialize your library, use a Content Provider [Read how Firebase does it - Ref Link]
-
Reduce installed app size with
"android:extractNativeLibs:false"
in<application>
[Ref Link]This will essentially prevent the system from creating a second copy of the .so files and fix the System.loadLibrary call so it’s able to find and open native libs straight from the APK, no code changes on your part required.
-
Selectivily execute a specific method in Android Studio [Ref Link]
###Tips regarding UI/UX
-
Motion
- Material Design uses real-world metaphors as its foundation. Objects in the real world don't move linearly, they move in curved paths and accelerate and decelerate according to the motion's properties.
- As such, motion should also use such properties and animate objects so that the motion feels natural rather than forced
- For example, a car leaving the screen in a movie starts off slowly, then accelerates till it's out of the frame. Similarly, views should be interpolated using classes like AccelerateInterpolator, FastOutSlowInInterpolator, etc. [[More Info]](https://developer.android.com/reference/android/animation/TimeInterpolator.html
-
Typography
- While custom typefaces can be used for branding, it is essential to stick to Roboto and Noto if possible, especially for body text, due to their clarity and optimistic nature.
- Roboto covers Latin, Greek and Cyrillic extended scripts, with Noto filling in for other language scripts [More Info]
- Weight balancing is an important aspect of typography, the fundamental concept of which is that the larger a typeface is, the less its weight should be so that it doesn't appear too thick and balances its weight with smaller typefaces of higher weights
- Typography should align to a 4dp baseline grid, and maintain a minimum contrast ratio of 4.5:1 based on luminance values, with a recomemended ratio being 7:1.
- The ideal reading length for large blocks of text is 40 to 60 characters per line. Anything less is too narrow and anything more is too wide.
-
Icons
- Icons should be designed at 48dp, with 1dp edges, which equates to
- 48px by 48px at mdpi
- 72px by 72px at hdpi
- 96px by 96px at xhdpi
- 144px by 144px at xxhdpi
- 192px by 192px at xxxhdpi
- An additional icon of 512px by 512px should be designed for use on Google Play
- Material icons, in addition to the base icon, should contain the following important elements
- 1dp tinted edge at the top
- 1dp shaded edge at the bottom
- Contact shadow - a soft shadow around all edges of raised elements
- Finish - a soft tint to provide surface lighting, fading from upper life to lower right [More Info]
- Icons should be designed at 48dp, with 1dp edges, which equates to
-
Ripples
-
When implementing Ripple Effect use
?attr/selectableItemBackground
instead of?android:attr
(Ref) -
When implementing Ripples contained within the view like Button, use (Ref)
android:background="?attr/selectableItemBackground"
-
When implementing Ripples that extend beyond the view's bounds like ImageView: (Ref)
?attr/selectableItemBackgroundBorderless
-
-
Other Points to Note
- Views should be aligned to Material Design's 8dp baseline grid and the keylines when possible. This gives the UI a sense of structure and hierarchy. [More Info]
- If you plan on keeping a reference to any ViewGroup (LinearLayout, FrameLayout, RelativeLayout, etc.), and you don’t want to use any methods specific to this particular type of Layout, keep it as a ViewGroup object. [More Info]
- While picking an accent color (if the brand already has one), pick a color complementary to the primary color so that the contrast is high enough
###Tips if you use Kotlin
-
Checkout From Java to Kotlin
Cheatsheet when you come from Java to Kotlin. Very nice resource to compare the two languages.
###Other Resources
-
Listen to podcasts
There are others too, but the above two are the popular ones, you can lookup more using tag
android
on sites offering Podcast Services.P.S : I use Player.fm to listen to these podcasts. They even have an Android Client , all for FREE.
-
Checkout Android Dialogs Short byte sized android interview videos with experts.
-
Checkout CodePath Android Cliffnotes
It is the central crowdsourced resource for complete and up-to-date practical Android developer guides for any topic.
-
Checkout new android libraries
Android Arsenal - Android developer portal with tools, libraries, and apps
-
Checkout android example apps
- Android Examples - Simple basic isolated apps, for budding android devs.
- Google Samples - Various sample apps provided by Google
- Google Android Codelabs
-
Follow on Twitter
-
Create a List on Twitter
-
Bite sized Android development videos
-
Bookmark these sites for staying upto date
- Android Developers - Youtube Channel
- Android Niceties - UI Showcase
- Material Design Specs
- Everything About Material Design
- Platform Version Distribution
- Android Studio Release Notes
- Android Developers Blog
- AndroidDev-Reddit
- Github Trending Java Projects
- Stackoverflow-Android tag
- Support Library History
- Android Conferences
- Android Dev Docs
- Material Up - DesignShowcase
- Dribbble - MaterialDeisgnShowcase
-
Use freely available mockable api points
- Mockey - A tool for testing application interactions over http, with a focus on testing web services, specifically web applications that consume XML, JSON, and HTML.
- JSON Placeholder - Fake Online REST API for Testing and Prototyping
- API Studio - a playground for API developers
- Mocky - Mock your HTTP responses to test your REST API
- Mockbin - Mockbin allows you to generate custom endpoints to test, mock, and track HTTP requests & responses between libraries, sockets and APIs.
-
Subscribe to newsletters to stay upto date
- Android Weekly - Free newsletter that helps you to stay cutting-edge with your Android Development
- AndroidDevDigest - A Handcrafted Weekly #AndroidDev Newsletter
- Infinium #AndroidSweets - Fresh news from Droid zone
- Kotlin Weekly - Free newsletter to stay uptodate with Kotlin Development
-
ADB/Fastboot Tools made avaialble as a separate package by google, download latest version for
-
Some other awesome utility tools
- Android SVG to VectorDrawable - One VectorDrawable to rule all screen densities
- SQLite Viewer - View sqlite file online
- Android 9-patch shadow generator - Tool that makes fully customizable shadows possible
- APK method count - Tool that outputs per-package method counts
- Material Palette - Easily generate the color pallete based on material design
- Javadoc Themer - Give your boooring javadocs a splash of colors!
- Method Count - Use this tool to avoid the dreaded 65K method limit of the DEX file format!
- Gradle, please - Lookup dependency reference name to include as your gradle dependencies
- jsonschema2pojo - Generate Plain Old Java Objects from JSON or JSON-Schema
- Android Asset Studio - A web-based set of tools for generating graphics and other assets that would eventually be in an Android application's res/ directory.
- Device Art Generator - Quickly wrap app screenshots in device artwork
- Google Translator Toolkit - Translate strings.xml files to any language and download as XML
- JSONViewer - Awesome JSON formatter
-
Awesome android libraries
- StorIO - Beautiful API for SQLiteDatabase and ContentResolver
- Retrofit - Type-safe HTTP client for Android and Java by Square, Inc.
- Picasso - A powerful image downloading and caching library for Android
- LeakCanary - A memory leak detection library for Android and Java.
- AndroidViewAnimations - Cute view animation collection.
- Calligraphy - Custom fonts in Android the easy way.
Extra : Android Libraries built by me
- EasyDeviceInfo - Enabling device information to be at android developers hand like a piece of cake!
- Sensey - Android library to make detecting gestures easy
- PackageHunter - Android library to hunt down package information
- Zentone - Easily generate audio tone in android
- RecyclerViewHelper - RecyclerViewHelper provides the most common functions around recycler view like Swipe to dismiss, Drag and Drop, Divider in the ui, events for when item selected and when not selected, on-click listener for items.
- StackedHorizontalProgressbar - Android Library to implement stacked horizontal progressbar
- QREader - A library that uses google's mobile vision api and simplify the QR code reading process
- ScreenShott - Simple library to take a screenshot of the device screen , programmatically!
- EvTrack - Android library to make event and exception tracking easy
- OptimusHTTP - Android library that simplifys networking in android via an async http client
- ShoutOut - Android library for logging information in android
####Credits This curated cheatsheet includes tips and tricks that I have been following in my workflow as well as those being suggested/followed by other android devs worldwide.I have tried to add direct links wherever I could remember, giving people due credit who have explained the concepts. If you think I have missed any , then either send a PR or open an issue and I will fix it asap.
If you found this cheatsheet helpful or you learned something today and want to thank me, consider buying me a cup of ☕
License
Copyright 2016 Nishant Srivastava
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
http://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.