SpringBoot + openFeign实现远程接口调用的过程

更新时间：2022年11月23日 15:08:16 作者：12程序猿

现在的微服务项目不少都使用的是springboot+spring cloud构建的项目，微服务之间的调用都离不开feign来进行远程调用，这篇文章主要介绍了SpringBoot + openFeign实现远程接口调用,需要的朋友可以参考下

SpringBoot服务之间通过openFeign实现远程接口调用

现在的微服务项目不少都使用的是springboot+spring cloud构建的项目，微服务之间的调用都离不开feign来进行远程调用。那么我们一个服务需要调用第三方的服务的时候，我们常常可能使用httpclient或者restTemplate等客户端api来实现远程调用，其实我们可以在微服务没有适用spring cloud框架的情况下，想调用第三方服务，也可以通过feign组件实现http的远程调用。

实现过程

1.首先创建服务端项目，提供数据接口

1.1添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

1.2 配置application.yml

application.yml:

server:
  port: 8080

spring:
  application:
    name: serviceDemo

1.3 实体类

User:

package com.example.servicedemo.entity;

import lombok.Data;

/**
 * 用户信息
 * @author qzz
 */
@Data
public class User {

    private Integer id;
    private String name;
    private Integer age;
}

1.4 添加控制器方法

UserController:

package com.example.servicedemo.controller;

import com.example.servicedemo.entity.User;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * @author qzz
 */
@RestController
public class UserController {

    @RequestMapping("/api/user/getUserList")
    public List<User> getUserList(){
        //模拟数据库请求数据
        List<User> list = new ArrayList<>();
        User user = new User();
        user.setId(1);
        user.setName("Jack");
        user.setAge(31);
        list.add(user);
        return list;
    }
}

1.5 启动类

package com.example.servicedemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author qzz
 */
@SpringBootApplication
public class ServiceDemoApplication {

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

}

浏览器访问：http://localhost:8080/api/user/getUserList

在这里插入图片描述

2.创建客户端项目，调用服务端接口

2.1添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

2.2 配置application.yml

application.yml:

server:
  port: 8081

spring:
  application:
    name: clientName

2.3 实体类

User:

package com.example.clientdemo.entity;

import lombok.Data;

/**
 * @author qzz
 */
@Data
public class User {

    private Integer id;
    private String name;
    private Integer age;
}

2.4 创建OpenFeign接口

注意：@FeignClient的name和value属性必填其一，另外url必填。

package com.example.clientdemo.feign;

import com.example.clientdemo.entity.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;

import java.util.List;

/**
 * openFeign接口
 * URL：就是远程端需要调用接口的服务URL路径，name：就是服务名，value和name一样
 * @author qzz
 */
@FeignClient(name = "serviceDemo",url = "http://localhost:8080")
public interface ServiceDemoFeign {

    /**
     * 获取用户列表
     * @return
     */
    @RequestMapping("/api/user/getUserList")
    List<User> getUserList();

}

2.5 添加控制器方法

UserController:

/**
 * @author qzz
 */
@RestController
public class UserController {

     /**
     * 注入OpenFeign接口
     */
    @Autowired
    private ServiceDemoFeign serviceDemoFeign;

    @RequestMapping("/api/client/user/getUserList")
    public List<User> getUserList(){
        return serviceDemoFeign.getUserList();
    }

}

2.6 启动类

启动类需要添加@EnableFeignClients注解。
加入EnableFeignClients开启Feign注解,使Feign的bean可以被注入

package com.example.clientdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

/**
 * @author qzz
 */
@EnableFeignClients
@SpringBootApplication
public class ClientDemoApplication {

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

}

2.7 测试效果

浏览器访问：http://localhost:8081/api/client/user/getUserList

在这里插入图片描述

返回结果成功，说明服务调用成功。

完整代码

点击此处进行下载

到此这篇关于SpringBoot + openFeign实现远程接口调用的文章就介绍到这了,更多相关SpringBoot openFeign远程接口调用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

BeanDefinition基础信息讲解
今天小编就为大家分享一篇关于BeanDefinition基础信息讲解，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-02-02
springboot+dubbo+validation 进行rpc参数校验的实现方法
这篇文章主要介绍了springboot+dubbo+validation 进行rpc参数校验的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-09-09
如何用IDEA调试BUG的几种方法
这篇文章主要介绍了如何用IDEA调试BUG的几种方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2020-03-03
详解mybatis @SelectProvider 注解
这篇文章主要介绍了mybatis @SelectProvider 注解的相关知识，本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧
2020-12-12
SpringBoot集成tika实现word转html的操作代码
Tika是一个内容分析工具,自带全面的parser工具类,能解析基本所有常见格式的文件,得到文件的metadata,content等内容,返回格式化信息,本文给大家介绍了SpringBoot集成tika实现word转html的操作,需要的朋友可以参考下
2024-06-06
Java获取当前时间方法总结
本篇文章给大家整理了关于Java获取当前时间方法，以及相关代码分享，有需要的朋友测试参考下吧。
2018-02-02
深入浅析springsecurity入门登录授权
SpringSecurity为我们提供了基于注解的权限控制方案,这也是我们项目中主要采用的方式,我们可以使用注解去指定访问对应的资源所需的权限,这篇文章主要介绍了springsecurity入门登录授权,需要的朋友可以参考下
2024-05-05
java正则表达式提取数字的方法实例
这篇文章主要介绍了java正则表达式提取数字的方法，还有去除字符串数字的方法，大家参考使用吧
2013-12-12
Java lastIndexOf类使用方法原理解析
这篇文章主要介绍了Java lastIndexOf类使用方法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-07-07
mybatisplus的逻辑删除过程
这篇文章主要介绍了mybatisplus的逻辑删除过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2025-08-08