Spring 3.1 WebApplicationInitializerおよびEmbedded Jetty 8のアノテーション構成
Spring 3.1と組み込みJetty 8サーバーを使用して、XML構成なしで単純なWebアプリを作成しようとしています。
ただし、Spring WebApplicationInitializerインターフェイスの実装をJettyに認識させるのに苦労しています。
プロジェクト構造：
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を見つけて配線する必要があります...
ただし、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 [email protected]:8080
重要なのはこれです：
No Spring WebApplicationInitializer types detected on classpath
src/main/JavaはEclipseでソースフォルダーとして定義されているため、クラスパス上にある必要があります。また、動的Webモジュールファセットが3.0に設定されていることにも注意してください。
簡単な説明があると確信していますが、私は木のために木を見るのに苦労しています！キーは次の行にあると思われます。
...
webAppContext.setResourceBase("src/main/webapp");
...
これは、web.xmlを使用する2.5サーブレット（以下を参照）では理にかなっていますが、AnnotationConfigurationを使用する場合はどうすればよいですか？
注：構成を次のように変更すると、すべてが正しく起動します。
...
webAppContext.setConfigurations(new Configuration[] { new WebXmlConfiguration() });
...
この場合、src/main/webappの下でweb.xmlを見つけ、それを使用してDispatcherServletおよびAnnotationConfigWebApplicationContext通常の方法で（上記のWebApplicationInitializer実装を完全にバイパスします）。
これはクラスパスの問題に非常に似ていますが、JettyがWebApplicationInitializerの実装にどのように関連付けられるかを理解するのに苦労しています-どんな提案でも大歓迎です！
情報については、私は次を使用しています：
Spring 3.1.1 Jetty 8.1.7 STS 3.1.0
問題は、JettyのAnnotationConfigurationクラスがクラスパス上の非jarリソースをスキャンしないことです（WEB-INF/classesを除く）。
WebApplicationInitializerのサブクラスを登録すると、AnnotationConfigurationが見つかります。このサブクラスは、configure(WebAppContext)をオーバーライドして、コンテナおよびweb-infの場所に加えてホストクラスパスをスキャンします。
サブクラスのほとんどは、（悲しいことに）親からのコピー＆ペーストです。以下が含まれます。
- configureメソッドの最後に追加の解析呼び出し（
parseHostClassPath）; parseHostClassPathのAnnotationConfigurationから主にコピーアンドペーストされるparseWebInfClassesメソッド。- クラスローダーから最初の非jar URLを取得する
getHostClassPathResourceメソッド（少なくとも私にとっては、EclipseのクラスパスへのファイルURLです）。
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;
}
},
});
Update：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();
}
}
});
このようにロードしたい実装クラス（この例ではMyWebApplicationInitializerImpl）を明示的にAnnotationConfigurationに提供するだけで、より簡単ですがより限定的な方法で解決できました。
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#c5
ヤン
以下のコードは、私の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サーブレットを直接作成します。
最近これを経験している人にとって、これは問題を回避するようです：
@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");
}
}
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 に配置しました
スキャンする必要があるコンテナクラスパスに属するものをスキャナに伝えるコンテキスト属性を設定するだけではどうでしょうか。
コンテキスト属性：org.Eclipse.jetty.server.webapp.ContainerIncludeJarPattern ./ servlet-api-[^ /]。jar $
Jar名で使用するように設計されていますが、すべてを一致させることができます。
WebInfConfigurationクラスとAnnotationConfigurationクラスを使用する必要があります。
乾杯
Jetty 9の場合、webjarがある場合、提供されたソリューションはすぐには機能しません。これらのjarはクラスパス上にある必要があり、JARコンテンツはwebappのリソースとして利用できる必要があるためです。そのため、webjarと連携するためには、構成は次のようになります。
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の前に来る必要があります）。
「magomarcelo」回答のJetty 9バージョン：
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;
}
}
それだけです-あなたが使用するSpring WebApplicationInitializerは、そのようなアプリ初期化子の存在を明示的にjettyサーバーに知らせることなく検出されます。
私のために働いたソリューションで、スキャンは必要ありませんが、提供された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のスタートアップコードに役立ちました。
ClassList cl = Configuration.ClassList.setServerDefault(server);
cl.addBefore("org.Eclipse.jetty.webapp.JettyWebXmlConfiguration", "org.Eclipse.jetty.annotations.AnnotationConfiguration");