JSON Adlandırma Sözleşmesi [kapalı]

JSON adlandırmada bir standart var mı? Alt çizgi ile ayrılmış tüm küçük harf kullanarak çoğu örnek görüyorum (küçük_kutu). Ancak, PascalCase veya camelCase kullanabilir misiniz?

Hiçbir TEK standarttır, ama ( "Pascal / Microsoft", "Java" (söz 3 stilleri gördük camelCase) ve "C" (alt çizgi, snake_caseaynı zamanda en az birini daha, -)) kebab-casegibilonger-name ).

Çoğunlukla söz konusu hizmetin arka plan geliştiricilerinin sahip oldukları şeye bağlı olduğu görülüyor; c / c ++ arka planı olanlar (veya birçok komut dosyası dili, yakut vb. içeren benzer adlandırma kullanan diller) genellikle alt çizgi varyantını seçer; ve benzer şekilde dinlenin (Java vs .NET). Sözü edilen Jackson kütüphanesi, Java fasulyesi adlandırma kuralını (camelCase )

GÜNCELLEME: Benim "standart" tanımım TEK bir kuraldır. Bu yüzden "evet, birçok standart var" iddiasında bulunabilse de, bana göre Naming Conventions, hepsi "Standart" standart değil. Bunlardan biri, belirli bir platform için standart olarak kabul edilebilir, ancak JSON'un, çok anlamlı olabilecek veya olmayabilecek platformlar arasında birlikte çalışabilirlik için kullanıldığı göz önüne alındığında.

Bu dokümanda Google JSON Stil Kılavuzu (Google'da JSON API'leri oluşturmaya yönelik öneriler),

Şunları önerir:

1. Özellik adları camelCased , ASCII dizeleri olmalıdır.

2. İlk karakter bir harf, alt çizgi (_) veya dolar işareti ($) olmalıdır.

Misal:

{
  "thisPropertyIsAnIdentifier": "identifier value"
}

Ekibim bu sözleşmeyi takip ediyor.

Öncül

Orada JSON anahtarlardan hiçbir standart adlandırma . Spesifikasyonun Nesneler bölümüne göre :

JSON sözdizimi, ad olarak kullanılan dizelere herhangi bir kısıtlama getirmez, ...

Bu da demek camelCase veya snake_case cezası çalışmalıdır.

Sürüş faktörleri

JSON adlandırma kuralını uygulamak çok kafa karıştırıcıdır. Ancak, bileşenlere ayırırsanız bu kolayca çözülebilir.

1. JSON oluşturmak için programlama dili

   • Python - snake_case
   • PHP - snake_case
   • Java - camelCase
   • JavaScript - camelCase

2. JSON'un kendisinde standart anahtar adı yoktur

3. JSON ayrıştırma için programlama dili

   • Python - snake_case
   • PHP - snake_case
   • Java - camelCase
   • JavaScript - camelCase

Bileşenleri karıştırın

1. Python »JSON» Python - snake_case - oybirliği ile
2. Python »JSON» PHP - snake_case - oybirliği ile
3. Python »JSON» Java - snake_case - lütfen aşağıdaki Java sorununa bakın
4. Python »JSON» JavaScript - snake_case anlamlı olacak; ön ucu yine de vidala
5. Python »JSON» bilmiyorsunuz - snake_case mantıklı olacak; ayrıştırıcıyı yine de vidala
6. PHP »JSON» Python - snake_case - oybirliği ile
7. PHP »JSON» PHP - snake_case - oybirliği ile
8. PHP »JSON» Java - snake_case - lütfen aşağıdaki Java sorununa bakın
9. PHP »JSON» JavaScript - snake_case anlamlı olacak; ön ucu yine de vidala
10. PHP »JSON» bilmiyorsunuz - snake_case mantıklı olacak; ayrıştırıcıyı yine de vidala
11. Java »JSON» Python - snake_case - lütfen aşağıdaki Java sorununa bakın
12. Java »JSON» PHP - snake_case - lütfen aşağıdaki Java sorununa bakın
13. Java »JSON» Java - camelCase - oybirliği ile
14. Java »JSON» JavaScript - camelCase takdim edilenler - oybirliği ile
15. Java »JSON» bilmiyorsunuz - camelCase anlamlı olacak; ayrıştırıcıyı yine de vidala
16. JavaScript »JSON» Python - snake_case anlam ifade edecektir; ön ucu yine de vidala
17. JavaScript »JSON» PHP - snake_case anlamlı olacak; ön ucu yine de vidala
18. JavaScript »JSON» Java - camelCase - oybirliği ile
19. JavaScript »JSON» JavaScript - camelCase - Orijinal

Java sorunu

Java için mevcut JSON kitaplıkları standart dot.syntax kullanmak yerine yalnızca anahtarlara erişmek için yöntemler kullandığından snake_case , Java girişleri olanlar için yine de anlamlı olacaktır . Bu, Java'nın snake_cased'a erişmesinin o kadar çok incitmeyeceği anlamına gelir yapabileceğiniz diğer programlama dili ile karşılaştırıldığında anahtarlarını dot.syntax .

Java paketi örneğiorg.json

JsonObject.getString("snake_cased_key")

Java paketi örneğicom.google.gson

JsonElement.getAsString("snake_cased_key")

Bazı gerçek uygulamalar

• Google Haritalar JavaScript API'sı - camelCased
• Facebook JavaScript API'sı - snake_cased
• Amazon İnternet Servisleri - snake_cased & camelCased
• Twitter API'sı - snake_cased
• JSON-LD - deveDevamı & ProperCamelCased

Sonuçlar

JSON uygulamanız için doğru JSON adlandırma kuralını seçmek, teknoloji yığınınıza bağlıdır. Birini kullanabilirsiniz durumlar vardır snake_case , camelCase , ya da başka bir adlandırma kuralı.

Dikkate alınması gereken başka bir şey, JSON-üretecine karşı JSON-ayrıştırıcı ve / veya ön uç JavaScript'e uygulanacak ağırlıktır. Genel olarak, JSON ayrıştırıcı tarafı yerine JSON üreteci tarafına daha fazla ağırlık konulmalıdır. Bunun nedeni, iş mantığının genellikle JSON-jeneratör tarafında bulunmasıdır.

Ayrıca, JSON ayrıştırıcı tarafı bilinmiyorsa, sizin için neyin işe yarayabileceğini beyan edebilirsiniz.

Özellikle NodeJS'de benim için, veritabanları ile çalışıyorsam ve alan adlarımın alt çizgileri ayrılmışsa, bunları yapı anahtarlarında da kullanırım.

Bunun nedeni, db alanlarının çok sayıda kısaltma / kısaltmaya sahip olmasıdır, bu nedenle appSNSInterfaceRRTest gibi bir şey biraz dağınık görünüyor, ancak app_sns_interface_rr_test daha güzel görünüyor .

Javascript değişkenleri tüm camelCase ve sınıf isimleri (yapıcılar) ProperCase, bu yüzden şöyle bir şey görürsünüz

var devTask = {
        task_id: 120,
        store_id: 2118,
        task_name: 'generalLedger'
    };

veya

generalLedgerTask = new GeneralLedgerTask( devTask );

Ve elbette JSON anahtarları / dizeleri çift tırnaklarla sarılır, ancak daha sonra JSON.stringify kullanın ve JS nesnelerini iletin, bu yüzden endişelenmenize gerek yok.

JSON ve JS adlandırma kuralları arasında bu mutlu ortamı bulana kadar bununla biraz uğraştım.

İnsanların tüm sözleşmelerden diğerlerine dönüşüm sağlamak için kendi yollarından gitmeleri için yeterli varyasyon var gibi görünüyor: http://www.cowtowncoder.com/blog/archives/cat_json.html

Özellikle, bahsedilen Jackson JSON ayrıştırıcısı tercih eder bean_naming.

JSON için resmi bir adlandırma kuralı olmadığını düşünüyorum, ancak nasıl çalıştığını görmek için bazı endüstri liderlerini takip edebilirsiniz.

Dünyanın en büyük bilişim şirketlerinden biri olan Google'ın JSON stil kılavuzu vardır: https://google.github.io/styleguide/jsoncstyleguide.xml

Avantajlardan yararlanarak, Google'ın tanımladığı diğer stiller kılavuzunu burada bulabilirsiniz: https://github.com/google/styleguide

Diğerlerinin de belirttiği gibi standart yok, bu yüzden kendiniz bir tane seçmelisiniz. İşte bunu yaparken göz önünde bulundurmanız gereken birkaç nokta:

1. JSON'u tüketmek için JavaScript kullanıyorsanız, her ikisinde de özellikler için aynı adlandırma kuralını kullanmak görsel tutarlılık ve muhtemelen daha temiz kodun yeniden kullanımı için bazı fırsatlar sağlayacaktır.

2. Kebaptan kaçınmanın küçük bir nedeni, tire işaretlerinin -değerlerde görünen karakterlerle görsel olarak çakışabilmesidir .

   {
     "bank-balance": -10
   }