你也对阅读源码感兴趣,说说我是如何阅读Nacos源码的

发表于 2年以前  | 总阅读数:331 次

前言

最近写了一些列的Nacos源码相关文章,很多朋友都感兴趣的在问:你最近在阅读什么源码,如何阅读源码?今天这篇文章就以Nacos源码阅读来展开聊聊。

在读这篇文章的时候呢,要看你想获得什么了。因为这篇文章亦是在写如何阅读Nacos源码,也是在写如何阅读源码。不要被技术栈所束缚,要提炼属于自己的方法。看你所欲,取你所需。

阅读源码的目的

不清楚大家为什么要阅读源码,就聊聊个人阅读源码的目的,或许可以拿来借鉴。

学习底层原理与实现

阅读某一个框架的源码,最重要的目的就是更深入的学习它的底层实现及原理。这里的底层实现和原理相对来说要宏观一些,比如阅读Nacos源码我就是想知道,它是如何实现服务注册、服务发现以及那些服务实例是如何存储的。

像文章《[微服务的灵魂摆渡者——Nacos,来一篇原理全攻略] 》便是来源于此类阅读。你也可以像我一样,阅读之后绘制成流程图、架构图、数据结构图,甚至整理成文章等帮助自己学习和理解。

学习优秀的代码设计

这一项包含的点就太多了,比如架构设计、功能实现理念、优秀代码示范、设计模式、算法等等。凡是能看到的,比较优秀的实践,都可以学习。

以Nacos为例,简单的一个实例注销的入口方法,你能看到多少值得学习的内容?

上图是我一眼看过去,代码给我最直观的感受。然后就可以对照自己项目中的代码,思考一下是否能够达到这么高的标准?是否能进行改造?

再看一个Nacos Client中的例子,在Client中调用Server的API时,会涉及到重试机制和多个Server选一个进行注册的逻辑。看看Nacos是如何实现的。

暂且不说算法的优劣,看到这里是不是感觉又学到了一种实现?而且你也知道了Nacos Client在调用Server时到底是怎么处理请求重试和异常的。有意思吧。

当然,这个层面还有一些更深入的,比如一致性算法等很多解决方案的内容。

学习知识点的运用

这一项就更细碎更多了。像前面写的《[Nacos中已经有Optional使用案例了,是时候慎重对待这一语法了] 》和 《[Nacos源码中为什么使用了String.intern方法?] 》都是在阅读源码时发掘的知识点。

这个层面有一个很好的点大家一定要把握住。那就是你可能看过很多文章在写某个知识点,而且也写了一些简单的实例。但如果你没有实践的机会,或者没在大型项目中运用,看源码中的实现和思考就非常有意思了。

比如Nacos中对String.intern方法的使用,就没你想象中的那么简单。而且深入思考一下,还会发现并不是每个场景都适合,只有在字符串变化不大的情况下才适合缓存到常量池中。

这里再举一个Nacos中对常见知识点的运用,看看咱们思考的维度是否一样。ServiceManager中有下图这么几个成员变量:

上面的知识点可能你已经背的滚瓜烂熟了,但你见过怎么用么?你见过怎么结合起来使用吗?怎么支持分布式、高并发的场景吗?

只要你仔细分析一下,阅读一下源码的实现,你就能得到答案,也算是一次实践。

从源码中可学的内容太多了,我这里就不逐一讲解了,后面会逐步形成系列文章的形式把我看到的源码中的技术和思想分享给大家。

如何阅读源码

有了阅读源码的目标,下一步就是执行了。这里就分享一些我阅读源码的方法,不一定适合你,但可以参考和改进。这里全部以Nacos为例,后续不再做特殊说明。

代码的下载

开源项目可以直接拉取源代码,Nacos的源代码有两个平台可以获取:GitHub和码云。码云库作为同步,定时更新。这里采用GitHub作为源码来源,说不定啥时候还可以贡献一些代码。

可以直接执行git命令拉取开源库代码:

git clone git@github.com:alibaba/nacos.git

但个人并不建议这样直接拉取代码,可以从nacos的仓库fork到自己的GitHub账号下。这样既可以保持与主干的同步,又可以方便的修改一些内容。

项目结构

下载完成之后,直接通过IDEA打开项目,待依赖类库引入完毕,可看到如下项目结构:

此时可以大概了解一下目录结构,基本都能见名知意。

  • address:地址服务相关;
  • api:naming和config的api抽取;
  • auth:权限控制相关;
  • cmdb:支持对接第三方CMDB获取CMDB数据等;
  • client:为客户端代码;
  • common:共用工具类;
  • config:Nacos配置中心的实现;
  • consistency:一致性实现;
  • console:Nacos控制台相关实现;
  • console-uri:控制台UI部分实现;
  • core:属性加载,初始化,监听器相关;
  • distribution:发布相关;
  • example:示例;
  • istio:对istio的支持,如k8s等;
  • naming:Nacos的核心功能,动态服务发现;

项目的启动与测试

要阅读源码跟踪流程,肯定要先把项目启动起来。由于Nacos是基于Spring Boot来构建的,只需执行对应入口类的main方法即可。

在console项目中,执行Nacos的main方法即可启动项目。Nacos默认启动的是集群模式,研究代码先启动单机模式即可。这里通过在main方法中添加参数指定单机模式:

public class Nacos {

    public static void main(String[] args) {

        // 通过环境变量的形式设置单机启动
        System.setProperty(Constants.STANDALONE_MODE_PROPERTY_NAME, "true");
        // 通过环境变量的形式设置关闭权限校验
        System.setProperty("nacos.core.auth.enabled", "false");

        SpringApplication.run(Nacos.class, args);
    }
}

程序启动之后,在client项目中的单元测试(test)中可以看到NamingTest和ConfigTest类,直接执行单元测试中的方法即可连接刚启动的Server进行代码跟踪调试了。

此时,关于不同API的操作,也可参看官方文档的说明进行调用验证了,这就不做演示了。

项目流程的梳理

完成了代码的下载和启动之后,那么如何来梳理源代码的业务逻辑呢?很多朋友可能会遇到一些困惑,比如看不懂,或看了就忘了,每次都得重新梳理一遍。

这个种状况在初期阶段很容易出现,也算是正常情况。我的处理方式是,先将fork的代码打一个分支(branch),比如我会打一个comment的分支。在这个分支上,每看到一行代码有点难度的代码或者需要备注的代码,就会在上面添加注释。

关于Nacos本人fork的代码地址https://github.com/secbr/nacos,其中comment分支中在逐步添加注释,对Nacos源码感兴趣的朋友可以看一下。

比如上图是client请求服务器进行注册的部分代码逻辑,我会将梳理过的路径通过注释的形式进行描述。这样每次看到就不用再次梳理了。

当对上述逻辑看得多了,也就不会忘记了。就这样逐个逻辑,逐个类的添加注释,当享受梳理流程图或架构图时,只用将注释内容进行提炼和概况即可。

再看一下client注册时,server对应的代码注释:

至此,关于阅读源码的核心部分已经完事。剩下的就是逐个业务流程的梳理,逐个技术点的学习。如果遇到无法理解的部分,最好通过debug模式跟踪一下,看看执行到此处时,具体的数据都是什么。

小结

个人觉得阅读源码是每个程序员必备的技能,也是站在巨人肩膀上提升自己的必要手段。只有看得更多,才知道什么是更好的写法和实现。当然,每个人现阶段的能力有限,有很多技术点或设计思想当前阶段可能无法看到,但不要紧,你也可以拿我来做个垫背的,毕竟我是计划写一个源码解析系列的。

本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/4pVWPRKGwy9MpEzGL4rgLA

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:7月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:7月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:7月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:7月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:7月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:7月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:7月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:7月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:7月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:7月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:7月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:7月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:7月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:7月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:7月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:7月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:7月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:7月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:7月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:7月以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  236860次阅读
vscode超好用的代码书签插件Bookmarks 1年以前  |  6844次阅读
 目录