Modern Java Web App Patterns

Introduction

This repository provides a "real-world" application that implements the best practices and design patterns discussed in Modern Web App pattern for Java. The patterns are designed to be used with the Spring Framework and Azure, but can be adapted to other frameworks and cloud providers.

This project has a companion article in the Azure Architecture Center that describes design patterns and best practices. Here's an outline of the contents in this readme:

• Architecture
• Workflow
• Steps to deploy the reference implementation
• Changes from Reliable Web App
• Additional links
• Data Collection

Architecture

Contoso Fiber aligned to a hub and spoke network topology in the production deployment architecture to centralize common resources. This network topology provided cost savings, enhanced security, and facilitated network integration (platform and hybrid):

Steps to deploy the reference implementation

The following detailed deployment steps assume you are using a Dev Container inside Visual Studio Code.

For your convenience, we use Dev Containers with a fully-featured development environment. If you prefer to use another editor, we recommend installing the necessary dependencies and skip to the deployment instructions starting in Step 3.

1. Clone the repo

For Windows users, we require using Windows Subsystem for Linux (WSL) to improve Dev Container performance.

wsl

Clone the repository and open the project using the Dev Container.

git clone https://github.com/Azure/modern-web-app-pattern-java

cd modern-web-app-pattern-java

2. Open Dev Container in Visual Studio Code

If required, ensure Docker Desktop is started. Open the repository folder in Visual Studio Code. You can do this from the command prompt:

code .

Once Visual Studio Code is launched, you should see a popup allowing you to click on the button Reopen in Container.

If you don't see the popup, open the Visual Studio Code Command Palette to execute the command. There are three ways to open the command palette:

• For Mac users, use the keyboard shortcut ⇧⌘P
• For Windows and Linux users, use Ctrl+Shift+P
• From the Visual Studio Code top menu, navigate to View -> Command Palette.

Once the command palette is open, search for Dev Containers: Rebuild and Reopen in Container.

3. Login to Azure

Before deploying, you must be authenticated to Azure and have the appropriate subscription selected. Run the following command to authenticate:

az login

If you have multiple tenants, you can use the following command to log into the tenant:

az login --tenant <tenant-id>

Set the subscription to the one you want to use (you can use az account list to list available subscriptions):

export AZURE_SUBSCRIPTION_ID="<your-subscription-id>"

az account set --subscription $AZURE_SUBSCRIPTION_ID

Use the next command to login with the Azure Dev CLI (AZD) tool:

azd auth login

If you have multiple tenants, you can use the following command to log into the tenant:

azd auth login --tenant-id <tenant-id>

4. Create a new environment

Next we provide the AZD tool with variables that it uses to create the deployment. The first thing we initialize is the AZD environment with a name.

The environment name should be less than 18 characters and must be comprised of lower-case, numeric, and dash characters (for example, contosowebapp). The environment name is used for resource group naming and specific resource naming.

azd env new <pick_a_name>

Select the subscription that will be used for the deployment:

azd env set AZURE_SUBSCRIPTION_ID $AZURE_SUBSCRIPTION_ID

Set the Azure region to be used:

azd env set AZURE_LOCATION <pick_a_region>

Optional: Set the App Registration Service management reference:

azd env set AZURE_SERVICE_MANAGEMENT_REFERENCE <service_management_reference>

5. Build the applications

Run the following command to build the applications:

./mvnw clean install

6. Create the Azure resources and deploy the code

Run the following command to create the Azure resources and deploy the code (about 15-minutes to complete):

azd up

7. Tear down the deployment

Run the following command to tear down the deployment:

azd down --purge --force

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Additional links

• Known issues
• Troubleshooting
• Pattern Simulations
• Calculating SLA
• Find additional resources
• Report security concerns
• Find Support
• Contributing

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Data Collection

The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's privacy statement. Our privacy statement is located at https://go.microsoft.com/fwlink/?LinkId=521839. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.

Telemetry Configuration

Telemetry collection is on by default.

To opt out, run the following command azd env set ENABLE_TELEMETRY to false in your AZD environment.