Spring Boot REST接口调用实现及相关技术疑问咨询

问题 #

我正在编写一个简单的Java Spring Boot测试应用以调用REST API，目的是快速实现功能并重温Java应用调用REST接口的相关知识。我曾使用过Spring Boot及调用REST API，但时隔数年且无法访问旧项目，已遗忘诸多细节。

目前已编写的代码如下：

Application.java #

@SpringBootApplication
public class Application {
  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }
}

TestController.java #

@RestController
public class TestController {
  @Autowired
  private RestTemplate template;

  @GetMapping("/groups")
  public Object[] getAllGroups(String url) {
    Object[] groups = template.getForObject(url, Object[].class);
    return groups;
  }
}

我尚未尝试运行该代码，且发现多数在线示例未说明如何为REST调用提供URL。同时我无法理解@GetMapping中的资源路径/groups与方法中RestTemplate调用的映射关系，该注解中的资源路径有何作用？它与模板调用如何配合？

我推测RestTemplate应放在@Service层而非控制器中，但目前仅希望先实现功能并理解其工作原理。此外，除了将URL传入RestTemplate外，还有哪些方式可让应用获取REST API的URL？能否通过配置文件实现？我遗忘了很多细节，难以找到涵盖这些常被忽略的细节的示例。

解答 #

1. @GetMapping("/groups")的作用与RestTemplate的关系 #

@GetMapping("/groups")是用来暴露你的Spring Boot应用自身的REST接口，和RestTemplate调用外部API的行为完全独立：

• 当客户端（浏览器、Postman等）访问你的应用的http://localhost:8080/groups路径时，Spring会把请求转发到getAllGroups方法处理。
• RestTemplate是调用外部第三方REST API的工具，它的URL指向的是外部服务地址，和你自己的/groups路径没有直接映射关系。你当前的代码逻辑是：客户端调用你的/groups接口时传入外部API的URL，你的方法再用RestTemplate去调用这个外部地址，把结果返回给客户端。

2. RestTemplate的URL配置方式 #

除了方法参数传入URL，更规范的做法是通过配置文件管理外部API地址：

方式一：用@Value直接读取配置

• 在application.properties中配置外部API地址：

  external.api.url=https://example.com/api/groups
  

• 在代码中注入配置值：

  @RestController
  public class TestController {
    @Autowired
    private RestTemplate template;
    
    @Value("${external.api.url}")
    private String externalApiUrl;
  
    @GetMapping("/groups")
    public Object[] getAllGroups() {
      // 直接使用配置好的外部API地址
      Object[] groups = template.getForObject(externalApiUrl, Object[].class);
      return groups;
    }
  }
  

方式二：用@ConfigurationProperties绑定配置类（适合多配置项场景）

• 创建配置类：

  @ConfigurationProperties(prefix = "external.api")
  @Component
  public class ExternalApiConfig {
    private String url;
  
    // getter、setter
    public String getUrl() {
      return url;
    }
  
    public void setUrl(String url) {
      this.url = url;
    }
  }
  

• 在application.yml中配置：

  external:
    api:
      url: https://example.com/api/groups
  

• 在Controller中注入配置类使用：

  @RestController
  public class TestController {
    @Autowired
    private RestTemplate template;
    
    @Autowired
    private ExternalApiConfig apiConfig;
  
    @GetMapping("/groups")
    public Object[] getAllGroups() {
      Object[] groups = template.getForObject(apiConfig.getUrl(), Object[].class);
      return groups;
    }
  }
  

3. 代码优化补充 #

（1）RestTemplate的Bean配置

默认Spring容器中没有RestTemplate实例，需要手动配置：

@SpringBootApplication
public class Application {
  public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
  }

  @Bean
  public RestTemplate restTemplate() {
    return new RestTemplate();
  }
}

也可以用RestTemplateBuilder创建功能更丰富的实例：

@Bean
public RestTemplate restTemplate(RestTemplateBuilder builder) {
  return builder.build();
}

（2）将RestTemplate逻辑移到Service层

你之前的推测是对的，Controller只负责处理HTTP请求，业务逻辑（比如调用外部API）应该放到Service层，职责更清晰：

• 编写Service类：

  @Service
  public class GroupService {
    @Autowired
    private RestTemplate template;
    
    @Value("${external.api.url}")
    private String externalApiUrl;
  
    public Object[] getAllGroups() {
      return template.getForObject(externalApiUrl, Object[].class);
    }
  }
  

• 修改Controller调用Service：

  @RestController
  public class TestController {
    @Autowired
    private GroupService groupService;
  
    @GetMapping("/groups")
    public Object[] getAllGroups() {
      return groupService.getAllGroups();
    }
  }
  

内容的提问来源于stack exchange，提问作者Joseph Gagnon