Come si progetta un Generatore di risposte generico/Servizio Web RESTful utilizzando Spring MVC?

Question

Provare a creare un servizio Web RESTful utilizzando Spring MVC.

Il controller deve restituire tipi specifici di Java, ma il corpo della risposta deve essere una busta generica. Come si può fare?

le seguenti sezioni di codice sono ciò che ho finora: metodo

Controller:

@Controller 
    @RequestMapping(value = "/mycontroller") 
    public class MyController { 

     public ServiceDetails getServiceDetails() { 
      return new ServiceDetails("MyService"); 
     } 
    } 

busta di risposta:

public class Response<T> { 

     private String message; 
     private T responseBody; 

    } 

ServiceDetails codice:

public class ServiceDetails { 

     private String serviceName; 

     public ServiceDetails(String serviceName) { 
      this.serviceName = serviceName; 
     } 
    } 

Destinato risposta finale ai clienti dovrebbe apparire come:

{ 

    "message" : "Operation OK" 
    "responseBody" : { 
         "serviceName" : "MyService" 
         } 

    } 

Answer 1

Che cosa si può fare è avere un MyRestController solo avvolgendo il risultato in una Response come questo:

@Controller 
@RequestMapping(value = "/mycontroller") 
public class MyRestController { 

    @Autowired 
    private MyController myController; 

    @RequestMapping(value = "/details") 
    public @ResponseBody Response<ServiceDetails> getServiceDetails() { 
     return new Response(myController.getServiceDetails(),"Operation OK"); 
    } 
} 

Questa soluzione a mantenere il vostro MyController indipendente originale il tuo codice REST. Sembra è necessario includere Jackson nel classpath in modo che la primavera si auto-magicamente serializzare JSON (vedi this per i dettagli)

EDIT

Sembra avete bisogno di qualcosa di più generico ... ecco un consiglio.

@Controller 
@RequestMapping(value = "/mycontroller") 
public class MyGenericRestController { 

    @Autowired 
    private MyController myController; 

    //this will match all "/myController/*" 
    @RequestMapping(value = "/{operation}") 
    public @ResponseBody Response getGenericOperation(String @PathVariable operation) { 
      Method operationToInvoke = findMethodWithRequestMapping(operation); 
      Object responseBody = null; 
      try{ 
       responseBody = operationToInvoke.invoke(myController); 
      }catch(Exception e){ 
       e.printStackTrace(); 
       return new Response(null,"operation failed"); 
      } 
     return new Response(responseBody ,"Operation OK"); 
    } 

    private Method findMethodWithRequestMapping(String operation){ 
     //TODO 
     //This method will use reflection to find a method annotated 
     //@RequestMapping(value=<operation>) 
     //in myController 
     return ... 
    } 
} 

E mantenere il vostro "myController" originale quasi come lo era:

@Controller 
public class MyController { 

    //this method is not expected to be called directly by spring MVC 
    @RequestMapping(value = "/details") 
    public ServiceDetails getServiceDetails() { 
     return new ServiceDetails("MyService"); 
    } 
} 

grosso problema con questo: il @RequestMapping in MyController bisogno probabilmente per essere sostituito da un po 'di annotazione personalizzati (e adattarsi a findMethodWithRequestMapping eseguire l'introspezione su questa annotazione personalizzata).

Answer 2

Per impostazione predefinita, Spring MVC utilizza org.springframework.http.converter.json.MappingJacksonHttpMessageConverter per serializzare/deserializzare JSON tramite Jackson.

io non sono sicuro se è una grande idea, ma un modo per risolvere il tuo problema è quello di estendere questa classe, e sovrascrivere il metodo writeInternal:

public class CustomMappingJacksonHttpMessageConverter extends MappingJacksonHttpMessageConverter { 

    @Override 
    protected void writeInternal(Object object, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException { 
     super.writeInternal(new Response(object, "Operation OK"), outputMessage); 
    } 
} 

Se si sta utilizzando la configurazione XML, è potrebbe abilitare il convertitore personalizzato in questo modo:

<mvc:annotation-driven> 
    <mvc:message-converters> 
     <bean class="path.to.CustomMappingJacksonHttpMessageConverter"> 
    </mvc:message-converters> 
</mvc:annotation-driven>