文档首页/ 编译构建 CodeArts Build/ 用户指南（联盟区域）/ 用户指南/ 配置构建步骤/ 使用Maven构建
更新时间：2026-01-08 GMT+08:00
查看PDF
分享

使用Maven构建

图形化构建

在配置构建步骤中，添加“Maven构建”构建步骤。

参数说明如下：

参数项

说明

步骤显示名称

构建步骤的名称，可自定义修改。

工具版本

根据需要选择工具版本。

命令

配置Maven命令，一般使用系统默认生成的命令即可。

setting配置
  • 自动生成setting文件并配置依赖仓库：可根据用户的IP不同，自动识别最优站点访问方式，国内用户使用“国内站点”，国际用户使用“国际站点”。建议使用默认配置。
  • 公有依赖仓库：默认已添加开源镜像站，同时配置了SDK仓库。此配置仅在需要添加非软开云提供的公有依赖仓库时使用，添加方法如下：
    1. 单击“添加”。
    2. 填写公有依赖仓库地址，根据需要勾选“release仓库”和“snapshot仓库”。release仓库和snapshot仓库至少勾选一个，也可以同时勾选。

      release仓库：勾选后，构建过程将尝试从仓库中下载release版本依赖。

      snapshot仓库：勾选后，构建过程将尝试从仓库中下载snapshot版本依赖。

  • 私有依赖库：默认已配置软件开发生产线提供的私有依赖仓库。此配置仅在需要添加其它私有依赖仓库时使用，添加方法如下：
    1. 单击“添加”，选择上一步创建的服务扩展点，并根据需要勾选“release仓库”和“snapshot仓库”。
说明：

“release仓库”和“snapshot仓库”两种仓库对应的使用场景区分如下，使用时要务必注意区分，避免出现如“将依赖上传到软件发布库但是构建时无法下载”此类场景。

  • “snapshot仓库”：对于以调试为目的发布的私有依赖包，一般会给依赖版本号增加-SNAPSHOT后缀（如：1.0.0-SNAPSHOT），执行发布操作时，此类依赖会自动发布到snapshot仓库，发布时无需更新版本号，构建命令中增加-U参数即可拉取最新版本。
  • 对于正式发布的私有依赖包，版本号中不可带-SNAPSHOT后缀（如：1.0.0），执行发布操作时，此类依赖会自动发布到release仓库，发布时必须更新版本号，否则会导致构建过程无法拉取最新依赖包。

发布依赖包到CodeArts私有依赖库

编译构建服务默认使用私有依赖库作为私有依赖下载源，如果需要将构建产物上传至私有依赖库供其他项目依赖使用，则需要添加此配置。配置前，需已。配置方法如下：

  • 不配置pom：表示无需发布私有依赖包到CodeArts私有依赖库。
  • 配置所有pom：表示在项目下所有“pom.xml”文件增加deploy配置，使用mvn deploy命令将构建出的依赖包上传到私有依赖仓库。

    配置后，需在命令窗口，使用“#”注释命令mvn package -Dmaven.test.skip=true -U -e -X -B。

    删除#mvn deploy -Dmaven.test.skip=true -U -e -X -B命令前的“#”。

上传的私有依赖包，在其他项目添加pom.xml文件中的groupId、artifactId、version坐标即可引用。

单元测试

如果用户需要对单元测试结果进行处理，可配置此项。详见配置单元测试。

缓存配置

选择是否使用缓存以提高构建速度，选择“使用缓存”后，每次构建时会把下载依赖包缓存起来，后续构建无需重复拉取，可有效提高构建速度。

说明：

maven构建的依赖包存入缓存之后，只有当租户下面构建的项目有引进新的依赖包时，才会更新缓存目录，并不支持对已有的依赖包缓存文件进行更新。

代码化构建

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
 
version: 2.0 # 必须是2.0
steps:
  BUILD:
    - maven:
          image: cloudbuild@maven3.5.3-jdk8-open # 可以自定义镜像地址
          inputs:
            settings:
              public_repos:
                - https://mirrors.example.com/maven
            cache: true # 是否开启缓存
            unit_test:
              coverage: true
              ignore_errors: false
              report_path: "**/TEST*.xml"
              enable: true
              coverage_report_path: "**/site/jacoco"
            command: mvn package -Dmaven.test.failure.ignore=true -U -e -X -B

参数名

参数类型

描述

是否必填

默认值

image

string

镜像地址，有以下两种格式。

  • cloudbuild@maven3.5.3-jdk8-open ，以cloudbuild开始，@作为分隔符，后面是编译构建提供的默认镜像。
  • 完整的swr镜像地址，例如:swr.example.example.com/codeci_test/demo:141d26c455abd6d7xxxxxxxxxxxxxxxxxxxx

是

无

settings

map

maven构建的setting配置。

否

无

cache

bool

是否开启缓存。

否

false

command

string

执行命令。

是

无

unit_test

map

单元测试。

否

无

单元测试（unit_test）层级下参数说明:

参数名

参数类型

描述

是否必填

默认值

enable

bool

是否处理单元测试数据。

否

true

ignore_errors

bool

是否忽略单元测试错误。

否

true

report_path

String

单元测试数据路径。

是

无

converage

bool

是否处理覆盖率数据。

否

false

coverage_report_path

string

覆盖率数据路径。

否

无

配置单元测试（可选）

图形化构建时，如果需要配置单元测试，需执行以下操作。

  1. 配置单元测试前，需要在项目中编写单元测试代码，且需满足如下条件：
    • 单元测试用例代码存放位置需满足Maven默认单元测试用例目录规范及命名规范，或自行在配置中指定用例位置。

      如：单元测试用例统一存放在路径为“src/test/java/{{package}}/”时，单元测试将在Maven构建过程自动执行。

    • 项目中不可存在忽略单元测试用例的配置代码。
      单击代码仓库名称，进入代码托管“文件”页，确保以下代码未存在于项目“pom.xml”文件中。 
      1
2
3
4
5
6
7
8
      		 
      <plugin>  
    <groupId>org.apache.maven.plugins</groupId>  
    <artifactId>maven-surefire-plugin</artifactId>
    <version>2.18.1</version>  
    <configuration>  
        <skipTests>true</skipTests>  
    </configuration>  
</plugin>
    • 单击代码仓库名称，进入代码托管“文件”页，“pom.xml”文件中需引入junit依赖，代码示例如下。 
      1
2
3
4
5
      		 
      <dependency>
     <groupId>junit</groupId>
     <artifactId>junit</artifactId>
     <version>4.7</version>
 </dependency>
  2. 并。
  3. 在src目录下创建单元测试类。

    Demo代码样例如下：

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    		 
    package test;
 
public class Demo {
    public String test(Integer i) {
        switch (i) {
            case 1:
                return "1";
            case 2:
                return "2";
            default:
                return "0";
        }
}
}

    DemoTest代码样例如下：

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    		 
    package test;
 
import org.junit.Test;
 
public class DemoTest {
    private Demo demo=new Demo();
    @Test
    public void  test(){
        assert demo.test(1).equals("1");
        assert demo.test(2).equals("2");
        assert demo.test(3).equals("0");
    }
}
  4. 在命令窗口，使用“#”注释命令mvn package -Dmaven.test.skip=true -U -e -X -B。

  5. 删除#mvn deploy -Dmaven.test.skip=true -U -e -X -B命令前的“#”。

  6. 展开“单元测试”，根据实际需求配置如下参数。
    • 在“是否处理单元测试结果”处勾选“是”。
    • 根据需要选择“是否忽略用例失败”。
      • 若勾选“是”，则用例失败时构建任务仍然成功。
      • 若勾选“否”，则用例失败时构建任务也失败。
    • 配置单元测试结果文件路径。

      测试报告需要采集单元测试结果用以生成可视化报告，需在此处指明单元测试结果文件路径：

      • 多数情况下，保留默认路径“**/TEST*.xml”即可满足任务需求。
      • 为增加结果准确性，可根据实际情况制定精确的报告路径，如：“target/surefire-reports/TEST*.xml”。
    • 根据需要选择“是否处理单元测试覆盖率结果”，配置方法请参见使用JaCoCo生成单元测试覆盖率报告。
    • 配置单元测试覆盖率报告路径。

      请填写相对于项目根目录的相对路径，如：target/site/jacoco，选择处理单元测试覆盖率结果后，会将此目录下的所有文件进行打包上传。

    配置完成后，如果构建任务执行成功，即可在任务执行详情页面的“测试”页签查看测试报告。如果选择了处理单元测试覆盖率报告，会生成覆盖率测试报告，单击“覆盖率报告下载”即可下载。

配置使用JaCoCo生成单元测试覆盖率报告（可选）

配置单元测试时，如果选择处理单元测试覆盖率结果，则需要按照如下指导进行配置。

  • 单模块项目配置方法

    在项目中已添加jacoco-maven-plugin插件用于生成单元覆盖率报告，即在“pom.xml”文件中添加如下配置：

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    		 
    <plugin>
     <groupId>org.jacoco</groupId>
     <artifactId>jacoco-maven-plugin</artifactId>
     <version>0.8.5</version>
     <executions>
         <execution>
             <goals>
                 <goal>prepare-agent</goal>
             </goals>
         </execution>
         <execution>
             <id>report</id>
             <phase>test</phase>
             <goals>
                 <goal>report</goal>
             </goals>
         </execution>
     </executions>
 </plugin>

    JaCoCo的report目标默认是在verify阶段，这里需要将report目标定义为test阶段，执行mvn test时，才会在代码的“target/site/jacoco”目录下生成单元测试的覆盖率报告。

  • 多模块项目配置方法

    假设多模块项目代码结构如下，说明如何配置生成单元测试覆盖率报告。

    1
2
3
4
5
6
7
    		 
    ├── module1
│   └── pom.xml
├── module2
│   └── pom.xml
├── module3
│   └── pom.xml
├── pom.xml
    1. 在项目下添加一个用来聚合的模块，自定义名称如：report，添加聚合模块后的代码结构如下： 
      1
2
3
4
5
6
7
8
9
      		 
      ├── module1
│   └── pom.xml
├── module2
│   └── pom.xml
├── module3
│   └── pom.xml
├── report
│   └── pom.xml
├── pom.xml
    2. 在项目根目录的“pom.xml”文件添加jacoco-maven-plugin插件。 
       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
      		 
      <!-- 配置单元测试覆盖率-->
 <plugin>
     <groupId>org.jacoco</groupId>
     <artifactId>jacoco-maven-plugin</artifactId>
     <version>0.8.3</version>
     <executions>
         <execution>
             <goals>
                 <goal>prepare-agent</goal>
             </goals>
         </execution>
     </executions>
 </plugin>
    3. 配置聚合模块的“pom.xml”文件。

      以dependency形式引入所有依赖模块，并使用report-aggregate定义JaCoCo聚合目标。

       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
      		 
      <dependencies>
     <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>module1</artifactId>
         <version>${project.version}</version>
     </dependency>
     <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>module2</artifactId>
         <version>${project.version}</version>
     </dependency>
     <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>module3</artifactId>
         <version>${project.version}</version>
     </dependency>
 </dependencies>

 <build>
     <plugins>
         <plugin>
             <groupId>org.jacoco</groupId>
             <artifactId>jacoco-maven-plugin</artifactId>
             <version>0.8.3</version>
             <executions>
                 <execution>
                     <id>report-aggregate</id>
                     <phase>test</phase>
                     <goals>
                         <goal>report-aggregate</goal>
                     </goals>
                 </execution>
             </executions>
         </plugin>
     </plugins>
 </build>

      配置完成后，在项目根目录下执行mvn test，执行成功后会在“report/target/site/jacoco-aggregate”目录下生成各个模块的覆盖率报告。也可以在outputDirectory中自定义报告的输出路径：

       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
      		 
      <plugin>
     <groupId>org.jacoco</groupId>
     <artifactId>jacoco-maven-plugin</artifactId>
     <version>0.8.3</version>
     <executions>
         <execution>
             <id>report-aggregate</id>
             <phase>test</phase>
             <goals>
                 <goal>report-aggregate</goal>
             </goals>
             <configuration>
                 <outputDirectory>target/site/jacoco</outputDirectory>
             </configuration>
         </execution>
     </executions>
 </plugin>
父主题： 配置构建步骤