¿Dónde colocar y cómo leer los archivos de recursos de configuración en una aplicación basada en servlet?

Es tu elección. Básicamente, existen tres formas en un archivo de aplicación web Java (WAR):

1. Ponlo en classpath

Para que puedas cargarlo ClassLoader#getResourceAsStream()con una ruta relativa a classpath:

ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
InputStream input = classLoader.getResourceAsStream("foo.properties");
// ...
Properties properties = new Properties();
properties.load(input);

Se supone que aquí foo.propertiesdebe colocarse en una de las raíces que están cubiertas por la ruta de clase predeterminada de una aplicación web, por ejemplo, la aplicación web /WEB-INF/liby /WEB-INF/classesel servidor /libo JDK/JRE /lib. Si el archivo de propiedades es específico de la aplicación web, lo mejor es colocarlo en formato /WEB-INF/classes. Si está desarrollando un proyecto WAR estándar en un IDE, colóquelo en srcla carpeta (la carpeta de origen del proyecto). Si está utilizando un proyecto Maven, colóquelo en /main/resourcesla carpeta.

Alternativamente, también puede colocarlo en algún lugar fuera de la ruta de clase predeterminada y agregar su ruta a la ruta de clase del servidor de aplicaciones. Por ejemplo, en Tomcat puedes configurarlo como shared.loaderpropiedad de Tomcat/conf/catalina.properties.

Si lo ha colocado foo.propertiesen una estructura de paquete Java como com.example, entonces debe cargarlo como se muestra a continuación

ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
InputStream input = classLoader.getResourceAsStream("com/example/foo.properties");
// ...

Tenga en cuenta que esta ruta de un cargador de clases de contexto no debe comenzar con un archivo /. Solo cuando estás usando un cargador de clases "relativo" como SomeClass.class.getClassLoader(), entonces necesitas iniciarlo con un archivo /.

ClassLoader classLoader = getClass().getClassLoader();
InputStream input = classLoader.getResourceAsStream("/com/example/foo.properties");
// ...

Sin embargo, la visibilidad del archivo de propiedades depende del cargador de clases en cuestión. Solo es visible para el mismo cargador de clases que cargó la clase. Entonces, si la clase se carga, por ejemplo, mediante el cargador de clases común del servidor en lugar del cargador de clases de la aplicación web, y el archivo de propiedades está dentro de la aplicación web, entonces es invisible. El cargador de clases de contexto es su apuesta más segura, por lo que puede colocar el archivo de propiedades "en cualquier lugar" del classpath y/o desea poder anular uno proporcionado por el servidor desde la aplicación web.

2. Ponlo en contenido web.

Para que puedas cargarlo con ServletContext#getResourceAsStream()una ruta relativa al contenido web:

InputStream input = getServletContext().getResourceAsStream("/WEB-INF/foo.properties");
// ...

Tenga en cuenta que he demostrado cómo colocar el archivo en /WEB-INFuna carpeta; de lo contrario, cualquier navegador web podría acceder a él de forma pública. También tenga en cuenta que ServletContextestá en cualquier HttpServletclase a la que solo pueda acceder el heredado GenericServlet#getServletContext()y Filteren FilterConfig#getServletContext(). En caso de que no esté en una clase de servlet, generalmente solo se puede inyectar a través de @Inject.

3. Ponlo en el sistema de archivos del disco local.

Para que puedas cargarlo de la java.ioforma habitual con una ruta absoluta del sistema de archivos del disco local:

InputStream input = new FileInputStream("/absolute/path/to/foo.properties");
// ...

Tenga en cuenta la importancia de utilizar una ruta absoluta. Las rutas relativas del sistema de archivos del disco local son absolutamente prohibidas en una aplicación web Java EE. Consulte también el primer enlace "Ver también" a continuación.

¿Cuál elegir?

Simplemente sopese las ventajas/desventajas en su propia opinión sobre la mantenibilidad.

Si los archivos de propiedades son "estáticos" y nunca necesitan cambiar durante el tiempo de ejecución, entonces puede mantenerlos en WAR.

Si prefiere poder editar archivos de propiedades desde fuera de la aplicación web sin la necesidad de reconstruir y volver a implementar el WAR cada vez, colóquelo en el classpath fuera del proyecto (si es necesario, agregue el directorio al classpath).

Si prefiere poder editar archivos de propiedades mediante programación desde dentro de la aplicación web utilizando Properties#store()el método, colóquelo fuera de la aplicación web. Como Properties#store()requiere un archivo Writer, no puede utilizar una ruta del sistema de archivos del disco. Esa ruta, a su vez, se puede pasar a la aplicación web como un argumento de VM o propiedad del sistema. Como precaución, nunca utilizargetRealPath() . Todos los cambios en la carpeta de implementación se perderán al volver a implementar por la sencilla razón de que los cambios no se reflejan en el archivo WAR original.

Ver también:

• getResourceAsStream() frente a FileInputStream
• Agregar un directorio al classpath de Tomcat
• Acceder al archivo de propiedades en una aplicación JSF mediante programación

Jan 29 '2010 11:01 BalusC