File Upload
Un FileUploadDialog es un diálogo modal diseñado para permitir al usuario cargar archivos desde su sistema de archivos local. El diálogo bloquea la ejecución de la aplicación hasta que el usuario seleccione archivos para cargar o cierre el diálogo.
Si quieres un selector de archivos que se renderice directamente en el diseño de la página en lugar de un diálogo, considera utilizar el componente Upload.
Usos
El FileUploadDialog proporciona una manera de seleccionar y cargar archivos, permitiendo a los usuarios enviar documentos, imágenes u otros tipos de archivos requeridos por la aplicación. Usa showFileUploadDialog() para mostrar el diálogo y capturar el archivo cargado.
UploadedFile result = OptionDialog.showFileUploadDialog("Cargar un archivo");
Resultado
El FileUploadDialog devuelve un objeto UploadedFile que contiene información sobre el archivo cargado, como su nombre, tamaño y contenido. Si el usuario cierra el diálogo sin seleccionar un archivo, el resultado será null.
La cadena resultante será devuelta desde el método show(), o el método equivalente de OptionDialog como se muestra a continuación.
Mostrar Código
- FileUploadDialogBasicView.java
Moviendo archivos cargados
Por defecto, webforJ almacena los archivos cargados en una carpeta temporal que se limpia regularmente. Si no mueves el archivo a otro lugar, se eliminará. Para mover el archivo, usa el método move y especifica la ruta de destino.
UploadedFile uploadedFile = OptionDialog.showFileUploadDialog("Selecciona un archivo para cargar");
try {
File file = uploadedFile.move("my/full/path/" + uploadedFile.getSanitizedClientName());
// ... haz algo con el archivo
} catch (IOException e) {
// manejar la excepción
}
Utiliza el método getSanitizedClientName para obtener una versión sanitizada del nombre del archivo cargado. Este método ayuda a prevenir riesgos de seguridad como ataques de recorrido de directorios o caracteres no válidos en los nombres de archivo, asegurando la integridad y seguridad de tu sistema de almacenamiento de archivos.
Filtros
El FileUploadDialog te permite establecer filtros para limitar los tipos de archivos que se pueden seleccionar para cargar. Puedes configurar filtros utilizando el método setFilters(List<FileChooserFilter> filters).
FileUploadDialog dialog = new FileUploadDialog(
"Cargar un archivo",
Arrays.asList(new FileChooserFilter("Archivos de texto", "*.txt")));
UploadedFile result = dialog.show();
El servidor no validará el archivo cargado contra los filtros. Los filtros solo se aplican en la interfaz de usuario para guiar la selección del usuario. Debes implementar la validación del lado del servidor para asegurarte de que los archivos cargados cumplen con los requisitos de tu aplicación.
Tamaño máximo
Es posible establecer el tamaño máximo de archivo para cargadas para asegurarte de que los usuarios no carguen archivos que sean demasiado grandes para que tu aplicación los maneje. Esto se puede configurar utilizando el método setMaxFileSize(long maxSize), donde maxSize se especifica en bytes.
dialog.setMaxFileSize(2 * 1024 * 1024); // Establecer tamaño máximo a 2 MB
Internacionalización (i18n)
Los títulos, descripciones, etiquetas y mensajes dentro del componente son completamente personalizables utilizando la clase FileUploadI18n. Esta flexibilidad te permite adaptar la interfaz del diálogo para cumplir con requisitos de localización específicos o preferencias de personalización.
FileUploadDialog dialog = new FileUploadDialog("Cargar archivo");
FileUploadI18n i18n = new FileUploadI18n();
i18n.setUpload("Cargar");
i18n.setCancel("Cancelar");
dialog.setI18n(i18n);
UploadedFile result = dialog.show();
Mejores prácticas
- Indicaciones claras y concisas: Asegúrate de que el mensaje de indicación explique claramente qué se le pide al usuario que cargue.
- Filtros apropiados: Establece filtros de archivos que coincidan con los tipos de archivos requeridos para garantizar que los usuarios carguen archivos relevantes.
- Rutas iniciales lógicas: Establece rutas iniciales que brinden a los usuarios un punto de partida útil para su selección de archivos.
- Restringir la navegación por directorios: Restringe el diálogo a un directorio específico cuando sea necesario para evitar que los usuarios naveguen a áreas no autorizadas.
- Tematización consistente: Alinea los temas del diálogo y del campo de carga con el diseño de tu aplicación para una experiencia de usuario cohesiva.
- Minimizar el uso excesivo: Utiliza los diálogos de carga de archivos con moderación para evitar frustración en los usuarios. Resérvalos para acciones que requieran cargas de archivos específicas por parte del usuario.