Skip to content

Latest commit

 

History

History
155 lines (103 loc) · 5.5 KB

README.md

File metadata and controls

155 lines (103 loc) · 5.5 KB
Raw

02 - Build a simple Spring Boot microservice

This guide is part of the Azure Spring Cloud training

Build the simplest possible Spring Boot microservice, made with https://start.spring.io/.

Create a simple Spring Boot microservice

The microservice that we create in this guide is available here.

To create our microservice, we will use https://start.spring.io/ via the command line.

💡 Note: All subsequent commands in this workshop should be run from the same directory, except where otherwise indicated via cd commands.

curl https://start.spring.io/starter.tgz -d dependencies=web -d baseDir=simple-microservice -d bootVersion=2.3.8 -d javaVersion=1.8 | tar -xzvf -

We force the Spring Boot version to be 2.3.8.

Add a new Spring MVC Controller

Expanding the newly created "simple-microservice" directory, create a new class called HelloController in src/main/java/com/example/demo, next to DemoApplication with the following content:

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello from Azure Spring Cloud\n";
    }
}

The final project is available in the "simple-microservice" folder.

Test the project locally

Run the project:

cd simple-microservice
./mvnw spring-boot:run &
cd ..

Requesting the /hello endpoint should return the "Hello from Azure Spring Cloud" message.

curl http://127.0.0.1:8080/hello

Finally, kill running app:

kill %1

Create and deploy the application on Azure Spring Cloud

This section shows how to create an app instance and then deploy your code to it.

In order to create the app instance graphically, you can use the Azure portal:

  • Look for your Azure Spring Cloud instance in your resource group
  • Click on the "Apps" link under "Settings" on the navigation sidebar.
  • Click on "Create App" link at the top of the Apps page.
  • Create a new application named "simple-microservice"

Create application

  • Click on "Create".

Alternatively, you can use the command line to create the app instance, which is easier:

az spring-cloud app create -n simple-microservice

You can now build your "simple-microservice" project and deploy it to Azure Spring Cloud:

cd simple-microservice
./mvnw clean package
az spring-cloud app deploy -n simple-microservice --jar-path target/demo-0.0.1-SNAPSHOT.jar
cd ..

This creates a jar file on your local disk and uploads it to the app instance you created in the preceding step. The az command will output a result in JSON. You don't need to pay attention to this output right now, but in the future, you will find it useful for diagnostic and testing purposes.

Test the project in the cloud

Go to the Azure portal:

  • Look for your Azure Spring Cloud instance in your resource group
  • Click "Apps" in the "Settings" section of the navigation pane and select "simple-microservice"
  • Mouse over the URL labeled as "Test Endpoint" and click the clipboard icon that appears. This will give you something like: https://primary:BBQM6nsYnmmdQREXQINityNx63kWUbjsP7SIvqKhOcWDfP6HJTqg27klMLaSfpTB@rwo1106f.test.azuremicroservices.io/simple-microservice/default/ Note the text between https:// and @. These are the basic authentication credentials, without which you will not be authorized to access the service.

You can now use cURL again to test the /hello endpoint, this time served by Azure Spring Cloud. For example.

curl https://primary:BBQM6nsYnmmdQREXQINityNx63kWUbjsP7SIvqKhOcWDfP6HJTqg27klMLaSfpTB@rwo1106f.test.azuremicroservices.io/simple-microservice/default/hello/

💡Note that we have appended hello/ to the URL. Failure to do this will result in a "404 not found".

If successful, you should see the message: Hello from Azure Spring Cloud.

Conclusion

Congratulations, you have deployed your first Spring Boot microservice to Azure Spring Cloud!

If you need to check your code, the final project is available in the "simple-microservice" folder.

Here is the final script to build and deploy everything that was done in this guide:

curl https://start.spring.io/starter.tgz -d dependencies=web -d baseDir=simple-microservice -d bootVersion=2.3.8 -d javaVersion=1.8 | tar -xzvf -
cd simple-microservice
cat > HelloController.java << EOF
package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello from Azure Spring Cloud";
    }
}
EOF
mv HelloController.java src/main/java/com/example/demo/HelloController.java
az spring-cloud app create -n simple-microservice
./mvnw clean package
az spring-cloud app deploy -n simple-microservice --jar-path target/demo-0.0.1-SNAPSHOT.jar

⬅️ Previous guide: 01 - Create an Azure Spring Cloud instance

➡️ Next guide: 03 - Configure monitoring