七夕，幫他修個(gè) Bug！
幸運(yùn)又不幸，我是一名程序員，他也是一名程序員。
周末，我在開發(fā)網(wǎng)站，他在開發(fā)游戲，兩個(gè)人一起寫代碼，一起寫 Bug 頭禿，竟也有了一絲別樣的浪漫，好不自在！
今天，他遇到了一個(gè)后臺的 Bug，游戲死活啟動不了，我來幫忙排查一下，順便給大家分享點(diǎn)編程小知識~
Bug 起因
在開始游戲時(shí)，首先要加載一些配置，比如玩家的用戶名、關(guān)卡的難度、玩家的初始道具等。
由于游戲是使用 Java 語言開發(fā)的，他把這些配置封裝成了一個(gè)對象，代碼如下：
// 游戲配置
class GameConfig {
// 玩家名
String name;
// 游戲難度
int difficulty;
// 玩家物品
String[] items;
}
為了開發(fā)調(diào)試方便，他寫了一個(gè)默認(rèn)的配置；并且為了方便管理默認(rèn)配置，把它單獨(dú)存放到了一個(gè) JSON 格式的文件中，而不是寫死在代碼里。
默認(rèn) JSON 配置文件如下：
{
"name": "yupi",
"difficulty": 5,
"items": ["一級頭", "二級甲"]
}
然后在程序中，讀取該配置文件中的 JSON 字符串，再通過 Gson 解析庫將 JSON 字符串轉(zhuǎn)換為 Java 對象，就能獲取到游戲配置信息，從而進(jìn)行下一步處理了。
邏輯代碼如下：
// 加載游戲配置
void loadConfig() {
String jsonStr = loadFile('config.json');
GameConfig config = new Gson()
.fromJson(jsonStr, GameConfig.class);
// 獲取玩家名稱
String name = config.getName();
// 更多處理
...
}
整個(gè)流程看起來非常簡單，為啥會報(bào)錯(cuò)呢？
打印出異常信息，很明顯，是 JSON 解析錯(cuò)誤了：
仔細(xì)一看，哎，這小糊涂，配置文件竟然輸錯(cuò)了，行尾少了個(gè)必要的引號，當(dāng)然會解析失敗了！
{
// 行尾都少了個(gè)引號
"items": ["一級頭", "二級甲]
}
他表示很無奈，沒辦法，開發(fā)的時(shí)候配置越堆越多、改來改去，一不注意就少打個(gè)字符了。
我笑道：JSON 格式確實(shí)是很靈活強(qiáng)大的，我們在工作中，也經(jīng)常會編寫一些復(fù)雜的嵌套 JSON。我倒是知道一個(gè)辦法，可以幫助減少 JSON 文件寫錯(cuò)的概率。
他不以為然：哦，什么辦法？用編輯器或者校驗(yàn)網(wǎng)站檢查一下？
我：那也只能檢查基本的語法吧，來來來，給你個(gè)更好康的神器 —— JSON Schema！
JSON Schema
JSON 格式的優(yōu)點(diǎn)之一就是輕量，其本身并不支持寫注釋，所以沒辦法直接在文件本身中對字段進(jìn)行描述。
因此，假如我們用 JSON 來做配置文件，大多數(shù)情況下都要對著文檔來查看每個(gè)字段的類型、限制范圍，才能編寫出正確的配置。這樣做不僅效率低，而且必須要自己來校驗(yàn)編寫出的配置是否正確，一不小心就寫錯(cuò)了。
而 JSON Schema 就是為解決此問題而生的，他本身就是 JSON 文件，用來注解和校驗(yàn) JSON 文件。
舉個(gè)例子，上面的游戲配置中，因?yàn)椴恍⌒妮斿e(cuò)了字符串?dāng)?shù)組導(dǎo)致程序出了 Bug。那可以編寫一個(gè) JSON Schema 來校驗(yàn) items 字段是否為合法數(shù)組，代碼如下：
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://www.code-nav.cn/latest.json",
"title": "GameConfig",
"description": "游戲配置",
"type": "object",
"properties": {
"items": {
"type": "array"
}
}
}
在這個(gè)文件中，指定了 GameConfig 的類型必須為 object（對象），且 items 屬性類型必須為 array（數(shù)組）。
接下來在要校驗(yàn)的數(shù)據(jù)中指定 "$schema" 字段為該校驗(yàn)文件地址，比如下列 JSON 配置，故意把 items 字段的值設(shè)置為 string（字符串）而非數(shù)組：
{
"$schema": "https://www.code-nav.cn/latest.json",
{
"name": "yupi",
"difficulty": 5,
"items": "haha"
}
}
這樣就能檢查數(shù)據(jù)是否合法啦！很多主流的編輯器（比如 JetBrains 全家桶）可以自動識別校驗(yàn)文件，并且檢查你的 JSON 輸入是否合法。也可以使用 JSON Schema validation online 等在線校驗(yàn) JSON Schema 的網(wǎng)頁來查看效果：
JSON Schema 功能非常強(qiáng)大，除了對字段類型的校驗(yàn)外，還支持判斷字段是否必填、是否為某個(gè)值（支持正則表達(dá)式）、最大值最小值、字段個(gè)數(shù)、枚舉等，甚至支持組合多個(gè)判斷條件！
比如還可以給我們的游戲配置的難度字段添加校驗(yàn)，必須是 1 到 5 之間的數(shù)字，語法如下：
"difficulty": {
"type": "number",
"minimum": 1,
"maximum": 5
}
優(yōu)點(diǎn)
了解什么是 JSON Schema 后，總結(jié)下它的優(yōu)點(diǎn)：
對數(shù)據(jù)格式進(jìn)行描述，提高可讀性，幫助人類理解
讓機(jī)器更理解數(shù)據(jù)，從而提供數(shù)據(jù)校驗(yàn)和提示輸入等功能
提供了統(tǒng)一的數(shù)據(jù)規(guī)范語法，便于實(shí)現(xiàn)接口格式校驗(yàn)、自動化測試，甚至還能利用它自動生成代碼！比如 jsonschema2pojo 工具，根據(jù) JSON 生成 Java 類。
總之，利用好 JSON Schema，能大大減少開發(fā)者們溝通的成本、保證代碼的質(zhì)量就對了。畢竟 JSON 可是當(dāng)今前后端開發(fā)中最流行的數(shù)據(jù)交換格式??！
看著他一臉懵逼的樣子，我不禁笑到：這個(gè)魚皮就是遜啦！
求求給這么遜的魚皮 點(diǎn)贊 + 在看 支持一下吧~
往期推薦