此内容没有您所选择的语言版本。
Chapter 2. Maven basics in CodeReady Studio
In the context of application development, Maven provides a standardized build system for projects, and facilitates fetching dependencies from one or more repositories.
Root Maven projects can serve as aggregators for multiple Maven modules (sub-projects). For each module that is part of a maven project, a <module> entry is added to the project’s pom.xml
file. A pom.xml
contains <module> entries is often referred to as an aggregator pom.
When modules are included into a project it is possible to execute Maven goals across all of the modules by a single command issued from the parent project directory.
The following section describes how to:
- Create a new Maven project.
- Import existing Maven projects.
- Create a new Maven module.
- Add a Maven dependency to the Maven project.
- Add Maven support to a non-maven project.
Prerequisites
Set up Git Perspective.
For more information on how to set up Git Perspective, see Section 1.1, “Setting up Git Perspective”.
2.1. Creating a new Maven project
The following section describes how to create a new Maven project in CodeReady Studio. The instructions provided ensure that the packaging option is set to pom
, which is a requirement for multi-module Maven projects. Alternately, to create a standalone Maven project instead, set the packaging option to an option other than pom
.
Procedure
- Start CodeReady Studio.
- Open Git Perspective.
Click
. The New window appears.
- Enter Maven Projects in the Wizards field.
- Select Maven Projects.
Click the
button.The New Maven Project window appears.
Select the Create a simple project check box.
NoteBy selecting the Create a simple project check box you are skipping the archetype selection and the project type is automatically set to Project Object Model (POM). To create a standalone project, clear the Create a simple project check box and follow the onscreen instructions.
- Click the button to select the workspace location.
- Click the button.
Enter the group ID and the artificial ID.
NoteThe values cannot include spaces or special characters. The only special characters allowed are periods (
.
), underscores (_
), and dashes (-
). An example of a typical group ID or artificial ID isorg.company-name_project-name
.Optionally, you can name your project and give it a description.
- Set Packaging to pom.
- Click the button.
Verification steps
Click
. The Show view window appears.
- Enter Project Explorer in the search field.
- Select Project Explorer.
Click the
button.The Project Explorer view appears.
Your newly created Maven is now listed in the Project Explorer view.
2.2. Importing existing Maven projects
The following section describes how to import existing Maven projects into CodeReady Studio.
2.2.1. Importing the existing locally stored Maven project
The following section describes how to import the existing locally stored Maven project to CodeReady Studio.
Procedure
- Start CodeReady Studio.
- Open Git Perspective.
- Open Project Explorer.
Click
. The Import window appears.
- Enter Existing Maven Projects in the Select an import wizards field.
- Select Existing Maven Projects.
- Click the button.
- Click the button to locate your Maven project.
- Click the button.
Your local Maven project is now listed in the System Explorer view.
2.2.2. Importing the existing remotely stored Maven project
The following section describes how to import the existing remotely stored Maven project to CodeReady Studio.
Procedure
- Clone the Clone the source repository with HTTPS or SSH.
- Start CodeReady Studio.
- Open Git Perspective.
Click the
icon.Figure 2.1. Importing the existing Maven project
The Check out as Maven project from SCM window appears.
- Add the address for the source repository you cloned during step one to the SCM URL field.
- Click the button.
- Click the button to select the workspace location.
- Click the button.
Your remote Maven project is now listed in the System Explorer view and the Git Perspective view.
2.3. Creating a new Maven module
The following section describes how to create a new Maven module.
Prerequisites
An existing Maven project.
For more information on how to create a Maven project, see Section 2.1, “Creating a new Maven project”.
Procedure
- Start CodeReady Studio.
- Open Git Perspective.
Click
. The New window appears.
- Enter Maven Module in the Wizards field.
- Select Maven Module.
Click the
button.The New Maven Module window appears.
Select the Create a simple project check box.
NoteBy selecting the Create a simple project check box you are skipping the archetype selection and the project type is automatically set to Project Object Model (POM). To create a standalone module, clear the Create a simple project check box and follow the onscreen instructions.
- Name your module.
- Click the button to select the parent project.
- Click the button.
Set Packaging to pom.
Optionally, you can name your module and give it a description.
- Click the button.
Verification steps
Click
. The Show view window appears.
- Enter Project Explorer in the search field.
- Select Project Explorer.
Click the
button.The Project Explorer view appears.
Your newly created Maven module is now listed in the System Explorer view.
2.4. Adding a Maven dependency to the Maven project
The following section describes how to add a Maven dependency to the Maven project.
Prerequisites
An existing Maven project.
For more information on how to create a Maven project, see Section 2.1, “Creating a new Maven project”.
Procedure
- Start CodeReady Studio.
- Open Git Perspective.
- Open Project Explorer.
-
Right-click the target
. Enter the group ID or the artificial ID in the Enter groupId, artificialId or sha1 prefix or pattern field.
The fields above are populated automatically.
- Click the button.
The dependency is now added to the pom.xml
file of your target project.
2.5. Adding Maven support to an existing non-maven project
The following section describes how to add Maven support to an application created without Maven support.
- Start CodeReady Studio.
- Open Git Perspective.
- Open Project Explorer.
Right-click the target
. The Create a new POM window appears.
All fields are populated automatically. If you want to change the group ID or the Artificial ID, note that the values cannot include spaces or special characters. The only special characters allowed are periods (
.
), underscores (_
), and dashes (-
).Click the
button.Your newly generated
pom.xml
file appears in the System Explorer view.
2.6. Additional resources
- For more information on how to use Maven, see the JBoss Community Archive .