Different ways of loading a file as an InputStream

by

There are subtle differences as to how the fileName you are passing is interpreted. Basically, you have 2 different methods: ClassLoader.getResourceAsStream() and Class.getResourceAsStream(). These two methods will locate the resource differently.

In Class.getResourceAsStream(path), the path is interpreted as a path local to the package of the class you are calling it from. For example calling, String.class.getResourceAsStream("myfile.txt") will look for a file in your classpath at the following location: "java/lang/myfile.txt". If your path starts with a /, then it will be considered an absolute path, and will start searching from the root of the classpath. So calling String.class.getResourceAsStream("/myfile.txt") will look at the following location in your class path ./myfile.txt.

ClassLoader.getResourceAsStream(path) will consider all paths to be absolute paths. So calling String.class.getClassLoader().getResourceAsStream("myfile.txt") and String.class.getClassLoader().getResourceAsStream("/myfile.txt") will both look for a file in your classpath at the following location: ./myfile.txt.

Everytime I mention a location in this post, it could be a location in your filesystem itself, or inside the corresponding jar file, depending on the Class and/or ClassLoader you are loading the resource from.

In your case, you are loading the class from an Application Server, so your should use Thread.currentThread().getContextClassLoader().getResourceAsStream(fileName) instead of this.getClass().getClassLoader().getResourceAsStream(fileName). this.getClass().getResourceAsStream() will also work.

Read this article for more detailed information about that particular problem.

Warning for users of Tomcat 7 and below

One of the answers to this question states that my explanation seems to be incorrect for Tomcat 7. I’ve tried to look around to see why that would be the case.

So I’ve looked at the source code of Tomcat’s WebAppClassLoader for several versions of Tomcat. The implementation of findResource(String name) (which is utimately responsible for producing the URL to the requested resource) is virtually identical in Tomcat 6 and Tomcat 7, but is different in Tomcat 8.

In versions 6 and 7, the implementation does not attempt to normalize the resource name. This means that in these versions, classLoader.getResourceAsStream("/resource.txt") may not produce the same result as classLoader.getResourceAsStream("resource.txt") event though it should (since that what the Javadoc specifies). [source code]

In version 8 though, the resource name is normalized to guarantee that the absolute version of the resource name is the one that is used. Therefore, in Tomcat 8, the two calls described above should always return the same result. [source code]

As a result, you have to be extra careful when using ClassLoader.getResourceAsStream() or Class.getResourceAsStream() on Tomcat versions earlier than 8. And you must also keep in mind that class.getResourceAsStream("/resource.txt") actually calls classLoader.getResourceAsStream("resource.txt") (the leading / is stripped).

More Related Contents:

  1. How do I read / convert an InputStream into a String in Java?
  2. How can an app use files inside the JAR for read and write?
  3. Is it possible to read from a InputStream with a timeout?
  4. How to convert OutputStream to InputStream?
  5. Printing a Java InputStream from a Process
  6. getResourceAsStream() is always returning null [duplicate]
  7. byte[] to file in Java
  8. Reading InputStream as UTF-8
  9. How to read all of Inputstream in Server Socket JAVA
  10. Getting the inputstream from a classpath resource (XML file)
  11. Can you explain the HttpURLConnection connection process?
  12. How to use multiple Scanner objects on System.in?
  13. How to identify end of InputStream in java
  14. Why does InputStream#read() return an int and not a byte?
  15. What does InputStream.available() do in Java?
  16. What is the difference between Reader and InputStream?
  17. Java – How Can I Write My ArrayList to a file, and Read (load) that file to the original ArrayList?
  18. Convert BufferedInputStream into image [duplicate]
  19. Java Creating a new ObjectInputStream Blocks
  20. how to write content in a Specific position in a File
  21. Reading streams from java Runtime.exec
  22. Why is using BufferedInputStream to read a file byte by byte faster than using FileInputStream?
  23. Unable to read InputStream from Java Process (Runtime.getRuntime().exec() or ProcessBuilder)
  24. What is InputStream & Output Stream? Why and when do we use them?
  25. InputStream from a URL
  26. Most efficient way to create InputStream from OutputStream
  27. How to use multiple Scanner objects on System.in in Java?
  28. ClassLoader getResourceAsStream returns null
  29. Closing inputstreams in Java
  30. What’s the fastest way to read from System.in in Java?

Leave a Comment