阿里云首页 金融分布式架构 SOFAStack

搭建环境

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

安装 JDK

版本要求

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

安装步骤

  1. 前往 Oracle 官网下载并安装与您的操作系统相符的 Java SE 安装包。详情参考 Oracle 官方文档 > 如何安装 JDKInstallation Guide(英文)

  2. 配置系统环境变量。 详情参考 Oracle 官方文档 变量 PATH 和 CLASSPATH 介绍与配置(英文)

    说明

    配置环境变量时,在 Windows 系统中的文件路径用反斜杠 \,在 macOS 和 Linux 系统中的文件路径用斜杠 /。

    • Windows 系统:

      • JAVA_HOME:配置为 JDK 的安装路径,如 C:\Program Files\Java\jdk1.8.0_181

      • PATH:增加 %JAVA_HOME%\bin 文件夹路径。多个路径间使用英文分号(;)分隔。

    • macOS 及 Linux 系统:示例如下。如果使用 binary 安装包(dmg 或 RPM),您可能无需手动配置环境变量。可直接跳至下一步检查 Java 是否可用。

      export JAVA_HOME=/${path_to_jdk_dir}/jdk1.8.0_181
      export PATH=/${path_to_jdk_dir}/jdk1.8.0_181/bin:$PATH
  3. 检查 Java 是否安装成功:

    $ java -version
    说明

    符号 $ 在 Windows 系统上不需要输入。

安装 Apache Maven

版本要求

SOFABoot 要求 Apache Maven 版本 ≥ 3.2.5。

安装步骤

  1. 前往 Apache Maven 官网 下载安装包

  2. 解压安装包文件至安装目录:

     $ unzip apache-maven-3.6.1-bin.zip

     $ tar xzvf apache-maven-3.6.1-bin.tar.gz
  3. 配置环境变量:

    说明

    配置环境变量时,在 Windows 系统中的文件路径用反斜杠 \,在 macOS 和 Linux 系统中的文件路径用斜杠 /。

    • Windows 系统

      • M2_HOME:配置为 Maven 的安装路径。

      • PATH:增加 %M2_HOME%\bin 路径。多个路径间使用英文分号(;)分隔。

    • macOS 及 Linux 系统: 示例如下。

      export M2_HOME=/${path_to_maven_dir}/apache-maven-3.6.1
      export PATH=/${path_to_maven_dir}/apache-maven-3.6.1/bin:$PATH
  4. 在新的 Shell 终端中检查 Maven 是否安装成功:

    $ mvn -v
    mv

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

修改 Maven 本地配置文件

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

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

    系统全局配置文件路径:

    • Windows 系统:$M2_HOME\conf\settings.xml

    • Linux or macOS: $M2_HOME/conf/settings.xml

      说明

      当用户配置文件和系统配置文件都存在时,它们的内容将被合并,用户 settings.xml 文件占主导地位。

    用户配置文件路径:

    • Windows 系统:${user.home}\.m2\settings.xml。示例如下:

      C:\Users\userName_XXX\.m2\settings.xml

      说明

      • .m2 文件夹需要注释掉系统全局配置文件 settings.xml 里的<localRepository>D:\maven\repository</localRepository>,然后执行

        mvn help:system 命令才会生成。

      • settings.xml 非系统默认生成文件,需要手动拷贝过来。

    • Linux or macOS: ${user.home}/.m2/settings.xml。示例如下:

      /Users/userName_XXX/.m2/settings.xml

      注意

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

  2. Linux or macOS: ${Maven 在本机的安装路径}/conf/settings.xml。

  3. 单击 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 标签:用来配置一些全局信息及其激活条件,主要包括一些仓库标签,内容如下:

    <profile>
        <id>cloud-open-archetype</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <repositories>
            <repository>
                <id>archetype</id><!-- Don't change this! -->
                <url>http://mvn.cloud.alipay.com/nexus/content/groups/open</url>
                <releases>
                    <enabled>true</enabled>
                    <checksumPolicy>fail</checksumPolicy>
                </releases>
                <snapshots>
                    <enabled>true</enabled>
                    <checksumPolicy>warn</checksumPolicy>
                </snapshots>
            </repository>
        </repositories>
    </profile>