【无标题】

原创于 2025-12-23 11:52:53 发布 · 423 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #spring cloud

架构之美专栏收录该内容

43 篇文章

订阅专栏

作为资深Java专家，我来详细介绍在IDEA中生成微服务代码关系图的几种专业方法：

一、内置工具（推荐首选）

1. UML类图生成

// 操作路径：
// 1. 右键点击包/类 → Diagrams → Show Diagram
// 2. 快捷键：Ctrl+Alt+Shift+U (Windows) / Cmd+Option+Shift+U (Mac)
// 3. 可展示：类继承、接口实现、依赖关系、注解等

2. 依赖关系图（Dependency Diagram）

右键项目 → Analyze → Analyze Dependencies
- 可查看模块间依赖
- 支持循环依赖检测
- 导出为图片或文本

3. 调用链分析（Call Hierarchy）

// 选中方法 → Ctrl+Alt+H (Windows) / Cmd+Option+H (Mac)
// 可查看：
// - Incoming Calls (谁调用此方法)
// - Outgoing Calls (此方法调用谁)

二、微服务特定关系图生成

1. Spring Cloud 组件关系图

# 使用 PlantUML 插件生成微服务架构图
# 1. 安装 PlantUML 插件
# 2. 创建 .puml 文件
@startuml
!include <cloudinsight/spring>
!include <cloudinsight/aws>

[Service A] -> [Eureka Server] : 注册
[Service B] -> [Eureka Server] : 发现
[Gateway] -> [Service A] : 路由
[Service A] -> [Config Server] : 配置
@enduml

2. API 接口关系图

// 使用 Swagger/OpenAPI + Swagger2PlantUML
// pom.xml 配置：
<dependency>
    <groupId>com.github.rabestro</groupId>
    <artifactId>swagger2plantuml</artifactId>
    <version>0.1.2</version>
</dependency>

三、专业插件推荐

1. Code Iris（强推荐）

功能特点：
- 实时代码关系图
- 支持微服务模块划分
- 依赖关系可视化
- 技术债务分析

2. SequenceDiagram

// 特别适合生成调用序列图
// 操作：右键方法 → Sequence Diagram
// 可生成：
// 1. REST API 调用链
// 2. 服务间通信序列
// 3. 数据库操作流程

3. Mermaid.js 支持

四、高级分析方法

1. 架构梳理脚本

# 使用 jdeps 分析模块依赖
jdeps -verbose:class -recursive ./target/classes

# 使用 Dependency-Check 插件
mvn dependency:tree -DoutputFile=dependencies.txt

2. 自定义注解扫描

// 创建自定义注解标记服务边界
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MicroService {
    String value();
    String version() default "1.0";
}

// 使用反射扫描生成关系图
public class ServiceGraphGenerator {
    public void generateGraph(Class<?>... classes) {
        // 扫描 @MicroService 注解
        // 生成服务依赖关系
    }
}

五、最佳实践工作流

1. 日常开发使用

1. 使用 IDEA 内置 Diagrams → 快速查看类关系
2. 使用 SequenceDiagram → 分析调用流程
3. 使用 Code Iris → 整体架构视图

2. 架构文档生成

# 建议配置文档生成流水线
stages:
  - analyze:
      tools: [jdeps, maven-dependency-plugin]
  - visualize:
      tools: [PlantUML, Graphviz]
  - document:
      tools: [Asciidoctor, Mermaid]

3. CI/CD 集成

<!-- 在 pom.xml 中配置 -->
<plugin>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-maven-plugin</artifactId>
    <configuration>
        <locations>
            <location>classpath:db/migration</location>
        </locations>
    </configuration>
</plugin>
<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
</plugin>

六、实用技巧

过滤设置：在 Diagram 中右键 → Filter → 按需隐藏字段/方法
布局优化：使用分层布局（Layered Layout）显示服务层级
导出格式：支持 PNG、SVG、PDF 等格式
增量分析：只分析变更的模块提升效率

七、微服务特定建议

对于微服务架构，我建议：

服务边界图：使用 PlantUML 绘制服务划分
API 依赖图：基于 OpenAPI 生成 REST 调用关系
数据流图：展示消息队列、事件驱动关系
部署拓扑图：包含 Kubernetes/Docker 部署关系

这样可以获得从代码层面到架构层面的完整可视化视图。需要我详细说明某个具体工具的使用方法吗？@TOC

欢迎使用Markdown编辑器

你好！这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

新的改变

我们对Markdown编辑器进行了一些功能拓展与语法支持，除了标准的Markdown编辑器功能，我们增加了如下几点新功能，帮助你用它写博客：

全新的界面设计 ，将会带来全新的写作体验；
在创作中心设置你喜爱的代码高亮样式，Markdown 将代码片显示选择的高亮样式 进行展示；
增加了 图片拖拽 功能，你可以将本地的图片直接拖拽到编辑区域直接展示；
全新的 KaTeX数学公式 语法；
增加了支持甘特图的mermaid语法¹ 功能；
增加了 多屏幕编辑 Markdown文章功能；
增加了 焦点写作模式、预览模式、简洁写作模式、左右区域同步滚轮设置 等功能，功能按钮位于编辑区域与预览区域中间；
增加了 检查列表 功能。

功能快捷键

撤销：Ctrl/Command + Z
重做：Ctrl/Command + Y
加粗：Ctrl/Command + B
斜体：Ctrl/Command + I
标题：Ctrl/Command + Shift + H
无序列表：Ctrl/Command + Shift + U
有序列表：Ctrl/Command + Shift + O
检查列表：Ctrl/Command + Shift + C
插入代码：Ctrl/Command + Shift + K
插入链接：Ctrl/Command + Shift + L
插入图片：Ctrl/Command + Shift + G
查找：Ctrl/Command + F
替换：Ctrl/Command + G

合理的创建标题，有助于目录的生成

直接输入1次#，并按下space后，将生成1级标题。
输入2次#，并按下space后，将生成2级标题。
以此类推，我们支持6级标题。有助于使用TOC语法后生成一个完美的目录。

如何改变文本的样式

强调文本 强调文本

加粗文本 加粗文本

标记文本

~~删除文本~~

引用文本

H₂O is是液体。

2¹⁰ 运算结果是 1024.

插入链接与图片

链接: link.

图片: Alt

带尺寸的图片:

居中的图片: Alt

居中并且带尺寸的图片:

当然，我们为了让用户更加便捷，我们增加了图片拖拽功能。

如何插入一段漂亮的代码片

去博客设置页面，选择一款你喜欢的代码片高亮样式，下面展示同样高亮的 代码片.

// An highlighted block
var foo = 'bar';

生成一个适合你的列表

项目
- 项目
  - 项目

项目1
项目2
项目3

计划任务
完成任务

创建一个表格

一个简单的表格是这么创建的：

项目	Value
电脑	$1600
手机	$12
导管	$1

设定内容居中、居左、居右

使用:---------:居中
使用:----------居左
使用----------:居右

第一列	第二列	第三列
第一列文本居中	第二列文本居右	第三列文本居左

SmartyPants

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体。例如：

TYPE	ASCII	HTML
Single backticks	`'Isn't this fun?'`	‘Isn’t this fun?’
Quotes	`"Isn't this fun?"`	“Isn’t this fun?”
Dashes	`-- is en-dash, --- is em-dash`	– is en-dash, — is em-dash