Stiamo pianificando un progetto che serve principalmente contenuti alle app mobili, ma abbiamo bisogno di un sito web.
La mia domanda è se abbia senso utilizzare Jersey o Restlet per sviluppare API REST per le nostre app mobili e quindi utilizzare Play! per servire il sito web.
O ha più senso usare solo Play! fare tutto? In tal caso, come eseguire REST con Play! struttura?
Risposte:
Come da richiesta, un semplice approccio simile a REST. Funziona quasi allo stesso modo della soluzione di Codemwncis, ma utilizza l'intestazione Accept per la negoziazione del contenuto. Prima il file delle rotte:
GET /user/{id} Application.user
POST /user/ Application.createUser
PUT /user/{id} Application.updateUser
DELETE /user/{id} Application.deleteUserNon specifichi alcun tipo di contenuto qui. In questo modo IMHO è necessario solo quando si desidera avere URI "speciali" per determinate risorse. Come dichiarare una rotta per /users/feed/tornare sempre in Atom / RSS.
Il controller dell'applicazione ha questo aspetto:
public static void createUser(User newUser) {
newUser.save();
user(newUser.id);
}
public static void updateUser(Long id, User user) {
User dbUser = User.findById(id);
dbUser.updateDetails(user); // some model logic you would write to do a safe merge
dbUser.save();
user(id);
}
public static void deleteUser(Long id) {
User.findById(id).delete();
renderText("success");
}
public static void user(Long id) {
User user = User.findById(id)
render(user);
}Come puoi vedere, ho rimosso solo il metodo getUserJSON e rinominato il metodo getUser. Affinché diversi tipi di contenuto funzionino, ora è necessario creare diversi modelli. Uno per ogni tipo di contenuto desiderato. Per esempio:
user.xml:
<users>
<user>
<name>${user.name}</name>
. . .
</user>
</users>user.json:
{
"name": "${user.name}",
"id": "${user.id}",
. . .
}user.html:
<html>...</html>Questo approccio offre ai browser sempre la visualizzazione HTML, poiché tutti i browser inviano un tipo di contenuto testo / html nell'intestazione Accept. Tutti gli altri client (possibilmente alcune richieste AJAX basate su JavaScript) possono definire il proprio tipo di contenuto desiderato. Usando il metodo jQuerys ajax () puoi fare quanto segue:
$.ajax({
url: @{Application.user(1)},
dataType: json,
success: function(data) {
. . .
}
});Che dovrebbe fornirti i dettagli sull'utente con ID 1 in formato JSON. Play attualmente supporta HTML, JSON e XML in modo nativo, ma puoi facilmente utilizzare un tipo diverso seguendo la documentazione ufficiale o utilizzando il modulo di negoziazione del contenuto .
Se stai usando Eclipse per lo sviluppo ti suggerisco di usare il plugin client REST che ti permette di testare i tuoi percorsi e il loro tipo di contenuto corrispondente.
Questa è ancora una domanda popolare, ma le risposte con il voto più alto non sono aggiornate con la versione corrente del gioco. Ecco un esempio REST funzionante con play 2.2.1:
conf / percorsi:
GET /users controllers.UserController.getUsers
GET /users/:id controllers.UserController.getUser(id: Long)
POST /users controllers.UserController.createUser
PUT /users/:id controllers.UserController.updateUser(id: Long)
DELETE /users/:id controllers.UserController.deleteUser(id: Long)app / controllers / UserController.java:
public static Result getUsers()
{
List<User> users = Database.getUsers();
return ok(Json.toJson(users));
}
public static Result getUser(Long id)
{
User user = Database.getUser(id);
return user == null ? notFound() : ok(Json.toJson(user));
}
public static Result createUser()
{
User newUser = Json.fromJson(request().body().asJson(), User.class);
User inserted = Database.addUser(newUser);
return created(Json.toJson(inserted));
}
public static Result updateUser(Long id)
{
User user = Json.fromJson(request().body().asJson(), User.class);
User updated = Database.updateUser(id, user);
return ok(Json.toJson(updated));
}
public static Result deleteUser(Long id)
{
Database.deleteUser(id);
return noContent(); // http://stackoverflow.com/a/2342589/1415732
}Usa Play! per fare tutto. Scrivere servizi REST in Play è molto semplice.
In primo luogo, il file delle rotte rende semplice scrivere rotte conformi all'approccio REST.
Quindi, scrivi le tue azioni, nel controller, per ogni metodo API che desideri creare.
A seconda di come desideri restituire il risultato (XML, JSON ecc.), Ci sono alcuni metodi che puoi usare. Ad esempio, l'utilizzo del metodo renderJSON consente di visualizzare i risultati molto facilmente. Se vuoi rendere XML, puoi farlo nello stesso modo in cui creeresti un documento HTML nella tua vista.
Ecco un chiaro esempio.
file delle rotte
GET /user/{id} Application.getUser(format:'xml')
GET /user/{id}/json Application.getUserJSON
POST /user/ Application.createUser
PUT /user/{id} Application.updateUser
DELETE /user/{id} Application.deleteUserFile dell'applicazione
public static void createUser(User newUser) {
newUser.save();
renderText("success");
}
public static void updateUser(Long id, User user) {
User dbUser = User.findById(id);
dbUser.updateDetails(user); // some model logic you would write to do a safe merge
dbUser.save();
renderText("success");
}
public static void deleteUser(Long id) {
// first check authority
User.findById(id).delete();
renderText("success");
}
public static void getUser(Long id) {
User user = User.findById(id)
renderJSON(user);
}
public static void getUserJSON(Long id) {
User user = User.findById(id)
renderJSON(user);
}getUser.xml file
<user>
<name>${user.name}</name>
<dob>${user.dob}</dob>
.... etc etc
</user>L'integrazione con un'implementazione JAX-RS è un possibile approccio alternativo all'utilizzo del routing HTTP integrato di Play. Per un esempio RESTEasy, vedere RESTEasy Play! modulo .
Questo approccio ha senso se hai già investito in JAX-RS o se hai bisogno di alcune delle funzionalità avanzate REST fornite da JAX-RS come la negoziazione dei contenuti. In caso contrario, sarebbe più semplice utilizzare Play direttamente per servire JSON o XML in risposta alle richieste HTTP.
dovresti dare un'occhiata
http://www.lunatech-labs.com/open-source/resteasy-crud-play-module
è un modulo per il gioco che costruisce automaticamente un'interfaccia di riposo, proprio come il modulo crud costruisce automaticamente un'area di amministrazione ...
Sembra che questo approccio non sia funzionante nella versione Play 1.2.3. Se scarichi il codice sorgente fatto da @seb e menzionato in precedenza https://github.com/sebhoss/play-user-sample , la creazione di un nuovo oggetto utente utilizzando POST con un oggetto JSON non è più possibile.
È necessario disporre di metodi specifici per la creazione eseguiti utilizzando POST json e xml. Delineato qui: https://groups.google.com/forum/#!topic/play-framework/huwtC3YZDlU