Building android with maven

Создание Android-проектов с использованием Maven

Этот урок освещает создание простого Android проекта с Maven.

Что вы создадите

Вы создадите Android приложение, которое отображает время дня, а потом соберете его Maven’ом.

Что вам потребуется

• Примерно 15 минут свободного времени
• Любимый текстовый редактор или IDE
• JDK 6 и выше
• Android SDK
• Android устройство или эмулятор

Как проходить этот урок

Как и большинство уроков по Spring, вы можете начать с нуля и выполнять каждый шаг, либо пропустить базовые шаги, которые вам уже знакомы. В любом случае, вы в конечном итоге получите рабочий код.

Чтобы начать с нуля, перейдите в Настройка проекта.

Чтобы пропустить базовые шаги, выполните следующее:

• Загрузите и распакуйте архив с кодом этого урока, либо кнонируйте из репозитория с помощью Git: git clone https://github.com/spring-guides/gs-maven-android.git
• Перейдите в каталог gs-maven-android/initial
• Забегая вперед, установите Maven

Когда вы закончите, можете сравнить получившийся результат с образцом в gs-maven-android/complete .

Настройка проекта

Для начала, вам необходимо настроить Android проект для сборки Maven. Т.к. основное внимание данного урока уделено Maven, сделайте проект настолько простым, насколько это возможно. Если вы впервые работаете с Android проектами, установите и настройте ADT.

Создание структуры каталогов

В выбранном вами каталоге проекта создайте следующую структуру каталогов; к примеру, командой mkdir -p src/main/java/org/hello для *nix систем:

Создание Android манифеста

Android Manifest содержит всю информацию, необходимую для запуска Android приложения и оно не будет собираться без него.

Добавьте текстовую строку. Текстовые строки могут ссылаться на файлы приложения или другие источники.

Теперь определите визуальную структуру пользовательского интерфейса вашего приложения.

В директории src/main/java/org/hello вы можете создать любой Java класс, какой захотите. В соответствии с задачей урока, создайте следующий класс:

Установка Maven

Теперь у вас есть проект, который вы можете собрать с помощью Maven. Следующим шагом будет установка Maven.

Загрузите Maven как zip-файл с http://maven.apache.org/download.cgi. Достаточно только бинарники, поэтому смотрите ссылку на apache-maven--bin.zip или apache-maven--bin.tar.gz.

Загрузите и распакуйте файл, затем добавьте bin каталог в переменную окружения PATH.

Чтобы протестировать устаноку Maven, запустите mvn из командной строки:

Если все хорошо, то вы должны увидеть информацию об установке, похожую на эту:

Теперь у вас есть установленный Maven.

Настройка простой Maven сборки

Теперь, когда Maven установлен, вам необходимо создать определение Maven проекта через XML-файл pom.xml. Помимо всего остального, этот файл содержит имя проекта, версию и зависимости, которые он имеет от внешних библиотек.

Создайте файл с названием pom.xml в корне проекта и поместите в него следующее содержимое:

Это простейший pom.xml файл, который необходим для сборки Android проекта. Он состоит из следующих настроек проекта:

— Как проект будет собран, в данном случае как Android APK

Секция dependencies определяет список зависимостей проекта. В частности, она определяет единственную зависимость от Android библиотеки. В элементе dependency зависимость определяется деревом дочерних элементов:

В данном случае элемент имеет значение provided . Зависимости этого типа необходимы для компиляции кода проекта, но будут доступны и во время выполнения кода. К примеру, Android API всегда доступен, когда Android приложение запущено.

Секция определяет дополнительную конфигурацию для сборки приложения. В этой секции есть секция

, которая содержит список плагинов, которые добавляют функциональность процессу сборки. Здесь определена конфигурация для Android Maven Plugin. Для этой зависимости также имеются элементы , и . Плагин также содержит следующие элементы:

• — Конфигурация плагина. Здесь вы определяете, с каким Android Platform SDK будет собираться проект
• — Комбинация указания значений true и apk для

передает управление [Android Maven Plugin] в процессе сборки.

На текущий момент вы определили пока минимальный Maven проект.

Сборка Android кода

Сейчас Maven готов к сборке. Вы можете выполнить выполнить несколько задач сборки уже сейчас, включая компиляцию кода проекта, создание библиотеки пакета(JAR файл) и установить библиотеку в локальный репозиторий Maven зависимостей.

Эта команда запускает Maven, говоря ему выполнить задачу compile. Когда он завершит её, вы должны найти скомпилированные .class файлы в каталоге target/classes.

Т.к. вы вряд ли захотите работать или распостранять .class файлы непосредственно, взамен этого возможно запустить package задачу:

Эта задача компилирует ваш Java код, запускает тесты и упаковывает код в JAR файл каталоге target. Имя JAR файла состоит из значений и проекта. К примеру, исходя из содержимого pom.xml файла, отображенного ранее, JAR файл будет называться gs-maven-android-0.1.0.jar.

Т.к. вы установили значение элемента

в «apk», результатом будет АРК файл в target каталоге в дополнение к JAR файлу. Этот АРК файл является упакованным Android приложением, готовым к развертыванию на устройстве или эмуляторе.

Android Maven плагин предоставляет несколько Maven задач, которые вы можете использовать в различных фазах процесса сборки или взаимодействия с устройством и эмулятором. Список доступных задач вы можете увидеть, выполнив команду:

Описание записимостей

Простой Hello World пример полностью самодостаточен и не зависит от каких-либо дополнительных библиотек. Однако, большинство приложений, зависят от внешних библиотек, предоставляющих некоторую функциональность.

К примеру, предположим, что вы хотите, чтобы приложение отображало текущие дату и время. Несмотря на то, что вы фактически можете использовать дату и время из нативных Java библиотек, возможно использовать более интересные для этого вещи, которые предоставляют Joda Time библиотеки.

Для этого, измените HelloActivity.java как показано ниже:

В этом примере используемый Joda Time LocalTime класс возвращает и отображает текущее время.

Если вы запустите mvn package сейчас, то сборка завершится с ошибкой, потому что вы не описали Joda Time как компилируемую зависимость в сборке. Для исправления этой ошибки, просто добавьте следующие строки в секцию файла pom.xml.

Пересборка Android кода с зависимостями

Теперь, если вы выполните mvn compile или mvn package , то Maven должен разрешить Joda Time зависимость из Maven Central репозитория и успешно собрать проект.

Ниже приведена полная версия pom.xml файла:

Поздравляем! Вы только что создали простой, но эффективный Maven проект с целью сборки Android проектов.

Источник

Building Android Apps with Apache Maven — Tutorial

Android Maven. This tutorial describes how to build Android applications with Apache Maven and the «android-maven-plugin».

1. Gradle for building Android applications

1.1. Using Gradle for Android apps

By default, Android projects are handled by the Gradle build system. If you create a new project in Android studio, the Gradle build scripts are automatically created. Android studio provides the Gradle runtime, hence no additional installation is required.

If you press the run button in Android Studio, it triggers the corresponding Gradle task and starts the application.

You can also run Gradle via the command line. To avoid unnecessary local installation, Gradle provides a wrapper script which allows you to run Gradle without any local installation.

You find the available versions of the Android Gradle plug-in under the following URL: https://jcenter.bintray.com/com/android/tools/build/gradle/

1.2. Conversion process from source code to Android application

The Java source files are converted to Java class files by the Java compiler. The Android SDK contains a tool called dx which converts Java class files into a .dex (Dalvik Executable) file. All class files of the application are placed in this .dex file. During this conversion process redundant information in the class files are optimized in the .dex file. For example, if the same String is found in different class files, the .dex file contains only one reference of this String .

These .dex files are therefore much smaller in size than the corresponding class files.

The .dex file and other resources, e.g., the images and XML files, are packed into an .apk (Android Package) file. The program aapt (Android Asset Packaging Tool) performs this step.

The resulting .apk file contains all necessary data to run the Android application and can be deployed to an Android device via the adb tool.

As of Android 5.0 the Android RunTime (ART) is used as runtime for all Android applications. ART uses a combination of Ahead Of Time and _Just In Time _ compilation. During the installation of an application on an Android device, the application code is translated into machine code.

The dex2oat tool takes the .dex file created by the Android tool chain and compiles that into an Executable and Linkable Format (ELF file). This file contains the dex code, compiled native code and meta-data. Keeping the .dex code allows that existing tools still work.

1.3. Using Gradle on the command line

The Gradle build system is designed to support complex scenarios in creating Android applications:

Multi-distribution: the same application must be customized for several clients or companies

Multi-apk: supporting the creation of multiple apk for different device types while reusing parts of the code

You can start your Gradle build via the command line. Here is an overview of the important Android Gradle tasks:

Table 1. Android Gradle build targets

build project, runs both the assemble and check task

./gradlew clean build

build project complete from scratch

./gradlew clean build

build project complete from scratch

Run the instrumentation tests

To see all available tasks, use the gradlew wrapper command.

This command creates in the build folder the output of the Gradle build. By default, the Gradle build creates two .apk files in the build/outputs/apk folder.

To build and start your unit tests on the JVM use the following command.

To build and start your instrumented tests on your Android device use the following command.

1.4. Removing unused resources and Java classes via resource shrinking

The Gradle build system for Android supports resource shrinking at build time. This automatically removes resources that are unused from the packaged application. In addition to that, this also removes unnecessary resources from libraries you are depending on. This can hugely reduce the size of your application.

To enable resource shrinking, update your build file similar to the following snippet.

1.5. Defining dependencies and keeping the version external

A good practice is to define the version of your library dependencies outside the dependencies closure for better maintenance.

Command	Description

If you put the ext closure into the root build file, you can access its properties for example with ‘$rootProject.ext.junitVersion’.

2. Building Android applications with Maven

The android-maven-plugin plug-in allows to build Android applications via Maven.

The webpage of this maven plug-in is located under: http://code.google.com/p/maven-android-plugin/ — Android-Maven Plug-in.

The Eclipse support of this plug-in is provided by the https://github.com/rgladwell/m2e-android — m2e project.

You only have to install Maven, write a correct pom.xml file and issue the commands to Maven to build, install and run your application.

The following will build your Android application via Maven.

This will create the application and places the .apk file in the target_ folder.

If you want to install the application via Maven on your Android device, you can use the following command.

If more than one device is available you can specify the relevant device in your pom.xml. Maven can also start and stop an Android virtual device automatically for you.

You can also start the application via Maven.

3. Tutorial: Building Android Applications with Maven

Create a new Android project called «de.vogella.android.build.firstmaven». The actual content of the repository is not important as we are only using this project to create a working build for Maven.

Create the following «pom.xml» file in your directory. Make sure that artifactId is set to your project name.

Switch to the command line and enter the following command:

4. More information

For more information see the complete Maven Android Guide from Sonatype:

Another quick starting guide is available on the android-maven-plugin project side:

Источник

Building Android projects with Maven – Part 1: Setup

Building and managing Android projects with maven is not as easy as it could be. So in this blog, I’ll show you how we managed to get it work nicely.
In this example, we’ll create a parent project with an app module and a separate instrumentation tests module.

Project setup

The quickest approach to create a new Android project with maven is using a maven archetype from aquinet (http://mvnrepository.com/artifact/de.akquinet.android.archetypes).
For this project, we’ll use the android-release archetype, as it creates a skeleton for exactly our case, as we also want to release the app with maven.
Hint: be sure to use the latest version of the archetype

With this, a parent project named after the artifactId gets created in your current directory. Inside, you’ll find two modules, one for the app and one for the instrumentation tests, and the pom.xml of the parent is also already pre-configured with both of them as modules. In the pom, you’ll find several plugins already configured for you, on top of all the android-maven-plugin
Now check the pom for the android-maven-plugin version and update it to the latest version (3.6.1 at the moment I wrote this blog). It should be at least 3.6.0 – if not, the build will fail, because the aapt tool can’t be found as it moved in a previous android release and the plugin only considers this since version 3.6.0.
To test the setup, simply go into the parent project and run

Now everything should be compiled and the instrumentation tests should run on any emulator or device that is connected.
If you get an error stating „Platform/API level 16 not available“, install it via the SDK Manager, or replace the sdk version in the pom to an available one.
In the android-maven-plugin config:

Note: the archetypes from aquinet also include their androlog logging framework which is a wrapper around the Android logging that adds the functionality of disabling the logging for releases and provides log4j-like configuration. You could remove it from the poms, or you could give it a try, which I would recommend you to 🙂

Setting up Android Studio to work with maven

To conveniently work on a maven project with Android studio, we have to set it to automatically import Maven projects, so that it notices changes to the pom.xml and updates it’s dependencies.
File -> Settings -> Maven -> Importing -> Import Maven projects automatically

Import the project:

* File -> Import project
* Select your parent project
* Import from external model -> Select Maven
* Check „Import Maven projects automatically“ -> Next
* Select the Android platform -> Next
* Finish

configure Android Studio to also build using Maven:

* Select the project
* Run -> Edit Configurations
* „+“ Android Application
* Module: select Android App
* Launch default Activity
* Select default target device
* Before Launch: remove „Make“
* Before Launch: add Maven „clean install“
* OK
Now if you run the project in Android studio, Maven will be used.

Running Android Lint

It’s recommended to run Android Lint to check warnings and errors. To run it with the android-maven-plugin, simply insert this config to the android-maven-plugin int the pom (and edit the sources path accordingly to your project):

If you want to execute android lint on the build, add android:lint to the maven commands (e.g. „mvn clean install android:lint“)
Don’t forget to edit the Run config you previously created to include „android:lint“!
The results will be written to /target/lint-results/lint-results-html/. (We disabled the XML output and enabled HTML, because it just has a better readability and you have a way better overview on the HTML pages)

Create a separate Instrumentation Test Profile

We don’t want to install the app and run the Instrumentation Tests on every build, because it just takes so long. So we’ll execute the tests only in a separate maven profile.
First, we’ll disable the instrumentation tests for all cases by inserting a configuration for the android-maven-plugin in the parent pom:

In the parent pom, add the new profile „IT“:

And in the pom of the IT module, we also add the IT profile and enable the tests for it again:

The Instrumentation Tests should not run. And then

Now the tests should run.

Dependencies on android libraries

The dependencies on the android libraries are some kind of problem, because not all of them are published in maven central (e.g. only up to Android 4.1.1.4 right now, and only the support-v4 library, not the -v7 one…)
To compensate this, there is the maven-android-sdk-deployer project that lets you deploy your local sdk components into a maven repository of your choice (defaults to your local one).
For the tutorial on how to use it, please head over to their github page, everything is explained nicely detailed there.
Just some small pointers for this this setup: if you have a dependency on a apklib (except from the android framework itself), define the dependency in the parent project to define the version:

And in the IT module, set it as provided!

If you want to use newer versions than the preconfigured 4.1.1.4, you have to deploy them yourself and also use another group id for android, simply „android“ instead of „com.google.android“. For the exact versions, deploy them with the maven-android-deployer and look into your repository, or simply look at the readme at the github page of the deployer.
Here’s an example config of the dependencies deployed with the maven-android-deployer:

Don’t forget to update the modules dependencies accordingly!
As you can probably see, we also replaced the sdk platform version config with a parameter, in the android maven plugin config:

With this you should be able to develop Android (more or less comfortable) using maven and Android studio.
In the next blog, I’ll show you how to configure the plugins to build releases of Android apps!
I’ll also post the sources for the project at the end of the next blogpost, so you can check against it, if you get some errors.

Kommentare

Whenever I am loading a maven based project in android studio I am getting this error «Unable to locate Android SDK used by project». I did all the steps in your page.

if you dont want to setup a maven project paste the dependecy xml on this site: http://jar-download.com/index.php

Hey man, i followed your nice tutorial for building an Android Project with Maven. The project compiles and runs ok. But when i want to add some 3rd party libraries like (com.fasterxml.jackson.jaxrs), the build proccess fails. Take a look at the messages
[INFO] trouble processing «javax/xml/stream/EventFilter.class»:
[INFO]
[INFO] Ill-advised or mistaken usage of a core class (java.* or javax.*)
[INFO] when not building a core library.
.
.
.
[INFO] If you find that you cannot do this, then
[INFO] that is an indication that the path you are on will ultimately
[INFO] lead to pain, suffering, grief, and lamentation.
[INFO] 1 error; aborting
[INFO] ————————————————————————
[INFO] Reactor Summary:
[INFO]
[INFO] android-with-maven — Parent . SUCCESS [ 0.131 s]
[INFO] android-with-maven — Application . FAILURE [ 16.181 s]
[INFO] android-with-maven-it — Integration tests . SKIPPED
[INFO] ————————————————————————
[INFO] BUILD FAILURE
[INFO] ————————————————————————
[ERROR] Maven execution terminated abnormally (exit code 1)
THIS IS NOT THE FULL LOG.
Any ideas what is going on?

Having read this I believed it was really enlightening. I appreciate you taking the time and effort
to put this content together. I once again find myself spending way too much time
both reading and commenting. But so what, it was still worthwhile!

how to install android-maen-plugin in AndroisStudio? And how to check version?

android 4.3 with SDK 18 support which version of maven .

Источник