spring boot实战之跨域(CORS)支持

背景

前后端分离架构,前端anglerjs,后端spring boot,使用shiro作为权限控制,已配置通用跨域请求支持。
前端调用接口时部分情况正常,部分情况出现跨域请求不支持情况,错误信息如下:

Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'xxxx' is therefore not allowed access.

配置错了?

首先,想到的就是对跨域请求支持的配置是错误的,尝试着替换不同的跨域支持配置,有以下几种:
1、继承WebMvcConfigurerAdapter
@Configuration
public class AppConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowCredentials(true).allowedHeaders("Origin, X-Requested-With, Content-Type, Accept")
                .allowedMethods("GET", "POST", "DELETE", "PUT", "OPTIONS")
                .maxAge(3600);
    }
}

2、配置WebMvcConfigurer

@Bean
public WebMvcConfigurer corsConfigurer() {
    return new WebMvcConfigurerAdapter() {
        @Override
        public void addCorsMappings(CorsRegistry registry) {
            registry.addMapping("/**").allowedOrigins("*")
                    .allowedMethods("*").allowedHeaders("*")
                    .allowCredentials(true)
                    .exposedHeaders(HttpHeaders.SET_COOKIE).maxAge(3600L);
        }
    };
}

...

CORS support in Spring Framework内的方式都尝试了一遍,发现问题仍然未解决,看到文档内的一个点

If you are using Spring Security, make sure to enable CORS at Spring Security level as well to allow it to leverage the configuration defined at Spring MVC level.

大概意思就是使用Spring Security要进行特殊的配置来支持CORS。而当前项目内使用的是shiro,是不是权限控制导致的问题?检查shiro相关代码,果然找到了问题,在loginFilter内会判断如果未登录,就通过response写回未登录提示,代码如下:

Subject subject = SecurityUtils.getSubject();
if (!subject.isAuthenticated()) {
    HttpServletResponse resp = (HttpServletResponse) response;
    String contentType = "application/json";
    resp.setContentType(contentType);
    resp.setCharacterEncoding("UTF-8");
    
    Map<String, String> map = Maps.newLinkedHashMap();
    map.put("code", "xxx");
    map.put("msg", "xxx");
    String result = JacksonHelper.toJson(map);
    PrintWriter out = resp.getWriter();
    try{
        out.print(result);
        out.flush();
    } finally {
        out.close();
    }
    return;
}

那就添加上跨域支持

resp.setHeader("Access-Control-Allow-Credentials", "true");
resp.setHeader("Access-Control-Allow-Origin",request.getHeader("Origin"));

本来以为ok了,但是前端是不报错了,但并不能获得对应接口期望的结果,而是一直收到

{"code":"xxx","msg":"xxx"}

显然是被登录拦截了,但是明明已经登录,而且有的接口可以正常通过登录拦截,为什么部分接口会出现不能登录的情况呢?

明明登录了,为什么被loginFilter拦截?

遇到了问题就要想办法解决,首先就是怀疑客户端sessionId未被正常保存,在loginFilter内添加日志打印sessionID,发现每次的sessionID都不一样,问题清晰了一些,前端并未正确的保持登录状态,对比前端两个调用接口的代码,发现正常的是get请求,post请求不正常,通过在网上搜索,发现ajax post跨域请求时,默认是不携带浏览器的cookie的,也就是每次请求都会生成一个新的session,因此post请求都被登录拦截。解决办法如下:

$.ajax({
    type:"POST",
    url:"",
    data:{},
    crossDomain:true,
    xhrFields: {  withCredentials: true  },
    success:function(data){
        
    },
    error:function(data){
        
    }
})

配置crossDomain:true 和 xhrFields: { withCredentials: true }就可以让请求正常携带cookie。

一个完整可用方案

1、配置支持跨域请求(多种方式自由选择,推荐使用下面的方式)

@Configuration
public class WebConfig {

    /**
     * 跨域请求支持
     */
    @Bean
    public WebMvcConfigurer corsConfigurer() {
        return new WebMvcConfigurerAdapter() {
            @Override
            public void addCorsMappings(CorsRegistry registry) {
                registry.addMapping("/**").allowedOrigins("*")
                        .allowedMethods("*").allowedHeaders("*")
                        .allowCredentials(true)
                        .exposedHeaders(HttpHeaders.SET_COOKIE).maxAge(3600L);
            }
        };
    }
}

2、前端ajax post请求时添加xhrFields: { withCredentials: true }

$.ajax({
    type:"POST",
    url:"",
    data:{},
    crossDomain:true,
    xhrFields: {  withCredentials: true  },
    success:function(data){
        
    },
    error:function(data){
        
    }
})

3、检查权限控制代码,看是否有特殊处理的地方,未添加跨域支持。如上文所提,登录拦截直接通过response写回未登录提示;
使用spring-security框架时也要添加特殊配置,如下:

@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.cors().and()...
    }
}

解决跨域的本质就是在返回头内添加Access-Control-Allow-Origin,实现方式有多种,spring体系内解决跨域可参考CORS support in Spring Framework,很全面的介绍了各种场景。使用权限框架时,要注意权限框架本身的CORS支持。

本人搭建好的spring boot web后端开发框架已上传至GitHub,欢迎吐槽!
https://github.com/q7322068/rest-base,已用于多个正式项目,当前可能因为版本问题不是很完善,后续持续优化,希望你能有所收获!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容