Spring 3.1 WebApplicationInitializer & Embedded Jetty 8 AnnotationConfiguration

Posted 2023-02-27

【中文标题】Spring 3.1 WebApplicationInitializer & Embedded Jetty 8 AnnotationConfiguration

【英文标题】：

【发布时间】：2012-10-24 16:42:50

【问题描述】：

我正在尝试使用 Spring 3.1 和嵌入式 Jetty 8 服务器创建一个没有任何 XML 配置的简单 webapp。

但是，我很难让 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 的注释实现；它应该找到 Initializer 并将其连接到...

但是，当我（从 Eclipse 中）启动 Jetty 服务器时，我在命令行上看到以下内容：

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 中被定义为源文件夹，因此应该位于类路径中。另请注意，Dynamic Web Module Facet 设置为 3.0。

我确信有一个简单的解释，但我很难只见树木不见森林！我怀疑关键在于以下行：

...
webAppContext.setResourceBase("src/main/webapp");
...

这对于使用 web.xml 的 2.5 servlet 是有意义的（见下文），但是使用 AnnotationConfiguration 时应该是什么？

注意：如果我将配置更改为以下内容，一切都会正确启动：

...
webAppContext.setConfigurations(new Configuration[]  new WebXmlConfiguration() );
...

在这种情况下，它会在 src/main/webapp 下找到 web.xml 并使用它通过 DispatcherServlet 和 连接 servlet em>AnnotationConfigWebApplicationContext 以通常的方式（完全绕过上面的 WebApplicationInitializer 实现）。

这感觉很像一个类路径问题，但我很难理解 Jetty 如何将自己与 WebApplicationInitializer 的实现联系起来 - 任何建议都将不胜感激！

有关信息，我正在使用以下内容：

春季 3.1.1 码头 8.1.7 STS 3.1.0

【参考方案1】：

问题是Jetty的AnnotationConfiguration类没有扫描classpath下的非jar资源（WEB-INF/classes下除外）。

如果我注册AnnotationConfiguration 的子类，它会找到我的WebApplicationInitializer，它会覆盖configure(WebAppContext) 以扫描主机类路径以及容器和web-inf 位置。

大多数子类（可悲的是）从父类复制粘贴。它包括：

configure 方法末尾的额外解析调用 (parseHostClassPath)； parseHostClassPath 方法主要是从 AnnotationConfiguration的parseWebInfClasses； getHostClassPathResource 方法获取第一个非 jar URL 来自类加载器（至少对我来说，这是我的文件 url eclipse 中的类路径）。

我使用的 Jetty (8.1.7.v20120910) 和 Spring (3.1.2_RELEASE) 版本略有不同，但我想同样的解决方案也可以。

编辑：我在 github 中创建了一个工作示例项目，并进行了一些修改（下面的代码在 Eclipse 中可以正常工作，但在阴影 jar 中运行时却不行）-https://github.com/steveliles/jetty-embedded-spring-mvc-noxml

在 OP 的 JettyServer 类中，必要的更改将第 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();                 
            
        
    );

【讨论】：

这似乎有效。您是否考虑过通知 Jetty 或发送补丁？

非常感谢您的详细回答——正是我想要的。我自己玩了一场，现在从 Jetty 和 Spring 的角度对事情的运作方式有了更清晰的理解。肯定会在 Jetty 中修复并提交补丁。

@Duncan：是否曾向 Jetty 提交过补丁/问题？

@RyanStewart：我找不到。

@RyanStewart：我刚刚提交了：bugs.eclipse.org/bugs/show_bug.cgi?id=404176

【参考方案2】：

只需向 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);
        
    
);

【讨论】：

为了让 Jersey 类扫描工作，我还将 WebAppContext.getWebInf() 覆盖为始终 return newResource("target"); 而不是 resourceBase/WEB-INF/classes/。

我花了一段时间才发现WebXmlConfiguration 是允许 Jetty 提供资源所必需的（例如src/main/webapp 中的 html 和 CSS）。另见WebAppContext#setResourceBase()。

ClassInheritanceHandler 的构造函数采用 Jetty 8 和 9 中的 ConcurrentHashMap>？现在构建这张地图需要什么？ download.eclipse.org/jetty/stable-9/apidocs/org/eclipse/jetty/…

在 Jetty 9 中，您可以使用 ClassInheritanceMap 而不是 MultiMap。

【参考方案3】：

Jetty 9.0.1 包含一个增强功能，允许扫描容器类路径上的非 jar 资源（即类）的注释。有关如何使用它，请参阅关于以下问题的评论 #5：

https://bugs.eclipse.org/bugs/show_bug.cgi?id=404176#c5

一月

【讨论】：

有使用war文件的例子吗？使用 .* 和 .*/classes/.* 不起作用：|而且我真的没有 jetty_home，因为这是嵌入式码头。

【参考方案4】：

下面的代码在我的 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);
    

【参考方案5】：

根据我的测试和这个线程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 servlet，而不是依赖注解。

【讨论】：

感谢 jamesward 链接 - 很高兴知道如何直接/手动构建事物；不知道这引起了我的部分困惑。

【参考方案6】：

对于最近遇到这种情况的人来说，这似乎解决了这个问题：

@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");
    

【讨论】：

这对于使用 Spring 的人来说是完美的。它看起来很干净，可以解决所有问题。

【参考方案7】：

要使其在 Jetty 9 上工作，请在 WebAppContext 上设置属性 AnnotationConfiguration.CLASS_INHERITANCE_MAP

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

【参考方案8】：

如果只设置上下文属性，告诉扫描器哪些东西属于需要扫描的容器类路径？

上下文属性： org.eclipse.jetty.server.webapp.ContainerIncludeJarPattern ./servlet-api-[^/].jar$

它被设计为与 jar 名称一起使用，但您可以匹配所有内容。

您需要使用 WebInfConfiguration 以及 AnnotationConfiguration 类。

干杯 一月

【讨论】：

不幸的是我不能让它工作。我将模式设置为 .*，我看到我的类目录被添加到要扫描的 URI 列表中。不幸的是，AnnotationConfiguration 在 parseContainerPath 中使用了 JarScanner，它在第 147 行拒绝了我的类目录，因为 URI 不以“.jar”结尾。

顺便说一句，您的个人资料中有错字 - 我猜您的意思是 webtide.com，而不是 wetide.com？

【参考方案9】：

在我们的例子中，这些行有助于 Jetty 启动代码：

    ClassList cl = Configuration.ClassList.setServerDefault(server);
    cl.addBefore("org.eclipse.jetty.webapp.JettyWebXmlConfiguration", "org.eclipse.jetty.annotations.AnnotationConfiguration");

【参考方案10】：

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);
                
             );

【参考方案11】：

对于 Jetty 9，如果您有 webjars，则提供的解决方案不会立即起作用，因为这些 Jars 需要位于类路径中，并且 JAR 内容需要作为您的 webapp 的资源可用。因此，为了与 webjars 一起工作，配置必须是：

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 之前）。

【参考方案12】：

对我有用且不涉及扫描但使用您提供的 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();

这段代码 sn-p 的来源（俄语）在这里：https://habrahabr.ru/post/255773/

【参考方案13】：

做了一个简单的 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;
    

仅此而已 - 您使用的 spring WebApplicationInitializer 将被检测到，而无需明确让 jetty 服务器知道此类应用程序初始化程序的存在。