SpringBoot解决CORS跨域问题

说明

有时候在项目开发阶段的时候,前端在使用ajax请求的时候会存在跨域问题，这里记录一下在dev开发环境解决跨域问题的几种方法,如果是在生产环境,可以使用中间件来解决跨域问题,如nginx的反向代理。

第一种方法

这种方法是在类或者方法上加上@CrossOrigin注解来解决跨域问题,
加在类上就可以不用在该类里面的每个方法上面都加上该注解，如果是只允许该方法允许跨域，那么可以只在该方法上面加上该注解。

代码

package com.project.controllers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
//@CrossOrigin
public class TestController {
    
    @GetMapping("/list")
    @CrossOrigin
    public String list(){
        return "helloword";
    }
}

第二种方法

使用该方法时，第一种注解的方法就可以不用使用了。
添加CORS过滤器,在项目config文件夹下面建一个CorsConfig类。代码如下:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;

@Configuration
public class CorsConfig {

    @Bean
    public CorsFilter corsFilter(){
        CorsConfiguration corsConfiguration=new CorsConfiguration();
        //允许跨域的主机地址,*表示所有都可以
        corsConfiguration.addAllowedOrigin("*");
        //允许跨域的请求头
        corsConfiguration.addAllowedHeader("*");
        //允许跨域的请求方法
        corsConfiguration.addAllowedMethod("*");
        UrlBasedCorsConfigurationSource source=new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**",corsConfiguration);
        return new CorsFilter(source);
    }
}

第三种方法

使用该方法时，第一种注解的方法就可以不用使用了。
实现WebMvcConfigurer接口,重写addCorsMappings方法,在项目config文件夹下面建一个CorsConfig类。代码如下:

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class CorsConfig implements WebMvcConfigurer {


    @Override
    public void addCorsMappings(CorsRegistry corsRegistry) {
        corsRegistry.addMapping("/**")
                    .allowedOrigins("*")//允许跨域的主机地址,*表示所有都可以
                    .allowedHeaders("*")//允许跨域的请求头
                    .allowedMethods("GET","POST","PUT","DELETE","HEAD","OPTIONS")//允许跨域的请求方法
                    .allowCredentials(true)//是否允许携带cookie,true表示允许
                    .maxAge(3600);//单位为秒, 重新预检验跨域的缓存时间,表示该时间内，不用重新检验跨域
    }
}

第四种方法

使用该方法时，第一种注解的方法就可以不用使用了。
实现Filter接口，重写里面的doFilter方法。

import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Component
public class CorsConfig implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletResponse res = (HttpServletResponse) response;
        res.addHeader("Access-Control-Allow-Credentials", "true");//是否允许携带cookie,true表示允许
        res.addHeader("Access-Control-Allow-Origin", "*");//允许跨域的主机地址,*表示所有都可以
        res.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");//允许跨域的请求方法
        res.addHeader("Access-Control-Allow-Headers", "Content-Type,X-CAF-Authorization-Token,sessionToken,X-TOKEN");//允许跨域的请求头
        if (((HttpServletRequest) request).getMethod().equals("OPTIONS")) {
            response.getWriter().println("ok");
            return;
        }
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

先记录这几种方法，等以后有别的方法了，在加上。