Необходимо ли придерживаться соглашений о каталогах Java EE в webroot?

Question

Я сейчас работаю над проектом Java EE, и мне это нравится. Гораздо приятнее (IMO), чем PHP. Я искал список соглашений о кодировании Java EE, чтобы убедиться, что я придерживаюсь их. Я наткнулся на эту ссылку:

http://java.sun.com/developer/technicalArticles/javaserverpages/code_convention/

На этой странице указано, что у меня должны быть каталоги, такие как / js, / css и / WEB-INF / jspf, под webroot (/ web), но я НЕНАВИЖУ это. Я бы предпочел использовать значимые имена каталогов, такие как / scripts, / styles и / фрагменты, как я бы использовал в PHP.

Может С.О. пролить свет на это?

Answer 1

Имена, которые вы выбираете для своих различных подкаталогов, действительно являются вопросом выбора. Не забудьте выбрать имена, которые будут работать для других, хотя. Даже если ваш проект небольшой и личный, привычки, которые вы формируете, будут перенесены в проекты, которыми вы поделитесь с командами разработчиков в будущем.

Я бы порекомендовал вам выбрать / WEB-INF / фрагменты вместо / фрагментов, поскольку файлы в / фрагментах могут быть переданы непосредственно в браузер ... что может не иметь смысла, если файл содержит разметку, зависящую от контекста.

Файлы, которые находятся в / WEB-INF, доступны для вашего кода Java, но не доступны напрямую из браузера. Ваш код может читать файлы и использовать их ... но пользователь не сможет получить к ним доступ, набрав 'http://foo.com/WEB-INF/fragments/header.jspf.

Answer 2

Это просто соглашение об именах папок. Вам не нужно строго придерживаться этого, если вы не используете имена папок, такие как /tkjbwnkjh вместо /js или /scripts или /javascript и т. Д. Сохраняйте его самодокументированным, чтобы будущие сопровождающие кодовой базы не буду ругать тебя.

Что касается примечания к соглашениям по коду JSP, гораздо важнее действительные соглашения по коду, см. Также: Как избежать использования кода Java в файлах JSP?