Development Environment

§Development Environment

Lagom’s sbt and Maven based development environments allow running any number of services together with a single command.

The same command also reloads your services when the code changes, so that you don’t have to manually restart them. You can stay focused on your work and let Lagom do the compiling and reloading.

§Running all services in Maven

To run all services in Maven, simply run the lagom:runAll command:

$ cd <path to your Lagom project>
$ mvn lagom:runAll
INFO ...
INFO Service helloworld-impl listening for HTTP on 0:0:0:0:0:0:0:0:23966
INFO Service hellostream-impl listening for HTTP on 0:0:0:0:0:0:0:0:27462
(Services started, press enter to stop and go back to the console...)

This may take a while if you have a lot of services or if dependencies are being retrieved for the first time.

§Starting the sbt development console

Assuming you have followed the Installation instructions, it’s now time to fire up the console on your Lagom project directory:

$ cd <path to your Lagom project>
$ activator
[info] ...
>

To run all Lagom services together, with automatic reloading, just enter runAll in the activator console:

> runAll
[info] ...
[info] Service helloworld-impl listening for HTTP on 0:0:0:0:0:0:0:0:23966
[info] Service hellostream-impl listening for HTTP on 0:0:0:0:0:0:0:0:27462
(Services started, press enter to stop and go back to the console...)

This may take a while if you have a lot of services or if dependencies are being retrieved for the first time.

§Hot reloading

Once the “Services started” message has appeared, if you make a change to your source code, you’ll see output like this in the console:

[info] Compiling 1 Java source to /<project-path>/target/scala-2.11/classes...

--- (RELOAD) ---

§Behind the scenes

What’s happening behind the scenes when you runAll?

  • an embedded Service Locator is started
  • a Cassandra server is started
  • your services start
    • …and register with the Service Locator

This all happens automatically without special code or additional configuration.

You can verify that your services are running by viewing http://localhost:8000/services in a web browser (or with a command line tool such as curl). The Service Locator, running on port 8000, will return JSON such as:

[{"name":"hellostream","url":"http://0.0.0.0:26230"},
 {"name":"cas_native","url":"tcp://127.0.0.1:4000/cas_native"},
 {"name":"helloservice","url":"http://0.0.0.0:24266"}]

cas_native is the Cassandra server. As you will learn in the documentation for writing persistent and clustered services, Cassandra is the default database in Lagom, and it’s an integral part of the development environment.

Both the Service Locator and Cassandra are covered in more detail in the sections that follow.

Found an error in this documentation? The source code for this page can be found here. Please feel free to edit and contribute a pull request.