Doit-on appeler .close () sur HttpServletResponse.getOutputStream () /. GetWriter ()?

Dans les servlets Java, on peut accéder au corps de la réponse via response.getOutputStream()ou response.getWriter(). Doit-on appeler .close()cela OutputStreamaprès avoir été écrit?

D'une part, il y a l'exhortation blochienne de toujours fermer l' OutputStreamart. D'un autre côté, je ne pense pas que dans ce cas, il y a une ressource sous-jacente qui doit être fermée. L'ouverture / la fermeture des sockets est gérée au niveau HTTP, pour permettre des choses comme les connexions persistantes et autres.

Normalement, vous ne devez pas fermer le flux. Le conteneur de servlet fermera automatiquement le flux une fois le servlet exécuté dans le cadre du cycle de vie de la demande de servlet.

Par exemple, si vous fermiez le flux, il ne serait pas disponible si vous implémentiez un filtre .

Cela dit, si vous le fermez, rien de grave ne se passera tant que vous n'essayez pas de l'utiliser à nouveau.

EDIT: un autre lien de filtre

EDIT2: adrian.tarau est correct en ce sens que si vous voulez modifier la réponse après que le servlet a fait son travail, vous devez créer un wrapper étendant HttpServletResponseWrapper et tamponner la sortie. C'est pour empêcher la sortie d'aller directement au client mais vous permet également de vous protéger si le servlet ferme le flux, comme dans cet extrait (c'est moi qui souligne):

Un filtre qui modifie une réponse doit généralement capturer la réponse avant qu'elle ne soit renvoyée au client. La manière de procéder consiste à transmettre au servlet qui génère la réponse un flux de secours. Le flux de secours empêche le servlet de fermer le flux de réponse d'origine lorsqu'il se termine et permet au filtre de modifier la réponse du servlet.

Article

On peut déduire de cet article officiel de Sun que la fermeture OutputStreamd'un servlet est quelque chose qui est une occurrence normale, mais n'est pas obligatoire.

La règle générale d'entre eux est la suivante: si vous avez ouvert le flux, vous devez le fermer. Sinon, vous ne devriez pas. Assurez-vous que le code est symétrique.

Dans le cas de HttpServletResponse, c'est un peu moins clair, car il n'est pas évident si l'appel getOutputStream()est une opération qui ouvre le flux. Le Javadoc dit simplement que " Returns a ServletOutputStream"; de même pour getWriter(). Dans tous les cas, ce qui est clair, c'est que HttpServletResponse"possède" le flux / l'écrivain, et qu'il (ou le conteneur) est responsable de le refermer.

Donc, pour répondre à votre question - non, vous ne devez pas fermer le flux dans ce cas. Le conteneur doit le faire, et si vous y entrez avant, vous risquez d'introduire de subtils bogues dans votre application.

S'il y a une chance que le filtre soit appelé sur une ressource «incluse», vous ne devriez certainement pas fermer le flux. Cela entraînera l'échec de la ressource d'inclusion avec une exception «flux fermé».

Vous devez fermer le flux, le code est plus propre puisque vous appelez getOutputStream () et le flux ne vous est pas passé en tant que paramètre, alors que vous l'utilisez généralement et n'essayez pas de le fermer. L'API Servlet n'indique pas que si le flux de sortie peut être fermé ou ne doit pas être fermé, dans ce cas, vous pouvez fermer le flux en toute sécurité, tout conteneur là-bas s'occupe de fermer le flux s'il n'a pas été fermé par le servlet.

Voici la méthode close () dans Jetty, ils ferment le flux s'il n'est pas fermé.

public void close() throws IOException
    {
        if (_closed)
            return;

        if (!isIncluding() && !_generator.isCommitted())
            commitResponse(HttpGenerator.LAST);
        else
            flushResponse();

        super.close();
    }

De même, en tant que développeur d'un filtre, vous ne devez pas présumer que OutputStream n'est pas fermé, vous devez toujours transmettre un autre OutputStream si vous souhaitez modifier le contenu une fois que le servlet a fait son travail.

EDIT: Je ferme toujours le flux et je n'ai eu aucun problème avec Tomcat / Jetty. Je ne pense pas que vous devriez avoir des problèmes avec un conteneur, ancien ou nouveau.

Un autre argument contre la fermeture du OutputStream. Regardez ce servlet. Cela lève une exception. L'exception est mappée dans le fichier web.xml à une erreur JSP:

package ser;

import java.io.*;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.*;

@WebServlet(name = "Erroneous", urlPatterns = {"/Erroneous"})
public class Erroneous extends HttpServlet {

  protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    resp.setContentType("text/html;charset=UTF-8");
    PrintWriter out = resp.getWriter();
    try {
      throw new IOException("An error");
    } finally {
//      out.close();
    }
  }
}

Le fichier web.xml contient:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
    <session-config>
        <session-timeout>
            30
        </session-timeout>
    </session-config>
    <error-page>
        <exception-type>java.io.IOException</exception-type>
        <location>/error.jsp</location>
    </error-page>
</web-app>

Et l'erreur.jsp:

<%@page contentType="text/html" pageEncoding="UTF-8" isErrorPage="true"%>
<!DOCTYPE html>
<html>
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title>Error Page</title>
    </head>
    <body>
        <h1><%= exception.getMessage()%></h1>
    </body>
</html>

Lorsque vous chargez /Erroneousdans le navigateur, vous voyez la page d'erreur affichant "Une erreur". Mais si vous annulez le commentaire de la out.close()ligne dans le servlet ci-dessus, redéployez l'application et rechargez, /Erroneousvous ne verrez rien dans le navigateur. Je n'ai aucune idée de ce qui se passe réellement, mais je suppose que cela out.close()empêche la gestion des erreurs.

Testé avec Tomcat 7.0.50, Java EE 6 avec Netbeans 7.4.