В Play, как включить настраиваемые параметры запроса в обратном URL? (Call)

Question

С маршрутом, как:

GET /users/:id controllers.Users.view(id) 

В контроллере я могу читать пользовательские backTo строки запроса параметров, как это:

def view (id: String) = Action {r => 
    val backTo = r.getQueryString("backTo") // read custom param 
    ... 
} 

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

Как создать URL-адрес с использованием обратного маршрутизации, который включает параметр backTo?

Я бы ожидать что-то вроде:

routes.Users.view(id).withQueryString("backTo" -> Seq("previous")) 

Но что не существует.

Answer 1

Я в конечном итоге просто жалкий способ withQueryString на Call что просто разбирает URL и перестраивает URL с дополнительными параметрами:

implicit class CallOps (c: Call) { 
    import org.jboss.netty.handler.codec.http.{QueryStringDecoder, QueryStringEncoder} 
    import scala.collection.JavaConverters._ 

    def withQueryString(query: (String,Seq[String])*): Call = { 
    val decoded = new QueryStringDecoder(c.url) 
    val newUrl = new QueryStringEncoder(decoded.getPath) 
    val params = decoded.getParameters.asScala.mapValues(_.asScala.toSeq).toSeq 
    for { 
     (key, values) <- params ++ query 
     value <- values 
    } newUrl.addParam(key, value) 
    Call(c.method, newUrl.toString, c.fragment) 
    } 
} 

И теперь я могу использовать его как это:

routes.Users.view(id).withQueryString("backTo" -> Seq("previous")).url 

Мне жаль, что мне не нужно повторно разбирать URL-адрес, но к моменту, когда у меня есть Call, URL-адрес уже создан.

Answer 2

Я думаю, вам нужно было бы спуститься до уровня String, так как такого метода нет (пока).

То, что дает вам обратный маршрутизатор, на самом деле является объектом play.api.mvc.Call. Вы можете посмотреть на источник здесь можно:

https://github.com/playframework/playframework/blob/2.5.0/framework/src/play/src/main/scala/play/api/mvc/Http.scala#L359

Вы увидите, что вы можете получить absoluteURL() - который возвращает вам String - отсюда вы бы манипулировать им, добавив параметр запроса:

val url = routes.Users.view(id).absoluteURL() + "?backTo=home"

Answer 3

Что плохого об использовании Parameters with default values (без разрешения его вручную самостоятельно)? Образец:

def view(id: String, backTo: String, forwardTo: String, whatever: String) = Action { 
    Ok(
    "ID: " + id 
     + ", backTo: " + backTo 
     + ", forwardTo: " + forwardTo 
     + ", whatever: " + whatever 
) 
} 

маршрут:

GET /users/:id controllers.Users.view(id, backTo ?= null, forwardTo ?= null, whatever ?= null) 

это позволяет делать обратные маршруты с только ID, как требуется пары:

// /users/john-doe 
routes.Users.view("john-doe") 

упорядоченного Params:

// /users/john-doe?backTo=prev&forwardTo=next&whatever=bar 
routes.Users.view("john-doe", "prev", "next", "bar") 

или только с именованными параметрами:

// /users/john-doe?whatever=baz 
routes.Users.view("john-doe", whatever = "baz") 

Что более важно, это типобезопасное, как это абсолютно под синтаксисом маршрутизации пьесы, без каких-либо ручных манипуляций. Также вам не нужно заботиться о том, следует ли начинать ваши параметры с ? или & char: "?backTo=home" против "&backTo=home" ...