搭建環(huán)境
本文主要向您講述 SOFABoot 的環(huán)境搭建要求。主要涉及 JDK 和 Maven 的安裝及配置。
安裝 JDK
版本要求
SOFABoot 基于 Spring Boot 框架開發(fā),要求 JDK 版本 ≥ 8。
安裝步驟
前往 Oracle 官網(wǎng)下載并安裝與您的操作系統(tǒng)相符的 Java SE 安裝包 。詳情參考 安裝 JDK 或 Installation Guide(英文)。
配置系統(tǒng)環(huán)境變量。 詳情參考 Oracle 官方文檔 變量 PATH 和 CLASSPATH 介紹與配置(英文)。
Windows 系統(tǒng):
JAVA_HOME
:配置為 JDK 的安裝路徑,如C:/Program Files/Java/jdk1.8.0_181
。PATH
:增加%JAVA_HOME%/bin
文件夾路徑。多個(gè)路徑間使用英文分號(hào)(;)分隔。
macOS 及 Linux 系統(tǒng):示例如下。如果使用 binary 安裝包 (dmg 或 RPM),您可能無(wú)需手動(dòng)配置環(huán)境變量。可直接跳至下一步檢查 Java 是否可用。
export JAVA_HOME=/${path_to_jdk_dir}/jdk1.8.0_181 export PATH=/${path_to_jdk_dir}/jdk1.8.0_181/bin:$PATH
檢查 Java 是否安裝成功:
$ java -version
說(shuō)明符號(hào) $ 在 Windows 系統(tǒng)上不需要輸入。
安裝 Apache Maven
版本要求
SOFABoot 要求 Apache Maven 版本 ≥ 3.2.5。
安裝步驟
前往 Apache Maven 官網(wǎng) 下載安裝包。
解壓安裝包文件至安裝目錄:
$ unzip apache-maven-3.6.1-bin.zip
或
$ tar xzvf apache-maven-3.6.1-bin.tar.gz
配置環(huán)境變量:
Windows 系統(tǒng):
M2_HOME
:配置為 Maven 的安裝路徑。PATH
:增加%M2_HOME%/bin
路徑。多個(gè)路徑間使用英文分號(hào)(;)分隔。
macOS 及 Linux 系統(tǒng): 示例如下。
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
在新的 Shell 終端中檢查 Maven 是否安裝成功:
$ mvn -v
更多信息,請(qǐng)參考 Apache Maven 官方文檔 。
修改 Maven 本地配置文件
修改步驟
SOFABoot 的 JAR 包并未上傳到 Maven 的中央倉(cāng)庫(kù)。為便于在構(gòu)建工程時(shí)能夠正常下載所依賴的 JAR 包,您需要:
找到本地 Maven 路徑下的
settings.xml
文件。在不同操作系統(tǒng)中,您可參考下述路徑,進(jìn)行查找。系統(tǒng)全局配置文件路徑:
Windows 系統(tǒng):$M2_HOME/conf/settings.xml
Linux or macOS: $M2_HOME/conf/settings.xml
說(shuō)明當(dāng)用戶配置文件和系統(tǒng)配置文件都存在時(shí),它們的內(nèi)容將被合并,用戶settings.xml文件占主導(dǎo)地位。
用戶配置文件路徑:
Windows 系統(tǒng):${user.home}/.m2/settings.xml。示例如下:
C:/Users/userName_XXX/.m2/settings.xml
說(shuō)明.m2 文件夾需要注釋掉系統(tǒng)全局配置文件settings.xml里的
<localRepository>D:/maven/repository</localRepository>
,然后執(zhí)行mvn help:system
命令才會(huì)生成。settings.xml 非系統(tǒng)默認(rèn)生成文件,需要手動(dòng)拷貝過(guò)來(lái)。
Linux or macOS: ${user.home}/.m2/settings.xml。示例如下:
/Users/userName_XXX/.m2/settings.xml
重要Linux or macOS 系統(tǒng)上,.m2 目錄可能被隱藏。macOS 可以通過(guò)
Command + Shift + .
進(jìn)行查看;Linux 可以通過(guò)Ctrl + H
進(jìn)行查看。
單擊 settings,下載 Maven 的
settings.xml
文件,拷貝到步驟 1 路徑下,或覆蓋掉步驟 1 路徑下的settings.xml
文件。說(shuō)明通過(guò) Maven 命令創(chuàng)建工程時(shí),默認(rèn)使用的是 Maven 默認(rèn)安裝路徑下的
settings.xml
文件,推薦將下載好的settings.xml
文件復(fù)制到 .m2 目錄下,如果 .m2 目錄下已有對(duì)應(yīng)同名文件,建議將其覆蓋掉。如果想使用自定義路徑下的 Maven
settings.xml
,建議在 Maven 命令中,通過(guò)mvn -s "file_path"
進(jìn)行指定,示例如下:mvn -s "C:/apache-maven-3.3.3/conf/settingsXXX.xml"
。
配置說(shuō)明
完成上述步驟 2 的覆蓋操作后,settings.xml
中已經(jīng)配置好的信息主要包括 profile 標(biāo)簽。
profile 標(biāo)簽:用來(lái)配置一些全局信息及其激活條件,主要包括一些倉(cāng)庫(kù)標(biāo)簽,內(nèi)容如下:
<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>