Wie Sie ein PNG-Bild von der Jersey REST-Service-Methode an den Browser zurückgeben

Baute ich eine Allgemeine Methode für die, die mit folgenden features:

• Rückkehr "not modified", wenn die Datei nicht lokal ändern, den Status.NOT_MODIFIED an den Anrufer. Verwendet Apache Commons Lang
• mit einem Datei-stream-Objekt zu Lesen, anstatt die Datei selbst

Hier der code:

import org.apache.commons.lang3.time.DateUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Utils.class);

@GET
@Path("16x16")
@Produces("image/png")
public Response get16x16PNG(@HeaderParam("If-Modified-Since") String modified) {
    File repositoryFile = new File("c:/temp/myfile.png");
    return returnFile(repositoryFile, modified);
}

/**
 * 
 * Sends the file if modified and "not modified" if not modified
 * future work may put each file with a unique id in a separate folder in tomcat
 *   * use that static URL for each file
 *   * if file is modified, URL of file changes
 *   * -> client always fetches correct file 
 * 
 *     method header for calling method public Response getXY(@HeaderParam("If-Modified-Since") String modified) {
 * 
 * @param file to send
 * @param modified - HeaderField "If-Modified-Since" - may be "null"
 * @return Response to be sent to the client
 */
public static Response returnFile(File file, String modified) {
    if (!file.exists()) {
        return Response.status(Status.NOT_FOUND).build();
    }

    //do we really need to send the file or can send "not modified"?
    if (modified != null) {
        Date modifiedDate = null;

        //we have to switch the locale to ENGLISH as parseDate parses in the default locale
        Locale old = Locale.getDefault();
        Locale.setDefault(Locale.ENGLISH);
        try {
            modifiedDate = DateUtils.parseDate(modified, org.apache.http.impl.cookie.DateUtils.DEFAULT_PATTERNS);
        } catch (ParseException e) {
            logger.error(e.getMessage(), e);
        }
        Locale.setDefault(old);

        if (modifiedDate != null) {
            //modifiedDate does not carry milliseconds, but fileDate does
            //therefore we have to do a range-based comparison
            //1000 milliseconds = 1 second
            if (file.lastModified()-modifiedDate.getTime() < DateUtils.MILLIS_PER_SECOND) {
                return Response.status(Status.NOT_MODIFIED).build();
            }
        }
    }        
    //we really need to send the file

    try {
        Date fileDate = new Date(file.lastModified());
        return Response.ok(new FileInputStream(file)).lastModified(fileDate).build();
    } catch (FileNotFoundException e) {
        return Response.status(Status.NOT_FOUND).build();
    }
}

/*** copied from org.apache.http.impl.cookie.DateUtils, Apache 2.0 License ***/

/**
 * Date format pattern used to parse HTTP date headers in RFC 1123 format.
 */
public static final String PATTERN_RFC1123 = "EEE, dd MMM yyyy HH:mm:ss zzz";

/**
 * Date format pattern used to parse HTTP date headers in RFC 1036 format.
 */
public static final String PATTERN_RFC1036 = "EEEE, dd-MMM-yy HH:mm:ss zzz";

/**
 * Date format pattern used to parse HTTP date headers in ANSI C
 * <code>asctime()</code> format.
 */
public static final String PATTERN_ASCTIME = "EEE MMM d HH:mm:ss yyyy";

public static final String[] DEFAULT_PATTERNS = new String[] {
    PATTERN_RFC1036,
    PATTERN_RFC1123,
    PATTERN_ASCTIME
};

Beachten Sie, dass die Locale-Wechsel scheint nicht thread-safe. Ich denke, es ist besser, Sie wechseln die locale Global. Ich bin nicht sicher über die Nebenwirkungen, aber...

InformationsquelleAutor der Antwort koppor

Wenn Sie eine Reihe von Bild-Ressource-Methoden, es lohnt sich, die Schaffung eines MessageBodyWriter für die Ausgabe der BufferedImage:

@Produces({ "image/png", "image/jpg" })
@Provider
public class BufferedImageBodyWriter implements MessageBodyWriter<BufferedImage>  {
  @Override
  public boolean isWriteable(Class<?> type, Type type1, Annotation[] antns, MediaType mt) {
    return type == BufferedImage.class;
  }

  @Override
  public long getSize(BufferedImage t, Class<?> type, Type type1, Annotation[] antns, MediaType mt) {
    return -1; //not used in JAX-RS 2
  }

  @Override
  public void writeTo(BufferedImage image, Class<?> type, Type type1, Annotation[] antns, MediaType mt, MultivaluedMap<String, Object> mm, OutputStream out) throws IOException, WebApplicationException {
    ImageIO.write(image, mt.getSubtype(), out);
  } 
}

Diese MessageBodyWriter, wird automatisch verwendet, wenn die automatische Erkennung aktiviert ist, für das Trikot, sonst wird es zurückgegeben werden muss, die von einer benutzerdefinierten Anwendung, die sub-Klasse. Sehen JAX-RS Entity-Provider für mehr info.

Sobald dies eingerichtet ist, einfach wieder ein BufferedImage aus einer Ressource-Methode, und es wird die Ausgabe als Bild Datei Daten:

@Path("/whatever")
@Produces({"image/png", "image/jpg"})
public Response getFullImage(...) {
  BufferedImage image = ...;
  return Response.ok(image).build();
}

Ein paar der Vorteile dieses Ansatzes:

• Dann schreibt es in die Antwort OutputSteam eher als Vermittler BufferedOutputStream
• Es unterstützt png und jpg-Ausgabe (je nach Medien-Typen zugelassen, die von der Ressource-Methode)

InformationsquelleAutor der Antwort Justin Emery