[Vue]使用Vite設定代理(Proxy),轉發請求給後端Spring Boot

當使用前後端分離技術進行開發時,發現兩個服務的 port 不同,那該怎麼讓前端的請求轉送到後端呢?
下面就使用Vue+Spring Boot進行說明

代理是什麼?

負責將客戶端的請求轉發給後端的原始服務器,並將服務器的回應返回給客戶端。

安裝Vite

Vue設定代理

在專案最外層新增或修改vite.config.ts,一般使用npm語法建立的vue專案,預設都有這個檔案

vite.config.ts加入proxy設定

import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  },
  server: {
    proxy: {
      // 將所有以 /api 開頭的請求轉發到後端服務器
      '/api': {
        target: 'http://localhost:8080',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/api/, ''),
      },
    },
  }
})

新增按鈕,用來接收 API 返回的資料顯示於主畫面

新增HelloButton.vue製作一個按鈕,用來打hello API到後端

<template>
  <div>
    <button @click="fetchHello">Click me</button>
    <p>{{ message }}</p>
  </div>
</template>

<script>
import axios from 'axios';

export default {
  data() {
    return {
      message: '',
    };
  },
  methods: {
    async fetchHello() {
      try {
        const response = await axios.get('/api/hello');
        console.log('Response data:', response.data); // 返回資料
        this.message = response.data;
      } catch (error) {
        if (error.response) {
          // 狀態碼不是 2xx
          console.error('Error response:', error.response);
        } else if (error.request) {
          // 已發出 request ,但沒有回應
          console.error('Error request:', error.request);
        } else {
          // 其他錯誤
          console.error('Error:', error.message);
        }
        this.message = 'Error fetching the API';
      }
    },
  },
};
</script>

<style scoped>
button {
  padding: 10px 20px;
  font-size: 16px;
}
</style>

HelloButton.vue加入App.vue

<script setup lang="ts">
import { RouterLink, RouterView } from 'vue-router'
import HelloWorld from './components/HelloWorld.vue'
import HelloButton from './components/HelloButton.vue';
</script>

<template>
  <header>
    <img alt="Vue logo" class="logo" src="@/assets/logo.svg" width="125" height="125" />

    <div class="wrapper">
      <HelloWorld msg="這是一個 Vue 專案!" />
      <HelloButton />
      <nav>
        <RouterLink to="/">Home</RouterLink>
        <RouterLink to="/about">About</RouterLink>
      </nav>
    </div>
  </header>

  <RouterView />
</template>

<style scoped>
header {
  line-height: 1.5;
  max-height: 100vh;
}

.logo {
  display: block;
  margin: 0 auto 2rem;
}

nav {
  width: 100%;
  font-size: 12px;
  text-align: center;
  margin-top: 2rem;
}

nav a.router-link-exact-active {
  color: var(--color-text);
}

nav a.router-link-exact-active:hover {
  background-color: transparent;
}

nav a {
  display: inline-block;
  padding: 0 1rem;
  border-left: 1px solid var(--color-border);
}

nav a:first-of-type {
  border: 0;
}

@media (min-width: 1024px) {
  header {
    display: flex;
    place-items: center;
    padding-right: calc(var(--section-gap) / 2);
  }

  .logo {
    margin: 0 2rem 0 0;
  }

  header .wrapper {
    display: flex;
    place-items: flex-start;
    flex-wrap: wrap;
  }

  nav {
    text-align: left;
    margin-left: -1rem;
    font-size: 1rem;

    padding: 1rem 0;
    margin-top: 1rem;
  }
}
</style>

啟動前端服務

Spring Boot 新增WebConfig解決跨域(CORS)問題

在主目錄下新增config資料夾,新增WebConfig類別

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 WebConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("http://localhost:5173")
                .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
                .allowedHeaders("*")
                .allowCredentials(true);
    }
}

在allowedOrigins方法填入前端url,這樣就可以解決跨域問題了!

新增HelloController

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello World!";
    }

}

啟動後端服務

測試

進入網址前端 url 並打開「F12」,點擊「Click me」

就可以看到hello API 請求成功,回傳的狀態碼為200,回傳的 Hello World! 字串也顯示在畫面上了!

參考資料

  1. ChatGPT

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *