Best way to incorporate Volley (or other library) into Android Studio project

GradleAndroid StudioAndroid Volley

Gradle Problem Overview


I've seen different advice on the best way to do this This question covers creating a jar. Elsewhere, I've seen advice to simply copy the volley source into your own project. This section on libraries at android.com would seem the most authoritative. However, after compiling volley, I don't have an aal library, whereas that section says I should have.

So my question is this: I have an existing Android Studio project with a standard layout, and a git repository; what should I do to add volley? Where should I download it to? How should I add it to Android Studio? Which Gradle files, if any, do I need to modify.

Hopefully, for those of you have done this a few times, this should be bread-and-butter stuff, but I haven't been able to find a straightforward description.

--

Updating, per Scott Barta's suggestion.

The gradle.build file in the volley repository has this line.

apply plugin: 'android-library'

According to the documentation: "Library projects do not generate an APK, they generate a .aar package (which stands for Android archive)." However, when I build the volley project, no .aar is created.

My feeling is that as Volley is a library project, created by the Android team, it is most probably intended to be generated and used as .aar package. Any advice on whether it would be preferable to generate a .aar, and how to do that, would be appreciated.

Gradle Solutions


Solution 1 - Gradle

As pointed out by others as well, Volley is officially available on Github:

Add this line to your gradle dependencies for volley:

compile 'com.android.volley:volley:1.0.0'


To install volley from source read below:

I like to keep the official volley repository in my app. That way I get it from the official source and can get updates without depending on anyone else and mitigating concerns expressed by other people.

Added volley as a submodule alongside app.

git submodule add -b master https://github.com/google/volley.git volley

In my settings.gradle, added the following line to add volley as a module.

include ':volley'

In my app/build.gradle, I added a compile dependency for the volley project

compile project(':volley')

That's all! Volley can now be used in my project.

Everytime I want to sync the volley module with Google's repo, i run this.

git submodule foreach git pull

Solution 2 - Gradle

LATEST UPDATE:

Use the official version from jCenter instead.

dependencies {
    compile 'com.android.volley:volley:1.0.0'
}

The dependencies below points to deprecated volley that is no longer maintained.

ORIGINAL ANSWER

You can use this in dependency section of your build.gradle file to use volley

  dependencies {
      compile 'com.mcxiaoke.volley:library-aar:1.0.0'
  }

UPDATED:

Its not official but a mirror copy of official Volley. It is regularly synced and updated with official Volley Repository so you can go ahead to use it without any worry.

https://github.com/mcxiaoke/android-volley

Solution 3 - Gradle

#Nowadays#

dependencies {
    compile 'com.android.volley:volley:1.0.0'
}   

#A lot of different ways to do it back in the day (original answer)#

  • Use the source files from git (a rather manual/general way described here)

    1. Download / install the git client (if you don't have it on your system yet): http://git-scm.com/downloads (or via git clone https://github.com/git/git ... sry bad one, but couldn't resist ^^)
    2. Execute git clone https://android.googlesource.com/platform/frameworks/volley
    3. Copy the com folder from within [path_where_you_typed_git_clone]/volley/src to your projects app/src/main/java folder (Integrate it instead, if you already have a com folder there!! ;-))

The files show up immediately in Android Studio. For Eclipse you will have to right-click on the src folder and press refresh (or F5) first.

  • Use gradle via the "unofficial" maven mirror

    1. In your project's src/build.gradle file add following volley dependency:

       dependencies {
           compile fileTree(dir: 'libs', include: ['*.jar'])
           // ...
      
           compile 'com.mcxiaoke.volley:library:1.+'
       }
      
    2. Click on Try Again which should right away appear on the top of the file, or just Build it if not

    The main "advantage" here is, that this will keep the version up to date for you, whereas in the other two cases you would have to manually update volley.

    On the "downside" it is not officially from google, but a third party weekly mirror.

    But both of these points, are really relative to what you would need/want. Also if you don't want updates, just put the desired version there instead e.g. compile 'com.mcxiaoke.volley:library:1.0.7'.

Solution 4 - Gradle

As of today, there is an official Android-hosted copy of Volley available on JCenter:

compile 'com.android.volley:volley:1.0.0'

This was compiled from the AOSP volley source code.

Solution 5 - Gradle

UPDATE:

compile 'com.android.volley:volley:1.0.0'

OLD ANSWER: You need the next in your build.gradle of your app module:

dependencies {
        compile 'com.mcxiaoke.volley:library:1.0.19'
        (Rest of your dependencies)

    }

This is not the official repo but is a highly trusted one.

Solution 6 - Gradle

For incorporate volley in android studio,

  1. paste the following command in terminal (
    git clone https://android.googlesource.com/platform/frameworks/volley ) and run it.

    Refer android developer tutorial for this.

    It will create a folder name volley in the src directory.

  2. Then go to android studio and right click on the project.

  3. choose New -> Module from the list.

  4. Then click on import existing Project from the below list.

  5. you will see a text input area namely source directory, browse the folder you downloaded (volley) and then click on finish.

  6. you will see a folder volley in your project view.

  7. the switch to android view and open the build:gradle(Module:app) file and append the following line in the dependency area:

    compile 'com.mcxiaoke.volley:library-aar:1.0.0'

  8. Now synchronise your project and also build your project.

Solution 7 - Gradle

I have set up Volley as a separate Project. That way its not tied to any project and exist independently.

I also have a Nexus server (Internal repo) setup so I can access volley as
compile 'com.mycompany.volley:volley:1.0.4' in any project I need.

Any time I update Volley project, I just need to change the version number in other projects.

I feel very comfortable with this approach.

Solution 8 - Gradle

add

compile 'com.mcxiaoke.volley:library:1.0.19'
        compile project('volley')

in the dependencies, under build.gradle file of your app

DO NOT DISTURB THE build.gradle FILE OF YOUR LIBRARY. IT'S YOUR APP'S GRADLE FILE ONLY YOU NEED TO ALTER

Solution 9 - Gradle

This solution is for Kotlin DSL (build.gradle.kts):

dependencies {
    implementation("com.android.volley:volley:1.2.1")
    // ...
}

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
Questionuser3185563View Question on Stackoverflow
Solution 1 - GradleshauvikView Answer on Stackoverflow
Solution 2 - GradlePiyush AgarwalView Answer on Stackoverflow
Solution 3 - GradleLeviteView Answer on Stackoverflow
Solution 4 - GradleSam SternView Answer on Stackoverflow
Solution 5 - GradleSottiView Answer on Stackoverflow
Solution 6 - GradleMukul AggarwalView Answer on Stackoverflow
Solution 7 - GradleSayooj ValsanView Answer on Stackoverflow
Solution 8 - GradlearusheView Answer on Stackoverflow
Solution 9 - GradleMahozadView Answer on Stackoverflow