Skip to content

Commit

Permalink
修改文档
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrninistrator committed Aug 8, 2024
1 parent 087e437 commit e4bf898
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 18 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
[![Maven Central](https://img.shields.io/maven-central/v/com.github.adrninistrator/java-all-call-graph.svg)](https://search.maven.org/artifact/com.github.adrninistrator/java-all-call-graph/)

[![Apache License 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-green.svg)](https://github.com/Adrninistrator/java-all-call-graph/blob/master/LICENSE)
# 1. 前言

# 1. 加群讨论

[加群讨论](group_discussions.md)

# 2. 前言

在很多场景下,如果能够生成Java代码中方法之间的调用链,是很有帮助的,例如分析代码执行流程、确认被修改代码的影响范围、代码审计/漏洞分析等。

Expand All @@ -21,46 +26,46 @@ IDEA提供了显示调用指定Java方法向上的完整调用链的功能,可

在github查看文档时,图片可能无法显示,影响使用说明文档的查看,可查看gitee中的当前项目[https://gitee.com/Adrninistrator/java-all-call-graph](https://gitee.com/Adrninistrator/java-all-call-graph)

# 2. 输出结果示例
# 3. 输出结果示例

[输出结果示例](output_example.md)

# 3. 快速开始
# 4. 快速开始

[快速开始](quick_start.md)

# 4. 更新说明
# 5. 更新说明

[更新说明](change_log.md)

# 5. 使用说明
# 6. 使用说明

[使用说明](how_to_use.md)

# 6. JVM参数及Java代码开关
# 7. JVM参数及Java代码开关

[JVM参数及Java代码开关](jvm_options_java_switch.md)

# 7. 二次开发
# 8. 二次开发

[二次开发](custom_development.md)

# 8. 其他功能
# 9. 其他功能

[其他功能](other_functions.md)

# 9. 扩展功能
# 10. 扩展功能

[扩展功能](extensions.md)

# 10. 原理说明
# 11. 原理说明

[原理说明](how_to_implementation.md)

# 11. 其他说明
# 12. 其他说明

[其他说明](other_instructions.md)

# 12. 常见问题
# 13. 常见问题

[常见问题](question_answer.md)
13 changes: 13 additions & 0 deletions group_discussions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 1. 加群讨论

已创建微信群“Java静态分析交流@java-all-call-graph”,如果有兴趣可以加群讨论

由于群二维码只有7天有效期,请先添加微信,备注“jacg”,再加到群里

![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/wechat.png)

由于只有部分业余时间维护,所以相关的讨论和问题不能保证及时回复,请见谅

建议先在github提issue再讨论,便于整理相关内容

后续有价值且不重复的问题相关内容会整理到文档中
8 changes: 4 additions & 4 deletions how_to_use.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ java-all-call-graph对应代码地址为[https://github.com/Adrninistrator/java-

如下图所示:

![](pic/step-all.png)
![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/step-all.png)

## 4.2. 释放启动类及配置文件

Expand Down Expand Up @@ -158,7 +158,7 @@ test.jacg.TestRunnerWriteDb

当前步骤执行的操作及使用的相关参数如下图所示:

![](pic/args-use-b.png)
![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/args-use-b.png)

### 4.3.1. b.1 调用增强后的java-callgraph2.jar中的类的方法

Expand Down Expand Up @@ -278,7 +278,7 @@ test.jacg.TestRunnerGenAllGraph4Callee

当前步骤执行的操作及使用的相关参数如下图所示:

![](pic/args-use-c.1.png)
![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/args-use-c.1.png)

### 4.4.1. c.1.1 从数据库读取Java方法调用关系

Expand Down Expand Up @@ -409,7 +409,7 @@ test.jacg.TestRunnerGenAllGraph4Caller

当前步骤执行的操作及使用的相关参数如下图所示:

![](pic/args-use-c.2.png)
![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/args-use-c.2.png)

### 4.5.2. c.2.1 从数据库读取Java方法调用关系

Expand Down
4 changes: 2 additions & 2 deletions output_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

以上对应的调用关系如下所示:

![](pic/example-cg-4callee.png)
![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/example-cg-4callee.png)

调用指定类方法向上的完整调用链输出结果格式类似一棵树,每行代表一个调用者Java方法,前面的数字越大代表调用层级越靠上,0代表被调用的指定类中的方法。

Expand Down Expand Up @@ -60,7 +60,7 @@ org.mybatis.spring.MyBatisExceptionTranslator:initExceptionTranslator()

以上对应的调用关系如下所示:

![](pic/example-cg-4caller.png)
![](https://gitee.com/adrninistrator/java-all-call-graph/raw/main/pic/example-cg-4caller.png)

指定方法向下完整调用链输出结果类似一棵树,每行代表一个被调用者Java方法,与实际的代码执行顺序一致,前面的数字越大代表调用层级越靠下,0代表指定方法。

Expand Down
Binary file added pic/wechat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e4bf898

Please sign in to comment.