com.github.jerryxia.devhelper.spring.boot.autoconfigure.DevHelperAutoConfiguration Maven / Gradle / Ivy
/**
*
*/
package com.github.jerryxia.devhelper.spring.boot.autoconfigure;
import java.util.ArrayList;
import java.util.Map;
import javax.servlet.DispatcherType;
import javax.servlet.FilterRegistration;
import javax.servlet.ServletContext;
import javax.servlet.ServletRegistration;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import com.github.jerryxia.devhelper.requestcapture.support.servlet.RequestCaptureFilter;
import com.github.jerryxia.devhelper.requestcapture.support.servlet.RequestCaptureWebServlet;
import com.github.jerryxia.devhelper.snoop.support.servlet.SnoopServlet;
import com.github.jerryxia.devhelper.web.filter.RequestIdInitFilter;
import com.github.jerryxia.devhelper.web.interceptor.RequestIdInitInterceptor;
import com.github.jerryxia.devhelper.web.interceptor.RequestResponseLogInterceptor;
import com.github.jerryxia.devhelper.web.listener.BootstrapperContextListener;
/**
* @author guqk
*
*/
@Configuration
@EnableConfigurationProperties(DevHelperProperties.class)
@ConditionalOnWebApplication
public class DevHelperAutoConfiguration extends WebMvcConfigurerAdapter {
public static final String REQUEST_ID_INIT_FILTER_REGISTRATION_BEAN_NAME = "devhelper-requestIdInitFilter-registration";
public static final String REQUEST_CAPTURE_FILTER_REGISTRATION_BEAN_NAME = "devhelper-requestCaptureFilter-registration";
public static final String REQUEST_CAPTURE_WEB_SERVLET_REGISTRATION_BEAN_NAME = "devhelper-requestCaptureWebServlet-registration";
public static final String SNOOP_SERVLET_REGISTRATION_BEAN_NAME = "devhelper-snoopServlet-registration";
@Bean(name = REQUEST_ID_INIT_FILTER_REGISTRATION_BEAN_NAME)
@ConditionalOnMissingBean(name = REQUEST_ID_INIT_FILTER_REGISTRATION_BEAN_NAME)
public FilterRegistrationBean requestIdInitFilter(DevHelperProperties properties, ServletContext servletContext) {
String filterName = "requestIdInitFilter";
RequestIdInitFilterProperties config = properties.getRequestIdInit();
FilterRegistrationBean registrationBean = new FilterRegistrationBean();
RequestIdInitFilter filter = new RequestIdInitFilter();
registrationBean.setFilter(filter);
registrationBean.setName(filterName);
if (config.getRequestIdResponseHeaderName() != null) {
registrationBean.addInitParameter(RequestIdInitFilter.PARAM_NAME_REQUEST_ID_RESPONSE_HEADER_NAME,
config.getRequestIdResponseHeaderName());
}
registrationBean.addUrlPatterns("/*");
registrationBean.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.ASYNC);
FilterRegistration filterRegistration = servletContext.getFilterRegistration(filterName);
if (filterRegistration != null) {
// if webapp deployed as war in a container with MonitoringFilter already added by web-fragment.xml,
// do not try to add it again
registrationBean.setEnabled(false);
for (Map.Entry entry : registrationBean.getInitParameters().entrySet()) {
filterRegistration.setInitParameter(entry.getKey(), entry.getValue());
}
}
return registrationBean;
}
@Bean(name = REQUEST_CAPTURE_FILTER_REGISTRATION_BEAN_NAME)
@ConditionalOnMissingBean(name = REQUEST_CAPTURE_FILTER_REGISTRATION_BEAN_NAME)
public FilterRegistrationBean requestCaptureFilter(DevHelperProperties properties, ServletContext servletContext) {
String filterName = "requestCaptureFilter";
RequestCaptureFilterProperties config = properties.getRequestCapture();
FilterRegistrationBean registrationBean = new FilterRegistrationBean();
RequestCaptureFilter filter = new RequestCaptureFilter();
filter.setIncludeClientInfo(true);
filter.setIncludeQueryString(true);
filter.setIncludePayload(true);
filter.setIncludeHeaders(true);
filter.setMaxPayloadLength(1024 * 10);
registrationBean.setFilter(filter);
registrationBean.setName(filterName);
if (config.isEnabled() != null) {
registrationBean.addInitParameter(RequestCaptureFilter.PARAM_NAME_ENABLED, config.isEnabled().toString());
}
if (config.getExclusions() != null) {
registrationBean.addInitParameter(RequestCaptureFilter.PARAM_NAME_EXCLUSIONS, config.getExclusions());
}
if (config.getReplayRequestIdRequestHeaderName() != null) {
registrationBean.addInitParameter(RequestCaptureFilter.PARAM_NAME_REPLAY_REQUEST_ID_REQUEST_HEADER_NAME,
config.getReplayRequestIdRequestHeaderName());
}
registrationBean.addUrlPatterns("/*");
registrationBean.setDispatcherTypes(DispatcherType.REQUEST);
FilterRegistration filterRegistration = servletContext.getFilterRegistration(filterName);
if (filterRegistration != null) {
// if webapp deployed as war in a container with MonitoringFilter already added by web-fragment.xml,
// do not try to add it again
registrationBean.setEnabled(false);
for (Map.Entry entry : registrationBean.getInitParameters().entrySet()) {
filterRegistration.setInitParameter(entry.getKey(), entry.getValue());
}
}
return registrationBean;
}
@Bean(name = REQUEST_CAPTURE_WEB_SERVLET_REGISTRATION_BEAN_NAME)
@ConditionalOnMissingBean(name = REQUEST_CAPTURE_WEB_SERVLET_REGISTRATION_BEAN_NAME)
public ServletRegistrationBean requestCaptureWebServlet(DevHelperProperties properties,
ServletContext servletContext) {
String servletName = "requestCaptureWebServlet";
RequestCaptureWebServletProperties config = properties.getRequestCaptureServlet();
ServletRegistrationBean registrationBean = new ServletRegistrationBean();
RequestCaptureWebServlet servlet = new RequestCaptureWebServlet();
registrationBean.setServlet(servlet);
registrationBean.setName(servletName);
if (config.getUrlPattern() != null) {
registrationBean.addUrlMappings(config.getUrlPattern());
} else {
registrationBean.addUrlMappings("/requestcapture/*");
}
ServletRegistration servletRegistration = servletContext.getServletRegistration(servletName);
if (servletRegistration != null) {
// if webapp deployed as war in a container with MonitoringFilter and SessionListener already added by
// web-fragment.xml,
// do not add again
registrationBean.setEnabled(false);
for (Map.Entry entry : registrationBean.getInitParameters().entrySet()) {
servletRegistration.setInitParameter(entry.getKey(), entry.getValue());
}
}
return registrationBean;
}
@Bean(name = SNOOP_SERVLET_REGISTRATION_BEAN_NAME)
@ConditionalOnMissingBean(name = SNOOP_SERVLET_REGISTRATION_BEAN_NAME)
public ServletRegistrationBean snoopServlet(DevHelperProperties properties,
ServletContext servletContext) {
String servletName = "snoopServlet";
SnoopServletProperties config = properties.getSnoopServlet();
ServletRegistrationBean registrationBean = new ServletRegistrationBean();
SnoopServlet servlet = new SnoopServlet();
registrationBean.setServlet(servlet);
registrationBean.setName(servletName);
if (config.getUrlPattern() != null) {
registrationBean.addUrlMappings(config.getUrlPattern());
} else {
registrationBean.addUrlMappings("/requestcapture/snoop");
}
ServletRegistration servletRegistration = servletContext.getServletRegistration(servletName);
if (servletRegistration != null) {
// if webapp deployed as war in a container with MonitoringFilter and SessionListener already added by
// web-fragment.xml,
// do not add again
registrationBean.setEnabled(false);
for (Map.Entry entry : registrationBean.getInitParameters().entrySet()) {
servletRegistration.setInitParameter(entry.getKey(), entry.getValue());
}
}
return registrationBean;
}
@Bean
public ServletListenerRegistrationBean bootstrapperContextListener() {
String listenerName = "bootstrapperContextListener";
ServletListenerRegistrationBean registrationBean = new ServletListenerRegistrationBean();
BootstrapperContextListener listener = new BootstrapperContextListener();
registrationBean.setListener(listener);
registrationBean.setName(listenerName);
return registrationBean;
}
@Autowired
private DevHelperProperties devHelperProperties;
@Bean(initMethod = "init")
public RequestIdInitInterceptor requestIdInitInterceptor() {
RequestIdInitFilterProperties config = devHelperProperties.getRequestIdInit();
RequestIdInitInterceptor interceptor = new RequestIdInitInterceptor();
interceptor.setRequestIdResponseHeaderName(config.getRequestIdResponseHeaderName());
return interceptor;
}
@Bean(initMethod = "init")
public RequestResponseLogInterceptor requestResponseLogInterceptor() {
RequestResponseLogProperties config = devHelperProperties.getRequestResponseLog();
RequestResponseLogInterceptor interceptor = new RequestResponseLogInterceptor();
if(config.getEnabled() != null) {
interceptor.setEnabled(config.getEnabled().booleanValue());
}
if(!StringUtils.isEmpty(config.getLogRequestHeaderNames())) {
String[] reqheadNames = config.getLogRequestHeaderNames().split(",");
ArrayList list = new ArrayList();
for(String reqHeadName : reqheadNames) {
String trimReqHeadName = reqHeadName.trim();
if(!StringUtils.isEmpty(trimReqHeadName)) {
list.add(trimReqHeadName);
}
}
interceptor.setLogRequestHeaderNames(list.toArray(new String[list.size()]));
}
return interceptor;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 多个拦截器组成一个拦截器链
// addPathPatterns 用于添加拦截规则
// excludePathPatterns 用户排除拦截
registry.addInterceptor(requestIdInitInterceptor()).addPathPatterns("/**");
registry.addInterceptor(requestResponseLogInterceptor()).addPathPatterns("/**");
}
}