Apache Maven is a build automation tool for Java, which builds JAR files for deployment into App Engine.
For faster deployments, use the following Maven tools:
- App Engine plugin
- Maven Archetypes
Setting up Maven
To use Maven:
Determine whether Maven is installed and which version you have by running the following command:
If you have Maven installed, a long string of information beginning with
Apache Mavenand followed by a version number such as
If you don't have Maven 3.5 or newer installed:
Setting up and validating your Cloud project
You need to set up your Cloud project and install Cloud SDK.
Use the Google Cloud Console to create and set up your Cloud project:
- Select or create a new Cloud project.
- Follow the prompts to ensure that an App Engine application
exists and billing is enabled:
- If you need to create an App Engine application for your project, you are prompted to select the region where you want your App Engine application located.
- Follow the prompts to create a new billing account or select an existing account.
- The Dashboard opens after your App Engine application has been created and billing has been enabled in your project.
If you already have the
gcloudtool installed and want to configure it to use a Cloud project ID other than the one that you initialized it to, see Managing Cloud SDK Configurations.
Install the Cloud SDK
gcloud components install app-engine-java
Adding the App Engine Maven and Eclipse Jetty Maven plugins
To develop and deploy your application, use the App Engine Maven plugin.
To use the plugin in an existing Maven project, add the following into the
plugins section in the project
<plugin> <groupId>com.google.cloud.tools</groupId> <artifactId>appengine-maven-plugin</artifactId> <version>2.2.0</version> </plugin>
Compile and build your project using Maven
To build a Java App Engine app using Maven with its
Change to the main directory for your project.
For example, if you downloaded the sample Hello World app, change into the following directory:
Wait for the project to build. When the project successfully finishes you will see a message similar to this one:
BUILD SUCCESS Total time: 10.724s Finished at: 2016-07-29T12:13:36-07:00 Final Memory: 24M/213M
Deploying your app
After you add the App Engine Maven plugin to your project's
file, you can deploy your application:
mvn package appengine:deploy -Dapp.deploy.projectId=PROJECT_ID
Replace PROJECT_ID with the ID of your Cloud project. If
pom.xml file already
project ID, you don't need to include the
-Dapp.deploy.projectId property in the
command you run.
appengine:deploy goal and all other goals in the App Engine Maven
plugin have associated parameters that you can use. For a complete list, see
App Engine Maven Plugin Goals and Parameters.
What happens when you deploy
By default, the
does the following:
Deploys a new version of your service to the Google Cloud project you configured the
gcloudtool to use.
Because each new version requires a unique ID, the
appengine:deploygoal also generates a unique version ID.
Routes all traffic to the new version.
Changing the deployment defaults
You can change the default deployment behavior by passing parameters in the
appengine:deploy command. For example, the following command deploys the
service defined in your
pom.xml file to a specific Google Cloud project,
assigns a custom version ID to the service, and turns off automatic traffic
routing for the new version:
mvn appengine:deploy -Dapp.deploy.projectId=PROJECT_ID -Dapp.deploy.version=VERSION_ID -Dapp.deploy.promote=False
You can also use the
appengine:deploy command to deploy configuration files,
For more information, see the