Creating, Running and Packaging Your First Java Application
This tutorial illustrates a Java SE application development workflow. The age-old Hello, World application is used as an example.
- Before you start
- Creating a project
- Exploring the project structure
- Creating a package and a class
- Writing code for the HelloWorld class
- Building and running the application
- Remarks: building and running applications
- Packaging the application in a JAR
- Running the packaged application
Before you start
To develop Java applications, you need a Java Development Kit (JDK). If you don't have a JDK installed, you can download an Oracle JDK from the Java SE Downloads page.
Creating a project
Any new development in IntelliJ IDEA starts with creating a project. So let's create one now.
- If no project is currently open in IntelliJ IDEA, click Create New Project on the Welcome screen. Otherwise, select File | New | Project.
- In the left-hand pane, select Java. (We want a Java-enabled project to be created, or, to be more exact, a project with a Java module.)
-
If you haven't defined a JDK in IntelliJ IDEA yet,
you should do it now.
In the Select Home Directory for JDK dialog that opens, select the directory in which you have the desired JDK installed.
The JDK you have specified is shown in the Project SDK field.
Because our application is going to be a "plain old Java application", we don't need any additional technologies to be supported. So, don't select any of the options under Additional Libraries and Frameworks.
-
The options on the next page have to do with creating a Java class with a
main()
method.Since we are going to study the very basics of IntelliJ IDEA, and do everything from scratch, we don't need these options at the moment. So, don't select any of the options.
-
On the next page, specify the project name (e.g.
HelloWorld
). If necessary, change the project location suggested by IntelliJ IDEA.Wait while IntelliJ IDEA is creating the project. When this process is complete, the structure of your new project is shown in the Project tool window.
Exploring the project structure
Let's take a quick look at the project structure.
There are two top-level nodes:
-
HelloWorld. This node represents your Java module.
The
.idea
folder and the fileHelloWorld.iml
are used to store configuration data for your project and module respectively. The foldersrc
is for your source code. -
External Libraries. This is a category that represents all the "external" resources
necessary for your development work.
Currently in this category are the
.jar
files that make up your JDK.
(For more information, see Tool Windows and Project Tool Window.)
Creating a package and a class
Now we are going to create a package and a class.
Let the package and the class names be com.example.helloworld
and
HelloWorld
respectively.
Though a package can be created separately, we will create both the package and the class at once.
-
In the Project tool window,
select the
src
folder and press Alt+Insert. (Alternatively, you can select File | New, or New from the context menu for the foldersrc
.) - In the New menu, select Java Class (e.g. by pressing Enter).
-
In the Create New Class dialog that opens,
type
com.example.helloworld.HelloWorld
in the Name field. The Class option selected in the Kind list is OK for creating a class. Press Enter to create the package and the class, and close the dialog.The package
com.example.helloworld
and the classHelloWorld
are shown in the Project tool window.At the same time, the file
HelloWorld.java
(corresponding to the class) opens in the editor.
Note the package statement at the beginning of the file and also the class declaration. When creating the class, IntelliJ IDEA used a file template for a Java class. (IntelliJ IDEA provides a number of predefined file templates for creating various file types. For more information, see File and Code Templates.)
Also note a yellow light bulb . This bulb indicates that IntelliJ IDEA has suggestions for the current context. Click the light bulb, or press Alt+Enter to see the suggestion list.
At the moment, we are not going to perform any of the actions suggested by IntelliJ IDEA (such actions are called intention actions.) Note, however, that this IntelliJ IDEA feature may sometimes be very useful.
Finally, there are code folding markers next to the commented code fragment (). Click one of them to collapse that fragment. (For more information, see Code Folding.)
Writing code for the HelloWorld class
The code in its final state (as you probably know) will look this way:
package com.example.helloworld;
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
The package statement and the class declaration are already there. Now we are going to add the missing couple of lines.
Press Shift+Enter. (In contrast to Enter, Shift+Enter starts a new line without breaking the current one.)
Using a live template for the main() method
The line
public static void main(String[] args) {}
may well be typed. However, we suggest that you use a different method.
Type p
and press Ctrl+J.
Select psvm - main() method declaration. (Use the Up and Down arrow keys for moving within the suggestion list, Enter for selecting a highlighted element.)
Here is the result:
IntelliJ IDEA provides code snippets called live templates.
psvm
is an abbreviation for one of such templates.
To insert a live template into your code,
you can use or Ctrl+J.
For more information, see Live Templates.
Using code auto-completion
Now, it's time to add the remaining line of code
System.out.println("Hello, World!");
We'll do that using code auto-completion.
Type Sy
The code completion suggestion list is shown.
Select System (java.lang) by pressing Enter.
Type .o
and press Ctrl+Period.
out
is inserted followed by a dot.
(You can select an item in the suggestion list by pressing Ctrl+Period.
In that case, the selected item is inserted into the editor followed by a dot.)
Type p
and then find and select println(String x).
IntelliJ IDEA prompts you which parameter types can be used in the current context.
Type "
The second quotation mark is inserted automatically and the cursor is placed between the quotation marks.
Type Hello, World!
The code at this step is ready.
(For more information, see Auto-Completing Code.)
Using a live template for println()
As a side note, we could have inserted the call to println()
by using a live template (sout
).
If you think that it's enough for live templates, proceed to running the application. Otherwise, try that now as an additional exercise. Delete
System.out.println("Hello, World!");
Type s
, press Ctrl+J and
select sout - Prints a string to System.out.
The line
System.out.println();
is added and the cursor is placed between (
and )
.
Type "
and then type Hello, World!
Building and running the application
Classes with a main()
method can be run right from the editor.
To show that, there are the green arrow markers () in the left margin.
Click one of the markers and select Run 'HelloWorld.main()'.
Wait while IntelliJ IDEA is compiling the class. When the compilation is complete, the Run tool window opens at the bottom of the screen.
On the first line, there is a fragment of the command that IntelliJ IDEA used to run the class.
(Click the fragment to see the whole command line including all options and arguments.)
The last line shows that the process has exited normally, and no infinite loops occurred.
And, finally, you see the program output Hello, World!
between these lines.
(For more information, see Run Tool Window.)
Remarks: building and running applications
Some remarks related to building and running applications in IntelliJ IDEA:
-
Prior to running the class, IntelliJ IDEA has automatically compiled it.
When necessary, you can initiate the compilation yourself.
The corresponding options can be found in the Build menu.
Many of these options are also available as context menu commands in the Project tool window and in the editor.
Finally, there is an icon in the upper-right part of the workspace that corresponds to the Build Project command ().
For more information, see Build Process and Compilation Types.
-
The options for running and debugging applications can be found in the Run menu.
As in the case of the build operations, the run options can also be accessed from the Project tool window and the editor, as well as by means of controls in the upper-right part of the workspace.
-
Applications in IntelliJ IDEA are run according to what is called run/debug configurations.
Such configurations, generally, should be created prior to running an application.
When you performed the Run 'HelloWorld.main()' command, IntelliJ IDEA, first, created a run configuration and then executed it.
The name of this run configuration (HelloWorld) is now shown in the run/debug configuration selector to the left of .
The HelloWorld configuration now exists as a temporary configuration and, if necessary, you can save it to make it permanent.
-
Run/debug configurations can do a lot more than just run applications.
They can also build applications and perform other useful tasks.
If you look at the settings for the HelloWorld run configuration (Run | Edit Configurations or Edit Configurations from the run configuration selector), you'll see that the Build option is included by default in the Before launch task list. That's why IntelliJ IDEA compiled the class when you performed the Run 'HelloWorld.main()' command.
-
If you look at the Project tool window, you'll see that now there is the folder
out
there. This is the project output folder.Inside it is the module output folder (
production\HelloWorld
), the folder structure for the packagecom.example.helloworld
and the compiled class fileHelloWorld.class
.For more information, see Configuring Project Compiler Output and Configuring Module Compiler Output.
Packaging the application in a JAR
When happy with your application, you may want to package it in a Java archive (JAR) for distribution. To do that, you should create an artifact configuration for your JAR and then build the artifact.
Creating an artifact configuration for the JAR
- Select File | Project Structure to open the Project Structure dialog.
- Under Project Settings, select Artifacts.
- Click , point to JAR and select From modules with dependencies.
-
In the dialog that opens, specify the main application class.
(To the right of the Main Class field, click and
select HelloWorld (com.example.helloworld) in the dialog that opens.)
As a result, the artifact configuration is created and its settings are shown in the right-hand part of the Project Structure dialog.
- Click OK.
Building the JAR artifact
- Select Build | Build Artifacts.
-
Point to HelloWorld:jar and select Build.
(In this particular case, Build is the default action,
so you can just press Enter instead.)
If you now look at the
out/artifacts
folder, you'll find your JAR there.
Running the packaged application
To make sure that everything is fine with the JAR, let's run it. To do that, we'll create a JAR Application run configuration and then execute that run configuration.
Creating a JAR Application run configuration
To run Java applications packaged in JARs, IntelliJ IDEA provides the JAR Application run configurations. To create such a configuration:
- Select Run | Edit Configurations.
- In the Run/Debug Configurations dialog that opens, click and select JAR Application.
-
Specify the path to the JAR file.
(To the right of the Path to JAR field, click and
select the JAR file in the dialog that opens.)
The rest of the settings in this case don't matter, however, there's one more thing that we'll do - just for convenience.
-
Under Before launch, click ,
select Build Artifacts and
select the HelloWorld:jar artifact in the dialog that opens.
The Build 'HelloWorld:jar' artifact task is included in the Before launch task list. So each time you execute this run configuration, the artifact will be built automatically.
Executing the run configuration
-
To the right of the run configuration selector, click .
As before, the Run tool window opens and the application output is shown there.