package cn.iocoder.yudao.framework.web.config; import cn.hutool.core.util.StrUtil; import cn.iocoder.yudao.framework.common.biz.infra.logger.ApiErrorLogCommonApi; import cn.iocoder.yudao.framework.common.enums.WebFilterOrderEnum; import cn.iocoder.yudao.framework.web.core.filter.CacheRequestBodyFilter; import cn.iocoder.yudao.framework.web.core.filter.DemoFilter; import cn.iocoder.yudao.framework.web.core.handler.GlobalExceptionHandler; import cn.iocoder.yudao.framework.web.core.handler.GlobalResponseBodyHandler; import cn.iocoder.yudao.framework.web.core.util.WebFrameworkUtils; import com.google.common.collect.Maps; import jakarta.servlet.Filter; 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.webmvc.autoconfigure.WebMvcRegistrations; import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.restclient.RestTemplateBuilder; import org.springframework.boot.web.servlet.FilterRegistrationBean; import org.springframework.context.annotation.Bean; import org.springframework.core.annotation.Order; 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.mvc.method.annotation.RequestMappingHandlerMapping; import java.util.Map; import java.util.function.Predicate; @AutoConfiguration @EnableConfigurationProperties(WebProperties.class) public class YudaoWebAutoConfiguration { /** * 应用名 */ @Value("${spring.application.name}") private String applicationName; @Bean public WebMvcRegistrations webMvcRegistrations(WebProperties webProperties) { return new WebMvcRegistrations() { @Override public RequestMappingHandlerMapping getRequestMappingHandlerMapping() { RequestMappingHandlerMapping mapping = new RequestMappingHandlerMapping(); // 实例化时就带上前缀 mapping.setPathPrefixes(buildPathPrefixes(webProperties)); return mapping; } /** * 构建 prefix → 匹配条件的映射 */ private Map>> buildPathPrefixes(WebProperties webProperties) { AntPathMatcher antPathMatcher = new AntPathMatcher("."); Map>> pathPrefixes = Maps.newLinkedHashMapWithExpectedSize(2); putPathPrefix(pathPrefixes, webProperties.getAdminApi(), antPathMatcher); putPathPrefix(pathPrefixes, webProperties.getAppApi(), antPathMatcher); return pathPrefixes; } /** * 设置 API 前缀,仅仅匹配 controller 包下的 */ private void putPathPrefix(Map>> pathPrefixes, WebProperties.Api api, AntPathMatcher matcher) { if (api == null || StrUtil.isEmpty(api.getPrefix())) { return; } pathPrefixes.put(api.getPrefix(), // api 前缀 clazz -> clazz.isAnnotationPresent(RestController.class) && matcher.match(api.getController(), clazz.getPackage().getName())); } }; } @Bean @SuppressWarnings("SpringJavaInjectionPointsAutowiringInspection") public GlobalExceptionHandler globalExceptionHandler(ApiErrorLogCommonApi apiErrorLogApi) { return new GlobalExceptionHandler(applicationName, apiErrorLogApi); } @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 @Order(value = WebFilterOrderEnum.CORS_FILTER) // 特殊:修复因执行顺序影响到跨域配置不生效问题 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 = "yudao.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 RestTemplateBuilder#build} */ @Bean @ConditionalOnMissingBean public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder) { return restTemplateBuilder.build(); } }