Spring解决跨域问题(@CrossOrigin)

本文介绍了跨域问题的基本概念及浏览器如何通过CORS机制处理跨域请求。具体讲解了Spring框架中@CrossOrigin注解的使用方法及其各项配置参数的意义,并通过一个示例展示了如何在Spring Boot应用中实现跨域请求。

一、关于跨域介绍

在前后分离的架构下,跨域问题难免会遇见比如,站点 http://domain-a.com 的某 HTML 页面通过 的 src 请求 http://domain-b.com/image.jpg。网络上的许多页面都会加载来自不同域的CSS样式表,图像和脚本等资源。

出于安全原因,浏览器限制从脚本内发起的跨源HTTP请求。 例如,XMLHttpRequest和Fetch API遵循同源策略。 这意味着使用这些API的Web应用程序只能从加载应用程序的同一个域请求HTTP资源,除非使用CORS头文件。

跨域的体现,在于它的域名不同或者端口不同,但要注意以下的形式为非跨域模式
http://www.example.com/index.html ==> http://www.example.com/login.html


二、Spring解决跨域问题(@CrossOrigin)

1、@CrossOrigin使用场景要求

  • jdk1.8+
  • Spring4.2+

2、@CrossOrigin源码解析(翻译参考网络,文末列出参考地址)

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CrossOrigin {

    String[] DEFAULT_ORIGINS = { "*" };

    String[] DEFAULT_ALLOWED_HEADERS = { "*" };

    boolean DEFAULT_ALLOW_CREDENTIALS = true;

    long DEFAULT_MAX_AGE = 1800;


    /**
     * 同origins属性一样
     */
    @AliasFor("origins")
    String[] value() default {};

    /**
     * 所有支持域的集合,例如"http://domain1.com"。
     * <p>这些值都显示在请求头中的Access-Control-Allow-Origin
     * "*"代表所有域的请求都支持
     * <p>如果没有定义,所有请求的域都支持
     * @see #value
     */
    @AliasFor("value")
    String[] origins() default {};

    /**
     * 允许请求头重的header,默认都支持
     */
    String[] allowedHeaders() default {};

    /**
     * 响应头中允许访问的header,默认为空
     */
    String[] exposedHeaders() default {};

    /**
     * 请求支持的方法,例如"{RequestMethod.GET, RequestMethod.POST}"}。
     * 默认支持RequestMapping中设置的方法
     */
    RequestMethod[] methods() default {};

    /**
     * 是否允许cookie随请求发送,使用时必须指定具体的域
     */
    String allowCredentials() default "";

    /**
     * 预请求的结果的有效期,默认30分钟
     */
    long maxAge() default -1;
}

3、@CrossOrigin的使用

/**
 * @Title: UserController
 * @ProjectName demo
 * @Description: 请求处理控制器
**/
@RestController
// 实现跨域注解
// origin="*":代表所有域名都可访问
// maxAge:简单来说就是Cookie的有效期,单位为秒
// 若maxAge是负数,则代表为临时Cookie,不会被持久化,Cookie信息保存在浏览器内存中,浏览器关闭Cookie就消失
@CrossOrigin(origins = "*", maxAge = 3600)
public class UserController {
    @Resource
    private IUserFind userFind;

    @GetMapping("/finduser")
    public User finduser(@RequestParam(value="id") Integer id){
        //此处省略相应代码
    }
}

正常调用:
这里写图片描述

前端跨域请求:

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title>demo</title>
        <script type="text/javascript" src="js/jquery-3.3.1.min.js" ></script>
    </head>
    <body>
        <input type="button" value="测试" onclick="ajaxloding()" />
        <div id="usermessage"></div>
        <script>
            var getdata=0;
            function ajaxloding(){
                $.ajax({
                    async:false,
                    type:"get",
                    url:"http://localhost:8080/api/finduser?id=1",
                    contentType: "application/x-www-form-urlencoded",
                    dataType: "json",
                    data: {},
                    success:function(result){
                        getdata=result.name
                    },
                    error: function (errorMsg) {
                        //请求失败时执行该函数
                        alert("请求数据失败!");
                    }
                });
                $("#usermessage").text(getdata)
            }
        </script>
    </body>
</html>

这样就解决了跨域问题,获取了后台的数据:
这里写图片描述

转载自《SpringBoot解决CORS跨域(@CrossOrigin)》

### `@CrossOrigin` 注解在 Spring Boot 中的使用方法 在 Spring Boot 应用中,`@CrossOrigin` 是一个用于解决请求问题的注解。它允许指定哪些源可以访问特定的控制器方法或整个控制器类。该注解可以应用于方法级别或类级别,并提供多个参数以进行细粒度控制。 #### 基本语法 ```java @CrossOrigin(origins = "http://example.com", maxAge = 3600) @GetMapping("/getinfos") public ResponseEntity getInfos() { return ResponseEntity.ok(userService.getInfos()); } ``` - **origins**:指定允许访问的源(名、IP 地址等),例如 `"http://example.com"`。若设置为 `"*"`,则表示允许所有源访问[^2]。 - **maxAge**:预检请求(preflight request)的结果缓存时间(单位:秒)。默认值为 1800 秒(30 分钟),若设置为 3600,则浏览器会在一小时内不再发送预检请求[^4]。 - **allowedHeaders**:定义请求头中允许的字段,默认支持所有请求头。若需要限制某些字段,可显式声明,如 `{"Content-Type", "Authorization"}`。 - **exposedHeaders**:指定响应头中允许暴露给客户端的字段。默认为空,若需传递自定义头信息,应在此处声明。 - **methods**:指定允许的 HTTP 方法,例如 `{RequestMethod.GET, RequestMethod.POST}`。若未指定,则默认支持所有方法。 - **allowCredentials**:是否允许发送凭据(如 Cookie)。默认为 `true`,但若要启用此功能,必须明确指定具体的源,不能使用 `"*"`[^4]。 #### 在方法上使用 `@CrossOrigin` 可以在某个具体的请求处理方法上添加该注解,仅对该方法生效。例如: ```java @CrossOrigin(origins = "*", maxAge = 3600) @GetMapping("/getinfos") public ResponseEntity getInfos() { return ResponseEntity.ok(userService.getInfos()); } ``` 此配置表示 `/getinfos` 接口允许来自任意源的 GET 请求,并且预检请求的有效期为 1 小时[^2]。 #### 在类上使用 `@CrossOrigin` 如果某个控制器类下的所有方法都需要相同的策略,可以直接将注解加在类上: ```java @RestController @CrossOrigin(origins = "http://example.com", allowCredentials = "true") public class UserController { @GetMapping("/users") public List<User> getAllUsers() { return userService.findAll(); } @PostMapping("/users") public User createUser(@RequestBody User user) { return userService.save(user); } } ``` 以上代码表示 `UserController` 中的所有接口都只接受来自 `http://example.com` 的请求,并允许携带凭证[^3]。 #### 全局配置 CORS 尽管 `@CrossOrigin` 可以满足局部需求,但如果希望在整个应用中统一管理策略,可以通过实现 `WebMvcConfigurer` 接口来配置全局 CORS 规则: ```java @Configuration @EnableWebMvc public class CorsConfig implements WebMvcConfigurer { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/**") .allowedOrigins("*") .allowedMethods("GET", "POST", "PUT", "DELETE") .maxAge(3600) .allowCredentials(true); } } ``` 该配置表示所有路径为 `/api/**` 的接口都允许请求,支持常见的 HTTP 方法,并启用凭据共享[^1]。 #### 注意事项 - 当同时存在 `@CrossOrigin` 注解和全局 CORS 配置时,注解的优先级更高。 - 避免在生产环境中无条件地使用 `origins = "*"` 和 `allowCredentials = "true"`,因为这可能带来安全风险。应根据实际业务需求设定具体来源。 - 某些旧版本浏览器对 CORS 支持有限,特别是涉及复杂请求(如带有自定义头部的请求)时,需确保客户端环境兼容。 ### 相关问题 1. 如何在 Spring Boot 中配置全局 CORS 策略? 2. 使用 `@CrossOrigin` 注解时如何控制允许的请求头和响应头? 3. `@CrossOrigin` 注解是否支持 HTTPS 请求?
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值