Parâmetros da matriz de URL vs. parâmetros de consulta

Eu estou querendo saber se deve usar parâmetros de matriz ou consulta em meus URLs. Eu achei uma discussão mais antiga sobre esse tópico não satisfatória.

Exemplos

• URL com parâmetros de consulta: http: //some.where/thing? ParamA = 1 & paramB = 6542
• URL com parâmetros de matriz: http: //some.where/thing; paramA = 1; paramB = 6542

À primeira vista, os parâmetros de matriz parecem ter apenas vantagens:

• mais legível
• nenhuma codificação e decodificação de "&" em documentos XML é necessária
• URLs com "?" não são armazenados em cache em muitos casos; URLs com parâmetros de matriz são armazenados em cache
• parâmetros de matriz podem aparecer em qualquer lugar do caminho e não estão limitados ao seu final
• parâmetros de matriz podem ter mais de um valor: paramA=val1,val2

Mas também há desvantagens:

• apenas algumas estruturas, como JAX-RS, suportam parâmetros de matriz
• Quando um navegador envia um formulário via GET, os parâmetros se tornam parâmetros de consulta. Portanto, acaba em dois tipos de parâmetros para a mesma tarefa. Para não confundir os usuários dos serviços REST e limitar o esforço para os desenvolvedores dos serviços, seria mais fácil usar sempre os parâmetros de consulta - nesta área.

Como o desenvolvedor do serviço pode escolher uma estrutura com suporte a parâmetros de matriz, a única desvantagem restante seria que os navegadores criem por parâmetros de consulta padrão.

Existem outras desvantagens? O que você faria?

A diferença importante é que os parâmetros da matriz se aplicam a um elemento de caminho específico, enquanto os parâmetros de consulta se aplicam à solicitação como um todo. Isso entra em jogo ao fazer uma consulta complexa no estilo REST para vários níveis de recursos e sub-recursos:

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

Realmente se resume ao namespacing.

Nota: Os 'níveis' de recursos aqui são categoriese objects.

Se apenas parâmetros de consulta fossem usados ​​para um URL de vários níveis, você terminaria com

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

Dessa forma, você também perderia a clareza adicionada pela localidade dos parâmetros na solicitação. Além disso, ao usar uma estrutura como JAX-RS, todos os parâmetros de consulta apareceriam em cada manipulador de recursos, levando a possíveis conflitos e confusão.

Se sua consulta tiver apenas um "nível", a diferença não será realmente importante e os dois tipos de parâmetros serão efetivamente intercambiáveis. No entanto, os parâmetros de consulta geralmente são mais bem suportados e mais amplamente reconhecidos. Em geral, eu recomendaria que você se atenha aos parâmetros de consulta para coisas como formulários HTML e APIs HTTP simples e de nível único.

Além da resposta de Tim Sylvester, gostaria de fornecer um exemplo de como os parâmetros da matriz podem ser tratados com o JAX-RS .

1. Parâmetros da matriz no último elemento do recurso

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

   Você pode acessá-los usando a @MatrixParamanotação

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

   Resposta

   green

   Mas, como os estados Javadoc

   Observe que o @MatrixParamvalor da anotação se refere ao nome de um parâmetro da matriz que reside no último segmento de caminho correspondente da estrutura Java anotada por Path que injeta o valor do parâmetro da matriz.

   ... o que nos leva ao ponto 2

2. Parâmetros da matriz no meio de uma URL

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

   Você pode acessar os parâmetros da matriz em qualquer lugar usando as variáveis ​​de caminho 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;
   }

   Resposta

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

   Como os parâmetros da matriz são fornecidos como um, MultivaluedMapvocê pode acessar cada um deles.

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

   ou se você só precisa do primeiro

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

3. Obter todos os parâmetros da matriz como um parâmetro de método

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

   Use a List<PathSegment>para obter todos

   @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();
   }

   Resposta

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

--Muito importante ser relegado para a seção de comentários .--

Não sei ao certo qual é o problema dos URLs da matriz. De acordo com o artigo de design do w3c que a TBL escreveu, era apenas uma idéia de design e afirma explicitamente que não é um recurso da web. Coisas como URLs relativos não são implementadas ao usá-lo. Se você quiser usá-lo, tudo bem; simplesmente não há uma maneira padrão de usá-lo, porque não é um padrão. - Steve Pomeroy

Uma resposta tão curta é que, se você precisar do RS para fins comerciais, é melhor usar o parâmetro request.