项目配置

相关源文件

• .devcontainer/Dockerfile
• .devcontainer/devcontainer.json
• .github/workflows/codeql.yml
• .github/workflows/infer.yml
• .gitpod.dockerfile
• .gitpod.yml
• pom.xml
• spotbugs-exclude.xml
• src/main/java/com/thealgorithms/ciphers/Caesar.java
• src/main/java/com/thealgorithms/devutils/nodes/LargeTreeNode.java
• src/main/java/com/thealgorithms/maths/AliquotSum.java
• src/main/java/com/thealgorithms/maths/PerfectNumber.java
• src/main/java/com/thealgorithms/scheduling/LotteryScheduling.java
• src/main/java/com/thealgorithms/scheduling/SRTFScheduling.java
• src/main/java/com/thealgorithms/searches/QuickSelect.java
• src/main/java/com/thealgorithms/sorts/MergeSortRecursive.java
• src/test/java/com/thealgorithms/ciphers/CaesarTest.java
• src/test/java/com/thealgorithms/maths/AliquotSumTest.java
• src/test/java/com/thealgorithms/maths/PerfectNumberTest.java
• src/test/java/com/thealgorithms/others/LinkListSortTest.java
• src/test/java/com/thealgorithms/scheduling/LotterySchedulingTest.java
• src/test/java/com/thealgorithms/scheduling/SRTFSchedulingTest.java
• src/test/java/com/thealgorithms/searches/QuickSelectTest.java

本页面介绍了 The Algorithms - Java 仓库中使用的构建系统、开发环境设置和代码质量工具。它解释了如何设置和使用该项目，包括 Maven 配置、代码分析工具和开发环境。有关特定代码质量标准和工具的信息，请参阅代码质量工具。

Maven 构建系统

The Algorithms - Java 仓库使用 Maven 作为其构建系统。配置在项目的 POM (Project Object Model) 文件中定义。

来源：pom.xml spotbugs-exclude.xml

Java版本

该项目配置为使用 Java 21 进行源代码和目标编译

Maven Compiler Plugin 配置了用于警告处理的特定编译器参数

来源：pom.xml11-15 pom.xml69-84

依赖项

该项目使用以下主要依赖项

类别	依赖项	目的
测试	JUnit 5, AssertJ, Mockito	单元测试和断言
实用工具	Apache Commons Lang3, Commons Collections4	常用操作工具

来源：pom.xml30-57

测试配置

测试使用 Maven Surefire Plugin 执行

代码覆盖率使用 JaCoCo 测量

来源：pom.xml60-103

代码质量工具

该项目使用多种代码质量工具，以确保代码风格一致并检测潜在错误。

来源：pom.xml104-153 spotbugs-exclude.xml .github/workflows/codeql.yml .github/workflows/infer.yml

Checkstyle

Checkstyle 强制执行代码风格标准

来源：pom.xml104-121

SpotBugs

SpotBugs 用于错误检测，并配有用于安全漏洞和自定义错误模式的额外插件

该项目在 spotbugs-exclude.xml 中包含了详细的 SpotBugs 排除配置，其中列出了要忽略的特定错误模式。

来源：pom.xml122-142 spotbugs-exclude.xml

PMD

PMD 执行静态代码分析

来源：pom.xml143-153

开发环境

该仓库支持多种开发环境，以方便不同的工作流程。

来源：.gitpod.dockerfile .gitpod.yml .devcontainer/devcontainer.json .devcontainer/Dockerfile

Gitpod 配置

Gitpod 提供了一个基于云的开发环境，包含 Java 21 及所需工具

Gitpod Dockerfile 基于 Java 21 工作区，并安装了 LLVM 和 clang-format 等附加工具

来源：.gitpod.yml .gitpod.dockerfile

VS Code 开发容器

该仓库包含了 Visual Studio Code 的开发容器功能的配置

来源：.devcontainer/devcontainer.json .devcontainer/Dockerfile

CI/CD 流水线

该仓库使用 GitHub Actions 进行持续集成和分析。

来源：.github/workflows/codeql.yml .github/workflows/infer.yml

CodeQL 分析

CodeQL 工作流程分析 Java 代码中的安全漏洞

来源：.github/workflows/codeql.yml

Infer 分析

Facebook Infer 用于静态分析，以检测潜在错误

来源：.github/workflows/infer.yml

构建和测试项目

要在本地构建和测试项目

1. 安装 Java 21
2. 克隆仓库
3. 运行 Maven 命令

该项目使用 JUnit 5 进行单元测试，如测试类中所示

来源：src/test/java/com/thealgorithms/maths/AliquotSumTest.java src/test/java/com/thealgorithms/ciphers/CaesarTest.java