Google JSON风格指南：最佳实践与规范

"www.google.com", "location": { "street": "1600 Amphitheatre Parkway", "city": "Mountain View", "state": "CA", "zip": "94043" } } 结构化地址: { "company": "Google", "website": "www.google.com", "location": { "street": { "name": "1600 Amphitheatre Parkway" }, "city": "Mountain View", "state": "CA", "zip": "94043" } } 在上面的例子中，两者都可行，但扁平化的形式更简洁，易于阅读。然而，如果地址包含更复杂的子结构，如多行街道或包含国家/地区的完整国际地址，那么结构化的形式就更有优势。 属性命名 使用小驼峰式命名 属性名应使用小驼峰式命名法，即单词首字母小写，后续单词首字母大写。避免使用下划线(_)或连字符(-)分隔单词。 例如： "firstName": "John", "lastName": "Doe", "age": 30 数值与布尔值 数值和布尔值直接写 数值和布尔值（true、false）在JSON中不需要引号。直接写即可。 例如： "isEmployee": true, "salary": 50000 空值与缺失值 避免使用null 尽可能避免在属性值中使用null。如果属性不存在，可以完全省略该属性。这有助于区分值为null和属性不存在的情况。 例如： // 不推荐 { "name": "Alice", "email": null } // 推荐 { "name": "Alice" } 数组 数组应包含相关项目 数组应包含相关项目，且所有项目应具有相似的数据类型。数组的索引从0开始，但通常不显示在JSON中。 例如： "employees": [ {"firstName": "Alice", "lastName": "Smith"}, {"firstName": "Bob", "lastName": "Johnson"} ] 错误处理 错误消息作为对象 当需要表示错误时，应使用一个包含错误信息的对象，而不是简单地返回一个错误字符串。 例如： { "error": { "code": 404, "message": "Not found" } } 结论 JSON风格指南的目标是提高JSON数据的可读性和一致性，使其在API中易于理解和使用。遵循这些指南可以确保JSON对象在Google的APIs中有统一的格式，提高开发人员的效率，并减少潜在的解析错误。尽管此指南主要针对Google的API设计，但其原则和最佳实践也可广泛应用于其他JSON数据的生成和消费场景。