本文旨在探讨在 Spring Boot 项目中，如何有效地分离 REST API 和 Web 应用程序。针对小型项目，建议保持简单，将代码放在同一模块的不同包中。对于大型项目，则需要考虑可伸缩性、团队协作和性能需求，将前后端分离成两个独立的 Spring Boot 应用。文章将深入分析不同场景下的架构选择，并提供相应的技术建议，帮助开发者做出最合适的决策。
在 Spring Boot 项目中，同时构建 RESTful API 和 Web 应用是一种常见的需求。这两种应用通常都需要访问相同的数据库，因此如何有效地组织代码，并根据实际情况进行分离，就显得尤为重要。本文将探讨不同的架构方案，并提供相应的建议。
小型项目：保持简单
对于小型项目，如果业务逻辑相对简单，开发人员数量较少，并且对可伸缩性没有过高的要求，那么最简单的方案就是将 REST API 和 Web 应用的代码放在同一个 Spring Boot 项目中。
方案一：使用不同的包进行组织
可以将 API 相关的 Controller 和 Web 相关的 Controller 放在不同的包中，例如：
package com.example.demo.api;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ApiController {
@GetMapping("/api/hello")
public String helloApi() {
return "Hello from API!";
}
}package com.example.demo.web;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.ui.Model;
@Controller
public class WebController {
@GetMapping("/web/hello")
public String helloWeb(Model model) {
model.addAttribute("message", "Hello from Web!");
return "hello"; // Thymeleaf template name
}
}在这个例子中，ApiController 处理 API 请求，返回 JSON 数据，而 WebController 处理 Web 请求，返回 HTML 页面。
方案二：使用 Maven 模块进行组织
如果希望代码结构更加清晰，可以使用 Maven 模块来区分 API 和 Web 应用。创建一个父项目，然后在父项目下创建两个子模块：api 和 web。
- 父项目 pom.xml:
com.example.demo parent 1.0-SNAPSHOT pom api web org.springframework.boot spring-boot-dependencies 2.7.0 pom import
- api 模块 pom.xml:
com.example.demo parent 1.0-SNAPSHOT api org.springframework.boot spring-boot-starter-web
- web 模块 pom.xml:
com.example.demo parent 1.0-SNAPSHOT web org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-thymeleaf
这种方式可以更好地组织代码，但最终仍然会将两个模块打包成一个 Spring Boot 应用运行。
优点:
- 部署简单，只需要部署一个应用。
- 代码共享方便，例如可以共享 Service 层和 Repository 层。
缺点:
KGOGOMall 是一套采用 Php + MySql 开发的基于 WEB 应用的 B/S 架构的B2C网上商店系统。具有完善的商品管理、订单管理、销售统计、新闻管理、结算系统、税率系统、模板系统、搜索引擎优化，数据备份恢复，会员积分折扣功能，不同的会员有不同的折扣，支持多语言，模板和代码分离等，轻松创建属于自己的个性化用户界面。主要面向企业和大中型网商提供最佳保障，最大化满足客户目前及今后的独立
- 可伸缩性有限，无法独立扩展 API 和 Web 应用。
- 团队协作可能存在冲突，特别是当 API 和 Web 应用由不同的团队开发时。
大型项目：考虑分离
对于大型项目，如果需要更高的可伸缩性，并且由不同的团队负责 API 和 Web 应用的开发，那么将 REST API 和 Web 应用分离成两个独立的 Spring Boot 应用是一个更好的选择。
架构方案:
将 API 和 Web 应用分别部署在不同的服务器上，通过 API Gateway 进行统一管理。Web 应用通过 API Gateway 调用 API 服务。
优点:
- 可伸缩性高，可以独立扩展 API 和 Web 应用。
- 团队协作更高效，不同的团队可以独立开发和部署 API 和 Web 应用。
- 安全性更高，可以通过 API Gateway 对 API 进行统一的安全控制。
缺点:
- 部署复杂，需要部署多个应用。
- 代码共享困难，需要通过 API Gateway 进行通信。
- 需要额外的 API Gateway 组件。
技术实现:
- 创建两个独立的 Spring Boot 项目，分别负责 API 和 Web 应用的开发。
- 使用 API Gateway（例如 Spring Cloud Gateway 或 Kong）对 API 进行统一管理。
- Web 应用通过 REST 客户端（例如 RestTemplate 或 WebClient）调用 API 服务。
示例：Web 应用调用 API 服务
import org.springframework.web.client.RestTemplate;
@Service
public class ApiService {
private final RestTemplate restTemplate;
public ApiService(RestTemplate restTemplate) {
this.restTemplate = restTemplate;
}
public String getHelloMessage() {
String apiUrl = "http://api-gateway/api/hello"; // API Gateway 地址
return restTemplate.getForObject(apiUrl, String.class);
}
}注意事项:
- 需要考虑 API 的版本管理，可以使用 URL 版本控制或 Header 版本控制。
- 需要考虑 API 的认证和授权，可以使用 OAuth 2.0 或 JWT。
- 需要考虑 API 的监控和日志，可以使用 Spring Boot Actuator 和 Micrometer。
总结
在 Spring Boot 项目中分离 REST API 和 Web 应用是一个需要根据实际情况进行权衡的决策。对于小型项目，保持简单，将代码放在同一个项目中即可。对于大型项目，需要考虑可伸缩性、团队协作和性能需求，将前后端分离成两个独立的 Spring Boot 应用。选择合适的架构方案，可以提高开发效率，降低维护成本，并提升系统的整体性能。
