Skip to content

README.md

Latest commit

 

History

History
103 lines (87 loc) · 4.55 KB

README.md

File metadata and controls

103 lines (87 loc) · 4.55 KB
Raw

开发者文档 —— release 分支（current）

English | 简体中文

本文档面向 microsphere-build 仓库的维护者。它解释父 POM 的架构设计、分析 pom.xml 源码、梳理其中使用的 设计模式，并用 Mermaid 流程图/时序图描述复杂的构建与 CI/CD 流程。

依据 release 分支 0.3.18-SNAPSHOT 分析。仓库不存在 release-1.x 分支，因此只提供 current/ 文档集。

文档（每个 Maven 模块一篇 + 跨模块主题）

文档 范围
microsphere-build.md 根父 POM —— pom.xml 源码分析：章节布局、生效构建生命周期、Profile 交互模型、flatten/CI 友好版本机制
microsphere-build-example.md 示例模块 —— 它如何验证父 POM 契约；ExampleService 及其测试的源码分析
build-pipeline.md CI/CD —— 七个 GitHub Actions 工作流的流程图与发布时序图

架构总览

flowchart TD
    subgraph repo["microsphere-build 仓库（release 分支）"]
        ROOT["pom.xml —— 根父 POM<br/>packaging: pom<br/>版本：${revision} = 0.3.18-SNAPSHOT"]
        EX["microsphere-build-example<br/>packaging: jar<br/>deploy: 已跳过"]
        WF[".github/workflows<br/>构建 · 发布 · release notes ·<br/>合并 · 同步 · wiki · readme 版本"]
        WRAP[".mvn/wrapper<br/>Maven 3.9.16"]
    end

    DOWNSTREAM["下游 Microsphere 项目<br/>（microsphere-java、microsphere-spring …）"]
    CENTRAL[("Maven Central<br/>central.sonatype.com")]
    SNAP[("快照仓库<br/>maven-snapshots")]

    ROOT -- "聚合 &lt;modules&gt;<br/>+ &lt;parent&gt; 继承" --> EX
    ROOT -- "仅发布父 POM" --> CENTRAL
    ROOT -. "快照" .-> SNAP
    WF -- "mvn deploy -P publish,ci" --> CENTRAL
    WF -- "mvn test 矩阵 JDK 8–25" --> ROOT
    WRAP -- "构建工具链" --> WF
    DOWNSTREAM -. "&lt;parent&gt; microsphere-build:0.3.x" .-> CENTRAL
Loading

关键架构事实：

  1. 产品是 POM，不是 JAR。 使用者获得的唯一制品就是父 POM 本身（及其扁平化形式）。 microsphere-build-example 被刻意排除在部署之外。
  2. 构建事实的单一来源。 所有插件版本都以 *.version 属性形式存在于根 <properties> 中，且只被 <pluginManagement> 引用 —— 子项目通过属性覆盖，绝不复制粘贴插件 XML。
  3. 行为按 Profile 分层。 六个手动 Profile（publish、release、ci、test、coverage、docs）按需挂载 重型插件；六个 JDK 区间 Profile（java8+、java9+、java11+、java9-15、java16+、java17+）自动调整 工具版本与 JVM 参数。参见 microsphere-build.md § Profile 交互模型。
  4. 版本是一个构建参数。 ${revision} + Flatten 插件 + 发布工作流中的 -Drevision=，使 POM 在静止状态下 无版本、在飞行中有版本。

模块依赖关系

reactor 内部：

flowchart LR
    A["microsphere-build（pom）"] -->|parent + module| B["microsphere-build-example（jar）"]
    B -->|test scope| J1["junit-jupiter 6.1.3<br/>（JDK ≥ 17）"]
    B -->|test scope，经 java8-16 Profile| J2["junit-jupiter 5.14.3<br/>（JDK 8–16）"]
    A -->|pluginManagement 依赖| C["checkstyle 14.3.0 基础版<br/>按 JDK 为 9.3 / 10.26.1 / 11.1.0"]
Loading

父 POM 对外部构建工具的依赖（全部位于 pluginManagement；按下图所示按 Profile 激活，详见 用户文档）：

flowchart TD
    subgraph always["每次构建都继承"]
        COMP[maven-compiler 3.16.0]
        SRC[maven-source 3.4.0]
        FLAT[flatten-maven 1.7.3]
    end
    subgraph publishP["-P publish / release"]
        JAVADOC[maven-javadoc 3.12.0]
        REL[maven-release 3.3.1]
        ENF[maven-enforcer 3.6.3]
        GPG[maven-gpg 3.2.8]
        GIT[git-commit-id 4.9.10]
        CENTRALP[central-publishing 0.11.0]
        NEXUS[nexus-staging 1.7.0]
    end
    subgraph testP["-P test"]
        SUR[maven-surefire 3.6.0]
        FAIL[maven-failsafe 3.6.0]
        CHK[maven-checkstyle 3.6.0]
    end
    subgraph covP["-P coverage"]
        JAC[jacoco 0.8.15]
    end
    subgraph docsP["-P docs"]
        ASC[asciidoctor 3.2.0/2.2.6]
        DBK[docbkx 2.0.17]
        BH[build-helper 3.6.2]
    end
    subgraph ciP["-P ci"]
        SIGN[sign-maven 1.2.0]
    end
    JAC -. "jacoco.argLine →<br/>surefire argLine" .-> SUR
Loading