web-dev-qa-db-fra.com

Configuration du contrôleur Spring MVC pour envoyer le fichier au client

Je pense que mon scénario est assez courant. J'ai une base de données et je veux mon Spring MVC application pour accepter une demande dans le contrôleur, appeler le service DB pour obtenir des données et envoyer ces données au client sous forme de fichier CSV. J'utilise la bibliothèque JavaCSV trouvée ici pour aider au processus: http://sourceforge.net/projects/javacsv/

J'ai trouvé plusieurs exemples de personnes faisant des choses similaires et bricolé quelque chose qui semble correct. Quand je touche la méthode, cependant, rien ne se passe vraiment.

Je pensais que l'écriture des données dans le outputStream de HttpServletResponse serait suffisante, mais apparemment, il me manque quelque chose.

Voici mon code de contrôleur:

@RequestMapping(value="/getFullData.html", method = RequestMethod.GET)
public void getFullData(HttpSession session, HttpServletRequest request, HttpServletResponse response) throws IOException{
    List<CompositeRequirement> allRecords = compReqServ.getFullDataSet((String)session.getAttribute("currentProject"));

    response.setContentType("data:text/csv;charset=utf-8"); 
    response.setHeader("Content-Disposition","attachment; filename=\yourData.csv\"");
    OutputStream resOs= response.getOutputStream();  
    OutputStream buffOs= new BufferedOutputStream(resOs);   
    OutputStreamWriter outputwriter = new OutputStreamWriter(buffOs);  

    CsvWriter writer = new CsvWriter(outputwriter, '\u0009');  
    for(int i=1;i <allRecords.size();i++){              
        CompositeRequirement aReq=allRecords.get(i);  
        writer.write(aReq.toString());  
    }     
    outputwriter.flush();   
    outputwriter.close();

};

Quelle étape me manque ici? Fondamentalement, l'effet net est ... rien. J'aurais pensé que la définition de l'en-tête et du type de contenu ferait que mon navigateur capte la réponse et déclenche une action de téléchargement de fichier.

javaspringservletsfile-iocsv
24
Raevik

Cela semble être dû au fait que votre type de contenu n'est pas défini correctement, il devrait être response.setContentType("text/csv;charset=utf-8") au lieu de response.setContentType("data:text/csv;charset=utf-8").

De plus, si vous utilisez Spring 3, vous devez probablement utiliser un @ ResponseBodyHttpMessageConverter pour la réutilisation du code. Par exemple:

  • Dans le contrôleur:

    @RequestMapping(value = "/getFullData2.html", method = RequestMethod.GET, consumes = "text/csv")
@ResponseBody // indicate to use a compatible HttpMessageConverter
public CsvResponse getFullData(HttpSession session) throws IOException {
      List<CompositeRequirement> allRecords = compReqServ.getFullDataSet((String) session.getAttribute("currentProject"));
      return new CsvResponse(allRecords, "yourData.csv");
}

  • plus un simple HttpMessageConverter:

    public class CsvMessageConverter extends AbstractHttpMessageConverter<CsvResponse> {
   public static final MediaType MEDIA_TYPE = new MediaType("text", "csv", Charset.forName("utf-8"));
   public CsvMessageConverter() {
       super(MEDIA_TYPE);
   }

   protected boolean supports(Class<?> clazz) {
       return CsvResponse.class.equals(clazz);
   }

   protected void writeInternal(CsvResponse response, HttpOutputMessage output) throws IOException, HttpMessageNotWritableException {
       output.getHeaders().setContentType(MEDIA_TYPE);
       output.getHeaders().set("Content-Disposition", "attachment; filename=\"" + response.getFilename() + "\"");
       OutputStream out = output.getBody();
       CsvWriter writer = new CsvWriter(new OutputStreamWriter(out), '\u0009');
       List<CompositeRequirement> allRecords = response.getRecords();
       for (int i = 1; i < allRecords.size(); i++) {
            CompositeRequirement aReq = allRecords.get(i);
            writer.write(aReq.toString());
       }
       writer.close();
   }
}

  • et un simple objet pour tout lier ensemble:

    public class CsvResponse {    
   private final String filename;
   private final List<CompositeRequirement> records;

   public CsvResponse(List<CompositeRequirement> records, String filename) {
       this.records = records;
       this.filename = filename;
   }
   public String getFilename() {
       return filename;
   }
   public List<CompositeRequirement> getRecords() {
       return records;
   }
}
29
Pierre

Sur la base de la réponse de Pierre, j'ai fait un convertisseur. Voici le code complet, qui fonctionne avec n'importe quel objet passé:

TsvMessageConverter.Java

public class TsvMessageConverter extends AbstractHttpMessageConverter<TsvResponse> {

    public static final MediaType MEDIA_TYPE = new MediaType("text", "tsv", Charset.forName("utf-8"));
    private static final Logger logger = LoggerFactory.getLogger(TsvMessageConverter.class);

    public TsvMessageConverter() {
        super(MEDIA_TYPE);
    }

    protected boolean supports(Class<?> clazz) {
        return TsvResponse.class.equals(clazz);
    }

    @Override
    protected TsvResponse readInternal(Class<? extends TsvResponse> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException {
        return null;
    }

    protected void writeInternal(TsvResponse tsvResponse, HttpOutputMessage output) throws IOException, HttpMessageNotWritableException {
        output.getHeaders().setContentType(MEDIA_TYPE);
        output.getHeaders().set("Content-Disposition", "attachment; filename=\"" + tsvResponse.getFilename() + "\"");
        final OutputStream out = output.getBody();

        writeColumnTitles(tsvResponse, out);

        if (tsvResponse.getRecords() != null && tsvResponse.getRecords().size() != 0) {
            writeRecords(tsvResponse, out);
        }

        out.close();
    }

    private void writeRecords(TsvResponse response, OutputStream out) throws IOException {
        List<String> getters = getObjectGetters(response);
        for (final Object record : response.getRecords()) {
            for (String getter : getters) {
                try {
                    Method method = ReflectionUtils.findMethod(record.getClass(), getter);
                    out.write(method.invoke(record).toString().getBytes(Charset.forName("utf-8")));
                    out.write('\t');
                } catch (IllegalAccessException | InvocationTargetException e) {
                    logger.error("Erro ao transformar em CSV", e);
                }
            }
            out.write('\n');
        }
    }

    private List<String> getObjectGetters(TsvResponse response) {
        List<String> getters = new ArrayList<>();
        for (Method method : ReflectionUtils.getAllDeclaredMethods(response.getRecords().get(0).getClass())) {
            String methodName = method.getName();
            if (methodName.startsWith("get") && !methodName.equals("getClass")) {
                getters.add(methodName);
            }
        }
        sort(getters);
        return getters;
    }

    private void writeColumnTitles(TsvResponse response, OutputStream out) throws IOException {
        for (String columnTitle : response.getColumnTitles()) {
            out.write(columnTitle.getBytes());
            out.write('\t');
        }
        out.write('\n');
    }
}

TsvResponse.Java

public class TsvResponse {
   private final String filename;
   private final List records;
    private final String[] columnTitles;

   public TsvResponse(List records, String filename, String ... columnTitles) {
       this.records = records;
       this.filename = filename;
       this.columnTitles = columnTitles;
   }
   public String getFilename() {
       return filename;
   }
   public List getRecords() {
       return records;
   }

    public String[] getColumnTitles() {
        return columnTitles;
    }
}

Et sur SpringContext.xml, ajoutez ce qui suit:

<mvc:annotation-driven>
        <mvc:message-converters register-defaults="true">
            <bean class="com.mypackage.TsvMessageConverter"/>
        </mvc:message-converters>
    </mvc:annotation-driven>

Ainsi, vous pouvez utiliser sur votre contrôleur comme ceci:

@RequestMapping(value="/tsv", method= RequestMethod.GET, produces = "text/tsv")
    @ResponseBody
    public TsvResponse tsv() {
        return new TsvResponse(myListOfPojos, "fileName.tsv",
                "Name", "Email", "Phone", "Mobile");
    }
7
renanleandrof