Spring 3.1 WebApplicationInitializer & Embedded Jetty 8 Аннотация Конфигурация
Я пытаюсь создать простое веб-приложение без какой-либо конфигурации XML, используя Spring 3.1 и встроенный сервер Jetty 8.
Однако я изо всех сил пытаюсь заставить Jetty распознать мою реализацию интерфейса Spring WebApplicationInitializer.
Структура проекта:
src
+- main
+- java
| +- JettyServer.java
| +- Initializer.java
|
+- webapp
+- web.xml (objective is to remove this - see below).
Приведенный выше класс Initializer представляет собой простую реализацию WebApplicationInitializer:
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import org.springframework.web.WebApplicationInitializer;
public class Initializer implements WebApplicationInitializer {
@Override
public void onStartup(ServletContext servletContext) throws ServletException {
System.out.println("onStartup");
}
}
JettyServer также представляет собой простую реализацию встроенного сервера Jetty:
import org.eclipse.jetty.annotations.AnnotationConfiguration;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.webapp.Configuration;
import org.eclipse.jetty.webapp.WebAppContext;
public class JettyServer {
public static void main(String[] args) throws Exception {
Server server = new Server(8080);
WebAppContext webAppContext = new WebAppContext();
webAppContext.setResourceBase("src/main/webapp");
webAppContext.setContextPath("/");
webAppContext.setConfigurations(new Configuration[] { new AnnotationConfiguration() });
webAppContext.setParentLoaderPriority(true);
server.setHandler(webAppContext);
server.start();
server.join();
}
}
Насколько я понимаю, при запуске Jetty будет использовать AnnotationConfiguration для поиска аннотированных реализаций ServletContainerInitializer; он должен найти инициализатор и подключить его...
Однако, когда я запускаю сервер Jetty (из Eclipse), я вижу следующее в командной строке:
2012-11-04 16:59:04.552:INFO:oejs.Server:jetty-8.1.7.v20120910
2012-11-04 16:59:05.046:INFO:/:No Spring WebApplicationInitializer types detected on classpath
2012-11-04 16:59:05.046:INFO:oejsh.ContextHandler:started o.e.j.w.WebAppContext{/,file:/Users/duncan/Coding/spring-mvc-embedded-jetty-test/src/main/webapp/}
2012-11-04 16:59:05.117:INFO:oejs.AbstractConnector:Started SelectChannelConnector@0.0.0.0:8080
Важный момент заключается в следующем:
No Spring WebApplicationInitializer types detected on classpath
Обратите внимание, что src / main / java определена как исходная папка в Eclipse, поэтому должна быть в classpath. Также обратите внимание, что для фасета Dynamic Web Module установлено значение 3.0.
Я уверен, что есть простое объяснение, но я изо всех сил пытаюсь увидеть лес за деревьями! Я подозреваю, что ключ со следующей строкой:
...
webAppContext.setResourceBase("src/main/webapp");
...
Это имеет смысл с сервлетом 2.5, использующим web.xml (см. Ниже), но что должно быть при использовании AnnotationConfiguration?
NB: все запускается правильно, если я изменяю конфигурации следующим образом:
...
webAppContext.setConfigurations(new Configuration[] { new WebXmlConfiguration() });
...
В этом случае он находит файл web.xml в каталоге src / main / webapp и использует его для подключения сервлета с помощью DispatcherServlet и AnnotationConfigWebApplicationContext обычным способом (полностью обходя реализацию WebApplicationInitializer, описанную выше).
Это очень похоже на проблему пути к классам, но я изо всех сил пытаюсь понять, как Jetty ассоциирует себя с реализациями WebApplicationInitializer - любые предложения будут наиболее цениться!
Для информации я использую следующее:
Spring 3.1.1 Jetty 8.1.7 STS 3.1.0
13 ответов
Проблема в том, что Jetty AnnotationConfiguration class не сканирует не jar-ресурсы на пути к классам (кроме как в WEB-INF/classes).
Находит мой WebApplicationInitializerэто если я зарегистрирую подкласс AnnotationConfiguration который переопределяет configure(WebAppContext) сканировать путь к классу хоста в дополнение к расположению контейнера и веб-инф.
Большая часть подкласса - это (к сожалению) копирование-вставка от родителя. Это включает:
- дополнительный анализ вызова (
parseHostClassPath) в конце метода настройки; parseHostClassPathметод, который в значительной степени копировать-вставить изAnnotationConfiguration"sparseWebInfClasses;getHostClassPathResourceметод, который захватывает первый не-jar URL из загрузчика классов (который, по крайней мере для меня, является URL-адресом файла моего пути к классам в eclipse).
Я использую немного разные версии Jetty (8.1.7.v20120910) и Spring (3.1.2_RELEASE), но я думаю, что будет работать то же самое решение.
Изменить: я создал рабочий пример проекта в github с некоторыми изменениями (приведенный ниже код отлично работает с Eclipse, но не при работе в затененной банке) - https://github.com/steveliles/jetty-embedded-spring-mvc-noxml
В классе JettyServer OP необходимое изменение заменит строку 15 на:
webAppContext.setConfigurations (new Configuration []
{
new AnnotationConfiguration()
{
@Override
public void configure(WebAppContext context) throws Exception
{
boolean metadataComplete = context.getMetaData().isMetaDataComplete();
context.addDecorator(new AnnotationDecorator(context));
AnnotationParser parser = null;
if (!metadataComplete)
{
if (context.getServletContext().getEffectiveMajorVersion() >= 3 || context.isConfigurationDiscovered())
{
parser = createAnnotationParser();
parser.registerAnnotationHandler("javax.servlet.annotation.WebServlet", new WebServletAnnotationHandler(context));
parser.registerAnnotationHandler("javax.servlet.annotation.WebFilter", new WebFilterAnnotationHandler(context));
parser.registerAnnotationHandler("javax.servlet.annotation.WebListener", new WebListenerAnnotationHandler(context));
}
}
List<ServletContainerInitializer> nonExcludedInitializers = getNonExcludedInitializers(context);
parser = registerServletContainerInitializerAnnotationHandlers(context, parser, nonExcludedInitializers);
if (parser != null)
{
parseContainerPath(context, parser);
parseWebInfClasses(context, parser);
parseWebInfLib (context, parser);
parseHostClassPath(context, parser);
}
}
private void parseHostClassPath(final WebAppContext context, AnnotationParser parser) throws Exception
{
clearAnnotationList(parser.getAnnotationHandlers());
Resource resource = getHostClassPathResource(getClass().getClassLoader());
if (resource == null)
return;
parser.parse(resource, new ClassNameResolver()
{
public boolean isExcluded (String name)
{
if (context.isSystemClass(name)) return true;
if (context.isServerClass(name)) return false;
return false;
}
public boolean shouldOverride (String name)
{
//looking at webapp classpath, found already-parsed class of same name - did it come from system or duplicate in webapp?
if (context.isParentLoaderPriority())
return false;
return true;
}
});
//TODO - where to set the annotations discovered from WEB-INF/classes?
List<DiscoveredAnnotation> annotations = new ArrayList<DiscoveredAnnotation>();
gatherAnnotations(annotations, parser.getAnnotationHandlers());
context.getMetaData().addDiscoveredAnnotations (annotations);
}
private Resource getHostClassPathResource(ClassLoader loader) throws IOException
{
if (loader instanceof URLClassLoader)
{
URL[] urls = ((URLClassLoader)loader).getURLs();
for (URL url : urls)
if (url.getProtocol().startsWith("file"))
return Resource.newResource(url);
}
return null;
}
},
});
Обновление: Jetty 8.1.8 вводит внутренние изменения, которые несовместимы с кодом выше. Для 8.1.8, кажется, работает следующее:
webAppContext.setConfigurations (new Configuration []
{
// This is necessary because Jetty out-of-the-box does not scan
// the classpath of your project in Eclipse, so it doesn't find
// your WebAppInitializer.
new AnnotationConfiguration()
{
@Override
public void configure(WebAppContext context) throws Exception {
boolean metadataComplete = context.getMetaData().isMetaDataComplete();
context.addDecorator(new AnnotationDecorator(context));
//Even if metadata is complete, we still need to scan for ServletContainerInitializers - if there are any
AnnotationParser parser = null;
if (!metadataComplete)
{
//If metadata isn't complete, if this is a servlet 3 webapp or isConfigDiscovered is true, we need to search for annotations
if (context.getServletContext().getEffectiveMajorVersion() >= 3 || context.isConfigurationDiscovered())
{
_discoverableAnnotationHandlers.add(new WebServletAnnotationHandler(context));
_discoverableAnnotationHandlers.add(new WebFilterAnnotationHandler(context));
_discoverableAnnotationHandlers.add(new WebListenerAnnotationHandler(context));
}
}
//Regardless of metadata, if there are any ServletContainerInitializers with @HandlesTypes, then we need to scan all the
//classes so we can call their onStartup() methods correctly
createServletContainerInitializerAnnotationHandlers(context, getNonExcludedInitializers(context));
if (!_discoverableAnnotationHandlers.isEmpty() || _classInheritanceHandler != null || !_containerInitializerAnnotationHandlers.isEmpty())
{
parser = createAnnotationParser();
parse(context, parser);
for (DiscoverableAnnotationHandler h:_discoverableAnnotationHandlers)
context.getMetaData().addDiscoveredAnnotations(((AbstractDiscoverableAnnotationHandler)h).getAnnotationList());
}
}
private void parse(final WebAppContext context, AnnotationParser parser) throws Exception
{
List<Resource> _resources = getResources(getClass().getClassLoader());
for (Resource _resource : _resources)
{
if (_resource == null)
return;
parser.clearHandlers();
for (DiscoverableAnnotationHandler h:_discoverableAnnotationHandlers)
{
if (h instanceof AbstractDiscoverableAnnotationHandler)
((AbstractDiscoverableAnnotationHandler)h).setResource(null); //
}
parser.registerHandlers(_discoverableAnnotationHandlers);
parser.registerHandler(_classInheritanceHandler);
parser.registerHandlers(_containerInitializerAnnotationHandlers);
parser.parse(_resource,
new ClassNameResolver()
{
public boolean isExcluded (String name)
{
if (context.isSystemClass(name)) return true;
if (context.isServerClass(name)) return false;
return false;
}
public boolean shouldOverride (String name)
{
//looking at webapp classpath, found already-parsed class of same name - did it come from system or duplicate in webapp?
if (context.isParentLoaderPriority())
return false;
return true;
}
});
}
}
private List<Resource> getResources(ClassLoader aLoader) throws IOException
{
if (aLoader instanceof URLClassLoader)
{
List<Resource> _result = new ArrayList<Resource>();
URL[] _urls = ((URLClassLoader)aLoader).getURLs();
for (URL _url : _urls)
_result.add(Resource.newResource(_url));
return _result;
}
return Collections.emptyList();
}
}
});
Мне удалось разрешить более простым, но более ограниченным способом, просто предоставив AnnotationConfiguration явный класс реализации (в этом примере MyWebApplicationInitializerImpl), который я хочу загрузить следующим образом:
webAppContext.setConfigurations(new Configuration[] {
new WebXmlConfiguration(),
new AnnotationConfiguration() {
@Override
public void preConfigure(WebAppContext context) throws Exception {
MultiMap<String> map = new MultiMap<String>();
map.add(WebApplicationInitializer.class.getName(), MyWebApplicationInitializerImpl.class.getName());
context.setAttribute(CLASS_INHERITANCE_MAP, map);
_classInheritanceHandler = new ClassInheritanceHandler(map);
}
}
});
Jetty 9.0.1 содержит усовершенствование, которое позволяет сканировать аннотации не jar-ресурсов (то есть классов) на пути к классам контейнера. См. Комментарий № 5 по следующему вопросу о том, как его использовать:
https://bugs.eclipse.org/bugs/show_bug.cgi?id=404176
январь
Код ниже добился цели в моем проекте Maven:
public static void main(String[] args) throws Exception {
Server server = new Server();
ServerConnector scc = new ServerConnector(server);
scc.setPort(Integer.parseInt(System.getProperty("jetty.port", "8080")));
server.setConnectors(new Connector[] { scc });
WebAppContext context = new WebAppContext();
context.setServer(server);
context.setContextPath("/");
context.setWar("src/main/webapp");
context.getMetaData().addContainerResource(new FileResource(new File("./target/classes").toURI()));
context.setConfigurations(new Configuration[]{
new WebXmlConfiguration(),
new AnnotationConfiguration()
});
server.setHandler(context);
try {
System.out.println(">>> STARTING EMBEDDED JETTY SERVER, PRESS ANY KEY TO STOP");
System.out.println(String.format(">>> open http://localhost:%s/", scc.getPort()));
server.start();
while (System.in.available() == 0) {
Thread.sleep(5000);
}
server.stop();
server.join();
} catch (Throwable t) {
t.printStackTrace();
System.exit(100);
}
}
Основываясь на моем тестировании и этой теме http://forum.springsource.org/showthread.php?127152-WebApplicationInitializer-not-loaded-with-embedded-Jetty Я не думаю, что это работает в данный момент. Если вы посмотрите в AnnotationConfiguration.configure:
parseContainerPath(context, parser);
// snip comment
parseWebInfClasses(context, parser);
parseWebInfLib (context, parser);
кажется, что это связано с военным развертыванием, а не с внедрением.
Вот пример использования Spring MVC и встроенного Jetty, который может быть более полезным:
http://www.jamesward.com/2012/08/13/containerless-spring-mvc
Он создает Spring-сервлет напрямую, а не полагается на аннотации.
Чтобы заставить его работать на Jetty 9, установите атрибут AnnotationConfiguration.CLASS_INHERITANCE_MAP на WebAppContext
webAppContext.setAttribute(AnnotationConfiguration.CLASS_INHERITANCE_MAP, createClassMap());
А вот как создать эту карту:
private ClassInheritanceMap createClassMap() {
ClassInheritanceMap classMap = new ClassInheritanceMap();
ConcurrentHashSet<String> impl = new ConcurrentHashSet<>();
impl.add(MyWebAppInitializer.class.getName());
classMap.put(WebApplicationInitializer.class.getName(), impl);
return classMap;
}
Я разместил это решение на gitHub
Тем, кто испытывает это в последнее время, кажется, что это обходит проблему:
@Component
public class Initializer implements WebApplicationInitializer {
private ServletContext servletContext;
@Autowired
public WebInitializer(ServletContext servletContext) {
this.servletContext = servletContext;
}
@PostConstruct
public void onStartup() throws ServletException {
onStartup(servletContext);
}
public void onStartup(ServletContext servletContext) throws ServletException {
System.out.println("onStartup");
}
}
А как насчет простой установки атрибута контекста, который сообщает сканеру, какие вещи принадлежат к пути к классу контейнера, который нужно сканировать?
атрибут контекста: org.eclipse.jetty.server.webapp.ContainerIncludeJarPattern./ servlet-api - [^ /].jar $
Он предназначен для использования с именами банок, но вы можете просто сопоставить все.
Вам нужно будет использовать классы WebInfConfiguration, а также классы AnnotationConfiguration.
ура Ян
Для Jetty 9, если у вас есть веб-файлы, предоставленное решение не работает сразу, поскольку эти файлы Jar должны находиться на пути к классам, а содержимое JAR должно быть доступно в качестве ресурсов для вашего веб-приложения. Итак, для того, чтобы это работало вместе с веб-файлами, конфигурация должна быть:
context.setExtraClasspath(pathsToWebJarsCommaSeparated);
context.setAttribute(WebInfConfiguration.WEBINF_JAR_PATTERN, ".*\\.jar$");
context.setAttribute(WebInfConfiguration.CONTAINER_JAR_PATTERN, ".*\\.jar$");
context.setConfigurations(
new org.eclipse.jetty.webapp.Configuration[] {
new WebInfConfiguration(), new MetaInfConfiguration(),
new AnnotationConfiguration() {
@Override
public void preConfigure(WebAppContext context) throws Exception {
final ClassInheritanceMap map = new ClassInheritanceMap();
final ConcurrentHashSet<String> set = new ConcurrentHashSet<>();
set.add(MyWebAppInitializer.class.getName());
map.put(WebApplicationInitializer.class.getName(), set);
context.setAttribute(CLASS_INHERITANCE_MAP, map);
_classInheritanceHandler = new ClassInheritanceHandler(map);
}
} });
Порядок здесь важен (WebInfConfiguration должна предшествовать MetaInf).
Решение, которое работает для меня и не включает сканирование, но использует предоставленный вами класс WebApplicationInitializer. Версия причала: 9.2.20
public class Main {
public static void main(String... args) throws Exception {
Properties properties = new Properties();
InputStream stream = Main.class.getResourceAsStream("/WEB-INF/application.properties");
properties.load(stream);
stream.close();
PropertyConfigurator.configure(properties);
WebAppContext webAppContext = new WebAppContext();
webAppContext.setResourceBase("resource");
webAppContext.setContextPath(properties.getProperty("base.url"));
webAppContext.setConfigurations(new Configuration[] {
new WebXmlConfiguration(),
new AnnotationConfiguration() {
@Override
public void preConfigure(WebAppContext context) {
ClassInheritanceMap map = new ClassInheritanceMap();
map.put(WebApplicationInitializer.class.getName(), new ConcurrentHashSet<String>() {{
add(WebInitializer.class.getName());
add(SecurityWebInitializer.class.getName());
}});
context.setAttribute(CLASS_INHERITANCE_MAP, map);
_classInheritanceHandler = new ClassInheritanceHandler(map);
}
}
});
Server server = new Server(Integer.parseInt(properties.getProperty("base.port")));
server.setHandler(webAppContext);
server.start();
server.join();
}
}
Источник этого фрагмента кода здесь: https://habrahabr.ru/post/255773/
Jetty 9 версия "magomarcelo" ответ:
context.setConfigurations(
new org.eclipse.jetty.webapp.Configuration[] { new WebXmlConfiguration(), new AnnotationConfiguration() {
@Override
public void preConfigure(WebAppContext context) throws Exception {
final ClassInheritanceMap map = new ClassInheritanceMap();
final ConcurrentHashSet<String> set = new ConcurrentHashSet<>();
set.add(MyWebAppInitializer.class.getName());
map.put(WebApplicationInitializer.class.getName(), set);
context.setAttribute(CLASS_INHERITANCE_MAP, map);
_classInheritanceHandler = new ClassInheritanceHandler(map);
}
} });
Сделал простой проект Maven, чтобы продемонстрировать, как это можно сделать чисто.
public class Console {
public static void main(String[] args) {
try {
Server server = new Server(8080);
//Set a handler to handle requests.
server.setHandler(getWebAppContext());
//starts to listen at 0.0.0.0:8080
server.start();
server.join();
} catch (Exception e) {
log.error("server exited with exception", e);
}
}
private static WebAppContext getWebAppContext() {
final WebAppContext webAppContext = new WebAppContext();
//route all requests via this web-app.
webAppContext.setContextPath("/");
/*
* point to location where the jar into which this class gets packaged into resides.
* this could very well be the target directory in a maven development build.
*/
webAppContext.setResourceBase("directory_where_the_application_jar_exists");
//no web inf for us - so let the scanning know about location of our libraries / classes.
webAppContext.getMetaData().setWebInfClassesDirs(Arrays.asList(webAppContext.getBaseResource()));
//Scan for annotations (servlet 3+)
final AnnotationConfiguration configuration = new AnnotationConfiguration();
webAppContext.setConfigurations(new Configuration[]{configuration});
return webAppContext;
}
}
и все - пружина WebApplicationInitializer, которую вы используете, будет обнаружена без явного уведомления сервера Jetty о существовании такого инициализатора приложения.
В нашем случае эти строки помогли в коде запуска Jetty:
ClassList cl = Configuration.ClassList.setServerDefault(server);
cl.addBefore("org.eclipse.jetty.webapp.JettyWebXmlConfiguration", "org.eclipse.jetty.annotations.AnnotationConfiguration");