楔子

说起读开源项目源码,很多朋友觉得高大上、大佬牛逼,云云~

挡在很多人面前的不是源码怎么读,而是不知道如何导入源码到开发工具以及如何调试源码。

本文将以 spring-cloud-gateway 源码导入一个简单的 SpringBoot 项目中举例,目的就是给读者一个导入开源项目源码并调试的简单方法。

看文过程中感觉有不明白的地方欢迎评论留言,如果本文帮到了你,本人不胜荣幸的同时,也欢迎为本文点个大拇哥

准备工作

1、默认大家本地有装 IDEA、Maven、Git,Java 程序员通识就不再细述。

2、下载源码 https://github.com/spring-cloud/spring-cloud-gateway.git

3、切换 tag 创建分支 v3.0.2

本例中切换分支有其原因:根据BOM spring-cloud-dependencies-parent 中定义的版本对应的仓库tag 正是v3.0.2

4、使用 https://start.spring.io/ 初始化一个demo,引入 spring-cloud-starter-gateway依赖,使用Java 8,项目名等其他信息默认

点击 GENERATE 下载生成的代码压缩包,解压到自己的目录

5、目前 demo 与 spring-cloud-gateway 源码都放到了 ~/WorkSpace/gitRepo 目录下了。

接下来,开始导入项目与源码

导入项目与源码

1、导入demo工程

给出一下demo的pom.xml:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <parent>
  6. <groupId>org.springframework.boot</groupId>
  7. <artifactId>spring-boot-starter-parent</artifactId>
  8. <version>2.4.4</version>
  9. <relativePath/> <!-- lookup parent from repository -->
  10. </parent>
  11. <groupId>com.example</groupId>
  12. <artifactId>demo</artifactId>
  13. <version>0.0.1-SNAPSHOT</version>
  14. <name>demo</name>
  15. <description>Demo project for Spring Boot</description>
  16. <properties>
  17. <java.version>1.8</java.version>
  18. <spring-cloud.version>2020.0.2</spring-cloud.version>
  19. </properties>
  20. <dependencies>
  21. <dependency>
  22. <groupId>org.springframework.cloud</groupId>
  23. <artifactId>spring-cloud-starter-gateway</artifactId>
  24. </dependency>
  25. <dependency>
  26. <groupId>org.springframework.boot</groupId>
  27. <artifactId>spring-boot-starter-test</artifactId>
  28. <scope>test</scope>
  29. </dependency>
  30. </dependencies>
  31. <dependencyManagement>
  32. <dependencies>
  33. <dependency>
  34. <groupId>org.springframework.cloud</groupId>
  35. <artifactId>spring-cloud-dependencies</artifactId>
  36. <version>${spring-cloud.version}</version>
  37. <type>pom</type>
  38. <scope>import</scope>
  39. </dependency>
  40. </dependencies>
  41. </dependencyManagement>
  42. <build>
  43. <plugins>
  44. <plugin>
  45. <groupId>org.springframework.boot</groupId>
  46. <artifactId>spring-boot-maven-plugin</artifactId>
  47. </plugin>
  48. </plugins>
  49. </build>
  50. </project>

2、检查 gateway 相关依赖是否引入

直接输入关键字,搜索 gateway,查看是否有gateway相关依赖,这是我们一般引Maven依赖的方式。

3、引入 spring-cloud-gateway 源码工程

使用 spring-cloud-gateway 下的pom.xml 引入项目

等待依赖拉取完成,如下图所示

验证

1、验证External Libraries 下是否仍有 spring-cloud-starter-gateway 依赖

直接用搜索关键字来查

2、修改 spring-cloud-gateway 子工程源码,测试demo是否使用spring-cloud-gateway源码工程

把demo工程run起来,什么也不需要配置,直接看日志输出

如上图,当前依赖的是源码了,可以放心的加注释与Debug了。

原理

这个方法是利用了Maven依赖搜索顺序做到的。

  1. 源码依赖 > 本地仓库依赖 > 远程仓库依赖

ps:Gradle也是类似的

详细解释就是引入 spring-cloud-gateway 的 pom.xml时,会连带着将其子工程均依赖到当前工作空间中,对于 Maven 而言,这几个子工程的pom.xml是它首先要搜索的地方,这些pom.xml正是定义坐标的地方。

当Maven按demo工程的pom找坐标时,会按下图的坐标到所有引进来的工程中先找上一波

当找到spring-cloud-gateway源码工程时,发现还有子工程,再到子工程找一遍

找到 spring-cloud-starter-gateway 工程的pom.xml时,就会将其源码依赖进来

由于SpringBoot 和 SpringCloud 的 Starter 都是虚包,spring-cloud-starter-gateway 会把其他相关依赖引到项目中。

后话

写这篇文章做个记录,希望能帮到有需要的人,如果本文对你有所启发,点个推荐再走呗~

我是 Hellxz,一个Java/Vue/K8s/DevOps等集多功能于一身的软件工程师!

细水长流,我们下次再见,peace~


本文同步发布于我的CSDN博客 https://blog.csdn.net/u012586326?spm=1001.2101.3001.5343

如何调试 Java 开源项目源码,记一种源码导入开发工具并调试的通用方法的更多相关文章

  1. Android 开源项目源码解析(第二期)

    Android 开源项目源码解析(第二期) 阅读目录 android-Ultra-Pull-To-Refresh 源码解析 DynamicLoadApk 源码解析 NineOldAnimations ...

  2. Java开源项目(备查)

    转自:http://www.blogjava.net/Carter0618/archive/2008/08/11/221222.html Spring Framework  [Java开源 J2EE框 ...

  3. 网上下载的 java开源项目 如何 打jar包

    目前很多java开源项目(例如qlexpress)只提供了源码,没有提供jar,下面提供maven打jar包的方法. 1.进入qlexpress下载后源代码所在的目录,此目录应包含pom.xml,如下 ...

  4. 用Java开源项目JOONE实现人工智能编程

    http://www.robotsky.com/ZhiN/MoS/2011-08-25/13142461416649.html 用Java开源项目JOONE实现人工智能编程 https://sourc ...

  5. 硬核! Github上 ,star超高的Java 开源项目分享给你!

    Awsome JavaGreat Java project on Github(Github 上非常棒的 Java 开源项目). English Version 大家都知道 Github 是一个程序员 ...

  6. 【我整理的java开源项目】

    摘要: 1. 整理出一些使用比较广或者个人觉得比较好的java开源项目和资料供参考. 2. 如果你觉得好但是我没有列出的开源项目请告诉我,方便我添加到列表里. 3. 如果你发现信息描述有误请联系我,我 ...

  7. 阿里巴巴的26款Java开源项目

    阿里巴巴的26款Java开源项目 开源展示了人类共同协作,成果分享的魅力.没有任何一家网络公司可以不使用开源技术,仅靠自身技术发展起来.“取之于开源,用之于开源,才能促进开源的良性发展”,阿里巴巴各个 ...

  8. 3月份GitHub上最热门的Java开源项目

    今天,我们来盘点3月份GitHub上最热门的Java项目的时候了,如果你每月都有关注猿妹发布的排行榜,那么本月的Java项目对你来说一定不陌生,这些都是曾经多次出现在榜单中的项目: 1 advance ...

  9. 硬核! 逛了4年Github ,一口气把我收藏的 Java 开源项目分享给你!

    Awsome Java Great Java project on Github(Github 上非常棒的 Java 开源项目). English Version 大家都知道 Github 是一个程序 ...

随机推荐

  1. github & code owners

    github & code owners https://help.github.com/en/github/creating-cloning-and-archiving-repositori ...

  2. js clear copy

    js clear copy window.getSelection().empty() & window.getSelection().removeAllRanges() & docu ...

  3. C++算法代码——快速排序

    题目来自:http://218.5.5.242:9018/JudgeOnline/problem.php?cid=1371&pid=1 题目描述 第一行一个数字n, n<=100000. ...

  4. openwrt编译加载龙尚U9300模组上网

    硬件平台:MT7628A openwrt版本:MTK_SDK 1.添加模组信息 /build_dir/target-mipsel_24kc_musl/linux-ramips_mt76x8/linux ...

  5. new String("abc"),到底在不在常量池中存储"abc"?

    String str = new String("Hello World"); 问之:这行代码到底有没有在字符串常量池中创建"Hello World"字符串呢? ...

  6. 剑指 Offer 36. 二叉搜索树与双向链表 + 中序遍历 + 二叉排序树

    剑指 Offer 36. 二叉搜索树与双向链表 Offer_36 题目描述 题解分析 本题考查的是二叉树的中序遍历以及二叉排序树的特征(二叉排序树的中序遍历序列是升序序列) 利用排序二叉树中序遍历的性 ...

  7. MVC base64加密的文件,前端下载

    后端代码: public FileResult OutPutFile(string  base64file,string filename) { buffer = Convert.FromBase64 ...

  8. Mybatis系列全解(六):Mybatis最硬核的API你知道几个?

    封面:洛小汐 作者:潘潘 2020 年的大疫情,把世界撕成几片. 时至今日,依旧人心惶惶. 很庆幸,身处这安稳国, 兼得一份安稳工. · 东家常讲的一个词:深秋心态 . 大势时,不跟风.起哄, 萧条时 ...

  9. HYSBZ 1734 二分

    传送门 题面: 农夫 John 建造了一座很长的畜栏,它包括N (2 <= N <= 100,000)个隔间,这些小隔间依次编号为x1,...,xN (0 <= xi <= 1 ...

  10. JAVA常用的集合转换

    在Java应用中进行集合对象间的转换是非常常见的事情,有时候在处理某些任务时选择一种好的数据结构往往会起到事半功倍的作用,因此熟悉每种数据结构并知道其特点对于程序员来说是非常重要的,而只知道这些是不够 ...