开源软件名称（OpenSource Name）：

开源软件地址(OpenSource Url)：

开源编程语言(OpenSource Language)：

开源软件介绍(OpenSource Introduction)：

android-archetypes

Provides Maven archetypes for Android to quickly bootstrap a Maven project and start developing an Android application.

All artifacts are based on the android-maven-plugin http://code.google.com/p/maven-android-plugin/. It currently uses the 3.8.1 version.

Before starting

JDK

Use at least Java JDK 6 from Oracle.

Android SDK

Download the latest Android SDK from http://developer.android.com/sdk/index.html and follow the instructions there.

From Android SDK, install at least the following packages :

• Tools (all packages)
• Android 4.4 (API 19)
• Android 2.3.3 (API 10)
• Extras (all packages according to your platform)

Or from the command line (headless environment) :

android update sdk --no-ui --all --filter \
	tools,\
	platform-tools,\
	build-tools-19.0.1

android update sdk --no-ui --all --filter \
	extra-android-m2repository,\
	extra-android-support,\
	extra-google-admob_ads_sdk,\
	extra-google-analytics_sdk_v2,\
	extra-google-google_play_services_froyo,\
	extra-google-google_play_services,\
	extra-google-m2repository,\
	extra-google-play_apk_expansion,\
	extra-google-play_billing,\
	extra-google-play_licensing,\
	extra-google-webdriver

android update sdk --no-ui --all --filter \
	android-19,\
	sysimg-19,\
	addon-google_apis-google-19

android update sdk --no-ui --all --filter \
	android-10,\
	sysimg-10,\
	addon-google_apis-google-10

where options :

• --no-ui : Updates from command-line (does not display the GUI)
• --all : Includes all packages (such as obsolete and non-dependent ones)
• --filter: A filter that limits the update to the specified types of packages

Maven

Install Maven (3.1.1 or higher is required) and set the M2_HOME environment variable to the location that should contain Maven.

Maven Android SDK Deployer

Install Maven Android SDK Deployer :

git clone https://github.com/mosabua/maven-android-sdk-deployer.git
cd maven-android-sdk-deployer/
mvn install -P 2.3.3
mvn install -P 4.4
cd extras/compatibility-v4/
mvn clean install

Installation

Use Maven to install these archetypes in your local Maven repository :

git clone https://github.com/makinacorpus/android-archetypes.git
cd android-archetypes/
mvn clean install

android-quickstart archetype

This archetype creates a simple Android application ready to be deployed on an Android device. To initiate this Android project :

mvn archetype:generate \
	-DarchetypeArtifactId=android-quickstart \
	-DarchetypeGroupId=com.makina.android.archetypes \
	-DarchetypeVersion=0.1.3 \
	-DarchetypeCatalog=local \
	-DarchetypeRepository=local \
	-DgroupId=your.company \
	-DartifactId=my-android-application \
	-Dpackage=your.company.myapp \
	-Dversion=0.1 \
	-DinteractiveMode=false

where properties :

• -DgroupId : your Maven project groupId
• -DartifactId : the name of your Maven project
• -Dversion : the first version number of your Maven project

You can define three optional properties :

• -Dpackage : define the package used by the application (default : the given groupId)
• -DminSdkVersion : the minimum API Level required for the application to run (default : 10, Android 2.3.3)
• -DtargetSdkVersion : the targeted Android platform version to use (default : 19, Android 4.4)

Once generated, your application is ready to be built. Start an android emulator or plug an Android dev phone (USB debugging must be enabled in Developer options settings) and execute the following commands :

cd my-android-application
mvn clean install

or with Gradle :

cd my-android-application
gradle clean build

To deploy and launch the application with Maven :

mvn clean install android:deploy android:run

or with Gradle (only deploy) :

gradle installDebug

To undeploy the application with Maven :

mvn android:undeploy

This generated project use JUnit and Robolectric as default unit test framework.

android-simple-project archetype

This archetype creates a multi-module project containing the Android application and a project for testing this application (instrumentation tests) :

mvn archetype:generate \
	-DarchetypeArtifactId=android-simple-project \
	-DarchetypeGroupId=com.makina.android.archetypes \
	-DarchetypeVersion=0.1.3 \
	-DarchetypeCatalog=local \
	-DarchetypeRepository=local \
	-DgroupId=your.company \
	-DartifactId=my-android-application \
	-Dpackage=your.company.myapp \
	-Dversion=0.1 \
	-DinteractiveMode=false

where properties :

• -DgroupId : your Maven project groupId
• -DartifactId : the name of your Maven project
• -Dversion : the first version number of your Maven project

You can define three optional properties :

• -Dpackage : define the package used by the application (default : the given groupId)
• -DminSdkVersion : the minimum API Level required for the application to run (default : 10, Android 2.3.3)
• -DtargetSdkVersion : the targeted Android platform version to use (default : 19, Android 4.4)

Once generated, your application is ready to be built and tested. Start an android emulator or plug an Android dev phone (USB debugging must be enabled in Developer options settings) and execute the following commands :

cd my-android-application
mvn clean install

To deploy and launch the application with Maven :

cd my-android-application
mvn clean install android:deploy android:run

This generated project use JUnit and Robolectric as default unit test framework.

To undeploy all installed applications (main application and instrumentation tests application) with Maven :

cd my-android-application-app
mvn android:undeploy
cd ../my-android-application-instrumentation
mvn android:undeploy

or from the parent pom (the application package name must be specified) :

mvn android:undeploy -Dandroid.package=your.company.myapp
mvn android:undeploy -Dandroid.package=your.company.myapp.test

android-actionbar-project archetype

This archetype creates a multi-module project containing the Android application including action bar support and a project for testing this application (instrumentation tests) :

mvn archetype:generate \
	-DarchetypeArtifactId=android-actionbar-project \
	-DarchetypeGroupId=com.makina.android.archetypes \
	-DarchetypeVersion=0.1.3 \
	-DarchetypeCatalog=local \
	-DarchetypeRepository=local \
	-DgroupId=your.company \
	-DartifactId=my-android-application \
	-Dpackage=your.company.myapp \
	-Dversion=0.1 \
	-DinteractiveMode=false

where properties :

• -DgroupId : your Maven project groupId
• -DartifactId : the name of your Maven project
• -Dversion : the first version number of your Maven project

You can define three optional properties :

• -Dpackage : define the package used by the application (default : the given groupId)
• -DminSdkVersion : the minimum API Level required for the application to run (default : 10, Android 2.3.3)
• -DtargetSdkVersion : the targeted Android platform version to use (default : 19, Android 4.4)

Note : The action bar support use ActionBarSherlock Android library only if the minimum API Level required for the application is prior to API level 11.

Once generated, your application is ready to be built and tested. Start an android emulator or plug an Android dev phone (USB debugging must be enabled in Developer options settings) and execute the following commands :

cd my-android-application
mvn clean install

To deploy and launch the application with Maven :

cd my-android-application
mvn clean install android:deploy android:run

android-library-quickstart archetype

This archetype creates a simple Android library project ready to be used with another Android project application. To initiate this Android library project :

mvn archetype:generate \
	-DarchetypeArtifactId=android-library-quickstart \
	-DarchetypeGroupId=com.makina.android.archetypes \
	-DarchetypeVersion=0.1.3 \
	-DarchetypeCatalog=local \
	-DarchetypeRepository=local \
	-DgroupId=your.company \
	-DartifactId=my-android-library \
	-Dpackage=your.company.mylib \
	-Dversion=0.1 \
	-DinteractiveMode=false

where properties :

• -DgroupId : your Maven project groupId
• -DartifactId : the name of your Maven project
• -Dversion : the first version number of your Maven project

You can define three optional properties :

• -Dpackage : define the package used by the library (default : the given groupId)
• -DminSdkVersion : the minimum API Level required for the library (default : 10, Android 2.3.3)
• -DtargetSdkVersion : the targeted Android platform version to use (default : 19, Android 4.4)

Once generated, your library is ready to be built :

cd my-android-library
mvn clean install

This generated project use JUnit and Robolectric as default unit test framework.

android-library-project archetype

This archetype creates a multi-module project containing the Android application, an Android library project and a project for testing this application and its library (instrumentation tests). This archetype may be use to develop a complete Android application using a custom Android library or to develop an Android library with an example application using this library :

mvn archetype:generate \
	-DarchetypeArtifactId=android-library-project \
	-DarchetypeGroupId=com.makina.android.archetypes \
	-DarchetypeVersion=0.1.3 \
	-DarchetypeCatalog=local \
	-DarchetypeRepository=local \
	-DgroupId=your.company \
	-DartifactId=my-android-library-project \
	-Dpackage=your.company.mylib \
	-Dversion=0.1 \
	-DinteractiveMode=false

where properties :

• -DgroupId : your Maven project groupId
• -DartifactId : the name of your Maven project
• -Dversion : the first version number of your Maven project

You can define three optional properties :

• -Dpackage : define the package used by the library (default : the given groupId)
• -DminSdkVersion : the minimum API Level required for the library (default : 10, Android 2.3.3)
• -DtargetSdkVersion : the targeted Android platform version to use (default : 19, Android 4.4)

Once generated, your application is ready to be built and tested. Start an android emulator or plug an Android dev phone (USB debugging must be enabled in Developer options settings) and execute the following commands :

cd my-android-library-project
mvn clean install

To deploy and launch the application with Maven :

cd my-android-library-project
mvn clean install android:deploy android:run

This generated project use JUnit and Robolectric as default unit test framework.

android-google-maps-project archetype

This archetype creates a multi-module project containing the Android application using Google Maps Android library and a project for testing this application (instrumentation tests).

Before starting

The Google Maps Android API v2 is distributed as part of the Google Play services SDK. So we need to install and configure the Google Play services SDK first.

Android SDK

From Android SDK, install the following packages if needed :

• Android 2.2 (API 8)
• Extras / Google Play services
• Extras / Google Play services for Froyo

Or from the command line (headless environment) :

android update sdk --no-ui --all --filter \
	extra-google-google_play_services_froyo,\
	extra-google-google_play_services

android update sdk --no-ui --all --filter \
	android-8,\
	addon-google_apis-google-8

Maven Android SDK Deployer

From Maven Android SDK Deployer, install the following package :

cd maven-android-sdk-deployer/
mvn install -P 2.2
cd extras/google-play-services/
mvn clean install

Eclipse

From Eclipse, import the Google Play services library project into your workspace. Click File > Import, select Android > Existing Android Code into Workspace, and browse to the copy of the library project to import it :

<android-sdk>/extras/google/google_play_services/libproject/google-play-services_lib/

References the Google Play services in your app's project only (and not the instrumentation tests project). See the Referencing a Library Project for Eclipse for more information on how to do this.

Project initialization

To initiate this Android project :

mvn archetype:generate \
	-DarchetypeArtifactId=android-google-maps-project \
	-DarchetypeGroupId=com.makina.android.archetypes \
	-DarchetypeVersion=0.1.3 \
	-DarchetypeCatalog=local \
	-DarchetypeRepository=local \
	-DgroupId=your.company \
	-DartifactId=my-android-application \
	-Dpackage=your.company.myapp \
	-Dversion=0.1 \
	-DinteractiveMode=false

where properties :

• -DgroupId : your Maven project groupId
• -DartifactId : the name of your Maven project
• -Dversion : the first version number of your Maven project

You can define three optional properties :

• -Dpackage : define the package used by the application (default : the given groupId)
• -DminSdkVersion : the minimum API Level required for the application to run (default : 10, Android 2.3.3)
• -DtargetSdkVersion : the targeted Android platform version to use (default : 19, Android 4.4)

Note : This archetype is only compatible with Android API 10 or higher.

Follow instructions from https://developers.google.com/maps/documentation/android/start?hl=fr#get_an_android_certificate_and_the_google_maps_api_key to obtain a Google Maps API key for your application.

Your application is ready to be built. Start an android emulator (use the latest Android platform with Google API) or plug a compatible Android dev phone (USB debugging must be enabled in Developer options settings) and execute the following commands :

cd my-android-application
mvn clean install

To deploy and launch the application with Maven :

mvn clean install android:deploy android:run

To undeploy the application with Maven :

mvn android:undeploy

Perform a release build (signed and zipaligned APK)

android-quickstart, android-simple-project, android-actionbar-project and android-library-project archetypes offers also a release profile to generate a signed and zipaligned APK. By default the application is built in "debug mode". This means the generated class constant BuildCongig.DEBUG and Android Manifest attribute android:debuggable are set to true. The APK is signed with the default debug key (~/.android/debug.keystore).

A release type build would be necessary for publication of the application to the Play Store and the necessary steps for it is configured. The following preparation for the execution is necessary :

• Create your private key following the instructions at http://developer.android.com/tools/publishing/app-signing.html#cert

• Create a sign.properties file in the root folder of your application project (not the instrumentation tests project) like this :

    sign.keystore=/absolute/path/to/your/keystore
    sign.alias=youralias
    sign.keypass=keypass
    sign.storepass=storepass
  

After this preparation, the release build can be invoked with the following command :

mvn clean install -P release

which will in turn sign and zipalign the APK.

Instead of using a properties file (sign.properties), you may also define a Maven profile. Add a profile to your ~/.m2/settings.xml file containing the signing informations :

<profile>
	<id>android-release</id>
	<properties>
		<sign.keystore>/absolute/path/to/your/keystore</sign.keystore>
		<sign.alias>key alias</sign.alias>
		<sign.keypass>key password</sign.keypass>
		<sign.storepass>keystore password</sign.storepass>
	</properties>
</profile>

And invoke the following command :

mvn clean install -P android-release,release

Licensing

Licensed under the Apache Software License, Version 2.0.

History

Inspired from android-archetypes Github project created by akquinet AG.