JeecgBoot前端代理配置的统一化实践

背景概述

在JeecgBoot 3.7.0版本的前端配置中，存在两个不同的环境变量配置项：VITE_GLOB_API_URL和VITE_GLOB_DOMAIN_URL。这两个配置项分别用于不同的API请求场景，导致开发者在配置时需要同时关注两个变量，增加了配置的复杂度。

配置项解析

1. VITE_GLOB_API_URL

该配置项通常用于配置基础API路径，默认值为/jeecgboot。这个路径会被用作大部分API请求的前缀。

2. VITE_GLOB_DOMAIN_URL

该配置项用于配置完整的API域名，默认值为http://api3.boot.jeecg.com。这个配置用于一些特殊的API请求场景。

统一配置方案

虽然JeecgBoot官方出于特殊场景考虑保留了这两个配置项，但开发者可以通过以下方式实现配置的统一化：

1. 统一使用VITE_GLOB_API_URL
   可以将两个配置项都设置为相同的值，例如都配置为/jeecgboot。这样所有的API请求都会使用相同的路径前缀。

2. 配置注意事项

   • 确保后端API网关能够正确处理统一后的路径
   • 如果存在跨域问题，需要在后端配置相应的CORS策略
   • 在微服务架构中，确保API网关能够正确路由所有请求

实现原理

JeecgBoot前端基于Vite构建，在开发环境下：

• 当使用/jeecgboot这样的相对路径时，Vite的开发服务器会自动代理这些请求
• 在生产环境下，这些路径会被解析为相对于当前域名的绝对路径

最佳实践建议

1. 开发环境配置
   建议在开发环境中统一使用相对路径配置，例如：

   VITE_GLOB_API_URL=/jeecgboot
   VITE_GLOB_DOMAIN_URL=/jeecgboot
   

2. 生产环境配置
   在生产环境中，可以根据实际情况选择：

   • 继续使用相对路径（当API与前端同域名时）
   • 使用完整域名（当API位于不同域名时）

3. 特殊场景处理
   如果确实存在必须使用不同路径的特殊API，可以在代码中单独处理这些例外情况，而不是通过全局配置区分。

总结

虽然JeecgBoot保留了两种不同的API路径配置方式，但通过合理的配置，开发者完全可以实现前端代理的统一化管理。这种统一化不仅能简化配置流程，还能减少因配置不一致导致的问题。在实际项目中，建议根据具体需求选择最适合的配置方案。