Configurando propiedades de webforJ
Para desplegar y ejecutar correctamente una aplicación webforJ, se requieren un par de archivos de configuración clave: webforj.conf y web.xml. Cada uno de estos archivos controla diferentes aspectos del comportamiento de la aplicación, desde puntos de entrada y configuraciones de depuración hasta mapeos de servlets.
Configurando webforj.conf
El archivo webforj.conf es un archivo de configuración central en webforJ, que especifica la configuración de la aplicación como puntos de entrada, modo de depuración e interacción cliente-servidor. El archivo está en formato HOCON y debe ubicarse en el directorio resources.
sugerencia
Si estás integrando con Spring, puedes establecer estas propiedades de webforj.conf en el archivo application.properties.
Ejemplo de archivo webforj.conf
# Este archivo de configuración está en formato HOCON:
# https://github.com/lightbend/config/blob/master/HOCON.md
webforj.entry = com.webforj.samples.Application
webforj.debug = true
webforj.reloadOnServerError = on
webforj.clientHeartbeatRate = 1s
Opciones de configuración
| Propiedad | Tipo | Explicación | Predeterminado |
|---|---|---|---|
webforj.assetsCacheControl | String | Cabecera Cache-Control para recursos estáticos. | null |
webforj.assetsDir | String | El nombre de la ruta utilizada para servir archivos estáticos, mientras que el nombre real de la carpeta sigue siendo static. Esta configuración es útil si la ruta predeterminada static entra en conflicto con una ruta definida en tu aplicación, lo que permite cambiar el nombre de la ruta sin renombrar la carpeta misma. | null |
webforj.assetsExt | String | Extensión de archivo predeterminada para archivos estáticos. | null |
webforj.assetsIndex | String | Archivo predeterminado servido para solicitudes de directorio (por ejemplo, index.html). | null |
webforj.clientHeartbeatRate | String | El intervalo en el que el cliente envía una señal al servidor para ver si todavía está vivo. Para el desarrollo, establece esto en un intervalo más corto, por ejemplo, 8s, para detectar rápidamente la disponibilidad del servidor. Establecer en 50 segundos o más en producción para evitar solicitudes excesivas. | 50s |
webforj.components | String | Cuando se especifica, la ruta base determina de dónde se cargan los componentes DWC. Por defecto, los componentes se cargan desde el servidor que hospeda la aplicación. Sin embargo, establecer una ruta base personalizada permite que los componentes se carguen desde un servidor alternativo o CDN. Por ejemplo, para cargar componentes de jsdelivr.com, establece la ruta base en: https://cdn.jsdelivr.net/gh/webforj/dwc-dist@1.0.0-${webforj.version}. Es importante que los componentes cargados sean compatibles con la versión del marco webforJ en uso; de lo contrario, la aplicación puede no funcionar como se espera. Esta configuración se ignora cuando se utiliza una instalación estándar de BBj sin el motor. Para una instalación estándar de BBj, la configuración se puede administrar con el !COMPONENTS STBL. | null |
webforj.debug | Boolean | Habilita el modo de depuración. En el modo de depuración, webforJ imprimirá información adicional en la consola y mostrará todas las excepciones en el navegador. El modo de depuración está deshabilitado por defecto. | null |
webforj.entry | String | Define el punto de entrada de la aplicación especificando el nombre completamente calificado de la clase que extiende webforj.App. Si no se define un punto de entrada, webforJ escaneará automáticamente el classpath en busca de clases que extiendan webforj.App. Si se encuentran múltiples clases, ocurrirá un error. Cuando un paquete incluye más de un punto de entrada potencial, se requiere establecer esto explícitamente para evitar ambigüedades, o alternativamente, se puede utilizar la anotación AppEntry para especificar el punto de entrada en tiempo de ejecución. | null |
webforj.i18n.supported-locales 25.12 | Lista | Lista de locales admitidos como etiquetas de idioma BCP 47 (por ejemplo, "en", "en-US", "fr", "de-DE"). Cuando la detección automática está habilitada, los locales preferidos del navegador se comparan con esta lista. El primer locale en la lista se utiliza como el predeterminado de reserva. Ver Traducción. | [] |
webforj.i18n.auto-detect 25.12 | Boolean | Cuando true, el locale de la aplicación se establece automáticamente en función del idioma preferido del navegador al iniciar. El locale se resuelve comparando los locales preferidos del navegador con la lista de supported-locales. Cuando es false o cuando supported-locales está vacío, la aplicación utiliza webforj.locale. Ver Traducción. | false |
webforj.fileUpload.accept | Lista | Los tipos de archivos permitidos para cargas de archivos. Por defecto, se permiten todos los tipos de archivos. Los formatos admitidos incluyen tipos MIME como image/*, application/pdf, text/plain, o extensiones de archivo como *.txt. Al utilizar una instalación estándar de BBj, esta configuración se ignora y se gestiona a través de fileupload-accept.txt. | [] |
webforj.fileUpload.maxSize | Long | El tamaño máximo de archivo permitido para cargas de archivos, en bytes. Por defecto, no hay límite. Al utilizar una instalación estándar de BBj, esta configuración se ignora y se gestiona a través de fileupload-accept.txt. | null |
webforj.iconsDir | String | Punto final URL para el directorio de íconos (por defecto se sirve desde resources/icons/). | icons/ |
webforj.legacyHtmlInText 26.01 | Boolean | Cuando true, un valor envuelto en <html> renderiza su contenido como HTML. Cuando false, el mismo valor se muestra literalmente. | true |
webforj.license.cfg | String | El directorio para la configuración de la licencia. Por defecto, es el mismo que el directorio de configuración de webforJ, pero esto puede ser personalizado si es necesario. | "." |
webforj.license.startupTimeout | Integer | Tiempo de espera de inicio de la licencia en segundos. | null |
webforj.locale | String | El locale para la aplicación, determinando el idioma, configuraciones regionales y formatos para fechas, horas y números. | null |
webforj.quiet | Boolean | Desactiva la imagen de carga durante el inicio de la aplicación. | false |
webforj.reloadOnServerError | Boolean | Solo entornos de desarrollo. En un entorno de desarrollo, recarga automáticamente la página en errores relacionados con la reimplementación en caliente, pero no otros tipos de errores. Al usar la reimplementación en caliente, si el cliente envía una solicitud al servidor mientras se reinicia, puede ocurrir un error mientras se intercambia el archivo WAR. Debido a que el servidor probablemente estará nuevamente en línea en breve, esta configuración permite que el cliente intente recargar automáticamente la página. | false |
webforj.security.maxContentLength 25.10 | Integer | La solicitud más grande que la aplicación aceptará, en bytes, como medida de protección contra solicitudes de tamaño excesivo destinadas a agotar la memoria del servidor. Establecer en 0 para deshabilitar el límite. | 0 |
webforj.security.maxInitPerMinute 25.10 | Integer | Cuántas nuevas sesiones de aplicación iniciará la aplicación cada minuto, como medida de protección contra la creación rápida de sesiones destinadas a agotar los recursos del servidor. Establecer en 0 para deshabilitar la limitación de tasa. | 0 |
webforj.servlets[n].name | String | Nombre del servlet (usa el nombre de la clase si no está especificado). | null |
webforj.servlets[n].className | String | Nombre de clase completamente calificado del servlet. | null |
webforj.servlets[n].config.<key> | Map<String,String> | Parámetros de inicialización del servlet. | null |
webforj.sessionTimeout | Integer | Duración del tiempo de espera de la sesión en segundos. | 60 |
webforj.stringTable | Map<String,String> | Un mapa de pares clave-valor utilizados para almacenar cadenas para su uso en la aplicación. Útil para almacenar mensajes o etiquetas de la aplicación. Más información sobre StringTable se puede encontrar aquí. | {} |
webforj.mime.extensions | Map<String,String> | Mapeos de tipo MIME personalizados para extensiones de archivo al servir archivos estáticos. Te permite sobrescribir tipos MIME predeterminados o definir tipos MIME para extensiones personalizadas. La clave del mapa es la extensión de archivo (sin el punto), y el valor es el tipo MIME. | {} |
Configurando web.xml
El archivo web.xml es un archivo de configuración esencial para aplicaciones web de Java, y en webforJ, define configuraciones importantes como la configuración del servlet, patrones de URL y páginas de bienvenida. Este archivo debe ubicarse en el directorio WEB-INF de la estructura de despliegue de tu proyecto.
| Configuración | Explicación | Valor Predeterminado |
|---|---|---|
<display-name> | Establece el nombre de visualización para la aplicación web, típicamente derivado del nombre del proyecto. Este nombre aparece en las consolas de administración de servidores de aplicaciones. | ${project.name} |
<servlet> y <servlet-mapping> | Define el WebforjServlet, el servlet principal para manejar solicitudes de webforJ. Este servlet está mapeado a todas las URLs (/*), convirtiéndose en el punto de entrada principal para solicitudes web. | WebforjServlet |
<load-on-startup> | Especifica que WebforjServlet debe ser cargado cuando la aplicación inicia. Establecer esto en 1 hace que el servlet se cargue inmediatamente, lo que mejora el manejo de solicitudes iniciales. | 1 |