Параметры матрицы URL по сравнению с параметрами запроса

Question

Мне интересно, следует ли использовать параметры матрицы или запроса в моих URL-адресах. Я нашел более старую discussion, чтобы эта тема не удовлетворяла.

Примеры

• URL с Params запроса: http://some.where/thing?paramA=1&paramB=6542
• URL с матричными Params: http://some.where/thing;paramA=1;paramB=6542

На первый взгляд матрицы Params, кажется, есть только преимущества:

• более читаемый
• не требуется кодирование и декодирование «&» в XML-документах
• URL-адреса с "?" во многих случаях не кэшируются; URL-адрес с матричной Params кэшируется
• параметров матрицы могут появляться везде в пути и не ограничены до конца
• параметры матрицы могут иметь более чем одно значение: paramA=val1,val2

Но есть и недостатки:

• лишь несколько структур, как параметры поддержки JAX-RS матричных
• Когда браузер отправляет форму через GET, то PARAMS становятся параметрами запроса. Таким образом, он заканчивается двумя параметрами для одной и той же задачи. Чтобы не путать пользователей служб REST и ограничить усилия для разработчиков сервисов, было бы проще использовать всегда параметры запроса - в этой области.

Поскольку разработчик службы может выбрать инфраструктуру с поддержкой матричного параметра, единственным оставшимся недостатком будет то, что браузеры создают параметры запроса по умолчанию.

Есть ли другие недостатки? Что бы вы сделали?

Answer 1

Важным отличием является то, что параметры матрицы применяются к определенному элементу пути, в то время как параметры запроса применяются к запросу в целом. Это входит в игру, делая сложный запрос REST стиля для нескольких уровней ресурсов и суб-ресурсов:

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

Это действительно сводится к именованию. Если бы использовались только параметры запроса, у вас были бы такие параметры, как «category_name» и «object_name», и вы потеряли бы ясность, добавленную местностью параметров в запросе. Кроме того, при использовании такой структуры, как JAX-RS, все параметры запроса будут отображаться внутри каждого обработчика ресурсов, что приведет к потенциальным конфликтам и путанице.

Если ваш запрос имеет только один «уровень», то разница не очень важна, и два типа параметров эффективно взаимозаменяемы, однако параметры запроса обычно лучше поддерживаются и широко распознаются. В общем, я бы рекомендовал вам придерживаться параметров запроса для таких вещей, как HTML-формы и простые одноуровневые HTTP-API.

Answer 2

--Too важно отнести к разделу комментариев.-

Я не уверен, в чем дело с матричными URL-адресами. Согласно статье дизайна w3c, написанной TBL, это была всего лишь дизайнерская идея и прямо заявляет, что она не является особенностью сети. Такие вещи, как относительные URL-адреса, не используются при его использовании. Если вы хотите использовать его, это нормально; нет стандартного способа использовать его, потому что это не стандарт. - Стив Померой

Столь короткий ответ: если вам нужен RS для деловых целей, вам лучше использовать параметр запроса.

Answer 3

В дополнение к Tim Sylvester's asnwer Я хотел бы привести пример того, как параметры матрицы могут быть обработаны с JAX-RS.

1. параметры MATIX на последнем элементе ресурса

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

   Вы можете получить доступ к ним с помощью @MatrixParam аннотацию

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

   Response

   green 
   

   Но как для документирования состояний

   Обратите внимание, что значение @MatrixParam аннотацию относится к имени параметра матрицы, который находится в сегменте последний соответствует пути пути аннотированный Java структуру, которая впрыскивает значение параметра матрицы.

   ... что приводит нас к точке 2

2. Матрица параметров в середине URL

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

   Вы можете получить доступ к параметрам матрицы в любом месте, используя переменные пути и @PathParamPathSegment.

   @GET 
   @Path("{categoryVar:categories}/objects") 
   public String objectsByCatecory(@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; 
   } 
   

   Response

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

   Поскольку параметры матрицы представлены в виде MultivaluedMap вы можете получить доступ к каждому по

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

   или, если вам нужно только первые один

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

3. Получить все параметры матрицы в качестве параметров один метод

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

   Используйте List<PathSegment>, чтобы получить их все

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

   Response

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