Java
平台支持 Java 1.8 和 Java 11,默认为前者。
打包工具
- Maven
- Gradle
依赖管理
若使用平台提供的配置文件则无需改动代码。平台打包时将自动准备如下文件并自动填充占位符。
- Maven: settings.xml
- Gradle: init.gralde
settings.xml 示例如下:
init.gradle 示例如下:
def NEXUS_USERNAME = "{{NEXUS_USERNAME}}"
def NEXUS_PASSWORD = "{{NEXUS_PASSWORD}}"
allprojects {
buildscript {
repositories {
maven {
credentials {
username NEXUS_USERNAME
password NEXUS_PASSWORD
}
url NEXUS_SERVER
}
}
}
repositories {
maven {
credentials {
username NEXUS_USERNAME
password NEXUS_PASSWORD
}
url NEXUS_SERVER
}
}
}
进入 DevOps > 我的应用 > 选择应用 > 应用设置 > 流水线 > 变量配置 > 选择环境。
点击 增加变量, 选择类型为 文件 并开启加密,将 settings.xml 上传,变量名称定义为 MAVEN_SETTING_FILE
。
::: warning 警告 因文件内含有密码等敏感信息,配置必须开启加密。 :::
settings.xml 示例如下:
<?xml version="1.0" encoding="UTF-8"?>
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>terminus</id>
<username>deployment</username>
<password>******</password>
</server>
</servers>
</settings>
配置 pom.xml 推送地址
请在对应项目的 pom.xml 中添加需要如下配置,否则将报错无法推送。
<distributionManagement>
<repository>
<id>terminus</id> <!-- settings.xml 里配置的 server.id -->
<name>Releases</name>
</repository>
<snapshotRepository>
<id>terminus</id>
<name>Snapshots</name>
<url>http://私服地址/repository/releases</url> <!-- snapshot 私服的地址 -->
</snapshotRepository>
</distributionManagement>
配置流水线实现 JAR 包上传
MAVEN_SETTING_FILE 即上文配置的名称。
如需自动触发构建,可增加持续集成配置。
on:
push:
branches:
- develop # 持续集成
::: tip 提示
- maven 401 错误即账号密码错误。
- maven 405 错误可能为私服地址错误,部分私服地址是无法推送的,例如 public。
:::
推送 JAR 包至私服(Gradle)
进入 DevOps > 我的应用 > 选择应用 > 应用设置 > 流水线 > 变量配置 > 选择环境。
- NEXUS_USERNAME
- NEXUS_PASSWORD
::: warning 警告 因文件内含有密码等敏感信息,配置必须开启加密。 :::
配置 build.gradle 推送地址
对应项目的 build.gradle 需增加如下配置,若未添加则会报错无法推送。更多信息请参见 build.gradle 配置方式。
publishing{
...
repositories {
maven {
// change URLs to point to your repos, e.g. http://my.org/repo
def releasesRepoUrl = "http://私服地址/repository/releases"
def snapshotsRepoUrl = "http://私服地址/repository/snapshots"
url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
credentials {
username = System.getenv("NEXUS_USERNAME")
password = System.getenv("NEXUS_PASSWORD")
}
}
}
}
配置流水线实现 JAR 包上传
version: '1.1'
stages:
- stage:
alias: git-checkout
params:
depth: 1
- stage:
- java-build:
alias: java-build
version: "1.0"
params:
build_cmd:
- "./gradlew publish"
jdk_version: 8
如需自动触发构建,可增加持续集成配置。
::: tip 提示
- maven 401 错误即账号密码错误。
- maven 405 错误可能为私服地址错误,部分私服地址是无法推送的,例如 public。
:::
接入平台日志
平台仅采集输出至控制台(Console)的日志,因此需应用程序将日志导入控制台。
::: warning 警告 请勿将日志写入磁盘文件,这可能导致性能下降或者磁盘资源耗尽等严重问题。 :::
通过 Logback 配置,将日志输出至控制台:
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="30 seconds">
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSZZ} [%thread] %-5level %logger{5} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="CONSOLE"/>
</root>
</configuration>
若采用平台提供的运行容器,平台将自动关闭 RollingFileAppender
等非 ConsoleAppender
的 appender,以确保日志无法写入磁盘。请确保已配置 ConsoleAppender
,否则将无法查看日志。
Java 构建分为两部分:
- 通过指明的打包方式和上下文参数,将源代码编译为打包产物。
- 按照指明的运行环境和版本,选择基础镜像,将 JAR 包制作成运行镜像。
::: tip 提示 此处特指打包产物而非 JAR 包,原因在于很多场景下编译的结果并非是 JAR 包,例如传统的 Spring MVC 程序产出 WAR 包,gradle distribution 产出的则是 Tar 或者 ZIP 包,通过解压执行 bin/xxx 运行。 :::
通过 Spring Boot 技术制作而成的 JAR 包称为 fat jar
,因其 JAR 包中嵌入了除 Java 虚拟机以外的所有依赖,故此得名。
由于 fat jar
是一个 all-in-one 的 JAR 包,因此仅需 Java 虚拟机环境便可通过 java -jar app.jar
直接运行。
pipeline.yml 示例如下:
version: '1.1'
stages:
- stage:
- git-checkout:
- stage:
- java:
params:
build_type: maven
workdir: ${git-checkout}
options: -am -pl user
target: ./user/target/user.jar
container_type: openjdk
打包加速
Caches
示例如下:
- stage:
- java:
caches:
- path: /root/.m2/repository
params:
build_type: maven
workdir: ${git-checkout}
options: -am -pl user
target: ./user/target/user.jar
container_type: openjdk
/root/.m2/repository
目录为 Linux 中 Maven 本地仓库的地址,缓存过后即可进行加速构建。
JVM 诊断
Arthas
若使用平台提供的运行容器,则已安装 Arthas。其安装路径为 /arthas-boot.jar,可在根目录通过 java -jar arthas-boot.jar
启动。
关于 Arthas 更多信息,请参见 。
若使用平台提供的运行容器,则已安装 Greys。
关于 Greys 更多信息,请参见 Greys 文档。
平台提供 VPN 的方式,支持本地远程连接平台上运行的服务。
为开启远程调试,需进入 DevOps > 我的应用 > 选择应用 > 应用设置 > 流水线 > 变量配置,添加 JAVA_OPTS 变量配置如下:
JDK 9 及以上:
JDK 5~8:
JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
此外,如需使用本地 IDE 进行连接,请进入 DevOps 平台 > 我的应用 > 选择应用 > 部署中心 > 部署总览 > 容器列表 中找到需调试的容器 IP,在 IDE 新建 Remote 配置如下:
JDK 9 及以上:
JDK 5~8: