全部产品
云市场

搭建环境

更新时间:2020-05-12 18:15:17

本文主要向您讲述 SOFABoot 的环境搭建要求。主要涉及 JDK 和 Maven 的安装及配置。

安装 JDK

版本要求

SOFABoot 基于 Spring Boot 框架开发,要求 JDK 版本 ≥ 8。

安装步骤

  1. 前往 Oracle 官网下载与您的操作系统相符的 Java SE 安装包
  2. 安装 JDK。详情参考 Oracle 官方文档 > 如何安装 JDKInstallation Guide(英文)
  3. 配置系统环境变量。 详情参考 Oracle 官方文档 变量 PATH 和 CLASSPATH 介绍与配置(英文)

    • Windows 系统:
      • JAVA_HOME:配置为 JDK 的安装路径,如 C:\Program Files\Java\jdk1.8.0_181
      • PATH:增加 %JAVA_HOME%\bin 文件夹路径。多个路径间使用英文分号(;)分隔。
    • MacOS 及 Linux 系统:示例如下。如果使用 binary 安装包 (dmg 或 RPM),您可能无需手动配置环境变量。可直接跳至下一步检查 Java 是否可用。

      1. export JAVA_HOME=/${path_to_jdk_dir}/jdk1.8.0_181
      2. export PATH=/${path_to_jdk_dir}/jdk1.8.0_181/bin:$PATH
  4. 检查 Java 是否安装成功:
    1. $ java -version

安装 Apache Maven

版本要求

SOFABoot 要求 Apache Maven 版本 ≥ 3.2.5。

安装步骤

  1. 前往 Apache Maven 官网 下载安装包
  2. 解压安装包文件至安装目录:
    1. $ unzip apache-maven-3.6.1-bin.zip
    1. $ tar xzvf apache-maven-3.6.1-bin.tar.gz
  3. 配置环境变量:
    • Windows 系统
      • M2_HOME:配置为 Maven 的安装路径。
      • PATH:增加 %M2_HOME%\bin 路径。多个路径间使用英文分号(;)分隔。
    • MacOS 及 Linux 系统: 示例如下。
      1. export M2_HOME=/${path_to_maven_dir}/apache-maven-3.6.1
      2. export PATH=/${path_to_maven_dir}/apache-maven-3.6.1/bin:$PATH
  4. 在新的 shell 终端中检查 Maven 是否安装成功:
    1. $ mvn -v

更多信息,请参考 Apache Maven 官方文档

修改 Maven 本地配置文件

修改步骤

SOFABoot 的 JAR 包并未上传到 Maven 的中央仓库。为便于在构建工程时能够正常下载所依赖的 JAR 包,您需要:

  1. 找到本地 Maven 路径下的 settings.xml 文件。在不同操作系统中,您可参考下述路径,进行查找。
    默认安装路径:

    • Windows 系统:${User directory}.m2\settings.xml。示例如下:
      C:\Users\userName_XXX\.m2\settings.xml

    • Linux or Mac OS: ${User directory}/.m2/settings.xml。示例如下:
      /Users/userName_XXX/.m2/settings.xml

      注意:Linux or Mac OS 系统上,.m2 目录可能被隐藏。Mac OS 可以通过 Command + Shift + . 进行查看;Linux 可以通过 Ctrl + H 进行查看。

    自定义安装路径:

    • Windows 系统:${Maven 在本机的安装路径}\conf\settings.xml
    • Linux or Mac OS: ${Maven 在本机的安装路径}/conf/settings.xml
  2. 点击 settings,下载 Maven 的 settings.xml 文件,拷贝到步骤 1 路径下,或覆盖掉步骤 1 路径下的settings.xml 文件。

    注意:

    • 通过 Maven 命令创建工程时,默认使用的是 Maven 默认安装路径下的 settings.xml 文件,推荐将下载好的 settings.xml 文件复制到 .m2 目录下,如果 .m2 目录下已有对应同名文件,建议将其覆盖掉。
    • 如果想使用自定义路径下的 Maven settings.xml,建议在 Maven 命令中,通过 mvn -s "file_path" 进行指定,示例如下:
      mvn -s "C:\apache-maven-3.3.3\conf\settingsXXX.xml"

配置说明

完成上述步骤 2 的覆盖操作后,settings.xml 中已经配置好的信息主要包括 profile 标签。

  • profile 标签:用来配置一些全局信息及其激活条件,主要包括一些仓库标签,内容如下:
    1. <profile>
    2. <id>cloud-open-archetype</id>
    3. <activation>
    4. <activeByDefault>true</activeByDefault>
    5. </activation>
    6. <repositories>
    7. <repository>
    8. <id>archetype</id> <!-- Don't change this! -->
    9. <url>http://mvn.cloud.alipay.com/nexus/content/groups/open</url>
    10. <releases>
    11. <enabled>true</enabled>
    12. <checksumPolicy>fail</checksumPolicy>
    13. </releases>
    14. <snapshots>
    15. <enabled>true</enabled>
    16. <checksumPolicy>warn</checksumPolicy>
    17. </snapshots>
    18. </repository>
    19. </repositories>
    20. </profile>
  • mirror 标签:用来从镜像仓库中,快速下载所需要的 JAR 包。如果由于依赖导致工程不能启动,可以考虑自行添加镜像标签。