小白如何学习大神的小项目

最新推荐文章于 2023-11-29 17:48:44 发布

极客重生

最新推荐文章于 2023-11-29 17:48:44 发布

阅读量218

点赞数

文章标签： java 编程语言面试人工智能 c++

原文链接：https://mp.weixin.qq.com/s?__biz=MzkyMTIzMTkzNA==&mid=2247579286&idx=2&sn=a8affa62cacdf5b2eda329397e43c381&chksm=c18541c7f6f2c8d1091dd5d53fe78daafe179d7f37c72d118067ec1fa64405cf485a2d84e998&scene=126&&sessionid=0

版权

0. 背景

最近Workflow的项目作者，
也就是一位低调的架构师（懂的都懂
起因只是为了供Workflow项目使用，
而低调地写了一个json-parser。

但我看完之后觉得🤩🤩🤩wow~
这代码如此简单，却应有尽有。
如果十年前的我能看到这样的项目就好了!
因此22同学冒着被打的风险，
结合这个项目写了这篇，
aka,《小白如何学习大神的小项目》
给当年的啥都不会的自己，也给需要的小童鞋~
So，有经验的朋友可以不用往下看了👋

其实，大家都希望多看优秀前辈的作品
学习里边经典的设计和优雅的编码风格
但前辈们的项目往往又太大、太难、太复杂
如果Jeff Dean能开个几百行代码的小项目
我会让十年前的自己每天大声朗读一遍👌

1. 了解项目要解决什么问题

理解项目最大的障碍在于：
看不到它的需求。
所以上来看复杂的项目会觉得很奇怪，
为什么要这样做？

回到项目本身：json-parser，顾名思义，
就是我们网络传输常用json格式，
而收到这么一串内容之后，
解析到具体数据结构，
方便我们后续用接口访问。

比如json里给我们这串内容是个数组：
[1, "abc", 12.3, -4]，
我们希望得到的数据结构是类似
struct json_value[4];
或者std::vector<JSON_VALUE>;
在工程上这件事很常见，叫做：反序列化

2. 项目结构和前置知识

项目往往需要依赖其他项目进行构建的，
因此我们需要先来看看目录结构，
它包括哪些内容，需要依赖什么其他项目
我们先看看这个json-parser：

基于C写的，所以人均都能看得明白：
里边有用于构建项目的Makefile
开源所需要的LICENSE
项目主页文档README.md

然后就是简单的代码本码，
可以看到四舍五入只有800行
适合懒癌晚期的你👍
项目依赖有多种做法，这里是源码依赖，
也可以交给github的submodule、
或者交给不同系统的包管理工具。
最后附上示例程序和性能测试用例，
方便使用者直接上手使用。

3. 了解构建方式, 快速run起来

以前我的大学时期，是没有教怎么构建项目的
入职百度之后学的第一件事就是写Makefile
（想念当年一起学的小伙伴果冻同学
现在学校里对工程构建的教学要重视多了
先前有遇到过大学生问怎么构建Workflow
说是老师给的作业？？？🤔
而Makefile是C++项目构建的必备知识
新的构建方式还有cmake、bazel等，
都值得后续了解。

这份Makefile麻雀虽小五脏俱全，
基本要素都有了：

CFLAGS = -g -Wall -O2
CC = gcc
LD = gcc

all: test_speed parse_json

test_speed: json_parser.o rbtree.o test_speed.o
    $(LD) -o test_speed $

parse_json: json_parser.o rbtree.o test.o
    $(LD) -o parse_json $^

clean:
    rm -f parse_json test_speed *.o

在Linux/Mac下直接执行命令make ，
就可以run起来～
避免新手IDE、构建搞半天然后从入门到放弃

4. 广搜看项目：初窥内核中的数据结构list.h和rbtree.h

看项目到底是bfs还是dfs？
我们可以对第一层先bfs看个大概，
梳理出有哪几块内容，
再针对每块内容dfs直到搞明白为止。

json-parser中内容很少，
值得一提的是仅有的两个依赖：
list和rbtree。
学习委员划重点：
链表和树，是工业项目最基本的数据结构
因为用的C99写的，
因此从Linux kernel里搬了这两结构过来用
感兴趣的小伙伴
可以借此机会围观下kernel的代码风格，
一个双向链表是长这样的：

struct list_head {
    struct list_head *next, *prev;
};

然后我们就可以愉快地嵌入到其他结构中
基于任何结构类型制作一个双向链表
但>~< 这不是这次要介绍的重点~~~

5. 深搜看项目：接口设计、架构层次、编码风格

接口设计的三个重点：简单！简单！还是简单！
我们先通过test.cc感受一下接口设计：

int main()
{
    ...
    json_value_t *val = json_value_create(buf);
    if (val)
    {    
        print_json_value(val, 0);    
        json_value_destroy(val);   
    }
   ...

输入一段内容，输出一个反序列化好的对象
不需要初始化任何东西，不需要其他参数。
什么额外的options、params、config
能不要尽量不要，
不要让使用者有其他心智负担。

create对应destroy，都很严谨的
明确的内存生命周期更有利于开发者理解。
接口设计是最体现细节和品控的～
如果哪个项目会create对应delete
或者new对应destroy之类的
甚至更过分调用new不需要delete的
我直接一口屏幕喷到鲜血上

那么架构层次呢？
项目整体的编程范式和架构是否统一很重要。

这个项目足够简单，
因此我们可以很快抓到它的架构重点：
它是C语言中面向对象的写法，
整体围绕json_value_t
打开头文件可以看到这个对象的几个方法：

int json_value_type(const json_value_t *val);    
const char *json_value_string(const json_value_t *val); 
double json_value_number(const json_value_t *val);

json的结构里，
数组里的元素可以是对象，
而对象里有可以是数组，
因此数据的表达可以是递归的。
而json-parser解析的架构层次一样，也是递归。

刚才介绍到的用户接口函数👇

json_value_t *json_value_create(const char *doc)

它会调用到我们递归的入口:

ret = __parse_json_value(doc, &doc, 0, val);

我们需要抽象出一些结构去进行递归，
把刚才的数组、对象的关系装到list/rbtree中
涉及到递归调用的接口有以下这些，
感兴趣的小伙伴欢迎源码进一步阅读

static int __parse_json_value(const char *cursor, const char **end, int depth, json_value_t *val);   
static int __parse_json_object(const char *cursor, const char **end, int depth, json_object_t *obj);   
static int __parse_json_elements(const char *cursor, const char **end, int depth, json_array_t *arr);
static int __parse_json_array(const char *cursor, const char **end, int depth, json_array_t *arr);
static int __parse_json_member(const char *cursor, const char **end, int depth, json_member_t *memb); 
static int __parse_json_members(const char *cursor, const char **end, int depth, json_object_t *obj);

这里就不细说状态转换图了
毕竟本文不是教大家怎么解json
另外，编码风格很重要。
多看风格好的项目，
才能不被有毒的代码带跑偏。