package com.iailab.framework.web.config; import com.iailab.framework.apilog.core.service.ApiErrorLogFrameworkService; import com.iailab.framework.common.enums.WebFilterOrderEnum; import com.iailab.framework.web.core.filter.CacheRequestBodyFilter; import com.iailab.framework.web.core.filter.DemoFilter; import com.iailab.framework.web.core.handler.GlobalExceptionHandler; import com.iailab.framework.web.core.handler.GlobalResponseBodyHandler; import com.iailab.framework.web.core.util.WebFrameworkUtils; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.util.AntPathMatcher; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.client.RestTemplate; import org.springframework.web.cors.CorsConfiguration; import org.springframework.web.cors.UrlBasedCorsConfigurationSource; import org.springframework.web.filter.CorsFilter; import org.springframework.web.servlet.config.annotation.PathMatchConfigurer; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import javax.annotation.Resource; import javax.servlet.Filter; @AutoConfiguration @EnableConfigurationProperties(WebProperties.class) public class IailabWebAutoConfiguration implements WebMvcConfigurer { @Resource private WebProperties webProperties; /** * 应用名 */ @Value("${spring.application.name}") private String applicationName; @Override public void configurePathMatch(PathMatchConfigurer configurer) { configurePathMatch(configurer, webProperties.getAdminApi()); configurePathMatch(configurer, webProperties.getAppApi()); } /** * 设置 API 前缀,仅仅匹配 controller 包下的 * * @param configurer 配置 * @param api API 配置 */ private void configurePathMatch(PathMatchConfigurer configurer, WebProperties.Api api) { AntPathMatcher antPathMatcher = new AntPathMatcher("."); configurer.addPathPrefix(api.getPrefix(), clazz -> clazz.isAnnotationPresent(RestController.class) && antPathMatcher.match(api.getController(), clazz.getPackage().getName())); // 仅仅匹配 controller 包 } @Bean public GlobalExceptionHandler globalExceptionHandler(ApiErrorLogFrameworkService ApiErrorLogFrameworkService) { return new GlobalExceptionHandler(applicationName, ApiErrorLogFrameworkService); } @Bean public GlobalResponseBodyHandler globalResponseBodyHandler() { return new GlobalResponseBodyHandler(); } @Bean @SuppressWarnings("InstantiationOfUtilityClass") public WebFrameworkUtils webFrameworkUtils(WebProperties webProperties) { // 由于 WebFrameworkUtils 需要使用到 webProperties 属性,所以注册为一个 Bean return new WebFrameworkUtils(webProperties); } // ========== Filter 相关 ========== /** * 创建 CorsFilter Bean,解决跨域问题 */ @Bean public FilterRegistrationBean corsFilterBean() { // 创建 CorsConfiguration 对象 CorsConfiguration config = new CorsConfiguration(); config.setAllowCredentials(true); config.addAllowedOriginPattern("*"); // 设置访问源地址 config.addAllowedHeader("*"); // 设置访问源请求头 config.addAllowedMethod("*"); // 设置访问源请求方法 // 创建 UrlBasedCorsConfigurationSource 对象 UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(); source.registerCorsConfiguration("/**", config); // 对接口配置跨域设置 return createFilterBean(new CorsFilter(source), WebFilterOrderEnum.CORS_FILTER); } /** * 创建 RequestBodyCacheFilter Bean,可重复读取请求内容 */ @Bean public FilterRegistrationBean requestBodyCacheFilter() { return createFilterBean(new CacheRequestBodyFilter(), WebFilterOrderEnum.REQUEST_BODY_CACHE_FILTER); } /** * 创建 DemoFilter Bean,演示模式 */ @Bean @ConditionalOnProperty(value = "iailab.demo", havingValue = "true") public FilterRegistrationBean demoFilter() { return createFilterBean(new DemoFilter(), WebFilterOrderEnum.DEMO_FILTER); } public static FilterRegistrationBean createFilterBean(T filter, Integer order) { FilterRegistrationBean bean = new FilterRegistrationBean<>(filter); bean.setOrder(order); return bean; } /** * 创建 RestTemplate 实例 * * @param restTemplateBuilder {@link RestTemplateAutoConfiguration#restTemplateBuilder} */ @Bean @ConditionalOnMissingBean public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder) { return restTemplateBuilder.build(); } }