文档

本地运行

更新时间:

您可以在本地使用 IDE 工具、Maven 或 Java 命令行运行工程,本文将向您介绍如何实现 SOFABoot Web 工程和 Core 工程在本地的编译与运行。

编译运行 Web 工程

下载示例 Demo

请单击下载示例工程:websofademo.7z

本地 IDE 运行

主要操作步骤如下:

  1. 开启 IDE 的依赖自动导入功能,或者在工程根目录下执行 mvn clean install 命令,完成相应依赖的下载。

  2. 运行 web 模块下的 main 函数,即可启动 SOFABoot Web 工程。

mvn spring-boot:run 方式运行

主要操作步骤如下:

  1. 通过 cd 命令,进入工程根目录,示例如下:

    C:\Users\user_Name\SOFABootWebProject

  2. 执行 mvn clean install 命令,完成相应依赖的下载。

  3. 通过 cd 命令,进入 web 模块所在根目录,示例如下:

    C:\Users\user_Name\SOFABootWebProject\app\web

  4. 执行 mvn spring-boot:run 命令。

SOFABoot Web 工程的 main 函数默认在 web 模块中,且默认在 web 模块中配置了 Spring Boot 的 Maven 插件,所以需要切换至 web 模块所在的目录并执行上述第 4 条命令以编译、运行该工程。

在上述命令执行过程中,默认的 spring-boot-maven-plugin 插件会对工程原型进行自动配置,如无特殊需求可以不用修改。

java -jar 方式运行

主要操作步骤如下:

  1. 通过 cd 命令,进入工程根目录,示例如下:

    C:\Users\user_Name\SOFABootWebProject

  2. 执行 mvn package 或者 mvn clean install 命令,SOFABoot 工程会被打包为 {XXX}-executable.jar 文件,并存放于工程根目录的 target 目录中。

  3. 通过 cd 命令,进入工程的 target 目录。

  4. 运行命令 java -jar XXX-executable.jar,编译运行该工程。

如需在私有服务器(已安装相应版本 JDK)上进行测试,可将上述第 2 步生成的 {XXX}-executable.jar 文件拷贝到服务器,然后使用 java -jar XXX-executable.jar 命令行执行该文件。

编译结果验证

通过以上任意一种方式运行工程后,您可以通过浏览器访问以下任一地址来运行并验证结果。

  • http://localhost:80808080页面反馈

  • http://localhost:8341/webapi/users/aliBaby

    8341返回页面
    说明

    URL 中的 aliBaby 部分,可自定义添加。

编译运行 Core 工程

下载示例 Demo

请单击下载示例工程:coresofademo.zip

本地 IDE 运行

主要操作步骤如下:

  1. 在工程根目录下执行 mvn clean install 命令,完成相应依赖的下载。

  2. 运行 service 模块下的 main 函数,即可启动 SOFABoot Core 工程。

mvn spring-boot:run 方式运行

主要操作步骤如下:

  1. 通过 cd 命令,进入工程根目录,示例如下:

    C:\Users\user_Name\SOFABootCoreProject

  2. 执行 mvn clean install 命令,完成相应依赖的下载。

  3. 通过 cd 命令,进入 service 模块所在根目录,示例如下:C:\Users\user_Name\SOFABootWebProject\SOFABootWebProject-service

  4. 执行 mvn spring-boot:run 命令。

SOFABoot Web 工程的 main 函数默认在 service 模块中,且默认在 service 模块中配置了 Spring Boot 的 Maven 插件,所以需要切换至 service 模块所在的目录并执行上述第 4 条命令以编译、运行该工程。

在上述命令执行过程中,默认的 spring-boot-maven-plugin 插件会对工程原型进行自动配置,如无特殊需求可以不用修改,具体配置可以参考 spring-boot-maven-plugin 使用说明

java -jar 方式运行

主要操作步骤如下:

  1. 通过 cd 命令,进入工程根目录,示例如下:

    C:\Users\user_Name\SOFABootCoreProject

  2. 执行 mvn package 或者 mvn clean install 命令,SOFABoot 工程会被打包为 {XXX}-executable.jar 文件,并存放于工程根目录的 target 目录中。

  3. 通过 cd 命令,进入工程的 target 目录。

  4. 运行命令 java -jar XXX-executable.jar,编译运行该工程。

如需在私有服务器(已安装相应版本 JDK)上进行测试,可将上述第 2 步生成的 {XXX}-executable.jar 文件拷贝到服务器,然后使用 java -jar XXX-executable.jar 命令行执行该文件。

编译结果验证

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

更多参考

测试完成后,您可以将工程部署至 SOFAStack 平台运行,为更多的用户提供应用服务。请参见 SOFABoot 云端发布