Руководство. Создание веб-приложения Java Spring Boot с помощью службы приложение Azure в Linux и Azure Cosmos DB

• Учетная запись Azure с активной подпиской. Если у вас нет учетной записи Azure, ее можно создать бесплатно.
• Учетная запись GitHub. Вы также можете получить его бесплатно.
• Знание Java с помощью разработки Spring Framework.
• (Необязательно) Чтобы попробовать GitHub Copilot, учетная запись GitHub Copilot. Доступна 30-дневная бесплатная пробная версия.

• Учетная запись Azure с активной подпиской. Если у вас нет учетной записи Azure, ее можно создать бесплатно.
• Установлен интерфейс командной строки разработчика Azure. Вы можете выполнить действия с помощью Azure Cloud Shell , так как он уже установлен с помощью Интерфейса командной строки разработчика Azure.
• Знание Java с помощью разработки Spring Framework.
• (Необязательно) Чтобы попробовать GitHub Copilot, учетная запись GitHub Copilot. Доступна 30-дневная бесплатная пробная версия.

2. Создание Служба приложений и Cosmos DB

Сначала вы создадите ресурсы Azure. Действия, используемые в этом руководстве, создают набор безопасных ресурсов по умолчанию, которые включают Служба приложений и Azure Cosmos DB. Для процесса создания укажите:

• Имя веб-приложения. Он используется в качестве части DNS-имени приложения в виде https://<app-name>-<hash>.<region>.azurewebsites.net.
• Регион для физического запуска приложения. Он также используется в качестве части DNS-имени приложения.
• Стек среды выполнения для приложения. Здесь вы выбираете версию Java, используемую для вашего приложения.
• План размещения для приложения. Это ценовая категория, которая включает набор функций и емкость масштабирования для вашего приложения.
• Группа ресурсов для приложения. Группа ресурсов позволяет группировать (в логическом контейнере) все ресурсы Azure, необходимые для приложения.

Войдите на портал Azure и выполните следующие действия, чтобы создать ресурсы Службы приложений Azure.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

3. Безопасные секреты подключения

Мастер создания создал строку подключения для вас уже в качестве параметра приложения. Однако рекомендуется сохранить секреты из Служба приложений полностью. Вы переместите секреты в хранилище ключей и измените параметр приложения на ссылку Key Vault с помощью соединителей служб.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

4. Развертывание примера кода

На этом шаге вы настроите развертывание GitHub с помощью GitHub Actions. Это всего лишь один из множества способов развертывания в Службе приложений, но это также отличный способ обеспечения непрерывной интеграции в процессе развертывания. По умолчанию каждый git push из репозитория GitHub запускает действие сборки и развертывания.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

5. Перейдите к приложению

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

6. Потоковая передача журналов диагностики

Служба приложений Azure захватывает все сообщения, выводимые на консоль, чтобы помочь в диагностике проблем с приложением. Пример приложения включает стандартные инструкции ведения журнала Log4j для демонстрации этой возможности, как показано в следующем фрагменте кода:

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

Узнайте больше о ведении журнала в приложениях Java в серии о включении Azure Monitor OpenTelemetry для приложений .NET, Node.js, Python и Java.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

7. Очистка ресурсов

По завершении работы можно удалить все ресурсы из вашей подписки Azure, удалив соответствующую группу ресурсов.

2. Создание ресурсов Azure и развертывание примера приложения

На этом шаге вы создадите ресурсы Azure и развернете пример приложения для Служба приложений в Linux. Действия, используемые в этом руководстве, создают набор безопасных ресурсов по умолчанию, которые включают Служба приложений и Azure Cosmos DB.

Контейнер разработки уже имеет интерфейс командной строки разработчика Azure (AZD).

1. Выполните команду azd initиз корневого каталога репозитория.

   azd init --template javase-app-service-cosmos-redis-infra
   

2. При появлении запроса укажите следующие ответы:

   Вопрос	Ответ
   Текущий каталог не пуст. Вы хотите инициализировать проект здесь в каталоге<>?	Y
   Что вы хотите сделать с этими файлами?	Сохранение существующих файлов без изменений
   Введите новое имя среды	Введите уникальное имя. Шаблон AZD использует это имя как часть DNS-имени веб-приложения в Azure (<app-name>-<hash>.azurewebsites.net). Разрешены буквенно-цифровые символы и дефисы.

3. Войдите в Azure, выполнив azd auth login команду и выполнив следующую команду:

   azd auth login
   

4. Создайте необходимые ресурсы Azure и разверните код приложения с azd up помощью команды. Следуйте запросу, чтобы выбрать нужную подписку и расположение для ресурсов Azure.

   azd up
   

   Выполнение azd up команды занимает около 15 минут (кэш Redis занимает больше всего времени). Он также компилирует и развертывает код приложения, но вы измените код позже, чтобы работать с Служба приложений. Во время выполнения команда предоставляет сообщения о процессе подготовки и развертывания, включая ссылку на развертывание в Azure. По завершении команда также отображает ссылку на приложение развертывания.

   Этот шаблон AZD содержит файлы (azure.yaml и инфракрасный каталог), создающие безопасную архитектуру по умолчанию со следующими ресурсами Azure:

   • Группа ресурсов: контейнер для всех созданных ресурсов.
   • Служба приложений план. Определяет вычислительные ресурсы для Служба приложений. Создается план Linux на уровне B1 .
   • Служба приложений. Представляет приложение и запускается в плане Служба приложений.
   • Виртуальная сеть: интегрированная с приложением Служба приложений и изолирует внутренний сетевой трафик.
   • Учетная запись Azure Cosmos DB с API MongoDB: доступна только за частной конечной точкой. База данных создается для вас на сервере.
   • Кэш Azure для Redis. Доступно только из виртуальной сети.
   • Хранилище ключей: доступно только из своей частной конечной точки. Используется для управления секретами для приложения Служба приложений.
   • Частные конечные точки: доступ к конечным точкам для хранилища ключей, сервера базы данных и кэша Redis в виртуальной сети.
   • Частная зона DNS зонах: включите разрешение DNS базы данных Cosmos DB, кэш Redis и хранилище ключей в виртуальной сети.
   • Рабочая область Log Analytics: выступает в качестве целевого контейнера для вашего приложения для отправки журналов, где можно также запрашивать журналы.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

3. Проверка строка подключения

Шаблон AZD, который вы используете, создали переменные подключения для вас уже в качестве параметров приложения и выводит их в терминал для удобства. Параметры приложения — это один из способов сохранения секретов подключения из репозитория кода.

1. В выходных данных AZD найдите параметр spring.data.mongodb.uriприложения. Отображаются только имена параметров. Они выглядят следующим образом в выходных данных AZD:

    App Service app has the following app settings:
            - spring.data.mongodb.uri
            - spring.data.mongodb.database
            - spring.redis.host
            - spring.redis.port
            - spring.redis.password
            - spring.redis.database
            - spring.redis.ssl
            - spring.cloud.azure.keyvault.secret.credential.managed_identity_enabled
            - spring.cloud.azure.keyvault.secret.endpoint
            - azure.keyvault.uri
            - azure.keyvault.scope
    

   spring.data.mongodb.uri содержит URI подключения к базе данных Cosmos DB в Azure. Это стандартная переменная Spring Data, которую приложение уже использует в файле src/main/resources/application.properties .

2. В обозревателе перейдите к src/main/resources/application.properties и убедитесь, что приложение Spring Boot уже использует spring.data.mongodb.uri переменную для доступа к данным.

3. Для удобства выходные данные шаблона AZD отображают прямую ссылку на страницу параметров приложения. Найдите ссылку и откройте ее на новой вкладке браузера.

   Если вы посмотрите на значение spring.data.mongodb.uri, это означает @Microsoft.KeyVault(...), что это ссылка на хранилище ключей, так как секрет управляется в хранилище ключей.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

4. Переход в приложение

1. В выходных данных AZD найдите URL-адрес приложения и перейдите к нему в браузере. URL-адрес выглядит следующим образом в выходных данных AZD:

    Deploying services (azd deploy)
   
      (✓) Done: Deploying service web
      - Endpoint: https://<app-name>-<hash>.azurewebsites.net/
    

2. Добавьте несколько задач в список.

   

   Поздравляем, вы запускаете веб-приложение в службе приложение Azure с безопасным подключением к Azure Cosmos DB.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

5. Потоковая передача журналов диагностики

служба приложение Azure может записывать журналы консоли для диагностики проблем с приложением. Для удобства шаблон AZD уже включил ведение журнала в локальную файловую систему и отправляет журналы в рабочую область Log Analytics.

Пример приложения включает стандартные инструкции ведения журнала Log4j для демонстрации этой возможности, как показано в следующем фрагменте кода:

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

В выходных данных AZD найдите ссылку для потоковой передачи журналов Служба приложений и перейдите к нему в браузере. Ссылка выглядит следующим образом в выходных данных AZD:

Stream App Service logs at: https://portal.azure.com/#@/resource/subscriptions/<subscription-guid>/resourceGroups/<group-name>/providers/Microsoft.Web/sites/<app-name>/logStream

Узнайте больше о ведении журнала в приложениях Java в серии о включении Azure Monitor OpenTelemetry для приложений .NET, Node.js, Python и Java.

Возникли проблемы? Ознакомьтесь с разделом "Устранение неполадок".

6. Очистка ресурсов

Чтобы удалить все ресурсы Azure в текущей среде развертывания, выполните azd down и следуйте инструкциям.

azd down