你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

教程:使用 Linux 上的 Azure 应用服务和 MySQL 生成 JBoss Web 应用

本教程介绍如何在连接到 MySQL 数据库的 Azure 应用服务中生成、配置和部署安全 JBoss 应用程序(使用 Azure Database for MySQL)。 Azure 应用服务是一种可缩放程度高、支持自修补的 Web 托管服务,可轻松地在 Windows 或 Linux 上部署应用。 完成本教程后,Linux 上的 Azure 应用服务中将会运行一个 JBoss 应用。

将数据存储到 MySQL 的 JBoss 应用程序的屏幕截图。

本教程介绍如何执行下列操作:

  • 为 Azure 应用服务和 Azure Database for MySQL 灵活服务器创建安全默认体系结构。
  • 使用无密码连接字符串保护数据库连接。
  • 使用 JBoss CLI 验证应用服务中的 JBoss 数据源。
  • 从 GitHub 存储库将 JBoss 示例应用部署到应用服务。
  • 在应用程序代码中访问应用服务应用设置。
  • 进行更新并重新部署应用程序代码。
  • 从应用服务流式传输诊断日志。
  • 在 Azure 门户中管理应用。

先决条件

  • 具有活动订阅的 Azure 帐户。 如果没有 Azure 帐户,可以免费创建一个
  • 一个 GitHub 帐户。 你也可以免费获得一个
  • 具备 JBoss 开发的 Java 知识。

1.运行示例

首先,将示例数据驱动的应用设置为起点。 为方便起见,示例存储库包含一个开发容器配置。 开发容器包含开发应用程序所需的所有内容,包括示例应用程序所需的数据库、缓存和所有环境变量。 开发容器可以在 GitHub codespace 中运行,这意味着可使用 Web 浏览器在任何计算机上运行示例。

步骤 1:在新浏览器窗口中:

  1. 登录到 GitHub 帐户。
  2. 导航到 https://github.com/Azure-Samples/msdocs-jboss-mysql-sample-app/fork
  3. 选择“创建分支”。

显示如何创建示例 GitHub 存储库分支的屏幕截图。

步骤 2:在 GitHub 分支中:

选择“代码”>“在主分支上创建 codespace”。 设置 codespace 需要几分钟时间。

显示如何在 GitHub 中创建 codespace 的屏幕截图。

步骤 3:在 codespace 终端中

  1. 运行 mvn clean wildfly:run
  2. 看到通知 Your application running on port 8080 is available. 时,请等待几秒钟,以便 WildFly 服务器完成应用程序的加载。 然后选择“在浏览器中打开”。 应在新的浏览器选项卡中看到该示例应用程序。若要停止 WildFly 服务器,请键入 Ctrl+C

显示如何在 GitHub codespace 中运行示例应用程序的屏幕截图。

提示

可以向 GitHub Copilot 询问有关此存储库的信息。 例如:

  • @workspace 这个项目有什么用?
  • @workspace .devcontainer 文件夹有什么用?

遇到问题? 检查故障排除部分

2.创建应用服务和 MySQL

首先,创建 Azure 资源。 本教程中使用的步骤创建一组默认安全的资源,其中包括应用服务和 Azure Database for MySQL。 对于创建过程,需要指定:

  • Web 应用的名称。 它以 https://<app-name>-<hash>.<region>.azurewebsites.net 的形式用作应用的 DNS 名称的一部分。
  • “区域”,在世界上以物理方式运行应用。 它还用作应用的 DNS 名称的一部分。
  • 应用的运行时堆栈。 在此处选择要用于应用的 PHP 版本。
  • 应用的托管计划。 它是定价层,包括应用的一组功能和缩放容量。
  • 应用的资源组。 使用资源组可将应用程序所需的所有 Azure 资源分组到一个逻辑容器中。

登录到 Azure 门户并按照以下步骤创建 Azure 应用服务资源。

步骤 1:在 Azure 门户中:

  1. 在顶部搜索栏中,键入“应用服务”
  2. 在“服务”标题下选择标有“应用服务”的项
  3. 选择“创建”>“Web 应用”。 还可以直接导航到创建向导

显示如何使用顶部工具栏中的搜索框查找“Web 应用”创建向导的屏幕截图。

第 2 步:在“创建 Web 应用”页上,按如下所述填写表单。

  1. 名称:msdocs-jboss-mysql。 系统将为你生成名为 msdocs-jboss-mysql_group 的资源组。
  2. 运行时堆栈Java 17
  3. Java Web 服务器堆栈:Red Hat JBoss EAP 8。 如果已使用 Azure 配置了 Red Hat 订阅,请选择“Red Hat JBoss EAP 8 BYO 许可证”
  4. 区域:你附近的任何 Azure 区域。
  5. Linux 计划:新建并使用名称 msdocs-jboss-mysql
  6. 定价计划:高级版 V3 P0V3。 准备就绪后,可以纵向扩展到不同的定价层。
  7. 使用应用进行部署:选择“数据库”。 默认情况下,系统会为你选择“Azure Database for MySQL - 灵活服务器”。 Azure Database for MySQL 是 Azure 上完全托管的 MySQL 数据库即服务,与最新社区版兼容。
  8. 选择“查看 + 创建”。
  9. 验证完成后,选择“创建”。

显示如何在“Web 应用”向导中配置新的应用和数据库的屏幕截图。

步骤 3:该部署需要数分钟才能完成。 部署完成后,选择“转到资源”按钮。 这将直接转到应用服务应用,但会创建以下资源:

  • 资源组:所有已创建资源的容器。
  • 应用服务计划:为应用服务定义计算资源。 将创建基本层中的 Linux 计划。
  • 应用服务:表示应用并在应用服务计划中运行。
  • 虚拟网络:与应用服务应用集成,并隔离后端网络流量。
  • Azure Database for MySQL 灵活服务器:只能从虚拟网络访问。 你的数据库和用户创建于此服务器上。
  • 专用 DNS 区域:在虚拟网络中启用数据库服务器的 DNS 解析。

屏幕截图显示已完成的部署过程。

遇到问题? 检查故障排除部分

3. 创建无密码连接

在此步骤中,你将生成一个基于托管标识的服务连接,稍后可以使用该链接在 JBoss 服务器中创建数据源。 通过使用托管标识连接到 MySQL 数据库,代码可以避免意外泄露机密。

第 1 步:创建托管标识。

  1. 在顶部搜索栏中,键入“托管标识”
  2. 在“服务”标题下选择标有“托管标识”的项。
  3. 选择创建
  4. 在“资源组”中,选择“msdocs-jboss-mysql_group”
  5. 在“区域”中,选择用于 Web 应用的同一区域。
  6. 在“名称”中,键入 msdocs-jboss-mysql-server-identity
  7. 选择“查看 + 创建”。
  8. 选择“创建”。

显示如何配置新托管标识的屏幕截图。

第 2 步:在 MySQL 服务器中启用 Microsoft Entra 身份验证。

  1. 在顶部搜索栏中,键入“msdocs-jboss-mysql-server”
  2. 选择名为 msdocs-jboss-mysql-server 的 Azure Database for MySQL 灵活服务器资源。
  3. 在左侧菜单中,选择“安全”>“身份验证”
  4. 在“分配访问权限”中,选择“仅 Microsoft Entra 身份验证”
  5. 在“用户分配的托管标识”下,选择“选择”。
  6. 选择“msdocs-jboss-mysql-server-identity”,然后选择“添加”。 将标识分配到 MySQL 服务器需要一段时间。
  7. 在“Microsoft Entra 管理员名称”中,选择“选择”
  8. 找到并选择 Azure 帐户,然后选择“选择”
  9. 选择“保存”并等待操作完成。

显示如何为 Azure Database for MySQL 灵活服务器配置 Microsoft Entra 身份验证的屏幕截图。

第 3 步:添加基于托管标识的服务连接器。

  1. 在顶部搜索栏中,键入“msdocs-jboss-mysql”
  2. 选择名为“msdocs-jboss-mysql”的应用服务资源。
  3. 在应用服务页面的左侧菜单中,选择“设置”>“服务连接器”。
  4. 选择创建
  5. 在“基本信息”选项卡中:
  6. 将“服务类型”设置为“DB for MySQL 灵活服务器”
  7. 将“MySQL 灵活服务器”设置为“msdocs-jboss-mysql-server”
  8. 将“MySQL 数据库”设置为“msdocs-jboss-mysql-database”
  9. 将“客户端类型”设置为“Java”
  10. 选择“身份验证”选项卡。
  11. 选择“系统分配的托管标识”
  12. 选择“查看 + 创建”选项卡。
  13. 验证完成后,选择“在 Cloud Shell 上创建”并等待操作在 Cloud Shell 中完成。
  14. 看到输出 JSON 时,可以关闭 Cloud Shell。 此外,请关闭“创建连接”对话框。
  15. 选择“刷新”以显示新的服务连接器。

显示完全配置的服务连接器的屏幕截图,该连接器已准备好使用 cloud shell 创建。

第 4 步:将身份验证插件添加到连接字符串。

  1. 在左侧菜单中,选择“环境变量”>“连接字符串”
  2. 选择“AZURE_MYSQL_CONNECTIONSTRING”。 “值”字段应包含 user 但不包含 password。 用户是托管标识。
  3. 应用服务应用中的 JBoss 服务器具有身份验证插件来验证托管标识,但你仍需要将其添加到连接字符串中。 滚动到值末尾并追加 &defaultAuthenticationPlugin=com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin&authenticationPlugins=com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin
  4. 选择“应用”。
  5. 选择“应用”,然后选择“确认”

屏幕截图显示了如何在 Azure 中更改 MySQL 环境变量的值。

遇到问题? 检查故障排除部分

4.确认 JNDI 数据源

如果你添加包含适用于 Oracle、SQL Server、PostgreSQL 或 MySQL 的有效 JDBC 连接字符串的应用设置,则应用服务会在 JBoss 服务器中为其添加一个 Java 命名和目录接口 (JNDI) 数据源。 在此步骤中,你使用与应用容器的 SSH 连接来验证 JNDI 数据源。 在此过程中,你将了解如何访问 SSH shell 并运行 JBoss CLI。

步骤 1:返回“应用服务”页:

  1. 在左侧菜单中,选择“开发工具”>“SSH”
  2. 选择“转到”。

显示如何从 Azure 门户打开应用的 SSH shell 的屏幕截图。

步骤 2:在 SSH 终端中:

  1. 运行 $JBOSS_HOME/bin/jboss-cli.sh --connect
  2. 在 JBoss CLI 连接中,运行 ls subsystem=datasources/data-source。 应该会看到自动生成的名为 AZURE_MYSQL_CONNECTIONSTRING_DS 的数据源。
  3. 使用 /subsystem=datasources/data-source=AZURE_MYSQL_CONNECTIONSTRING_DS:read-attribute(name=jndi-name) 获取数据源的 JNDI 名称。 现在,你已获得一个 JNDI 名称 java:jboss/env/jdbc/AZURE_MYSQL_CONNECTIONSTRING_DS,稍后可以在应用程序代码中使用。

显示在 SSH shell 中运行的 JBoss CLI 命令及其输出的屏幕截图。

注意

只有对 /home 中文件的更改才能在应用重启之后持久保存。 例如,如果在 JBoss CLI 中编辑 /opt/eap/standalone/configuration/standalone.xml 或更改服务器配置,则更改不会在应用重启之后保留。 若要保留更改,请使用启动脚本,如“在 Azure 应用服务中为 Tomcat、JBoss 或 Java SE 应用配置数据源”中所示

遇到问题? 检查故障排除部分

5.部署示例代码

在此步骤中,使用 GitHub Actions 配置 GitHub 部署。 这只是部署到应用服务的许多方法之一,也是一种在部署过程中持续集成的好方法。 默认情况下,进入 GitHub 存储库的每个 git push 都会启动生成和部署操作。

与 Tomcat 约定一样,如果要部署到 Tomcat 的根上下文,请将生成的项目命名为“ROOT.war”

第 1 步:返回“应用服务”页,在左侧菜单中,选择“部署”>“部署中心”

显示如何在“应用服务”中打开部署中心的屏幕截图。

步骤 2:在“部署中心”页中:

  1. 在“源”中,选择“GitHub”。 默认情况下,选择 GitHub Actions 作为生成提供程序。
  2. 登录到 GitHub 帐户,并按照提示授权 Azure。
  3. 在“组织”中,选择你的帐户。
  4. 在“存储库”中,选择“msdocs-jboss-mysql-sample-app”
  5. 在“分支”中,选择“主”。 这是与示例应用一起使用的同一分支,不包含任何与 Azure 相关的文件或配置。
  6. 对于“身份验证类型”,请选择“用户分配的标识”。
  7. 在顶部菜单中,选择“保存”。 应用服务会将工作流文件提交到所选 GitHub 存储库中(在 .github/workflows 目录中)。 默认情况下,部署中心会为工作流创建用户分配的标识,以便使用 Microsoft Entra(OIDC 身份验证)进行身份验证。 有关身份验证选项的详细信息,请参阅使用 GitHub Actions 部署到应用服务

显示如何使用 GitHub Actions 配置 CI/CD 的屏幕截图。

步骤 3:返回示例分支的 GitHub codespace,运行 git pull origin main。 这会将新提交的工作流文件拉取到 codespace。 可以按需在 .github/workflows/main_msdocs-jboss-mysql.yml 中更改

显示 GitHub codespace 内的 git 拉取的屏幕截图。

步骤 4(选项 1:使用 GitHub Copilot):

  1. 单击“聊天”视图,然后单击“+”,即可开始新的聊天会话。
  2. 问:“@workspace 应用如何连接到数据库?”Copilot 可能会提供有关 java:jboss/MySQLDS 数据源以及如何配置它的一些说明。
  3. 例如:“Azure 中的 JBoss 中的数据源使用 JNDI 名称 java:jboss/env/jdbc/AZURE_MYSQL_CONNECTIONSTRING_DS。”Copilot 可能会提供类似于下面“选项 2:不使用 GitHub Copilot”步骤中的代码建议,甚至会让你在类中进行更改。 GitHub Copilot 不会每次都给你相同的回复,你可能需要提出更多问题来优调其回复。 有关提示,请参阅我可以在 codespace 中使用 GitHub Copilot 做什么?

屏幕截图显示如何在新的 GitHub Copilot 聊天会话中提问。

步骤 4(选项 2:不使用 GitHub Copilot):

  1. 在资源管理器中打开 src/main/resources/META-INF/persistence.xml。 应用程序启动时,它会在此文件中加载数据库设置。
  2. <jta-data-source> 的值更改为 java:jboss/env/jdbc/AZURE_MYSQL_CONNECTIONSTRING_DS,这是你之前在 SSH shell 中使用 JBoss CLI 找到的数据源。

显示 GitHub codespace 和已打开的 ContextListener.java 文件的屏幕截图。

步骤 5:

  1. 选择“源代码管理”扩展。
  2. 在文本框中,键入类似 Configure Azure JNDI name 的提交消息。
  3. 选择“提交”,然后使用“是”进行确认
  4. 选择“同步更改 1”,然后使用“确定”进行确认。

显示正在提交并推送到 GitHub 的更改的屏幕截图。

步骤 6:返回到 Azure 门户中的“部署中心”页

  1. 选择“日志”。 已从提交的更改开始新的部署运行。
  2. 在部署运行的日志项中,选择具有最新时间戳的“生成/部署日志”条目。

显示如何在部署中心打开部署日志的屏幕截图。

步骤 7:你已转到 GitHub 存储库,并看到 GitHub Action 正在运行。 工作流文件定义两个单独的阶段,即生成和部署阶段。 等待 GitHub 运行以显示“完成”状态。 此过程大约需要 5 分钟。

屏幕截图显示 GitHub 正在运行。

遇到问题? 检查故障排除部分

6.浏览到应用

步骤 1:在“应用服务”页中:

  1. 从左侧菜单中选择“概述”。
  2. 在“默认域”中,选择应用的 URL。

显示如何从 Azure 门户中启动应用服务的屏幕截图。

步骤 2:将一些任务添加到列表。 恭喜,你已在 Azure 应用服务中运行了一个 Web 应用,并安全连接到了 Azure Database for MySQL。

使用在 Azure 中运行的 MySQL 的 JBoss Web 应用的屏幕截图。

遇到问题? 检查故障排除部分

7.流式传输诊断日志

Azure 应用服务会捕获输出到控制台的所有消息,以帮助你诊断应用程序的问题。 示例应用程序包括标准 Log4j 日志记录语句,用于演示此功能,如以下代码片段所示:

private static final Logger logger = Logger.getLogger(MethodHandles.lookup().lookupClass().getName());

@PersistenceContext
private EntityManager entityManager;

public List<Task> getAllTasks() {
    logger.log(Level.INFO, "Finding all tasks. ");

    return this.entityManager.createNamedQuery("findAllTasks", Task.class).getResultList();
}

在“应用服务”页的左侧菜单中,选择“日志流”。 将显示应用的日志,包括平台日志和容器内部的日志。

显示如何在 Azure 门户中查看日志流的屏幕截图。

为 .NET、Node.js、Python 和 Java 应用程序启用 Azure Monitor OpenTelemetry 系列中详细了解 Java 应用中的日志记录。

遇到问题? 检查故障排除部分

8.清理资源

完成后,可以通过删除资源组从 Azure 订阅中删除所有资源。

步骤 1:在 Azure 门户顶部的搜索栏中:

  1. 输入资源组名称“msdocs-jboss-mysql_group”
  2. 选择前面创建的资源组。

显示如何在 Azure 门户中搜索和导航到资源组的屏幕截图。

步骤 2:在资源组页上,选择“删除资源组”。

显示 Microsoft Azure 门户中“删除资源组”按钮位置的屏幕截图。

步骤 3:

  1. 键入资源组名称以确认删除。
  2. 选择“删除”。
  3. 再次使用“删除”进行确认

Azure 门户中删除资源组确认对话框的屏幕截图。

故障排除

创建向导中出现错误“无权使用自带许可功能”。

如果看到错误 The subscription '701ea799-fb46-4407-bb67-9cbcf289f1c7' is not entitled to use the Bring Your Own License feature when creating the application,则表示你在 Java Web 服务器堆栈中选择了 Red Hat JBoss EAP 7/8 BYO 许可证,但尚未在 Red Hat Cloud Access 中设置 Azure 帐户,或者在 Red Hat Cloud Access 中没有有效的 JBoss EAP 许可证。

Azure Database for MySQL 灵活服务器的门户部署视图显示冲突状态。

根据订阅和所选区域,你可能会看到 Azure Database for MySQL 灵活服务器的部署状态为 Conflict,并且操作详细信息中显示以下消息:

InternalServerError: An unexpected error occured while processing the request.

此错误很可能是由所选区域的订阅限制引起的。 请尝试为部署选择其他区域。

“创建连接”对话框显示“在 Cloud Shell 上创建”按钮,但未启用。

可能还会在对话框中看到错误消息:The database server is in Virtual Network and Cloud Shell can't connect to it. Please copy the commands and execute on an environment which can connect to the database server in Virtual Network.

服务连接器自动化需要通过网络访问 MySQL 服务器。 查看 MySQL 服务器资源的网络设置,并确保至少选择“允许公众使用公共 IP 地址通过互联网访问此资源”。 对于服务连接器而言,此为必要操作。

如果未看到此复选框,则可能已使用“Web 应用 + 数据库向导”创建了部署,并且该部署锁定了对 MySQL 服务器的所有公共网络访问。 无法修改配置。 由于应用的 Linux 容器可以通过虚拟网络集成访问 MySQL,因此可以在应用程序的 SSH 会话中安装 Azure CLI 并在那里运行给定的 Cloud Shell 命令。

已部署的示例应用未显示任务列表应用。

如果你看到的是 JBoss 启动页面而不是任务列表应用,则应用服务很可能仍会从最近的代码部署加载更新的容器。 等待几分钟,然后刷新页面。

我的应用无法启动,并且我在日志中看到“拒绝用户访问...(使用密码:否)”。

出现此错误很可能是因为你没有将无密码身份验证插件添加到连接字符串(请参阅将 Azure Database for MySQL 与服务连接器集成的 Java 示例代码)。 按照“3.创建无密码连接”中的说明更改 MySQL 连接字符串。

诊断日志中出现错误:“表‘任务’已存在”。

你可以忽略此休眠错误,因为此错误表明应用程序代码已连接到 MySQL 数据库。 已将该应用程序配置为在启动时创建必要的表(参见 src/main/resources/META-INF/persistence.xml)。 应用程序首次启动时,应该已成功创建表,但是在后续重新启动时,你会看到此错误,因为表已经存在。

常见问题解答

此设置花费有多大?

所创建资源的定价如下所示:

  • 除非配置额外的功能(例如对等互连),否则虚拟网络不会产生费用。 请参阅 Azure 虚拟网络定价
  • 专用 DNS 区域会产生少量费用。 请参阅 Azure DNS 定价

如何使用其他工具连接到虚拟网络后面的 MySQL 服务器?

  • JBoss 容器当前也没有 mysql-client 终端。 如果需要,则必须手动安装它。 请记住,你安装的任何内容都不会在应用重启时保留。
  • 若要从 MySQL Workbench 等桌面工具进行连接,计算机必须位于虚拟网络中。 例如,它可以是其中某个子网中的 Azure VM,也可以是与 Azure 虚拟网络建立站点到站点 VPN 连接的本地网络中的计算机。
  • 还可以将 Azure Cloud Shell 与虚拟网络集成。

本地应用开发如何与 GitHub Actions 配合使用?

以应用服务中自动生成的工作流文件为例,每个 git push 都会启动新的生成和部署运行。 从 GitHub 存储库的本地克隆中,进行所需更新并推送到 GitHub。 例如:

git add .
git commit -m "<some-message>"
git push origin main

我无权创建用户分配的标识

请参阅从部署中心设置 GitHub Actions 部署

我可以在 codespace 中使用 GitHub Copilot 做什么?

你可能注意到,创建 codespace 时,GitHub Copilot 聊天视图已经存在。 为了你的方便,我们在容器定义中包含了 GitHub Copilot 聊天扩展(参见 .devcontainer/devcontainer.json)。 不过,你需要一个 GitHub Copilot 帐户(可免费试用 30 天)。

下面是与 GitHub Copilot 交谈时的一些提示:

  • 在单次聊天会话中,问题和答案相互关联,你可以调整问题来微调所获得的答案。
  • 默认情况下,GitHub Copilot 无法访问你存储库中的任何文件。 若要询问有关文件的问题,请首先在编辑器中打开该文件。
  • 为了让 GitHub Copilot 在准备答案时有权访问存储库中的所有文件,请在问题开头加上 @workspace。 有关详细信息,请参阅 Use the @workspace agent
  • 在聊天会话中,GitHub Copilot 可以建议更改,甚至可以(在使用 @workspace 时)建议在何处进行更改,但系统不允许它为你进行更改。 你可以自行添加建议的更改并对其进行测试。

你还可以说下面的一些话来微调得到的答案:

  • 更改此代码以使用数据源 jdbc/AZURE_MYSQL_CONNECTIONSTRING_DS。
  • 你的代码中的某些导入使用了 javax,但我使用的是 Jakarta 应用。
  • 我希望只有在设置了环境变量 AZURE_MYSQL_CONNECTIONSTRING 的情况下才运行此代码。
  • 我希望此代码仅在 Azure 应用服务中运行,而不在本地运行。

后续步骤

在开发人员指南中详细了解在应用服务上运行 Java 应用。

了解如何使用自定义域和证书保护应用。