# Spring-Project-Tree

**Repository Path**: research_direction/Spring-Project-Tree

## Basic Information

- **Project Name**: Spring-Project-Tree
- **Description**: 新人熟悉项目必备工具！基于Java字节码开发的一款方法调用链分析插件，优点是代码侵入低，启用方便，异步非阻塞，完美嵌入Spring项目！再也不用担心搞不懂项目
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://116.85.23.6:8521/projecttree
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2019-02-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring Project Tree

![](./picture/220619.png)

很多新人进入一家新公司后，最头疼的就是如何快速了解公司的业务和项目架构。

因为文档很少，没有文档，或者是文档严重落伍， 根本没法看；如果你碰到一个特别热心的老员工，事无巨细地给你讲，随时在你身边答疑解惑， 那简直是天大的好运气， 现实是大家都很忙，没人给你讲解。

很快就要深入项目做开发了，怎么办呢？

我在加入新公司后，就遇到了悲催的情况。在那时，我就诞生了做一款可视化方法调用链分析插件的想法！帮助更多像我一样的新人！

## 下载使用

项目暂时没有加入Maven中央仓库，所以还需要你clone或download到本地。

在本地计算机进入项目的pom.xml文件所在目录，打开命令行（CMD）,执行install命令安装到本地。

```
mvn install
```

以后使用时，只需要导入依赖

```
<dependency>
    <groupId>cn.yueshutong</groupId>
    <artifactId>spring-project-tree</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
```

### 1.1 Spring Boot安装插件

如果你的项目是Spring Boot，那么使用会非常简单，只需要两步！

**第一步**：

在SpingBootApplication启动类注解`@EnableProjectTree`开启。

**第二步**：

在main函数里首先运行`ProjectTree.make()`方法，这个方法的传入的参数有两个，第一个是要进行方法监控的类，书写类似import，也就是说，要么是一个类的全限定名，要么是 * 通配符结尾的形式，完整代码如下：

```
@SpringBootApplication
@EnableProjectTree //第一步：注入Spring Bean
public class SpringbootApplication {

    public static void main(String[] args) {
        ProjectTree.make(new String[]{"com.example.springboot.demo.*"}
        ,new String[]{"com.example.springboot.demo.entity.MyEntity"});//第二步：参数1是要进行方法监控的类，参照import形式，参数2是要排除监控的类
        SpringApplication.run(SpringbootApplication.class, args);
    }

}
```

注：参数2的作用是排除如Entity类等易出错且无意义的类。

### 1.2 Spring安装插件

Spring和Spring Boot安装上的不同只有第一步的注解了，在Spring项目中，可以在Xml配置文件增加对`cn.yueshutong.springprojecttree`包的自动扫描即可。

### 1.3 访问网页

启动你的项目，首先访问你项目的某个接口，使其执行被监控的方法。然后访问`localhost:8080/projecttree`查看网页。

#### 其它接口

| 接口                         | 说明                 |
| ---------------------------- | -------------------- |
| /json/projecttree            | JSON形式的返回结果   |
| /json/projecttree/{methodId} | 对某一方法的分析结果 |

### 注意事项

1.使用Shiro、Spring Securit等安全框架时，需要注意对此URL的权限控制。

2.如果同时使用 spring-boot-devtools 进行热部署,必须调用makeHaveDevtool方法，而不是make。

3.出现Bug一般是一些特殊类与本框架的冲突，排除这部分类即可。

### 优势


使用上通过注解开启+方法调用的形式，代码侵入性低。

使用单例线程池实现异步非阻塞模型，降低对主流程的性能影响。

基于内存的内嵌数据库实现数据的快速读写，这里不用担心数据过大问题，本插件基于**方法调用链分析**进行选择性保存，理论上说，从接口开始，有多少流程分支，就有多少条数据记录，占用内存极小。

如何实现方法调用分析？

基于栈数据结构设计算法。

## 关于作者

博客：[http://www.yueshutong.cn](http://www.yueshutong.cn)

邮箱：yster@foxmail.com

Github：[https://github.com/yueshutong/Spring-Project-Tree](https://github.com/yueshutong/Spring-Project-Tree)

Gitee：[https://gitee.com/zyzpp/Spring-Project-Tree](https://gitee.com/zyzpp/Spring-Project-Tree)