Параметри матриці URL проти параметрів запиту

Мені цікаво, чи використовувати параметри матриці чи запиту у своїх URL-адресах. Я вважав, що старі дискусії на цю тему не задовольняють.

Приклади

• URL-адреса з парами запитів: http: //some.where/thing? ParamA = 1 & paramB = 6542
• URL з параметри матриці: http: //some.where/thing; paramA = 1; paramB = 6542

На перший погляд матричні парами, здається, мають лише переваги:

• більш читабельний
• не потрібно кодувати та розшифровувати "&" в XML-документах
• URL-адреси з "?" не є кешованим у багатьох випадках; URL-адреси з параметри матриці кешуються
• Параметри матриці можуть з'являтися скрізь на шляху і не обмежуються її кінцем
• Параметри матриці можуть мати більше одного значення: paramA=val1,val2

Але є і недоліки:

• лише декілька рамок, таких як параметри матриці підтримки JAX-RS
• Коли браузер подає форму через GET, парами стають парами запитів. Таким чином, він складається в двох видах параметрів для одного завдання. Щоб не збивати з пантелику користувачів REST-сервісів і обмежувати зусилля для розробників сервісів, було б простіше використовувати параметри запитів - у цій галузі.

Оскільки розробник служби може вибрати рамку з підтримкою параметри матриці, єдиним недоліком буде те, що браузери створюють за замовчуванням параметри запиту.

Чи є інші недоліки? Що б ти зробив?

Важлива відмінність полягає в тому, що параметри матриці застосовуються до певного елемента шляху, тоді як параметри запиту застосовуються до запиту в цілому. Це стає важливим при складанні запиту в стилі REST на декількох рівнях ресурсів і субресурсів:

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

Це дійсно зводиться до простору імен.

Примітка. Тут знаходяться "рівні" ресурсів categories і objects.

Якби для багаторівневої URL-адреси використовувались лише параметри запиту, ви закінчите

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

Таким чином, ви також втратите чіткість, додану локальністю параметрів у запиті. Крім того, при використанні такої рамки, як JAX-RS, всі параметри запиту відображатимуться в кожному обробнику ресурсів, що призводить до потенційних конфліктів та плутанини.

Якщо ваш запит має лише один "рівень", то різниця насправді не важлива, і два типи параметрів ефективно взаємозамінні, однак параметри запиту, як правило, краще підтримуються і ширше розпізнаються. Загалом, я б рекомендував дотримуватися параметрів запиту таких речей, як HTML форми та прості однорівневі API HTTP.

На додаток до відповіді Тіма Сильвестра, я хотів би навести приклад того, як матричні параметри можна обробляти за допомогою JAX-RS .

1. Параметри матриці на останньому ресурсному елементі

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

   Ви можете отримати доступ до них за допомогою @MatrixParamпримітки

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

   Відповідь

   green

   Але подібно до держав Javadoc

   Зауважте, що @MatrixParamзначення анотації стосується імені параметра матриці, який знаходиться в останньому зіставленому сегменті шляху структури Java-анотованої структури, який вводить значення параметра матриці.

   ... що приводить нас до пункту 2

2. Параметри матриці посередині URL-адреси

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

   Ви можете отримати доступ до параметрів матриці в будь-якому місці, використовуючи змінні шляху та @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;
   }

   Відповідь

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

   Оскільки параметри матриці надаються як a, 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();
   }

   Відповідь

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

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

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

Отже, коротка відповідь - якщо вам потрібна RS для ділових цілей, вам краще скористатися параметром запиту.