Spring RESTful API如何通过Spring库获取其他接口的端点URL？

嘿，这个需求很常见，Spring提供了现成的工具类来帮你动态生成目标URL，完全不用手动硬编码，既能保证和你的路由配置同步，还更符合RESTful最佳实践。下面给你两种靠谱的实现方式：

方法一：使用MvcUriComponentsBuilder（推荐） #

这个工具类可以直接通过方法引用来生成对应的URL，完美适配你已经定义的@GetMapping("/get/{id}")路由，以后哪怕你修改了路由路径，代码也不用跟着改。

修改后的控制器代码如下：

import org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder;
import org.springframework.web.util.UriComponents;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RequestMapping("/accounts")
public class AccountController { // 建议类名首字母大写，符合Java规范

    @GetMapping("/get/{id}")
    public final ResponseEntity<?> getHandler(@PathVariable Long id) {
        // 这里是你的获取逻辑
        return ResponseEntity.ok().build();
    }

    @PostMapping(value = "/create")
    public final ResponseEntity<?> createHandler() {
        // 1. 模拟生成新创建账户的ID
        Long newAccountId = 123L;

        // 2. 通过方法引用生成目标URL
        UriComponents uriComponents = MvcUriComponentsBuilder
                .fromMethodCall(MvcUriComponentsBuilder.on(AccountController.class).getHandler(newAccountId))
                .build();
        String accountUrl = uriComponents.toUriString();

        // 3. 将URL放入响应头（通常用Location头，符合REST规范）
        return ResponseEntity.created(uriComponents.toUri())
                // 或者如果要自定义头的话：.header("Custom-Location", accountUrl)
                .build();
    }
}

关键点说明： #

• MvcUriComponentsBuilder.on(AccountController.class).getHandler(newAccountId)：这里是通过类和方法引用来定位目标接口，传入的newAccountId会自动替换路由里的{id}占位符
• ResponseEntity.created(uri)：RESTful规范中，创建资源成功后应该返回201 Created状态码，并在Location头中返回新资源的URL，这个方法帮你一步搞定
• 如果你的控制器是通过依赖注入的（比如用@Autowired），也可以用更简洁的写法：

  UriComponents uriComponents = MvcUriComponentsBuilder.fromMethodName(this.getClass(), "getHandler", newAccountId).build();
  

方法二：使用UriComponentsBuilder（灵活手动构建） #

如果你需要更灵活的路径拼接，或者想基于当前请求的上下文来生成URL（比如包含域名、端口等完整路径），可以用UriComponentsBuilder，它会自动读取当前请求的上下文信息：

import org.springframework.web.util.UriComponentsBuilder;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RequestMapping("/accounts")
public class AccountController {

    @GetMapping("/get/{id}")
    public final ResponseEntity<?> getHandler(@PathVariable Long id) {
        return ResponseEntity.ok().build();
    }

    @PostMapping(value = "/create")
    public final ResponseEntity<?> createHandler(UriComponentsBuilder uriBuilder) {
        // 1. 模拟生成新ID
        Long newAccountId = 123L;

        // 2. 基于当前请求上下文构建URL
        String accountUrl = uriBuilder
                .pathSegment("get", "{id}")
                .buildAndExpand(newAccountId)
                .toUriString();

        // 3. 返回响应头
        return ResponseEntity.created(uriBuilder.pathSegment("get", "{id}").buildAndExpand(newAccountId).toUri())
                .build();
    }
}

关键点说明： #

• 直接在方法参数中注入UriComponentsBuilder，Spring会自动帮你实例化，它包含了当前请求的scheme、域名、端口等信息
• pathSegment("get", "{id}")：结合类上的@RequestMapping("/accounts")会自动拼接成完整的/accounts/get/{id}路径，避免重复写前缀

为什么不推荐硬编码？ #

• 硬编码的URL在路由修改时需要全局替换，很容易遗漏出错
• Spring的工具类会自动适配你的路由配置（比如如果配置了上下文路径server.servlet.context-path，会自动加上）
• 符合RESTful API的设计规范，返回的URL可以直接被客户端用来访问新创建的资源

内容的提问来源于stack exchange，提问作者Michael Sun