Jaki jest prawidłowy typ zawartości JSON?

Przez jakiś czas bawiłem się w JSON , wypychając go jako tekst i nikomu nie zaszkodzi (o czym wiem), ale chciałbym zacząć robić wszystko poprawnie.

Widziałem tak wiele rzekomych „standardów” dla typu zawartości JSON:

application/json
application/x-javascript
text/javascript
text/x-javascript
text/x-json

Ale który z nich jest poprawny, czy najlepszy? Rozumiem, że występują różne problemy związane z bezpieczeństwem i obsługą przeglądarki.

Wiem, że istnieje podobne pytanie, jaki typ MIME, jeśli JSON jest zwracany przez interfejs API REST? , ale chciałbym nieco bardziej ukierunkowaną odpowiedź.

W przypadku tekstu JSON:

application/json

Typ nośnika MIME dla tekstu JSON to application/json. Domyślne kodowanie to UTF-8. (Źródło: RFC 4627 ).

W przypadku JSONP (runnable javascript) z wywołaniem zwrotnym:

application/javascript

Oto kilka postów na blogu, które zostały wymienione w odpowiednich komentarzach.

• Dlaczego nie powinieneś używać text/htmlJSON
• Internet Explorer czasami ma problemy z application/json
• Dość kompletna lista typów Mimet i ich zastosowanie
• Oficjalna lista typów mimów w IANA z poniższej odpowiedzi @ gnrfan

IANA zarejestrowała oficjalny typ MIME dla JSON as application/json.

Zapytany o to, dlaczego nie text/json, Crockford powiedział, że JSON nie jest tak naprawdę JavaScript ani tekstem, a także IANA była bardziej skłonna do rozdania application/*niż text/*.

Więcej zasobów:

• Rodzaje mediów
• Prośba o komentarze 4627
• bluesmoon: JSON ma typ

W przypadku JSON:

Content-Type: application/json

W przypadku JSON-P :

Content-Type: application/javascript

Oczywiście poprawnym typem nośnika MIME dla JSON jest application/json , ale należy zdać sobie sprawę, jakiego rodzaju danych oczekuje się w Twojej aplikacji.

Na przykład używam Ext GWT i odpowiedź serwera musi iść jako text / html, ale zawiera dane JSON.

Po stronie klienta, moduł nasłuchujący Ext GWT

uploadForm.getForm().addListener(new FormListenerAdapter()
{
    @Override
    public void onActionFailed(Form form, int httpStatus, String responseText) 
    {
        MessageBox.alert("Error");
    }

    @Override
    public void onActionComplete(Form form, int httpStatus, String responseText) 
    {
        MessageBox.alert("Success");
    }
});

W przypadku użycia typu odpowiedzi aplikacji / json przeglądarka sugeruje mi zapisanie pliku.

Fragment kodu źródłowego po stronie serwera przy użyciu Spring MVC

return new AbstractUrlBasedView() 
{
    @SuppressWarnings("unchecked")
    @Override
    protected void renderMergedOutputModel(Map model, HttpServletRequest request,
                                           HttpServletResponse response) throws Exception 
    {
        response.setContentType("text/html");
        response.getWriter().write(json);
    }
};

JSON:

Odpowiedź to dane generowane dynamicznie, zgodnie z parametrami zapytania przekazanymi w adresie URL.

Przykład:

{ "Name": "Foo", "Id": 1234, "Rank": 7 }

Typ zawartości: application/json

JSON-P:

JSON z wyściółką. Odpowiedź to dane JSON, z zawiniętym wywołaniem funkcji.

Przykład:

functionCall({"Name": "Foo", "Id": 1234, "Rank": 7});

Typ zawartości: application/javascript

Jeśli używasz Ubuntu lub Debiana i serwujesz pliki .json za pośrednictwem Apache, możesz chcieć podawać pliki z poprawnym typem zawartości. Robię to przede wszystkim dlatego, że chcę korzystać z rozszerzenia Firefox JSONView

Moduł Apache mod_mime pomoże to zrobić łatwo. Jednak w Ubuntu musisz edytować plik /etc/mime.types i dodać linię

application/json json

Następnie uruchom ponownie Apache:

sudo service apache2 restart

Jeśli dzwonisz do ASP.NET Web Services po stronie klienta, musisz użyć application/jsontej funkcji, aby działała. Wierzę, że to samo dotyczy frameworków jQuery i Ext .

Właściwym typem zawartości dla JSON jest application/jsonJEŚLI używasz JSONP , znanego również jako JSON z Padding, który w rzeczywistości jest JavaScript, a więc właściwym typem treści byłby application/javascript.

Nie ma wątpliwości, że application/jsonjest to najlepszy typ MIME dla odpowiedzi JSON.

Ale miałem pewne doświadczenie, z którego musiałem korzystać z application/x-javascriptpowodu problemów z kompresją. Moje środowisko hostingowe to hosting współdzielony z GoDaddy . Nie pozwalają mi zmieniać konfiguracji serwera. Do mojego web.configpliku dodałem następujący kod do kompresji odpowiedzi.

<httpCompression>
    <scheme name="gzip" dll="%Windir%\system32\inetsrv\gzip.dll"/>
    <dynamicTypes>
        <add mimeType="text/*" enabled="true"/>
        <add mimeType="message/*" enabled="true"/>
        <add mimeType="application/javascript" enabled="true"/>
        <add mimeType="*/*" enabled="false"/>
    </dynamicTypes>
    <staticTypes>
        <add mimeType="text/*" enabled="true"/>
        <add mimeType="message/*" enabled="true"/>
        <add mimeType="application/javascript" enabled="true"/>
        <add mimeType="*/*" enabled="false"/>
    </staticTypes>
</httpCompression>
<urlCompression doStaticCompression="true" doDynamicCompression="true"/>

Dzięki temu strony .aspx zostały skompresowane za pomocą g-zip, ale odpowiedzi JSON nie. dodałem

<add mimeType="application/json" enabled="true"/>

w sekcjach typów statycznych i dynamicznych. Ale to wcale nie kompresuje odpowiedzi JSON.

Następnie usunąłem ten nowo dodany typ i dodałem

<add mimeType="application/x-javascript" enabled="true"/>

zarówno w sekcjach typów statycznych, jak i dynamicznych, i zmieniono typ odpowiedzi w

.ashx (program obsługi asynchronicznej) do

application/x-javascript

A teraz odkryłem, że moje odpowiedzi JSON zostały skompresowane za pomocą g-zip. Więc osobiście polecam używać

application/x-javascript

tylko jeśli chcesz skompresować swoje odpowiedzi JSON we współdzielonym środowisku hostingowym . Ponieważ w hostingu współdzielonym nie pozwalają one zmieniać konfiguracji IIS .

Tylko przy użyciu application/jsonjako typu MIME mam następujące informacje (od listopada 2011 r. Z najnowszymi wersjami Chrome, Firefox z Firebug ):

• Nigdy więcej ostrzeżeń z Chrome, gdy JSON jest ładowany z serwera.
• Firebug doda do odpowiedzi zakładkę pokazującą sformatowane dane JSON. Jeśli typ MIME jest inny, pojawi się jako „Treść odpowiedzi”.

Nie wszystko działa dla typu zawartości application/json .

Jeśli korzystasz z formularza przesyłania JS Ext do przesłania pliku, pamiętaj, że przeglądarka analizuje odpowiedź serwera, aby utworzyć dokument dla<iframe> .

Jeśli serwer używa JSON do wysłania obiektu zwracanego, Content-Typenagłówek musi być ustawiony natext/html , aby nakazać przeglądarce wstawienie tekstu bez zmian w treści dokumentu.

Zobacz dokumentację interfejsu API Ext JS 3.4.0 .

JSON jest język dziedzinowy (DSL) oraz niezależne format danych JavaScriptu, i jako taki posiada własny MIME typu, application/json. Szacunek dla typów MIME jest oczywiście oparty na kliencie, podobnie text/plainmoże być w przypadku przesyłania bajtów, ale wtedy niepotrzebnie popychasz interpretację do domeny aplikacji dostawcy - application/json. Czy przesłałbyś XML przez text/plain?

Ale szczerze mówiąc, twój wybór typu MIME jest wskazówką dla klienta, jak interpretować dane - text/plainlub text/HTML(gdy nie jest HTML) jest jak usuwanie typu - jest tak nieinformacyjny, jak uczynienie wszystkich twoich obiektów typu Object w języku pisanym na maszynie.

Żadne środowisko uruchomieniowe przeglądarki, o którym wiem, nie pobierze dokumentu JSON i automatycznie udostępni go środowisku wykonawczemu jako obiekt dostępny w JavaScript bez interwencji, ale jeśli pracujesz z kalekim klientem, to zupełnie inna sprawa. Ale to nie jest cała historia - usługi RESTful JSON często nie mają środowiska wykonawczego JavaScript, ale nie powstrzymuje ich to przed użyciem JSON jako realnego formatu wymiany danych. Jeśli klienci są tak sparaliżowani ... rozważałbym może zastrzyk HTML za pośrednictwem usługi szablonów Ajax .

Aplikacja / JSON!

Jeśli pracujesz w środowisku klienta, sprawdzenie dobrze obsługiwanej aplikacji internetowej jest obowiązkowe.

Właściwy typ treści HTTP byłby application/json, jak już inni podkreśleni, ale niektórzy klienci nie radzą sobie z tym dobrze, dlatego jQuery zaleca ustawienie domyślne text/html.

Poprawna odpowiedź to:

Content-Type: application/json

Jak wielu innych wspomniało, application/jsonto poprawna odpowiedź.

Ale to, co jeszcze nie zostało wyjaśnione, oznacza inne proponowane opcje.

• application/x-javascript: Eksperymentalny typ MIME dla JavaScript wcześniej application/javascriptstał się standardem.

• text/javascript: Teraz nieaktualne. Powinieneś używać application/javascriptpodczas używania javascript.

• text/x-javascript: Eksperymentalny typ MIME dla powyższej sytuacji.

• text/x-json: Eksperymentalny typ MIME dla JSON przed application/jsonoficjalną rejestracją.

Podsumowując, za każdym razem, gdy masz jakiekolwiek wątpliwości dotyczące typów treści, powinieneś sprawdzić ten link

W JSP możesz użyć tego w dyrektywie strony:

<%@ page language="java" contentType="application/json; charset=UTF-8"
    pageEncoding="UTF-8"%>

Prawidłowy typ nośnika MIME dla JSON to application/json. JSP użyje go do wysłania odpowiedzi do klienta.

„ application/json” Jest poprawnym typem treści JSON.

def ajaxFindSystems = {
  def result = Systems.list()
  render(contentType:'application/json') {
    results {
      result.each{sys->
        system(id:sys.id, name:sys.name)
      }
    }
    resultset (rows:result.size())
  }
}

Rejestracyjny IANAapplication/json mówi

Aplikacje korzystające z tego typu mediów: JSON służy do wymiany danych między aplikacjami napisanymi we wszystkich tych językach programowania: ActionScript, C, C #, Clojure, ColdFusion, Common Lisp, E, Erlang, Go, Java, JavaScript, Lua, Objective CAML, Perl, PHP, Python, Rebol, Ruby, Scala i Scheme.

Zauważysz, że IANA.org nie wymienia żadnego z tych innych rodzajów mediów , w rzeczywistości nawet application/javascriptjest już przestarzały. Tak application/jsonnaprawdę jest to jedyna możliwa poprawna odpowiedź.

Obsługa przeglądarki to inna sprawa.

Najczęściej obsługiwanymi niestandardowymi typami mediów są text/jsonlub text/javascript. Ale używają nawet niektórych wielkich nazwisk text/plain.

Jeszcze bardziej dziwny jest nagłówek Content-Type wysyłany przez Flickr, który zwraca JSON as text/xml. Google używatext/javascript dla niektórych swoich aps ajax.

Przykłady:

curl -I "https://ajax.googleapis.com/ajax/services/search/video?v=1.0&q=jsonexample"

Wynik: Content-Type: text/javascript

curl -I "https://www.flickr.com/services/rest/?method=flickr.test.echo&format=json&api_key=f82254c1491d894f1204d8408f645a93"

Wynik: Content-Type: text/xml

Właściwy typ MIME to application/json

ALE

Doświadczyłem wielu sytuacji, w których potrzebny był typ przeglądarki lub użytkownik frameworka:

text/html

application/javascript

Korzystam z poniższych

contentType: 'application/json',
data: JSON.stringify(SendData),

Content-Type nagłówek powinien być ustawiony na „ application / json ” podczas wysyłania. Serwer nasłuchujący żądania powinien zawierać „ Accept = application / json ”. W Spring MVC możesz to zrobić w następujący sposób:

@RequestMapping(value="location", method = RequestMethod.POST, headers = "Accept=application/json")

Dodaj nagłówki do odpowiedzi:

HttpHeaders headers = new HttpHeaders();
headers.add("Content-Type", "application/json");

Na wiosnę masz zdefiniowany typ: MediaType.APPLICATION_JSON_VALUErównoważny aplikacji / json .

Te application/jsonprace wielki w PHP do przechowywania tablicy lub obiektu danych.

Używam tego kodu do umieszczania danych w JSON w Google Cloud Storage (GCS), który jest ustawiony do publicznego wyświetlania :

$context = stream_context_create([
    'gs' => [
        'acl'=>'public-read', 
        'Content-Type' => 'application/json',
    ]
]);

file_put_contents(
    "gs://BUCKETNAME/FILENAME.json", 
    json_encode((object) $array), 
    false, 
    $context
);

Odzyskiwanie danych jest proste:

$data = json_decode(file_get_contents("gs://BUCKETNAME/FILENAME.json"));

Jeśli JSON jest wyposażony w padding, to będzie application/jsonp. Jeśli JSON jest bez wypełnienia, będzie application/json.

Aby poradzić sobie z obiema kwestiami, dobrą praktyką jest używanie: „application / javascript” bez zawracania sobie głowy, czy jest to padding czy padding.

W przypadku JSON używam:

 Content-Type: application/json

Jest to opisane w propozycji formatu JSON Data Interchange 7158 IETF, sekcja 1.2: Dane techniczne JSON .

Rozszerzanie akceptowanych odpowiedzi, gdy używasz JSON w kontekście REST ...

Istnieje silny argument na temat używania application/x-resource+jsoni application/x-collection+jsonreprezentowania zasobów i kolekcji REST.

A jeśli zdecydujesz się postępować zgodnie ze specyfikacją jsonapi , powinieneś użyć application/vnd.api+json, tak jak jest to udokumentowane.

Chociaż nie ma uniwersalnego standardu, jasne jest, że dodany semantyczny do przenoszonych zasobów uzasadnia bardziej wyraźny typ zawartości niż tylko application/json.

Zgodnie z tym rozumowaniem inne konteksty mogą uzasadniać bardziej szczegółowy typ zawartości .

Programiści PHP używają tego:

<?php
    header("Content-type: application/json");

    // Do something here...
?>

Jeśli otrzymujesz dane z interfejsu API REST w JSON, musisz użyć typu zawartości

For JSON data: Content-Type:application/json
For HTML data: Content-Type:text/html,
For XHTML data: Content-Type:application/xhtml+xml,
For XML data: Content-Type:text/xml, application/xml

Content-Type: application/json- json
Content-Type: application/javascript- json-P
Content-Type: application/x-javascript- javascript
Content-Type: text/javascript- javascript ALE przestarzałe, starsze wersje IE używane jako atrybuty HTML.
Content-Type: text/x-javascript- Typy mediów JavaScript ALE przestarzałe
Content-Type: text/x-json- json przed oficjalną rejestracją aplikacji / json.

Formaty JSON (JavaScript Object Notation) i JSONP („JSON with padding”) wydają się być bardzo podobne i dlatego może być bardzo mylące, jakiego typu MIME powinny używać. Mimo że formaty są podobne, istnieją między nimi pewne subtelne różnice.

Dlatego zawsze, gdy mam jakiekolwiek wątpliwości, mam bardzo proste podejście (które w większości przypadków działa idealnie), a mianowicie idź i sprawdź odpowiedni dokument RFC.

JSON RFC 4627 (Aplikacja / json Media Type for JavaScript Object Notation (JSON)) to specyfikacja formatu JSON. W sekcji 6 napisano, że typ nośnika MIME dla tekstu JSON to

application/json.

JSONP JSONP („JSON z paddingiem”) jest obsługiwany w przeglądarce inaczej niż JSON. JSONP jest traktowany jako zwykły skrypt JavaScript, dlatego powinien używać application/javascript,bieżącego oficjalnego typu MIME dla JavaScript. Jednak w wielu przypadkach text/javascripttyp MIME również będzie działał dobrze.

Zauważ, że text/javascriptzostał oznaczony jako przestarzały w dokumencie RFC 4329 (Scripting Media Types) i zaleca się użycie application/javascriptzamiast niego tekstu. Jednak ze względu na starsze wersje text/javascriptjest nadal szeroko stosowany i obsługuje wiele przeglądarek (co nie zawsze ma miejsce w przypadku application/javascripttypu MIME, szczególnie w starszych przeglądarkach).