SpringMVC 3.2.# 기반에 JSP-SiteMesh2로 되어있던 레거시 프로젝트를 Spring Boot로 전환했다.
역시나 설정 부분에서 어려운 점이 많은데 까먹기 전에 남겨두기로 한다.
Spring Boot에서
JSP와 SiteMesh를 사용하면서
FAT JAR로 배포하고 싶다면
Spring Boot 1.4.2를 사용해라.
기본적으로 jar로 만드는 SpringBoot에서는 JSP를 사용할 수 없다라고 되어 있다.
하지만 방법이 없는 건 아니고, Spring Boot 1.4.3을 기준으로 해법이 나뉜다.
해결 방법은 http://hillert.blogspot.kr/2016/03/spring-boot-with-jsp-in-executable-jar.html 에 나와있는데 정리하면,
- application.yml에 다음과 같이 지정
spring.mvc.view:
prefix: /WEB-INF/jsp/
suffix: .jsp- JSP 파일의 물리적 저장 위치
기존의
/WEB-INF/jsp에 저장했던 jsp 파일을 Spring Boot에서는resources/META-INF/resources/WEB-INF/jsp에 저장해야 한다.
그리고 아래 jar 파일 생성 후 실행 시 에러에서 설명한 것처럼 bootRepackage task로 jar를 만들어야 제대로 실행된다.
이렇게 하면 jar 파일로는 애플리케이션이 잘 동작하는데, IDE에서 애플리케이션을 실행시키면 /WEB-INF/를 못찾아서 site 화면이 제대로 뜨지 않는다. IDE에서 제대로 실행되지 않는다면 debug 모드를 못 쓴다는 의미이므로 사실상 개발이 어렵다.
편법이지만 webapp 폴더가 jar 생성 시 무시된다는 성질을 역이용하면 이 문제를 해결할 수 있다.
- webapp 폴더 활용
resources/META-INF/resources/WEB-INF/폴더 내의 내용을src/main/webapp/WEB-INF/폴더 내로 복사한다.
이렇게 하면 IDE에서 실행할 때도 /WEB-INF/를 문제 없이 찾으므로 debug 모드를 활용할 수 있고,
webapp 폴더는 jar에는 포함되지 않으므로 배포에도 영향이 없다.
resources/META-INF/resources/WEB-INF/와 webapp/WEB-INF/를 병행 사용하는 전략이 먹히지 않는다.
1.4.3을 쓰려면 Fat JAR를 포기하고 webapp 폴더를 쓰는 WAR를 선택하거나, 아니면 JSP-SiteMesh를 포기해야 한다.
Gradle의 jar 태스크를 실행해서 생성된 jar 파일을 java -jar로 실행하면 다음과 같은 에러가 날 수 있다.
이럴 때는 다음과 같이 해결한다.
Gradle의
bootRepackage태스크를 실행해서 jar를 만들고,
java -jar로 실행하면 정상적으로 실행된다.
JSP 파일이 잘 인식이 되더라도, 실제 JSP 파일을 불러보면 아래와 같은 에러가 날 수 있다.
The absolute uri: http://www.springframework.org/security/tags cannot be resolved in either web.xml or the jar files deployed with this application
이 오류의 발생 원인은 http://www.springframework.org/security/tags는 기본적인 spring-boot-starter-*에는 포함되어 있지 않기 때문이다. 따라서 다음과 같이 의존 관계를 추가해주면 된다.
build.gradle에compile group: 'org.springframework.security', name: 'spring-security-taglibs'을 추가해주면 된다.
기존 xml로 되어 있던 설정이 Java Config에서 어떻게 매칭되는지 하나하나 파악하는데 시간이 많이 소요되어 그냥 기존의 xml 그대로 쓰기로 했다.
MainApplication.java 에 @ImportResource({ "classpath:/config/spring/context-security.xml", ... 를 지정해주는 걸로 해결
비교적 간단하다.
webapp/static 에 있던 파일을 resources/static 으로 이동
비교적 간단하다.
webapp/index.html 을 resources/static/index.html 로 이동
Spring Boot로의 전환에서 가장 속 썩는 부분이 바로 SiteMesh 설정이다.
인터넷을 뒤져보면 SiteMesh 3과 Spring Boot를 설정하는 내용은 있어도 SiteMesh 2에 대한 내용은 도움이 될만한 내용이 거의 없다.
기존에는 SiteMesh 2를 사용해서 decorator도 JSP로 만들었는데, SiteMesh 3은 일단 홈페이지의 예제가 JSP가 아니라 HTML로만 되어 있어서, 3으로 올리면 소스 수준에서 decorator를 모두 수정해야 할 판이다. 그래서 그냥 SiteMesh 2를 그대로 사용하기로 했다.
해결 방법은 다음과 같다.
기존에
src/main/webapp/WEB-INF/decorators.xml파일은src/main/resources/META-INF/resources/WEB-INF/decorators.xml로 옮기고,
SiteMeshConfig라는@Configration클래스로SiteMeshFilter만Bean으로 등록해주면 다행스럽게도 잘 동작한다.
import com.opensymphony.sitemesh.webapp.SiteMeshFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SiteMeshConfig {
@Bean
public FilterRegistrationBean siteMeshFilter() {
FilterRegistrationBean filter = new FilterRegistrationBean();
filter.setFilter(new SiteMeshFilter());
return filter;
}
}
src/main/resources/META-INF/resources/WEB-INF/decorators.xml에서<decorators defaultdir="/WEB-INF/decorators">로 지정했으므로, decorator 파일들은src/main/resources/META-INF/resources/WEB-INF/decorators폴더 내부에 위치한다.
참고로 jsp로 된 decorator 파일은 대략 아래와 같은 형식으로 시작한다.
<%@ page contentType="text/html;charset=UTF-8"%>
<%@ include file="/WEB-INF/jsp/common/env.jsp"%> // <-- include 할 jsp 파일의 위치를 /WEB-INF/jsp/~~로 지정
<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator"%>천신만고 끝에 애플리케이션을 띄우고 index.html을 열면 한글이 뙇!!
검색해보면 쉽게 찾을 수 있는 방법이다.
@Bean
public HttpMessageConverter<String> responseBodyConverter() {
return new StringHttpMessageConverter(Charset.forName("UTF-8"));
}
@Bean
public Filter characterEncodingFilter() {
CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
characterEncodingFilter.setEncoding("UTF-8");
characterEncodingFilter.setForceEncoding(true);
return characterEncodingFilter;
}그런데 이걸로 안 될때도 있더라.. 그럴땐 2단계로.
이 방법은 검색으로는 금방 안 나오는데 application.yml에 다음 내용을 지정하면 된다.
spring.http.encoding:
force: true
force-request: true
force-response: true하는 김에 아래 내용도 추가하자. standalone Tomcat 시절에 server.xml에 항상 해주던 설정이다.
server.tomcat.uri-encoding: UTF-8이 경우는 java 실행 옵션 문제다. JAVA_OPTS라는 환경 변수에 -Dfile.encoding=UTF-8을 추가해준다.
확실하게는 java -Dfile.encoding=UTF-8 -jar로 jar 파일을 실행하면 된다.
Spring 1.4.2 라면 읽어오고 싶은 자원을 src/main/resources/META-INF/resources/를 /로 해서 strPath를 기술하면 된다.
예를 들어 src/main/resources/META-INF/resources/WEB-INF/abc.txt 파일은 context.getResourceAsStream("/WEB-INF/abc.txt")로 InputStream에 담을 수 있다.
하지만 src/main/resources/static/def.txt 파일을 context.getResourceAsStream("/def.txt")로 읽을 수는 없다.
설정 관련 한다고 했는데도 원하는 대로 되지 않는다면, localhost:8080/configprops 로 현재 설정 정보 JSON 을 확인해보는 것이 문제 해결에 드는 시간을 줄여준다. 그리고 설정 항목은 Spring Boot 문서에서 확인할 수 있다.
잘 해결되지 않던 한글 문제를 예로 들어보면, localhost:8080/configprops에서 확인해 본 결과
"spring.http.encoding-org.springframework.boot.autoconfigure.web.HttpEncodingProperties": {
"prefix": "spring.http.encoding",
"properties": {
"charset": "UTF-8",
"force": false,
"mapping": null,
"forceRequest": false,
"forceResponse": false
}
},라고 되어 있어서, 이를 발판 삼아 답을 찾을 수 있었다.
SpringMVC 에서는 Mapper.xml 파일이 src/main/java 아래에 있어도 classpath에 포함이 되었지만, Spring Boot에서는 포함되지 않아서 실행 시 클래스패스에서 Mapper.xml 파일을 찾지 못한다.
Mapper.xml 파일은 src/main/resources/sqlmapper 아래에 폴더별로 모아두고,
Databaseconfig.java에서 다음과 같이 Mapper의 위치를 지정
@Bean("sqlSessionFactory")
public SqlSessionFactory sqlSessionFactoryBean(DataSource dataSource) throws Exception {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(dataSource);
sqlSessionFactoryBean.setConfigLocation(applicationContext.getResource("classpath:/config/mybatis/mybatis-config.xml"));
sqlSessionFactoryBean.setMapperLocations(applicationContext.getResources("classpath:/sqlmapper/**/*Mapper.xml")); // <-- 이렇게 지정
return sqlSessionFactoryBean.getObject();
}SpringMVC에서는 Response의 content-type이 application/json이 아닌 경우, javascript에서 JSON.parse(result)를 해줘야 result 내의 데이터에 접근할 수 있었는데,
Spring Boot에서는 Response의 content-type이 application/json으로 넘어오므로, JSON.parse(result)를 실행하면 Uncaught SyntaxError: Unexpected token o in JSON at position 1라는 에러가 발생한다. 이유는 이미 result가 이미 JSON 객체라서 JSON.parse("[object Object]")와 같이 해석되어 object의 o에서 에러가 발생한다.
따라서 다음과 같이 JSON.parse()를 벗겨낸다.
var parsedData = JSON.parse(result); 를
var parsedData = result; 로 수정한다.
단순히 벗겨내기만 하면 data의 내부에 [{...}, {...}, {...}]와 같은 배열이 있는 경우 파싱이 안 될 수 있으므로 다음과 같이 앞에 JSON.stringify()를 앞에 추가해준다.
성능 관점에서 올바르지는 않지만 레거시라는 점을 감안하면 작업 관점에서는 더 효율적일 수 있다.
result = JSON.stringify(result); // 이렇게 다시 문자열화.. 전혀 아름답진 않다..
var parsedData = JSON.parse(result);The code of method _jspService(HttpServletRequest, HttpServletResponse) is exceeding the 65535 bytes limit
크기가 큰 JSP의 경우 Servlet Java 파일로 전환되면 doService() 메서드 하나에 JSP의 내용이 대부분 들어가서 code_length가 64k를 넘을 수가 있으며 이는 JVM 스펙에 위배되어 발생하는 에러다.
web.xml이 있던 시절에는 톰캣인 경우 아래와 같이 설정해주면 에러가 나지 않게 할 수 있었다.
<servlet>
<servlet-name>jsp</servlet-name>
<servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
<init-param>
<param-name>mappedfile</param-name>
<param-value>false</param-value>
</init-param>
</servlet>Spring Boot에서는 JspServlet이라는 클래스를 제공해주고 있으며, EmbeddedServletContainerCustomizer를 통해 임베디드 서블릿 컨테이너를 커스터마이징 할 수 있으므로 다음과 같이 설정하면 된다.
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.embedded.JspServlet;
//... 이하 import 생략 ...
@Configuration
public class WebConfig {
@Bean
public EmbeddedServletContainerCustomizer customizer() {
return container -> {
JspServlet jspServlet = new JspServlet();
HashMap<String, String> initParams = new HashMap<>();
initParams.put("mappedfile", "false");
jspServlet.setInitParameters(initParams);
container.setJspServlet(jspServlet);
};
// Java 8 미만이라면 다음과 같이 해준다.
// return new EmbeddedServletContainerCustomizer() {
// @Override
// public void customize(ConfigurableEmbeddedServletContainer container) {
// JspServlet jspServlet = new JspServlet();
// HashMap<String, String> initParams = new HashMap<>();
// initParams.put("mappedfile", "false");
// jspServlet.setInitParameters(initParams);
// container.setJspServlet(jspServlet);
// }
// };
}
}
파일 업로드 처리에 CommonsMultipartResolver를 사용하면 request에 file이 담겨있지 않을 수 있다.
CommonsMultipartResolver 대신에 Spring 3.1부터 추가된 StandardServletMultipartResolver를 사용하면 정상적으로 file이 담겨 있는 request를 받을 수 있는데, Spring Boot에서는 MultipartResolover 관련 별다른 설정이 없다면 기본으로 StandardServletMultipartResolver를 사용한다.
따라서, CommonsMultipartResolver를 별도로 설정하고 있었다면 해당 Bean 설정 내용을 제거한다.
DefaultMultipartHttpServletRequest도 마찬가지로 request에 client가 보낸 정보가 담겨있지 않은 채로 넘어올 수 있다.
Spring Boot에서는 Spring 3.1부터 추가된 StandardServletMultipartResolver을 사용하므로, DefaultMultipartHttpServletRequest 대신 StandardServletMultipartResolver를 사용한다.
Spring Boot에서는 starter-cache로 캐쉬도 자동 설정을 지원한다.
EhCache 2.*를 사용하고 있었다면 CacheManager 관련 별도의 Bean을 설정할 필요는 없고, 두 가지만 설정해주면 된다.
-
MainApplication에
@EnableCaching를 추가 -
application.yml에 아래의 내용을 추가해서ehcache.xml파일의 위치 지정spring.cache.ehcache.config: classpath:config/ehcache/ehcache.xml
<mvc:annotation-driven>으로 설정하던 Interceptor는 다음과 같은 방식으로 설정한다.
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
@Autowired
private ApplicationContext applicationContext;
@Override
public void addInterceptors(InterceptorRegistry registry) {
LocaleChangeInterceptor localeChangeInterceptor = new LocaleChangeInterceptor();
localeChangeInterceptor.setParamName("lang");
registry.addInterceptor(localeChangeInterceptor);
registry.addInterceptor(new KeyInfoBlockInterceptor(
applicationContext.getBean(CommonService.class)
))
.addPathPatterns("/application/**")
.addPathPatterns("/pdf/**")
.addPathPatterns("/sysadmin/**");
registry.addInterceptor(new MessageResolverInterceptor(
applicationContext.getBean("messageResolver", MessageResolver.class),
applicationContext.getBean("localeResolver", LocaleResolver.class)
))
.addPathPatterns("/application/**")
.addPathPatterns("/user/**")
.addPathPatterns("/sysadmin/**");
}
}WebMvcConfigurerAdapter 관련 주의할 점은 @EnableWebMvc를 주의해서 사용해야 한다는 점이다.
http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-web-applications.html 에 보면 다음과 같이 되어 있으니 주의하자.
If you want to keep Spring Boot MVC features, and you just want to add additional MVC configuration (interceptors, formatters, view controllers etc.) you can add your own @Configuration class of type WebMvcConfigurerAdapter, but without @EnableWebMvc.
Spring Boot MVC의 기능을 유지한채로 interceptors formatters, view controller 등을 추가할 필요가 있다면,
@Configuration애노테이션이 적용된 클래스가WebMvcConfigurerAdapter를 상속하게 하되, @EnableWebMvc 애노테이션을 붙이지 말아야 한다.
If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc
Spring Boot의 MVC 관련 자동 설정을 사용하지 않고, Spring MVC의 설정을 모두 자체적으로 정의하려면 @EnableWebMvc를 사용한다.
기존에는 AOP를 사용해서 서비스 메서드의 위치 및 이름을 기준으로 Transaction을 설정하는 방식을 사용했었다.
Spring Boot에서는 일반적으로는 서비스 클래스 또는 메서드 단위로 @Transactional 또는 @Transactional(readonly = true) 를 적용하는 방식을 사용하는데, 지금처럼 레거시를 전환할 때는 일일이 @Transactional을 붙여주는 것이 일이 많기도 하고 실수의 가능성도 높아서 기존 방식을 그대로 유지하는 것이 좋을 것 같다.
XML 기반의 AOP 방식의 Transaction 설정을 하려면 다음과 같은 처리가 필요하다.
-
starter-aop dependency 추가
build.gradle에 다음과 같이 추가
compile group: 'org.springframework.boot', name: 'spring-boot-starter-aop'
-
Auto-config에서 Transaction 관리 제외
Application.java에서 다음과 같은 애노테이션 적용
@EnableAutoConfiguration(exclude = { // MyBatis 사용 시 DataSource 구현체를 직접 등록해야 하므로 아래 내용을 exclude 처리 DataSourceTransactionManagerAutoConfiguration.class, DataSourceAutoConfiguration.class }) @ImportResource({ "classpath:/config/spring/context-transaction.xml" })
-
다음과 같은 AOP 방식의 xml 설정 파일을 위 @ImportResource로 지정한 위치에 저장
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd"> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="dataSource" /> </bean> <tx:advice id="txAdvice" transaction-manager="transactionManager"> <tx:attributes> <tx:method name="*TxNew" propagation="REQUIRES_NEW" rollback-for="Throwable"/> <tx:method name="get*" propagation="SUPPORTS" read-only="true"/> <tx:method name="retrieve*" propagation="SUPPORTS" read-only="true"/> <tx:method name="select*" propagation="SUPPORTS" read-only="true"/> <tx:method name="find*" propagation="SUPPORTS" read-only="true"/> <tx:method name="*" propagation="REQUIRED" rollback-for="Throwable"/> </tx:attributes> </tx:advice> <aop:config> <aop:pointcut id="serviceMethod" expression="execution(* kr.co.xxxxx.yyyyy.*..*Service.*(..))" /> <aop:advisor advice-ref="txAdvice" pointcut-ref="serviceMethod"/> </aop:config> </beans>
<tx:advice ...> 를 자바 설정으로 푸는 것이 사실 상 불가능하므로 그냥 xml 적용
HomoEfficio가 작성한 이 저작물은
크리에이티브 커먼즈 저작자표시-비영리-동일조건변경허락 4.0 국제 라이선스에 따라 이용할 수 있습니다.