全部产品
云市场

快速入门

更新时间:2020-03-05 21:29:14

本文将向您描述如何使用 SOFABoot 框架创建一个Web 工程,实现本地运行或部署到云端运行,以及如何引入中间件服务。主要步骤如下:

  • 创建 Web 工程
  • 将 Web 工程导入 IDE
  • 实现本地编译和运行
  • 实现云端运行
  • 引入中间件服务

说明Core 工程Web 工程类似,具体步骤详见 创建工程

创建 Web 工程

前置条件

为执行本文代码示例,您需要首先搭建 SOFABoot 的运行环境。具体步骤详见 搭建环境

创建步骤

SOFABoot Web 工程的创建,主要分为 2 个步骤:

  1. 通过 Maven 命令,创建本地工程;
  2. 到脚手架获取关键信息,实现属性配置。

具体操作步骤如下:

创建本地工程

注意:本文档仅支持 SOFABoot ≥ 3.3.0 版本的创建,如需升级,请参考 SOFABoot 升级说明
  1. 打开命令行工具,输入并执行以下语句:
    1. mvn archetype:generate -DarchetypeGroupId=com.alipay.sofa \
    2. -DarchetypeArtifactId=sofaboot-web-archetype \
    3. -DarchetypeVersion=1.0-SNAPSHOT -DarchetypeCatalog=internal
  2. 在执行过程中,根据系统提示输入以下 Maven 坐标信息:
    • groupId:是 Maven 仓库中的唯一标识,一般为公司域名或组织域名的反写。作为示例,可填为 com.alipay.sofa
    • artifactId:表示项目名称或应用名称。作为示例,可填为 web-app
    • version:版本号,默认为 1.0-SNAPSHOT。SNAPSHOT 意为快照,说明该项目还在开发中,是不稳定的版本。作为示例,此处可维持默认值。
    • package:应用包名,默认等同于 groupId。
      1. # 示例
      2. Define value for property 'groupId': com.alipay.sofa
      3. Define value for property 'artifactId': web-app
      4. Define value for property 'version' 1.0-SNAPSHOT: :
      5. Define value for property 'package' com.alipay.sofa: :
  3. 确认输入的 Maven 坐标信息。

    • 如果信息无误,输入 Y 确认,则工程继续创建。
    • 如需修改信息,输入 N 重新定义工程属性。
      1. # 示例
      2. Confirm properties configuration:
      3. groupId: com.alipay.sofa
      4. artifactId: web-app
      5. version: 1.0-SNAPSHOT
      6. package: com.alipay.sofa
      7. Y: :
  4. 工程创建完成。命令行提示以下信息。您可以在当前路径下的 ./web 文件夹找到创建的工程文件。

    1. [INFO] Project created from Archetype in dir: {current_dir}/web
    2. [INFO] ------------------------------------------------------------------------
    3. [INFO] BUILD SUCCESS
    4. [INFO] ------------------------------------------------------------------------
    5. [INFO] Total time: 28.298 s
    6. [INFO] Finished at: 2018-01-10T23:36:19+08:00
    7. [INFO] Final Memory: 15M/163M
    8. [INFO] ------------------------------------------------------------------------


  5. 请移步 版本说明,查看最新的 SOFABoot 版本,然后在工程根目录下的主 pom.xml 中,修改 <parent>标签的版本号,示例如下:

    版本号

配置关键信息

  1. 请前往 脚手架 > Step 2,示例如下:
    脚手架截图从中获取下述信息:
    • 实例标识:应用实例在工作空间中的唯一标识,在 application 中对应的 key 为:com.alipay.instanceid
    • AntVIP:应用通过 AntVIP 来获取各个组件的服务端地址,每个区域一个地址。在 application 中对应的 key 为 com.antcloud.antvip.endpoint
  2. 请前往 RAM 控制台 获取访问中间件的身份验证密钥。它们在 application 中对应的 key 分别为:

    • Access Key ID:com.antcloud.mw.access
    • Access Secret:com.antcloud.mw.secret

    更多详情,参见 创建 AccessKey

  3. 将上述信息,配置在 application.properties 文件中。

对于有关 SOFABoot 框架的整体配置、工程依赖的配置,以及中间件服务的配置,请参见:

将 Web 工程导入 IDE

SOFABoot 工程是标准的 Maven 工程。您可以使用经典的 Java 开发工具(如 IntelliJ IDEA 、Eclipse 等)对其进行开发。请遵照以下步骤将 SOFABoot 工程导入相应的 IDE 工具中:

IntelliJ IDEA

  1. 打开 IntelliJ IDEA 程序。
  2. 导入之前创建的工程目录。
    • 如果您是首次使用,或者之前关闭了所有工程,程序会跳出欢迎界面。在该界面中,点击 Open > 选择之前创建的工程目录 > OK
    • 如果 IntelliJ IDEA 自动为您载入了上次未关闭的工程,您可以点击 File > Open > 选择之前创建的工程目录 > OK
  3. 配置 Maven:
    1. 点击 File > Settings,打开设置窗口,并通过以下任一方式定位到 Maven 配置页面:
      • 依次点击 Build, Execution, Deployment > Build tools > Maven
      • 搜索关键字 Maven
    2. Maven home directory 项配置为本地 Maven 安装目录。
    3. User Settings file 项配置为本地 Maven 的 settings.xml 文件路径。
    4. 点击 OK 关闭设置窗口。

导入完成后,您可以在工程文件目录中查看工程结构与内容。

Eclipse

  1. 打开 Eclipse 程序。
  2. 配置 Maven:
    1. 点击 Window > Preferences,打开首选项窗口,并搜索关键字 Maven 定位到 Maven 配置页面。
    2. Maven 下,选择 Installations 并配置 Maven 目录。
      • 如果 Installations 列表中已有本地 Maven 安装目录选项,直接勾选该选项。
      • 如果列表中没有本地 Maven 安装目录选项,点击 Add。在新窗口中,将 Installation home 配置为本地 Maven 安装目录,点击 Finish 返回并勾选新添加的目录选项。
    3. 点击 Apply,保存配置。
    4. Maven 下,选择 User Settings 并将 User Settings 项配置为本地 Maven 的 settings.xml 文件路径。
    5. 点击 Apply and Close 保存配置并关闭首选项窗口。
  3. 依次点击 File > Import > Maven > Existing Maven Projects > Next > 选择之前创建的工程目录 > Finish

本地编译运行

  1. 右键点击 ./app/web/src/main/java/$groupId/SOFABootWebSpringApplication,选择 Run ‘SOFABootWebSpringApplication’ 编译并运行该工程。
  2. 成功运行后,在浏览器中访问 http://localhost:8080/index.html,您可以看到以下静态页面信息:
    1. the static page in SOFABoot based on spring-boot

    注意:SOFABoot Core 工程是没有页面的工程,因此无法在本地进行效果预览。但可以通过
    http://localhost:8080/actuator/readiness
    进行健康检查。如果 status 为 UP,表示创建成功。

更多本地编译运行 SOFABoot 工程的方法,请参阅 本地编译运行

云端运行

  1. 进入 应用管理 控制台页面,选择 应用列表
  2. 点击 创建应用,进入应用创建页面,输入应用信息:
    • 基本信息:应用名称、描述等。
    • 技术栈:根据工程中使用的 Java 版本选择对应的 SOFABoot 技术栈。详情请参考 SOFA 技术栈 使用指南版本说明
    • 代码库:根据实际情况选择 新建使用已有 代码库。
  3. 点击 确定,开始创建应用。
  4. 应用创建完成后,前往 经典应用服务 > 应用发布 > 发布包管理,进入发布包列表。
  5. 选择刚才创建的应用,点击 管理 > 上传发布包 > 选择文件
  6. 选择并打开本地工程中 target 目录下的 .jar 包,点击 确认
  7. 完成上传后,选中该 .jar 文件,点击右上角 发布部署
  8. 在弹出的 发布部署 窗口中,选择待发布应用,点击 立即发布
    • 如果您没有可用的云端实例,应用发布将提示“获取机器失败”。可参考 经典应用服务快速入门 中的步骤五:购买资源并绑定资源到应用服务,完成实例创建与绑定。
    • 更多有关应用部署的说明,请参考 应用部署

引入中间件服务

在成功创建 SOFABoot 工程后,通过在主 pom 文件中引入 starter,即可实现使用中间件服务。