Parametri della matrice URL vs. parametri della query

Mi chiedo se utilizzare i parametri matrice o query nei miei URL. Ho trovato una discussione più vecchia su questo argomento non soddisfacente.

Esempi

• URL con parametri di query: http: //some.where/thing? ParamA = 1 & paramB = 6542
• URL con parametri matrice: http: //some.where/thing; paramA = 1; paramB = 6542

A prima vista i parametri della matrice sembrano avere solo vantaggi:

• più leggibile
• non è richiesta alcuna codifica e decodifica di "&" nei documenti XML
• URL con "?" non sono memorizzati nella cache in molti casi; Gli URL con parametri matrice sono memorizzati nella cache
• i parametri della matrice possono apparire ovunque nel percorso e non sono limitati alla sua fine
• i parametri della matrice possono avere più di un valore: paramA=val1,val2

Ma ci sono anche degli svantaggi:

• solo alcuni framework come JAX-RS supportano i parametri della matrice
• Quando un browser invia un modulo tramite GET, i parametri diventano parametri di query. Quindi finisce in due tipi di parametri per la stessa attività. Per non confondere gli utenti dei servizi REST e limitare lo sforzo per gli sviluppatori dei servizi, sarebbe più facile usare sempre i parametri di query - in quest'area.

Poiché lo sviluppatore del servizio può scegliere un framework con supporto per i parametri matrix, l'unico svantaggio rimanente sarebbe che i browser creano con parametri di query predefiniti.

Ci sono altri svantaggi? Cosa faresti?

La differenza importante è che i parametri della matrice si applicano a un particolare elemento del percorso mentre i parametri della query si applicano alla richiesta nel suo insieme. Questo entra in gioco quando si effettua una complessa query in stile REST a più livelli di risorse e risorse secondarie:

http://example.com/res/categories;name=foo/objects;name=green/?page=1

Dipende davvero dallo spazio dei nomi.

Nota: i "livelli" delle risorse qui sono categoriese objects.

Se solo un parametro di query fosse usato per un URL multi-livello, si finirebbe con

http://example.com/res?categories_name=foo&objects_name=green&page=1

In questo modo si perderebbe anche la chiarezza aggiunta dalla località dei parametri all'interno della richiesta. Inoltre, quando si utilizza un framework come JAX-RS, tutti i parametri della query vengono visualizzati all'interno di ciascun gestore di risorse, causando potenziali conflitti e confusione.

Se la tua query ha un solo "livello", la differenza non è molto importante e i due tipi di parametri sono effettivamente intercambiabili, tuttavia i parametri della query sono generalmente meglio supportati e più ampiamente riconosciuti. In generale, consiglierei di attenersi ai parametri della query per cose come moduli HTML e API HTTP semplici a livello singolo.

Oltre alla risposta di Tim Sylvester, vorrei fornire un esempio di come i parametri della matrice possono essere gestiti con JAX-RS .

1. Parametri matrice nell'ultimo elemento risorsa

   http://localhost:8080/res/categories/objects;name=green

   Puoi accedervi usando l' @MatrixParamannotazione

   @GET
   @Path("categories/objects")
   public String objects(@MatrixParam("name") String objectName) {
     return objectName;
   }

   Risposta

   green

   Ma come gli stati Javadoc

   Si noti che il @MatrixParamvalore dell'annotazione si riferisce al nome di un parametro matrix che risiede nell'ultimo segmento di percorso corrispondente della struttura Java con annotazioni Path che inietta il valore del parametro matrix.

   ... cosa ci porta al punto 2

2. Parametri della matrice nel mezzo di un URL

   http://localhost:8080/res/categories;name=foo/objects;name=green

   Puoi accedere ai parametri della matrice ovunque usando le variabili path e @PathParam PathSegment.

   @GET
   @Path("{categoryVar:categories}/objects")
   public String objectsByCategory(@PathParam("categoryVar") PathSegment categorySegment, 
                                   @MatrixParam("name") String objectName) {
     MultivaluedMap<String, String> matrixParameters = categorySegment.getMatrixParameters();
     String categorySegmentPath = categorySegment.getPath();
     String string = String.format("object %s, path:%s, matrixParams:%s%n", objectName,
             categorySegmentPath, matrixParameters);
     return string;
   }

   Risposta

   object green, path:categories, matrixParams:[name=foo]

   Dal momento che i parametri della matrice sono forniti come un MultivaluedMapè possibile accedere a ciascuno di

   List<String> names = matrixParameters.get("name");

   o se hai solo bisogno del primo

   String name = matrixParameters.getFirst("name");

3. Ottieni tutti i parametri della matrice come parametro di un metodo

   http://localhost:8080/res/categories;name=foo/objects;name=green//attributes;name=size

   Usa a List<PathSegment>per ottenerli tutti

   @GET
   @Path("all/{var:.+}")
   public String allSegments(@PathParam("var") List<PathSegment> pathSegments) {
     StringBuilder sb =  new StringBuilder();
   
     for (PathSegment pathSegment : pathSegments) {
       sb.append("path: ");
       sb.append(pathSegment.getPath());
       sb.append(", matrix parameters ");
       sb.append(pathSegment.getMatrixParameters());
       sb.append("<br/>");
     }
   
     return sb.toString();
   }

   Risposta

   path: categories, matrix parameters [name=foo]
   path: objects, matrix parameters [name=green]
   path: attributes, matrix parameters [name=size]

- È molto importante essere relegati nella sezione commenti. -

Non sono sicuro di quale sia il grosso problema con gli URL a matrice. Secondo l'articolo di design di W3c che TBL ha scritto, era solo un'idea di design e afferma esplicitamente che non è una caratteristica del web. Cose come gli URL relativi non vengono implementate quando lo si utilizza. Se vuoi usarlo, va bene; non esiste un modo standard per usarlo perché non è uno standard. - Steve Pomeroy

Quindi la risposta breve è, se hai bisogno di RS per motivi di lavoro, stai meglio usando il parametro request.