Day 31 跨來源資源共享（CORS）

2024 iThome 鐵人賽

Modern Web

Spring Boot API 開發：從 0 到 1系列第 31 篇

16th鐵人賽

cashwugeek

2024-10-01 08:17:31

1482 瀏覽

分享至

在現代網路應用程式開發中，跨來源資源共用 （Cross-Origin Resource Sharing，簡稱 CORS）是一個常見且重要的概念

今天，我們就來聊聊 CORS 在 Spring Boot 中的應用，讓你的 API 能夠自由地跨網域通信

跨來源資源共享（CORS）

什麼是 CORS

技術上來說，CORS 是一種安全機制，允許網頁從不同來源 (不同網域) 的伺服器請求資源

沒有 CORS，瀏覽器會阻止這些跨不同來源請求，以防止潛在的安全威脅

CORS 對 API 的重要性

安全性：CORS 讓你能夠控制哪些網域可以存取你的 API，有效防止未經授權的存取
靈活性：它允許你的 API 被不同網域的前端應用程式使用，增加了 API 的通用性
合規性：許多現代網路應用架構（如微服務）需要跨網域通信，CORS 使這成為可能

CORS 的應用場景

單頁應用程式（SPA）呼叫後端 API
微服務架構中不同服務之間的通信
第三方整合，如使用外部 API 服務

關於 CORS 相關參數的深入解釋，請參考文末的參考連結，這裡不會深入的探討

在 Spring Boot 中設定 CORS

Spring Boot 提供了多種方式來配置 CORS，我們將介紹最常用的兩種方法

使用 @CrossOrigin 註解

這是最簡單的方法，適合需要對特定控制器或方法啟用 CORS 的情況

直接把註解加到控制器或方法上就好，然後指定相關的網域

在這個例子中，我們允許來自 http://example.com 的請求存取 /hello 端點

@RestController
public class HelloController {

    @CrossOrigin(origins = "http://example.com")
    @GetMapping("/hello")
    public String hello() {
        return "Hello, Cross-Origin World!";
    }
}

全局 CORS 配置

如果你想為整個應用程式配置 CORS，可以使用全局配置

@Configuration
public class CorsConfig {

    @Bean
    public WebMvcConfigurer corsConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addCorsMappings(CorsRegistry registry) {
                registry.addMapping("/**")
                        .allowedOrigins("http://example.com")
                        .allowedMethods("GET", "POST", "PUT", "DELETE")
                        .allowedHeaders("*")
                        .allowCredentials(true)
                        .maxAge(3600);
            }
        };
    }
}

讓我們來解釋一下 CORS 的相關參數

addMapping(String pathPattern)
- 功能：指定哪些路徑應該被 CORS 配置所涵蓋
- 設定內容：API 路徑模式
- 範例
  - /** 表示應用到所有路徑
  - /api/** 只應用到以 /api 開頭的路徑
allowedOrigins(String... origins)
- 功能：指定允許存取你的資源的來源（網域）
- 設定內容：允許的網域列表
- 範例
  - http://example.com 只允許來自 example.com 的請求
  - * 允許所有來源（不建議在生產環境中使用）
allowedMethods(String... methods)
- 功能：指定允許的 HTTP 方法
- 設定內容：HTTP 方法列表
- 範例
  - GET, POST, PUT, DELETE 允許這四種 HTTP 方法
allowedHeaders(String... headers)
- 功能：指定允許的 HTTP 標頭
- 設定內容：HTTP 標頭列表
- 範例
  - * 允許所有標頭
  - Content-Type, Authorization 只允許這兩個特定標頭
exposedHeaders(String... headers)
- 功能：指定回應中可以被客戶端存取的標頭
- 設定內容：要暴露給客戶端的標頭列表
- 範例
  - Authorization 允許客戶端讀取回應中的 Authorization 標頭
allowCredentials(boolean allowCredentials)
- 功能：指定是否允許發送認證資訊（如 cookies、HTTP 認證或客戶端 SSL 證書）
- 設定內容：true 或 false
- 範例
  - true 允許發送認證資訊
maxAge(long maxAge)
- 功能：指定預檢請求的結果可以被快取 多長時間（以秒為單位）
- 設定內容：快取時間（秒）
- 範例
  - 3600 表示預檢請求的結果可以被快取一小時

實際測試 CORS 功能

要在本機測試 CORS 功能，我們需要兩個部分：一個簡單的前端頁面和一個 Spring Boot 後端

讓我們一步步來設置和測試

設置 Spring Boot 後端

我們使用之前的全局配置方法來設定 CORS，但稍作修改以允許本地測試

@Configuration
public class CorsConfig {

    @Bean
    public WebMvcConfigurer corsConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addCorsMappings(CorsRegistry registry) {
                registry.addMapping("/**")
                        .allowedOrigins("http://localhost:5500") // 允許來自 local 伺服器的請求
                        .allowedMethods("GET", "POST", "PUT", "DELETE")
                        .allowedHeaders("*")
                        .allowCredentials(true);
            }
        };
    }
}

在一開始的 HelloController 增加一個 API 端點

@RestController
public class HelloController {

    @GetMapping("/api/hello")
    public String hello() {
        return "Hello from Spring Boot!";
    }
}

啟動你的 Spring Boot 應用程式，它應該會運行在 http://localhost:8080

建立前端頁面

建立一個簡單的 HTML 文件，命名為 index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>CORS Test</title>
</head>
<body>
    <h1>CORS Test</h1>
    <button onclick="testCORS()">Test API Call</button>
    <p id="result"></p>

    <script>
        function testCORS() {
            fetch('http://localhost:8080/api/hello')
                .then(response => response.text())
                .then(data => {
                    document.getElementById('result').textContent = data;
                })
                .catch(error => {
                    document.getElementById('result').textContent = 'Error: ' + error;
                });
        }
    </script>
</body>
</html>