Heroku Java 应用官方构建包使用文档

1. 安装指南

本构建包为Java应用提供了官方支持，使用Maven 3.9.4构建应用，并使用OpenJDK 8运行。JDK版本可以通过以下说明进行配置。

构建包将检测应用的根目录下是否存在pom.xml文件或其他由Maven Polyglot插件支持的POM格式文件，以确定其为Java应用。之后，构建包将使用Maven执行pom.xml中定义的构建过程，并下载依赖项。.m2文件夹（本地Maven仓库）将在构建之间缓存以提高依赖解析速度。但请注意，在运行时，mvn可执行文件和.m2文件夹将不会在您的slug中可用。

2. 项目使用说明

选择JDK版本

在项目目录的根目录下创建一个system.properties文件，并设置java.runtime.version=1.8。

示例：

$ ls
Procfile pom.xml src

$ echo "java.runtime.version=1.8" > system.properties

$ git add system.properties && git commit -m "Java 8"

$ git push heroku main
...

选择Maven版本

您可以通过向项目添加Maven Wrapper，为Heroku指定特定版本的Maven。当此构建包检测到存在mvnw脚本和.mvn目录时，它将运行Maven Wrapper而不是默认的mvn命令。

如果需要覆盖默认设置，system.properties文件允许设置maven.version条目（无论是否指定了java.runtime.version条目）。例如：

java.runtime.version=1.8
maven.version=3.3.9

自定义Maven

有三种配置变量可用于自定义Maven执行：

• MAVEN_CUSTOM_GOALS：默认设置为clean dependency:list install
• MAVEN_CUSTOM_OPTS：默认设置为-DskipTests
• MAVEN_JAVA_OPTS：默认设置为-Xmx1024m

这些变量可以这样设置：

$ heroku config:set MAVEN_CUSTOM_GOALS="clean package"
$ heroku config:set MAVEN_CUSTOM_OPTS="--update-snapshots -DskipTests=true"
$ heroku config:set MAVEN_JAVA_OPTS="-Xss2g"

还有其他选项可用于定义自定义settings.xml文件。

3. 项目API使用文档

由于此构建包主要针对Java应用的部署和运行，没有直接的API供用户调用。但是，构建包通过环境变量和配置文件提供了丰富的自定义选项，具体已在“项目使用说明”部分介绍。

4. 项目安装方式

要使用此构建包，您需要将Java应用部署到Heroku平台。以下是基本的安装步骤：

1. 确保已安装Heroku CLI工具。
2. 创建一个新的Heroku应用或配置现有应用以使用此构建包。

# 创建一个新Heroku应用，并指定构建包
heroku create --buildpack <your-github-url>

# 或者，配置现有Heroku应用以使用您的构建包
heroku buildpacks:set <your-github-url>

# 您也可以使用git分支！
heroku buildpacks:set <your-github-url>#your-branch

确保将<your-github-url>替换为您GitHub上fork的构建包的URL。

完成这些步骤后，您可以按照“项目使用说明”部分中提供的指南配置您的Java应用，并推送到Heroku进行部署。