Spring MVC cors 크로스 도메인 구현 소스 코드의 샘플 코드 분석

이 글에서는 주로 Spring MVC Cors 크로스 도메인 구현 소스 코드 파싱을 소개합니다. 참고할만한 가치가 아주 좋습니다.

용어설명: Cross-Origin Resource Sharing(Cross-Origin Resource Sharing)

간단히 설명하겠습니다. , 프로토콜, IP가 있는 한, http 방법의 차이점은 도메인 간입니다.

spring MVC는 4.2부터 도메인 간 지원을 추가했습니다.

크로스 도메인의 구체적인 정의는 Mozilla로 이동하여

사용 사례

3가지가 있습니다. spring mvc에서 도메인 간 사용 방식:

web.xml에서 CorsFilter 구성

<filter>
 <filter-name>cors</filter-name>
 <filter-class>org.springframework.web.filter.CorsFilter</filter-class>
</filter>
<filter-mapping>
 <filter-name>cors</filter-name>
 <url-pattern>/*</url-pattern>
</filter-mapping>

xml에서 구성

// 简单配置，未配置的均使用默认值，就是全面放开
<mvc:cors> 
 <mvc:mapping path="/**" /> 
</mvc:cors> 
// 这是一个全量配置
<mvc:cors> 
 <mvc:mapping path="/api/**" 
  allowed-origins="http://domain1.com, http://www.php.cn/" 
  allowed-methods="GET, PUT" 
  allowed-headers="header1, header2, header3" 
  exposed-headers="header1, header2" allow-credentials="false" 
  max-age="123" /> 
  <mvc:mapping path="/resources/**" 
  allowed-origins="http://domain1.com" /> 
</mvc:cors>

주석 사용

@CrossOrigin(maxAge = 3600) 
@RestController 
@RequestMapping("/account") 
public class AccountController { 
 @CrossOrigin("http://domain2.com") 
 @RequestMapping("/{id}") 
 public Account retrieve(@PathVariable Long id) { 
  // ... 
 } 
}

관련 개념

• CorsConfiguration은 다음과 같은 포조입니다. 교차 도메인 구성 정보를 구체적으로 캡슐화합니다.

• CorsConfigurationSource 요청 및 교차 도메인 구성 정보를 매핑하기 위한 컨테이너

• 특정 교차 도메인 작업을 위한 CorsProcessor 클래스

• Nuogan 크로스 도메인 구성 정보 초기화 클래스

• Nuogan 크로스 도메인 어댑터

관련 Java 클래스 :

정보를 캡슐화하는 Pojo

CorsConfiguration

요청 및 도메인 간 구성을 저장하는 컨테이너 정보

CorsConfigurationSource, UrlBasedCorsConfigurationSource

특정 처리 클래스

CorsProcessor, DefaultCorsProcessor

CorsUtils

OncePerRequestFilter 인터페이스를 구현하는 어댑터

CorsFilter

는 요청이 cors인지 확인하고 해당 어댑터를 캡슐화합니다

AbstractHandlerMapping, 내부 클래스 PreFlightHandler, CorsInterceptor 포함

CrossOrigin 주석 정보 읽기

AbstractHandlerMethodMapping, RequestMappingHandlerMapping

교차 읽기 xml 파일의 도메인 구성 정보

CorsBeanDefinitionParser

교차 도메인 등록 보조 클래스

MvcNamespaceUtils

디버그 분석

코드를 이해하려면 먼저 크로스 도메인 정보를 캡슐화하는 pojo를 이해해야 합니다. --CorsConfiguration

다음은 몇 가지 크로스 외에 매우 간단한 포조입니다. -도메인 해당 속성에는 Combine, checkOrigin, checkHttpMethod, checkHeaders만 있습니다.

속성은 여러 값과 조합하여 사용됩니다.

 // CorsConfiguration
 public static final String ALL = "*";
 // 允许的请求源
 private List<String> allowedOrigins;
 // 允许的http方法
 private List<String> allowedMethods;
 // 允许的请求头
 private List<String> allowedHeaders;
 // 返回的响应头
 private List<String> exposedHeaders;
 // 是否允许携带cookies
 private Boolean allowCredentials;
 // 预请求的存活有效期
 private Long maxAge;

결합은 도메인 간 정보를 병합하는 것입니다.

세 가지 확인 방법은 요청에 포함된 정보가

구성 초기화

시스템 시작 시 CorsBeanDefinitionParser를 통해 구성 파일을 구문 분석합니다.

RequestMappingHandlerMapping을 로드할 때, 초기화Bean의 afterProperties를 통해 후크는 initCorsConfiguration을 호출하여 주석 정보를 초기화합니다.

구성 파일 초기화

의 구문 분석 메소드에 중단점을 넣습니다. CorsBeanDefinitionParser 클래스.

CorsBeanDefinitionParser의 호출 스택

코드를 통해 파싱하는 모습을 보실 수 있습니다

Cross-domain 정보 구성은 경로 단위로 여러 매핑 관계를 정의할 수 있습니다.

파싱 중 정의가 없으면 기본 설정이 사용됩니다

// CorsBeanDefinitionParser
if (mappings.isEmpty()) {
 // 最简配置时的默认设置
 CorsConfiguration config = new CorsConfiguration();
 config.setAllowedOrigins(DEFAULT_ALLOWED_ORIGINS);
 config.setAllowedMethods(DEFAULT_ALLOWED_METHODS);
 config.setAllowedHeaders(DEFAULT_ALLOWED_HEADERS);
 config.setAllowCredentials(DEFAULT_ALLOW_CREDENTIALS);
 config.setMaxAge(DEFAULT_MAX_AGE);
 corsConfigurations.put("/**", config);
}else {
 // 单个mapping的处理
 for (Element mapping : mappings) {
  CorsConfiguration config = new CorsConfiguration();
  if (mapping.hasAttribute("allowed-origins")) {
   String[] allowedOrigins = StringUtils.tokenizeToStringArray(mapping.getAttribute("allowed-origins"), ",");
   config.setAllowedOrigins(Arrays.asList(allowedOrigins));
  }
  // ...
 }

파싱 완료 후 MvcNamespaceUtils.registerCorsConfiguratoions를 통해 등록

다음은 Spring Bean 컨테이너 관리의 통합 프로세스이며, 이제 BeanDefinition으로 변환된 후 인스턴스화됩니다.

// MvcNamespaceUtils
 public static RuntimeBeanReference registerCorsConfigurations(Map<String, CorsConfiguration> corsConfigurations, ParserContext parserContext, Object source) {
  if (!parserContext.getRegistry().containsBeanDefinition(CORS_CONFIGURATION_BEAN_NAME)) {
   RootBeanDefinition corsConfigurationsDef = new RootBeanDefinition(LinkedHashMap.class);
   corsConfigurationsDef.setSource(source);
   corsConfigurationsDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
   if (corsConfigurations != null) {
    corsConfigurationsDef.getConstructorArgumentValues().addIndexedArgumentValue(0, corsConfigurations);
   }
   parserContext.getReaderContext().getRegistry().registerBeanDefinition(CORS_CONFIGURATION_BEAN_NAME, corsConfigurationsDef);
   parserContext.registerComponent(new BeanComponentDefinition(corsConfigurationsDef, CORS_CONFIGURATION_BEAN_NAME));
  }
  else if (corsConfigurations != null) {
   BeanDefinition corsConfigurationsDef = parserContext.getRegistry().getBeanDefinition(CORS_CONFIGURATION_BEAN_NAME);   
   corsConfigurationsDef.getConstructorArgumentValues().addIndexedArgumentValue(0, corsConfigurations);
  }
  return new RuntimeBeanReference(CORS_CONFIGURATION_BEAN_NAME);
 }

주석 초기화

RequestMappingHandlerMapping의 initCorsConfiguration에서 CrossOrigin이라는 주석이 달린 메소드를 스캔하고 정보를 추출합니다.

RequestMappingHandlerMapping_initCorsConfiguration

// RequestMappingHandlerMapping
 @Override
 protected CorsConfiguration initCorsConfiguration(Object handler, Method method, RequestMappingInfo mappingInfo) {
  HandlerMethod handlerMethod = createHandlerMethod(handler, method);
  CrossOrigin typeAnnotation = AnnotatedElementUtils.findMergedAnnotation(handlerMethod.getBeanType(), CrossOrigin.class);
  CrossOrigin methodAnnotation = AnnotatedElementUtils.findMergedAnnotation(method, CrossOrigin.class);
  if (typeAnnotation == null && methodAnnotation == null) {
   return null;
  }
  CorsConfiguration config = new CorsConfiguration();
  updateCorsConfig(config, typeAnnotation);
  updateCorsConfig(config, methodAnnotation);
  // ... 设置默认值
  return config;
 }

교차 출처 요청 처리

HandlerMapping은 검색 프로세서 처리를 정상적으로 마친 후 AbstractHandlerMapping.getHandler에서 도메인 간 요청인지 확인합니다. 두 가지 방법으로 처리되는 경우:

• 사전 요청인 경우 프로세서는 내부 클래스 PreFlightHandler로 대체됩니다

• 정상 요청인 경우 CorsInterceptor 인터셉터를 추가합니다

拿到处理器后，通过请求头是否包含Origin判断是否跨域,如果是跨域,通过UrlBasedCorsConfigurationSource获取跨域配置信息，并委托getCorsHandlerExecutionChain处理

UrlBasedCorsConfigurationSource是CorsConfigurationSource的实现，从类名就可以猜出这边request与CorsConfiguration的映射是基于url的。getCorsConfiguration中提取request中的url后，逐一验证配置是否匹配url。

 // UrlBasedCorsConfigurationSource
 public CorsConfiguration getCorsConfiguration(HttpServletRequest request) {
  String lookupPath = this.urlPathHelper.getLookupPathForRequest(request);
  for(Map.Entry<String, CorsConfiguration> entry : this.corsConfigurations.entrySet()) {
   if (this.pathMatcher.match(entry.getKey(), lookupPath)) {
    return entry.getValue();
   }
  }
  return null;
 }
 // AbstractHandlerMapping
 public final HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception {
  Object handler = getHandlerInternal(request);
  // ...
  HandlerExecutionChain executionChain = getHandlerExecutionChain(handler, request);
  if (CorsUtils.isCorsRequest(request)) {
   CorsConfiguration globalConfig = this.corsConfigSource.getCorsConfiguration(request);
   CorsConfiguration handlerConfig = getCorsConfiguration(handler, request);
   CorsConfiguration config = (globalConfig != null ? globalConfig.combine(handlerConfig) : handlerConfig);
   executionChain = getCorsHandlerExecutionChain(request, executionChain, config);
  }
  return executionChain;
 }
 // HttpHeaders
 public static final String ORIGIN = "Origin";
 // CorsUtils
 public static boolean isCorsRequest(HttpServletRequest request) {
  return (request.getHeader(HttpHeaders.ORIGIN) != null);
 }

通过请求头的http方法是否options判断是否预请求，如果是使用PreFlightRequest替换处理器；如果是普通请求，添加一个拦截器CorsInterceptor。

PreFlightRequest是CorsProcessor对于HttpRequestHandler的一个适配器。这样HandlerAdapter直接使用HttpRequestHandlerAdapter处理。

CorsInterceptor 是CorsProcessor对于HnalderInterceptorAdapter的适配器。

 // AbstractHandlerMapping
 protected HandlerExecutionChain getCorsHandlerExecutionChain(HttpServletRequest request,
   HandlerExecutionChain chain, CorsConfiguration config) {
  if (CorsUtils.isPreFlightRequest(request)) {
   HandlerInterceptor[] interceptors = chain.getInterceptors();
   chain = new HandlerExecutionChain(new PreFlightHandler(config), interceptors);
  }
  else {
   chain.addInterceptor(new CorsInterceptor(config));
  }
  return chain;
 }
 private class PreFlightHandler implements HttpRequestHandler {
  private final CorsConfiguration config;
  public PreFlightHandler(CorsConfiguration config) {
   this.config = config;
  }
  @Override
  public void handleRequest(HttpServletRequest request, HttpServletResponse response)
    throws IOException {

   corsProcessor.processRequest(this.config, request, response);
  }
 }
 private class CorsInterceptor extends HandlerInterceptorAdapter {
  private final CorsConfiguration config;
  public CorsInterceptor(CorsConfiguration config) {
   this.config = config;
  }
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
    Object handler) throws Exception {

   return corsProcessor.processRequest(this.config, request, response);
  }
 }
 // CorsUtils
 public static boolean isPreFlightRequest(HttpServletRequest request) {
  return (isCorsRequest(request) && request.getMethod().equals(HttpMethod.OPTIONS.name()) &&
    request.getHeader(HttpHeaders.ACCESS_CONTROL_REQUEST_METHOD) != null);
 }

위 내용은 Spring MVC cors 크로스 도메인 구현 소스 코드의 샘플 코드 분석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!