Spring boot 调用自己的接口

原创

mob64ca12f58d71 2024-11-16 04:37:35 ©著作权

文章标签 spring ci 2d 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12f58d71的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 调用自己的接口：新手开发者指南

作为一名新入行的开发者，掌握如何在Spring Boot应用中调用自己的接口是非常重要的技能。这篇文章将为你提供详细的步骤和代码示例，帮助你快速上手。

整体流程

在开始之前，首先让我们了解一下整个流程，方便我们后续的实施。这是一个简单的步骤概览：

步骤	描述	代码
1	创建Spring Boot项目	`spring init --dependencies=web myproject`
2	编写控制器类	`@RestController`
3	创建服务类	`@Service`
4	调用自己的接口	使用`RestTemplate`
5	测试接口	使用Postman或其他工具

步骤详细说明

1. 创建Spring Boot项目

首先，你需要创建一个新的Spring Boot项目。如需使用命令行工具进行初始化，可以使用Spring Initializr：

spring init --dependencies=web myproject

这会创建一个名为myproject的Spring Boot项目，包含Spring Web依赖。

2. 编写控制器类

接下来，在项目中创建一个控制器类，它将处理HTTP请求。

package com.example.myproject.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

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

@RestController注解表示这是一个RESTful控制器。
@GetMapping("/hello")表示当访问/hello路径时，执行hello方法并返回字符串。

3. 创建服务类

然后，我们创建一个服务类用于业务逻辑处理。

package com.example.myproject.service;

import org.springframework.stereotype.Service;

@Service
public class MyService {
    
    public String fetchGreeting() {
        return "Hello from Service!";
    }
}

@Service注解表示这是一个服务组件。
fetchGreeting方法将被调用来返回问候语。

4. 调用自己的接口

我们将通过一个接口来调用刚刚创建的控制器中的方法。

package com.example.myproject.controller;

import com.example.myproject.service.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class ApiController {
    
    @Autowired
    private MyService myService;

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/greet")
    public String greet() {
        String response = restTemplate.getForObject("http://localhost:8080/hello", String.class);
        return myService.fetchGreeting() + " " + response;
    }
}

通过@Autowired注入服务和正则模板RestTemplate。
RestTemplate用于发起HTTP请求。
restTemplate.getForObject调用自己的/hello接口，获取返回值。

5. 测试接口

最后，使用Postman、curl或浏览器发送GET请求测试接口。

curl http://localhost:8080/greet

你应该能看到输出为Hello from Service! Hello, World!。

序列图

接下来，我们来看一下整个调用过程的序列图，帮助你更好地理解过程。

sequenceDiagram
    participant User
    participant ApiController
    participant MyService
    participant MyController
    
    User->>ApiController: GET /greet
    ApiController->>MyService: fetchGreeting()
    MyService-->>ApiController: "Hello from Service!"
    ApiController->>MyController: GET /hello
    MyController-->>ApiController: "Hello, World!"
    ApiController-->>User: "Hello from Service! Hello, World!"

甘特图

为了更好地理解任务分配和进度，这里是一个甘特图。

gantt
    title 项目初始化
    dateFormat  YYYY-MM-DD
    section 创建项目
    创建Spring Boot项目       :a1, 2023-10-01, 2d
    section 编写控制器类
    编写控制器类         :a2, after a1, 2d
    section 创建服务类
    创建服务类           :a3, after a2, 2d
    section 接口调用
    调用自己的接口        :a4, after a3, 2d
    section 测试接口
    测试接口              :a5, after a4, 1d