비공정

메이븐에서 프로젝트를 패키징할때, Assembly 플러그인을 사용하면 의존 라이브러리를 포함한 전체 파일을 하나의 jar 파일로 묶을 수 있다.
그런데 의존성에 Spring 관련 라이브러리를 추가한 뒤 패키징하면 간혹 실행시 다음과 같은 에러가 나는 경우가 있다.

Exception in thread "main" org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Configuration problem: Unable to locate Spring NamespaceHandler for XML schema namespace [http://www.springframework.org/schema/context]
Offending resource: file [/home/setzer/ManalithBot/ManalithBot/config.xml]

        at org.springframework.beans.factory.parsing.FailFastProblemReporter.error(FailFastProblemReporter.java:68)
        at org.springframework.beans.factory.parsing.ReaderContext.error(ReaderContext.java:85)
        at org.springframework.beans.factory.parsing.ReaderContext.error(ReaderContext.java:80)
        at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.error(BeanDefinitionParserDelegate.java:316)
        at org.springframework.beans.factory.xml.BeanDefinitionParserDelegate.parseCustomElement(BeanDefinitionParserDelegate.java:1416)

... (하략)

이 문제는, 정상적인 상황에서라면 스프링의 XML 스키마가 정의되어 있어야 할 META-INF/spring.schemas 파일에서 "http://www.springframework.org/schema/context"에 대한 정의가 들어있지 않아 발생한다. 이 파일은 spring-context.jar, spring-asm.jar 등 관련 패키지에 각각 다른 내용으로 들어있는데, 메이븐의 Assembly 플러그인이 이것들을 하나로 합치면서 내용을 서로 병합하지 않고 덮어씌워버리는 탓에 누락된 내용이 생기게 된다.

이를 해결하기 위해 jar 파일을 열어 META-INF/spring.schemas 파일을 직접 열어 고칠 수 있다. 그러나 패키징시마다 매번 이렇게 할 수는 없는 노릇인데, 다행히 Shade 플러그인을 사용하면 필요한 파일들을 병합하도록 지정해줄 수 있다.

<plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <mainClass>org.manalith.ircbot.BotMain</mainClass>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>assembly</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

<plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>1.7</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <finalName>${artifactId}-${version}-jar-with-dependencies</finalName>
                            <transformers>
                                <transformer
                                    implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                    <resource>META-INF/spring.handlers</resource>
                                </transformer>
                                <transformer
                                    implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                    <resource>META-INF/spring.schemas</resource>
                                </transformer>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>org.manalith.ircbot.BotMain</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

위는 수정 전의 Assembly 플러그인을 사용한 내용이고, 아래는 이를 Shade 플러그인으로 대체한 것이다. 대충 훑어보면 내용은 짐작이 갈 것이다. 다만 <finalname />은 필수사항이 아니며 지정하지 않으면 원래의 패키지 파일을 original-(원래 파일명).jar로 변경한 뒤 동일한 이름으로 jar 파일을 생성한다.

참고 :
http://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html#AppendingTransformer
http://forum.springsource.org/showthread.php?48787-Unable-to-locate-NamespaceHandler-when-using-context-annotation-config/page3