Для чего используется WEB-INF в веб-приложении Java EE?

Question

Для чего используется WEB-INF в веб-приложении Java EE?

Я работаю над веб-приложением Java EE со следующей структурой исходного кода:

src/main/java                 <-- multiple packages containing java classes
src/test/java                 <-- multiple packages containing JUnit tests
src/main/resources            <-- includes properties files for textual messages
src/main/webapp/resources     <-- includes CSS, images and all Javascript files
src/main/webapp/WEB-INF
src/main/webapp/WEB-INF/tags
src/main/webapp/WEB-INF/views

Я заинтересован в том, чтобы WEB-INF - это содержит web.xmlXML-файлы для настройки сервлетов, контексты проводки Spring bean, теги и представления JSP.

Название вопроса является основным, но я пытаюсь понять, что ограничивает / определяет эту структуру. Например, файлы JSP всегда должны быть в пределах WEB-INF или они могут быть где-то еще? И есть ли что-нибудь еще, что может войти в WEB-INF? Википедия упоминает запись в WAR-файлах classes для классов Java и lib для файлов JAR - не уверен, что я полностью понял, когда они понадобятся в дополнение к другим расположениям исходных файлов.

215

servlets java-ee war web-inf

Источник

user1063716 05 ноя '13 в 09:57

5 ответов

Решение

При развертывании веб-приложения Java EE (с использованием каркасов или без него) его структура должна соответствовать некоторым требованиям / спецификациям. Эти спецификации происходят из:

Контейнер сервлетов (например, Tomcat)
API сервлетов Java
Ваш домен приложения

Требования к сервлету
Если вы используете Apache Tomcat, корневой каталог вашего приложения должен быть помещен в папку web app. Это может отличаться, если вы используете другой контейнер сервлетов или сервер приложений.

Требования к сервлету Java
Java Servlet API утверждает, что ваш корневой каталог приложений должен иметь следующую структуру:

ApplicationName
|
|--META-INF
|--WEB-INF
      |_web.xml       <-- Here is the configuration file of your web app(where you define servlets, filters, listeners...)
      |_classes       <--Here goes all the classes of your webapp, following the package structure you defined. Only 
      |_lib           <--Here goes all the libraries (jars) your application need

Эти требования определены Java Servlet API.

3. Домен вашего приложения
Теперь, когда вы выполнили требования контейнера Servlet (или сервера приложений) и требования API Java Servlet, вы можете организовать другие части вашего веб-приложения на основе того, что вам нужно.
- Вы можете поместить свои ресурсы (файлы JSP, текстовые файлы, файлы сценариев) в корневой каталог приложения. Но тогда люди могут получить к ним доступ прямо из браузера, вместо того чтобы обрабатывать их запросы с помощью некоторой логики, предоставляемой вашим приложением. Таким образом, чтобы предотвратить прямой доступ к вашим ресурсам, вы можете поместить их в каталог WEB-INF, содержимое которого доступно только для сервера.
-Если вы используете некоторые фреймворки, они часто используют файлы конфигурации. Большинство этих фреймворков (Struts, Spring, Hibernate) требуют, чтобы вы поместили их файлы конфигурации в classpath (каталог "classes").

67

Источник

user1871404 05 ноя '13 в 10:40

Вы должны поместить в WEB-INF любые страницы или фрагменты страниц, которые вы не хотите публиковать. Обычно JSP или лицевые стороны находятся вне WEB-INF, но в этом случае они легко доступны для любого пользователя. Если у вас есть какие-либо ограничения авторизации, для этого можно использовать WEB-INF.

WEB-INF/ lib может содержать сторонние библиотеки, которые вы не хотите упаковывать на системном уровне (JAR могут быть доступны для всех приложений, работающих на вашем сервере), но только для этого конкретного приложения.

Вообще говоря, многие файлы конфигурации также входят в WEB-INF.

Что касается WEB-INF/ classes - он существует в любом веб-приложении, потому что это папка, в которую помещаются все скомпилированные исходники (не JARS, а скомпилированные файлы.java, которые вы написали сами).

13

Источник

user1005184 05 ноя '13 в 10:04

Это соглашение соблюдается по соображениям безопасности. Например, если неавторизованному лицу разрешен доступ к корневому файлу JSP напрямую с URL-адреса, он может перемещаться по всему приложению без какой-либо аутентификации и может получать доступ ко всем защищенным данным.

4

Источник

16 ноя '16 в 22:49

Существует соглашение (не обязательно) о размещении страниц jsp в каталоге WEB-INF, чтобы их нельзя было глубоко связать или добавить в закладки. Таким образом, все запросы к странице JSP должны быть направлены через наше приложение, чтобы пользовательский опыт гарантирован.

3

Источник

user2761641 15 апр '16 в 08:11

Другие вопросы по тегам servlets java-ee war web-inf

user1806944 05 ноя '13 в 10:04 2013-11-05 10:04 · Accepted Answer · 2013-11-05 10:04

В спецификации Servlet 2.4 говорится об WEB-INF (стр. 70):

В иерархии приложения существует специальный каталог с именем WEB-INF, Этот каталог содержит все вещи, связанные с приложением, которые не находятся в корне документа приложения. WEB-INFузел не является частью публичного дерева документов приложения. В файле нет файлов WEB-INF каталог может обслуживаться непосредственно клиентом контейнером. Тем не менее, содержание WEB-INF каталог виден для кода сервлета с помощью getResource а также getResourceAsStream вызов метода на ServletContextи могут быть выставлены с использованием RequestDispatcher звонки.

Это означает, что WEB-INF ресурсы доступны загрузчику ресурсов вашего веб-приложения и не доступны для общего доступа.

Вот почему многие проекты размещают свои ресурсы, такие как файлы JSP, JAR / библиотеки и свои собственные файлы классов или файлов свойств, или любую другую конфиденциальную информацию в WEB-INF папка. В противном случае они были бы доступны с помощью простого статического URL (например, для загрузки CSS или Javascript).

Ваши файлы JSP могут быть где угодно, хотя с технической точки зрения. Например, в Spring вы можете настроить их на WEB-INF в явном виде:

<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"
    p:prefix="/WEB-INF/jsp/" 
    p:suffix=".jsp" >
</bean>

WEB-INF/classes а также WEB-INF/lib папки, упомянутые в статье WAR-файлов Wikipedia, являются примерами папок, необходимых для спецификации сервлета во время выполнения.

Важно сделать различие между структурой проекта и структурой результирующего файла WAR.

Структура проекта в некоторых случаях будет частично отражать структуру файла WAR (для статических ресурсов, таких как файлы JSP или файлы HTML и JavaScript, но это не всегда так).

Переход от структуры проекта к результирующему файлу WAR выполняется процессом сборки.

В то время как вы, как правило, можете свободно разрабатывать собственный процесс сборки, в настоящее время большинство людей будут использовать стандартизированный подход, такой как Apache Maven. Среди прочего Maven определяет значения по умолчанию, для которых ресурсы в структуре проекта соответствуют ресурсам в результирующем артефакте (в этом случае результирующий артефакт представляет собой файл WAR). В некоторых случаях отображение состоит из простого процесса копирования, в других случаях процесс отображения включает преобразование, такое как фильтрация или компиляция и другие.

Один пример: WEB-INF/classes позже папка будет содержать все скомпилированные классы и ресурсы Java (src/main/java а также src/main/resources), которые должны быть загружены Classloader для запуска приложения.

Другой пример: WEB-INF/lib позже папка будет содержать все файлы JAR, необходимые для приложения. В проекте maven вы управляете зависимостями, и maven автоматически копирует необходимые файлы jar в WEB-INF/lib папка для вас. Это объясняет, почему у вас нет lib папка в проекте Maven.