TOC

JAX-RS @QueryParam-Beispiel

In JAX-RS können Sie die @ @ QueryParam-Annotation verwenden, um URI-Abfrageparameter in die Java-Methode einzufügen. zum Beispiel,

…​./users/query?url=mkyong.com 

Im obigen URI-Muster lautet der Abfrageparameter "**  url = mkyong.com ** " und der URL-Wert kann mit @QueryParam ("url") `abgerufen werden.

===  1. @QueryParam-Beispiel

Ein vollständiges Beispiel für die Verwendung von @ QueryParam in JAX-RS.

import java.util.List; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.QueryParam; import javax.ws.rs.core.Response;

@Path("/users") public class UserService { 

@GET
@Path("/query")
public Response getUsers(
    @QueryParam("from") int from,
    @QueryParam("to") int to,
    @QueryParam("orderBy") List<String> orderBy) {
return Response
   .status(200)
   .entity("getUsers is called, from : " + from + ", to : " + to
    + ", orderBy" + orderBy.toString()).build();
}

} 

URI-Muster: "**  Benutzer/Abfrage" von = 100

getUsers is called, from : 100, to : 200, orderBy[age, name]…​.

2. Programmatischer Abfrageparameter

Alternativ können Sie die Abfrageparameter auch grammatisch über "@Context UriInfo" abrufen. Siehe gleichwertige Version unten: 

import java.util.List;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;

@Path("/users")
public class UserService {

    @GET
    @Path("/query")
    public Response getUsers(@Context UriInfo info) {

        String from = info.getQueryParameters().getFirst("from");
        String to = info.getQueryParameters().getFirst("to");
        List<String> orderBy = info.getQueryParameters().get("orderBy");

        return Response
           .status(200)
           .entity("getUsers is called, from : " + from + ", to : " + to
            + ", orderBy" + orderBy.toString()).build();

    }

}

URI-Muster: "** Benutzer/Abfrage" von = 100 

getUsers is called, from : 100, to : 200, orderBy[age, name]....

===  3. @DefaultValue-Beispiel

`@ DefaultValue` eignet sich für optionale Parameter.

import java.util.List; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.QueryParam; import javax.ws.rs.core.Response;

@Path("/users") public class UserService { 

@GET
@Path("/query")
public Response getUsers(
    @DefaultValue("1000") @QueryParam("from") int from,
    @DefaultValue("999")@QueryParam("to") int to,
    @DefaultValue("name") @QueryParam("orderBy") List<String> orderBy) {
return Response
   .status(200)
   .entity("getUsers is called, from : " + from + ", to : " + to
    + ", orderBy" + orderBy.toString()).build();
}

} 

URI-Muster: "**  Benutzer/Abfrage ** "

getUsers is called, from : 1000, to : 999, orderBy[name]…​.

Quellcode herunterladen

Laden Sie den Link herunter://wp-content/uploads/2011/07/JAX-RS-QueryParam-Example.zip[JAX-RS-QueryParam-Example.zip](6 KB)

Referenzen

  1. http://jsr311.java.net/nonav/releases/1.1/index.html?javax/ws/rs/QueryParam.html [JAX-RS

@QueryParam JavaDoc]. http://jsr311.java.net/nonav/releases/1.1/javax/ws/rs/core/Context.html [JAX-RS

@Context JavaDoc]. http://jsr311.java.net/nonav/releases/1.1/javax/ws/rs/core/UriInfo.html [JAX-RS

UriInfo JavaDoc]. http://jsr311.java.net/nonav/releases/1.1/javax/ws/rs/DefaultValue.html [JAX-RS

@DefaultValue JavaDoc +]

jax-rs parameter resteasy

Related