從零開始學習JSON庫（一）

• LINDA
• 2018/5/8

原始碼連結

前幾天看了葉神的知乎專欄從零開始的JSON庫教程，葉老師很詳盡地跟我們講解一個專案的正確開啟方式：
1. 要做一個專案首先要知道做什麼，即專案要實現的協議是怎麼樣的，可以先看相關的RFC文件。
2. 知道大概要做什麼了，我們先從簡單的入手，構思相應的資料結構，函式介面，羅列出來。
3. 先寫對應介面的單元測試，當然，我們不可能一下子就把所有測試都想到，先寫一部分能想到的。
4. 把相應介面實現，看測試能否通過，測試通過了，思考是否實現過於繁瑣，能不能通過重構簡化介面。在寫介面時，對於一些正確情況下不可能出現的條件要設斷言，這樣在重構時才能避免一些錯誤。
5. 測試通過後，進行下一個介面的實現，重複2-4.

我跟著老師的步驟把過程走了一遍，還是覺得應該自己從0開始實現一個JSON庫，這樣才能發現自己有哪些沒掌握，並學學老師的寫作排版。好，我要開動來(^o^)/~
注：引用為葉老師教程裡的部分原文。

JSON是什麼

JSON（JavaScript Object Notation）是一個用於資料交換的文字格式，的標準為ECMA-404。雖然 JSON 源至於 JavaScript 語言，但它只是一種資料格式，可用於任何程式語言。現時具類似功能的格式有 XML、YAML，當中以 JSON 的語法最為簡單。

例如，一個動態網頁想從伺服器獲得資料時，伺服器從資料庫查詢資料，然後把資料轉換成 JSON 文字格式：

{
    "title": "Design Patterns",
    "subtitle": "Elements of Reusable Object-Oriented Software",
    "author": [
        "Erich Gamma",
        "Richard Helm",
        "Ralph Johnson",
        "John Vlissides"
    ],
    "year": 2009,
    "weight": 1.8,
    "hardcover": true,
    "publisher": {
        "Company"
 
: "Pearson Education",
        "Country": "India"
    },
    "website": null
}

網頁的指令碼程式碼就可以把此 JSON 文字解析為內部的資料結構去使用。
從此例子可看出，JSON 是樹狀結構，而 JSON 只包含 6 種資料型別：

• null: 表示為 null
• boolean: 表示為 true 或 false
• number: 一般的浮點數表示方式，在下一單元詳細說明
• string: 表示為 “…”
• array: 表示為 [ … ]
• object: 表示為 { … }

我們要實現的 JSON 庫，主要是完成 3 個需求：

1. 把 JSON 文字解析為一個樹狀資料結構（parse）。
2. 提供介面訪問該資料結構（access）。
3. 把資料結構轉換成 JSON 文字（stringify）。

JSON解析

1. null和boolean的解析

JSON文字表示（詳見老師課程1）

JSON-text = ws value ws
ws = *(%x20 / %x09 / %x0A / %x0D)
value = null / false / true 
null  = "null"
false = "false"
true  = "true"

enum{ // 返回狀態值
    LEPT_PARSE_OK = 0,  // 解析成功
    LEPT_PARSE_EXPECT_VALUE,  // 只含有空白
    LEPT_PARSE_INVALID_VALUE, // 無效值，非null，boolean字面量
    LEPT_PARSE_ROOT_NOT_SINGULAR // 若在值和空白之後還有其他字元
};
enum{ // JSON型別
    LEPT_NULL, LEPT_FALSE, LEPT_TRUE
};

class leptjson{
public:
    leptjson():type(LEPT_NULL){}
    int  parse(const string& json); // 解析json文字，目前只有null，boolean
    int  gettype();  // 獲取json型別
private:
    int parse_whitespace(); // 清除空格
    int parse_value(const string& json); // 解析分支
    int parse_null(const string& json);  // 解析null
    int parse_true(const string& json); // 解析true
    int parse_false(const string& json); // 解析false

    int type; // 型別
    size_t pos;  // 開始的位置
};

單元測試(使用google C++ test)入門文件

class leptjsontest :public ::testing::Test{
protected:
       virtual void SetUp(){}
       virtual void TearDown() {}
leptjson json; // 被測試的物件
};

TEST_F(leptjsontest, leptnull){
    EXPECT_EQ(LEPT_PARSE_OK, json.parse("null"));
    EXPECT_EQ(LEPT_NULL, json.gettype());
}

TEST_F(leptjsontest, leptboolean){
    EXPECT_EQ(LEPT_PARSE_OK, json.parse("true"));
    EXPECT_EQ(LEPT_TRUE,json.gettype());
    EXPECT_EQ(LEPT_PARSE_OK, json.parse("false"));
    EXPECT_EQ(LEPT_TRUE,json.gettype());
}

TEST_F(leptjsontest, leptinvalid){
    EXPECT_EQ(LEPT_PARSE_INVALID_VALUE, json.parse("tru"));
    EXPECT_EQ(LEPT_NULL, json.gettype());
    EXPECT_EQ(LEPT_PARSE_INVALID_VALUE, json.parse("n"));
    EXPECT_EQ(LEPT_NULL, json.gettype());
    EXPECT_EQ(LEPT_PARSE_INVALID_VALUE, json.parse("fase"));
    EXPECT_EQ(LEPT_NULL, json.gettype());
}

TEST_F(leptjsontest, leptrootnotsingular){
    EXPECT_EQ(LEPT_PARSE_ROOT_NOT_SINGULAR, json.parse("false s"));
    EXPECT_EQ(LEPT_NULL, json.gettype());
}

使用google test遇到的一些問題：

1. 編譯原始碼
   按照文件中所述，要先編譯google test原始碼：

   ~/googletest$: cd googletest/make  #我使用make所以要用make資料夾的makefile來編譯
   ~/googletest/googletest/make$: make
   
   #執行測試
   
   ~/googletest/googletest/make$: ./sample1_unittest

2. 寫單元測試的makefile。下面是一個模板，只要改路徑就可以了。

# A sample Makefile for building Google Test and using it in user
# tests.  Please tweak it to suit your environment and project.  You
# may want to move it to your project's root directory.
#
# SYNOPSIS:
#
#   make [all]  - makes everything.
#   make TARGET - makes the given target.
#   make clean  - removes all files generated by make.

# Please tweak the following variable definitions as needed by your
# project, except GTEST_HEADERS, which you can use in your own targets
# but shouldn't modify.

# Points to the root of Google Test, relative to where this file is.
# Remember to tweak this if you move this file.
#gtest資料夾所在路徑
GTEST_DIR = /home/googletest/googletest

# Where to find user code.
#我的測試原始碼的路徑
USER_DIR=.

# Flags passed to the preprocessor.
#預編譯的標頭檔案
CPPFLAGS+=-I $(GTEST_DIR)/include

# Flags passed to the C++ compiler.
#g++引數
CXXFLAGS+=-g -Wall -Wextra -std=c++11

# All tests produced by this Makefile.  Remember to add new tests you
# created to the list.
#你的單元測試可執行檔案的名字
TESTS=leptjson_test

# All Google Test headers.  Usually you shouldn't change this
# definition.
#注意'\'表示下一行接著上一行，和#define的'\'同理
GTEST_HEADERS=$(GTEST_DIR)/include/gtest/gtest.h \
                $(GTEST_DIR)/include/gtest/internal/*.h

# House-keeping build targets.

all : $(TESTS)

clean :
        rm -f $(TESTS) gtest.a gtest_main.a *.o

# Builds gtest.a and gtest_main.a.

# Usually you shouldn't tweak such internal variables, indicated by a
# trailing _.
GTEST_SRCS_=$(GTEST_DIR)/src/*.cc $(GTEST_DIR)/src/*.h $(GTEST_HEADERS)

# For simplicity and to avoid depending on Google Test's
# implementation details, the dependencies specified below are
# conservative and not optimized.  This is fine as Google Test
# compiles fast and for ordinary users its source rarely changes.
gtest-all.o : $(GTEST_SRCS_)
        $(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
            $(GTEST_DIR)/src/gtest-all.cc

gtest_main.o : $(GTEST_SRCS_)
        $(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
            $(GTEST_DIR)/src/gtest_main.cc

gtest.a : gtest-all.o
        $(AR) $(ARFLAGS) [email protected] $^

gtest_main.a : gtest-all.o gtest_main.o
        $(AR) $(ARFLAGS) [email protected] $^

# Builds a sample test.  A test should link with either gtest.a or
# gtest_main.a, depending on whether it defines its own main()
# function.

leptjson.o : $(USER_DIR)/leptjson.cc $(USER_DIR)/leptjson.h
        $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(USER_DIR)/leptjson.cc

test.o : $(USER_DIR)/test.cc $(USER_DIR)/leptjson.h $(GTEST_HEADERS)
        $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(USER_DIR)/test.cc

#[email protected]指leptjson_test   $^指冒號後面的
leptjson_test : leptjson.o  test.o gtest_main.a
#注意：-lpthread要放在gtest_main.a 之後，否則出錯
#       $(CXX) $(CPPFLAGS) $(CXXFLAGS) -lpthread $^ -o [email protected]
        $(CXX) $(CPPFLAGS) $(CXXFLAGS) $^ -lpthread -o [email protected]

遇到的錯誤的解答

模板
-lpthread
每一行的開頭不能為空格，而是tab鍵。
No rule to make target ‘vertex.cpp’, needed by ‘vertex.o’. Stop.
3. 只測試函式可以使用TEST(testCaseName, testName)，不同的test case測試相同的物件時，可以使用test fixture，即我上面的單元測試使用的，
當使用test fixture時，我們要使用TEST_F()代替TEST()。