DM-ROW 接口文档

Appearance

CI/CD流水线 ​

**本文引用的文件** - [lemes-web/Jenkinsfile](file://dm/lemes-web/Jenkinsfile) - [lemes-web/devops-ci.yml](file://dm/lemes-web/devops-ci.yml) - [lemes-cloud/Jenkinsfile](file://lemes-cloud/Jenkinsfile) - [lemes-cloud/lemes-auth/Jenkinsfile](file://lemes-cloud/lemes-auth/Jenkinsfile) - [lemes-cloud/lemes-gateway/Jenkinsfile](file://lemes-cloud/lemes-gateway/Jenkinsfile) - [lemes-cloud/lemes-service-common/Jenkinsfile](file://lemes-cloud/lemes-service-common/Jenkinsfile) - [lemes-cloud/lemes-business-devicemate/Jenkinsfile](file://lemes-cloud/lemes-business-devicemate/Jenkinsfile) - [lemes-cloud/lemes-business-devicemate/lemes-service-dm-device/Jenkinsfile](file://lemes-cloud/lemes-business-devicemate/lemes-service-dm-device/Jenkinsfile) - [lemes-cloud/lemes-business-devicemate/lemes-service-dm-store/Jenkinsfile](file://lemes-cloud/lemes-business-devicemate/lemes-service-dm-store/Jenkinsfile) - [lemes-cloud/lemes-business-devicemate/lemes-service-dm-workflow/Jenkinsfile](file://lemes-cloud/lemes-business-devicemate/lemes-service-dm-workflow/Jenkinsfile) - [lemes-cloud/lemes-business-devicemate/lemes-service-dm-common/Jenkinsfile](file://lemes-cloud/lemes-business-devicemate/lemes-service-dm-common/Jenkinsfile) - [lemes-cloud/src/devops/JenkinsCommon.groovy](file://lemes-cloud/src/devops/JenkinsCommon.groovy) - [lemes-cloud/devops-ci.yml](file://lemes-cloud/devops-ci.yml) - [lemes-cloud/lemes-framework/Jenkinsfile](file://lemes-cloud/lemes-framework/Jenkinsfile)

目录 ​

  1. 简介
  2. 项目结构
  3. 核心组件
  4. 架构总览
  5. 详细组件分析
  6. 依赖关系分析
  7. 性能与资源优化
  8. 故障排查指南
  9. 结论
  10. 附录

简介 ​

本文件面向DeviceMate项目的持续集成与持续交付（CI/CD）实践，系统化梳理Jenkins流水线配置、构建触发机制、并行执行策略、代码质量门禁、自动化测试与安全扫描、多环境部署策略、版本与发布管理、回滚机制、构建优化与缓存策略、资源管理、代码混淆、打包发布与部署验证等关键环节，并提供标准化的持续交付最佳实践指导。

项目结构 ​

DeviceMate项目由前后端两部分组成：

  • 前端应用：位于 dm/lemes-web，采用Vue生态，使用Jenkinsfile与devops-ci.yml进行流水线编排。
  • 后端微服务：位于 lemes-cloud，采用Spring Cloud与Maven多模块，各模块均提供独立的Jenkinsfile以驱动统一的JenkinsCommon.groovy执行器。

图表来源

章节来源

核心组件 ​

  • 统一执行器：JenkinsCommon.groovy封装了代码拉取、构建、可选混淆、镜像构建与推送、Rancher部署、Sonar扫描、结果判定等通用流程。
  • 前端流水线：通过Jenkinsfile与devops-ci.yml组合，实现前端构建、打包、归档与质量扫描。
  • 后端流水线：每个微服务模块提供Jenkinsfile，按需覆盖构建命令、是否混淆、是否打包镜像、目标环境映射、Sonar令牌等。
  • 环境映射：集中维护所有K8s/Rancher集群实例，按分支映射到目标环境列表，支持多分支多模块差异化配置。

章节来源

架构总览 ​

下图展示从代码提交到多环境部署的整体流程，以及关键决策点（是否子模块、是否前端、是否混淆、是否打包镜像、是否Sonar）：

图表来源

详细组件分析 ​

统一执行器：JenkinsCommon.groovy ​

  • 流水线阶段
    • 代码拉取：支持普通仓库与含子模块场景，按分支同步子模块。
    • 应用构建：前端使用Node容器内安装与构建；后端使用Maven打包。
    • 可选混淆：后端模块可启用混淆，下载工具与配置，生成混淆产物。
    • 镜像构建与推送：根据分支与模块路径生成镜像标签，推送至Harbor。
    • 多环境部署：按分支映射到Rancher集群实例，逐模块升级Pod。
    • Sonar扫描：按配置触发代码质量扫描。
    • 结果判定：全部成功为SUCCESS，存在失败为UNSTABLE，异常为FAILURE。
  • 关键配置项
    • willDeploy：分支到环境列表的映射。
    • submodule：分支到子模块集合的映射。
    • buildCommand：自定义构建命令或按分支覆盖。
    • confusion：是否启用混淆。
    • dockerBuild：是否打包镜像。
    • sonar：是否启用Sonar及令牌。
    • jdk：JDK版本选择。
    • commonDockerfile：是否使用公共Dockerfile。
  • 并行与资源
    • 当前实现为串行阶段，建议在Jenkinsfile中对不同模块或环境使用并行stage以提升吞吐。

图表来源

章节来源

前端流水线：dm/lemes-web ​

  • 触发与配置
    • Jenkinsfile：声明环境映射、子模块与Dockerfile策略，调用统一执行器。
    • devops-ci.yml：定义构建阶段、打包归档与Sonar扫描。
  • 构建与打包
    • 使用npm安装依赖与构建，产出dist目录，再打包为tar归档。
    • 可选Sonar扫描，通过环境变量注入项目键与主机地址。
  • 多环境部署
    • 通过willDeploy按分支映射到前端/UAT环境列表，交由统一执行器部署。

图表来源

章节来源

后端流水线：lemes-cloud ​

  • 通用模块
    • lemes-cloud/Jenkinsfile：统一构建命令、禁用镜像打包示例，指定JDK版本。
    • lemes-framework/Jenkinsfile：禁用镜像打包，指定JDK版本。
    • devops-ci.yml：Maven构建与Sonar配置示例。
  • 业务模块
    • lemes-auth、lemes-gateway、lemes-service-common：按需启用混淆、Sonar与目标环境映射。
    • lemes-business-devicemate及其子模块：按分支映射到devicemate-uat等环境。
  • 统一策略
    • 各模块Jenkinsfile仅覆盖差异配置，其余由JenkinsCommon.groovy统一执行。

图表来源

章节来源

依赖关系分析 ​

  • 松耦合：各模块Jenkinsfile仅传递差异配置，核心逻辑集中在JenkinsCommon.groovy，降低重复与维护成本。
  • 环境耦合：clusters字典集中管理所有Rancher集群实例，分支到环境映射通过willDeploy配置，便于扩展与变更。
  • 工具链耦合：统一使用Maven与Node工具链，JDK版本可按模块切换，Harbor镜像仓库与Sonar服务作为外部依赖。

图表来源

章节来源

性能与资源优化 ​

  • 构建缓存
    • 前端：使用NPM缓存目录，避免重复下载依赖；可结合镜像层缓存策略减少构建时间。
    • 后端：Maven临时本地仓库链接至工作空间，减少网络开销。
  • 并行执行
    • 在Jenkinsfile中对不同模块或环境使用并行stage，缩短整体流水线时长。
  • 镜像优化
    • 使用公共Dockerfile并按JDK版本动态替换，减少重复维护。
    • 仅在必要时构建镜像，避免不必要的镜像层与推送。
  • 资源管理
    • 控制并发节点数量，避免资源争抢；合理设置超时与重试策略。
  • 缓存策略
    • 前端：清理NPM缓存、设置私有镜像源；后端：复用Maven本地仓库。
  • 构建优化
    • 跳过测试可加速构建，但建议在质量门禁中保留静态检查与关键测试。

[本节为通用建议，无需列出章节来源]

故障排查指南 ​

  • 常见问题定位
    • 子模块未更新：确认Jenkinsfile中的submodule配置与分支一致，确保递归更新。
    • 前端构建失败：检查NPM版本与依赖安装日志，确认registry与缓存清理。
    • 后端构建失败：检查Maven版本、JDK版本与仓库权限。
    • 镜像推送失败：检查Harbor凭据、网络连通性与镜像标签格式。
    • Rancher部署失败：查看升级Pod接口返回码与堆栈，确认集群实例编码与rancherName正确。
    • Sonar扫描失败：确认令牌有效与项目键匹配。
  • 结果判定
    • 全部部署成功：SUCCESS；存在部分失败：UNSTABLE；异常：FAILURE。
  • 建议措施
    • 为关键阶段增加超时与重试；
    • 记录并归档构建日志与制品；
    • 对失败节点进行隔离与告警。

章节来源

结论 ​

通过统一的JenkinsCommon.groovy执行器与模块化的Jenkinsfile配置，DeviceMate项目实现了跨前端与后端的一致化CI/CD体验。结合分支到环境映射、可选混淆、镜像构建与推送、Sonar质量扫描以及Rancher部署，形成了标准化的持续交付流水线。建议进一步引入并行执行、缓存优化与资源配额控制，以提升整体效率与稳定性。

[本节为总结性内容，无需列出章节来源]

附录 ​

多环境部署策略与差异化配置 ​

  • 分支到环境映射
    • 通过willDeploy在Jenkinsfile中按分支配置目标环境列表，支持多模块同时部署。
    • 示例：devicemate-saas-develop映射到devicemate-uat等。
  • 子模块策略
    • 通过submodule配置分支到子模块集合，支持按模块粒度构建与部署。
  • 环境映射表
    • clusters字典集中维护所有Rancher集群实例编码与rancherName，便于统一管理。

章节来源

版本管理、发布管理与回滚机制 ​

  • 版本标签
    • 镜像标签基于分支与时间戳生成，便于追踪与回滚。
  • 发布管理
    • 通过Rancher升级Pod接口实现滚动更新，支持多模块与多环境。
  • 回滚机制
    • 建议保留最近N个镜像标签，结合Rancher历史版本回滚能力实现快速恢复。

章节来源

代码质量门禁、自动化测试与安全扫描 ​

  • Sonar扫描
    • 在Jenkinsfile中启用sonar配置，传入令牌与项目键，统一接入Sonar服务。
  • 自动化测试
    • 建议在构建阶段增加单元测试与集成测试步骤，结合覆盖率报告。
  • 安全扫描
    • 建议在构建完成后增加静态分析与依赖漏洞扫描，形成质量门禁。

章节来源

构建优化、缓存策略与资源管理 ​

  • 前端
    • 清理NPM缓存、设置私有镜像源、使用容器内构建与缓存目录。
  • 后端
    • Maven本地仓库链接至工作空间，避免重复下载依赖。
  • 资源管理
    • 控制并发节点数量，设置超时与重试策略，避免资源争抢。

章节来源

代码混淆、打包发布与部署验证 ​

  • 混淆
    • 后端模块可通过confusion启用混淆，自动下载工具与配置并生成混淆产物。
  • 打包发布
    • 前端打包为dist.tar，后端生成JAR/WAR并可构建镜像。
  • 部署验证
    • 通过Rancher升级Pod接口返回码判断部署结果，失败时标记UNSTABLE并继续后续阶段。

章节来源