Java Web 应用中，资源文件的位置和加载方式

资源文件位置

• 在项目结构中的位置（以Maven项目为例）
  • 通常，资源文件（如属性文件、配置文件、本地化资源文件等）放置在src/main/resources目录下。这个目录是Maven项目的默认资源目录，在构建项目时，Maven会将该目录下的所有文件复制到target/classes目录，而这个target/classes目录就是Java Web应用的类路径（classpath）的一部分。
  • 例如，你有一个名为application.properties的配置文件，放在src/main/resources目录下，在打包成WAR文件或者运行Web应用时，它会被正确地放置在类路径中，方便应用程序加载。
• 在WAR文件中的位置
  • 当项目打包成WAR文件后，src/main/resources目录下的资源文件会被放置在WEB - INF/classes目录下。WEB - INF是一个特殊的目录，它包含了Web应用的配置和资源信息，对客户端是不可直接访问的。这种放置方式保证了资源文件的安全性，防止外部直接访问这些敏感的文件。
  • 例如，在一个基于Spring Boot的Java Web应用中，其自动配置的属性文件（如application.properties）在打包后的WAR文件中就位于WEB - INF/classes目录下，Spring Boot在启动时可以从这个位置加载配置信息。

资源文件加载方式

• 使用ClassLoader加载
  • 基本原理：在Java中，类加载器（ClassLoader）负责加载类和资源。可以使用ClassLoader.getSystemResourceAsStream()或ClassLoader.getResourceAsStream()方法来加载资源文件。这两个方法的主要区别在于ClassLoader.getSystemResourceAsStream()是从系统类加载器（System ClassLoader）中查找资源，而ClassLoader.getResourceAsStream()是从加载当前类的类加载器中查找资源。
  • 示例代码：假设你有一个名为config.properties的配置文件，放在src/main/resources目录下，以下是使用类加载器加载的代码：

    import java.io.IOException;
    import java.io.InputStream;
    import java.util.Properties;
    public class ResourceLoaderExample {
             
      public static void main(String[] args) {
             
          // 使用当前类的类加载器
          InputStream inputStream = ResourceLoaderExample.class.getClassLoader().getResourceAsStream("config.properties");
          if (inputStream!= null) {
             
              Properties properties = new Properties();
              try {
             
                  properties.load(inputStream);
                  // 获取配置文件中的属性值
                  String propertyValue = properties.getProperty("key");
                  System.out.println(propertyValue);
              } catch (IOException e) {
             
                  e.printStackTrace();
              }
          }
      }
    }
    

• 使用ServletContext加载（在Web应用环境下）
  • 基本原理：在Java Web应用中，ServletContext代表了整个Web应用的上下文环境。它提供了访问Web应用资源的方法，其中getResourceAsStream()方法可以用于加载资源文件。这种方式特别适用于在Servlet或者JSP中加载资源。
  • 示例代码：假设你在一个Servlet中需要加载一个名为web - config.properties的文件，放在WEB - INF/classes目录下，以下是代码示例：

    import javax.servlet.ServletContext;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    import java.io.InputStream;
    import java.util.Properties;
    public class MyServlet extends HttpServlet {
             
      @Override
      protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
             
          ServletContext servletContext = getServletContext();
          InputStream inputStream = servletContext.getResourceAsStream("/WEB - INF/classes/web - config.properties");
          if (inputStream!= null) {
             
              Properties properties = new Properties();
              try {
             
                  properties.load(inputStream);
                  // 获取配置文件中的属性值并进行处理
                  String propertyValue = properties.getProperty("web - key");
                  System.out.println(propertyValue);
              } catch (IOException e) {
             
                  e.printStackTrace();
              }
          }
      }
    }
    

• 使用Spring框架加载（如果项目使用Spring）
  • 基本原理：在Spring框架中，资源加载是一个核心功能。Spring提供了ResourceLoader接口和Resource接口来方便地加载各种资源。可以通过实现ResourceLoaderAware接口或者使用ApplicationContext来获取资源。
  • 示例代码：假设你有一个Spring Boot应用，需要加载一个名为spring - config.properties的配置文件，以下是一种加载方式：

    import org.springframework.context.ResourceLoaderAware;
    import org.springframework.core.io.Resource;
    import org.springframework.core.io.ResourceLoader;
    import org.springframework.stereotype.Component;
    import java.io.IOException;
    import java.util.Properties;
    @Component
    public class SpringResourceLoaderExample implements ResourceLoaderAware {
             
      private ResourceLoader resourceLoader;
      @Override
      public void setResourceLoader(ResourceLoader resourceLoader) {
             
          this.resourceLoader = resourceLoader;
      }
      public void loadResource() {
             
          Resource resource = resourceLoader.getResource("classpath:spring - config.properties");
          try {
             
              Properties properties = new Properties();
              properties.load(resource.getInputStream());
              // 获取配置文件中的属性值并进行处理
              String propertyValue = properties.getProperty("spring - key");
              System.out.println(propertyValue);
          } catch (IOException e) {
             
              e.printStackTrace();
          }
      }
    }
    

  • 这里的classpath:spring - config.properties表示从类路径下加载资源文件。Spring还支持其他多种资源路径格式，如file:（从文件系统加载）等。