Open Source & Free ❤️

Maven Project Structure

Maven Project Structure

As a follow-up to our recent announcement about transitioning to Maven, this post provides an overview of the new project structure.

Jump To Topic

Tip

If you want to follow along with this tutorial, you can quickly generate a new project using Codename One intializr.

The new project structure is based on the cn1app-archetype. You can see the basic file layout by looking at the archetype-resources directory of that project.

Some Highlights:

1. This is a multi-module project with sub modules for each target platform.

2. It comes bundled with a maven wrapper script, and utility shell (and bat) scripts to facility command-line usage.

3. The includes NetBeans and IntelliJ configuration files to provide better integration with those IDEs.

4. The “common” module contains all of the cross-platform stuff, and is the most direct successor to the old Ant project structure.
       i. codenameone_settings.properties is found in the common module.

       ii. CSS files are in common/src/main/css.

       iii. Java files are in common/src/main/java.

       iv. Resources are in common/src/main/resources.

       v. Kotlin files are in common/src/main/kotlin.

       vi. GUIBuilder files are in common/src/main/guibuilder.

       vii. Unit tests are in common/src/test/java.
5. CSS By Detault. Projects are set to use CSS by default. You can edit the styles in common/src/main/css/theme.css.

6. You can install cn1lib dependencies either via a Maven <dependency> snippet in your common/pom.xml file, or using Codename One Settings. You can Also use the install-cn1lib goal.

Creating a New Project

The easiest way to create a new project is using Codename One initializr. This will allow you to generate and download a starter project that is ready to run, debug, and build.

Modules

Let’s now go through each module in the project and discuss its purpose.

common

A Codename One application. All of your cross-platform application code goes in this module.

android

Module containing native Android code such as native interface implementations.

ios

Module containing native iOS code, such as native interface implementations.

javase

Module containing native JavaSE code, such as native interface implementations.

javascript

Module containing native javascript code for the Javascript port.

win

Module containing native Windows UWP code for the UWP windows port.

cn1libs

Module where legacy cn1libs will be installed the cn1:install-cn1lib goal.

Shell Scripts

The archetype project includes run.sh and build.sh shell scripts, as well as their Windows counterparts run.bat and build.bat. These scripts are convenience wrappers for common commands that you may wish to perform on the Command-line. e.g.

Running project in the Codename One Simulator

				
					./run.sh

				
			

Building a cross-platform JavaSE desktop app locally

				
					./build.sh

				
			

Generating Xcode project locally

				
					./build.sh ios_source
# project will be generated in ios/target directory
				
			

Generating Android Studio project locally

				
					./build.sh android_source
# project will be generated in android/target directory.
				
			

Building iOS app using build server

				
					./build.sh ios

				
			

Building Android app using build server

				
					./build.sh android

				
			

Opening Codename One Settings

				
					./run.sh settings

				
			

Updating Codename One

				
					./run.sh update
				
			

Tip

The run and build scripts are very thin wrappers over mvn. Open these scripts in your text editor to see the exact mvn commands that they run.

The Raw Maven Commands

The Codename One Maven plugin includes several goals, some of which are executed internally at the appropriate phase of the Maven lifecycle. Others are meant to be executed by you. Typically, you would run the Maven goals in the root module.

By default, only the “common” module is activated. You can activate other modules by specifying them with the codename1.platform property. e.g. If you wanted to build the javase module, you would do:
				
					mvn package -Dcodename1.platform=javase

				
			

If, instead, you wanted to build for iOS, you would do:

				
					mvn package -Dcodename1.platform=ios

				
			

Tip

The codename1.platform property, if supplied, should correspond to the names of the platform-specific module projects. i.e. It supports values "javascript", "javase", "ios", "android", and "win".

When performing builds (e.g. mvn package), you may also need to specify which build target you wish to use, as most platforms have more than one build target. For example the javase platform is used for the simulator, Mac desktop apps, Windows desktop apps, and JavaSE desktop apps. You should use the codename1.buildTarget property to differentiate.

e.g. To build a Mac Desktop app you would run:

				
					mvn package -Dcodename1.platform=javase \
  -Dcodename1.buildTarget=mac-os-x-desktop
				
			

And to build for Windows Desktop, you would run:

				
					mvn package -Dcodename1.platform=javase \
  -Dcodename1.buildTarget=windows-desktop
				
			

Why 2 Properties?

You might be wondering why we need to include both codename1.platform and codename1.buildTarget properties explicitly. The codename1.buildTarget property should correspond to a unique codename1.platform value (e.g. codename1.buildTarget=mac-os-x-desktop implies codename1.platform=javase), so why can’t we just omit the codename1.platform property and let the build system “figure it out”? Indeed!
The reason is because Maven doesn’t allow you to do this in a way that will support our needs. The codename1.platform property is used for more than just activating the correct module. It is used by cn1lib projects that are listed as dependencies also to include the correct artifacts for the current build. If this property isn’t provided on the command-line, then it won’t be available early enough in the Maven reactor process to activate all of the needed modules and artifacts.

If you know a clever solution to this issue, I’m all ears. My solution was to just provide the build.sh and build.bat scripts to wrap the common goals and include the needed properties at that level.

Check out the build.sh script source for a list of the most-common build commands.

In the IDE

As mentioned above, we’ve done some work to add better integration than default to IntelliJ and NetBeans. If you open the project in IntelliJ, the Configuration menu will include options for all of the common commands including building the project for each target platform, running in the simulator, opening Codename Settings, and updating Codename One.

NetBeans includes similar support, and we plan to add “special” support for Eclipse and VSCode in the near future.

See Getting Started with the Bare-bones Java App Project for more in-depth coverage of each IDE including screenshots.

Where to go from here

Our Maven support represents months of careful work, and there is much more that could be discussed. Over the coming weeks I’ll be writing more blog posts on various aspects of this support. In the mean time, you can check out the Getting Started tutorial and the Codename One Maven Developer Guide for a deeper dive.

2 Comments

  • Eric Gbofu says:

    Hello

    I have a few things to report about Maven support

    1) Normally, a Kotlin project accepts a mix of Java and Kotlin files. With the old Ant support, I could mix * .kt and * .java files in the same project and everything worked fine. With this new Maven support, when I mix these two file formats in a kotlin project, the first run goes fine and everything displays fine, but when I make changes to the * .java file and re executes the code, the simulator starts but the modifications are applied. Any modification that is done after the first execution in the java file is not applied at all. With Ant, this problem was not present. What is the cause?

    2) With the previous Ant build system, we can see methods documentation in the IDE. With Maven, this documentation is no longer displayed. Can you fix that please ?

    3) In the documentation you show how to create CN1 maven project via the command line and Codename One initializer. Can you also add in the documentation how to do it directly via the IDE without going through the two previous options?

    Thanks

Leave a Reply