java使用Feign实现声明式Restful风格调用

更新时间：2019年04月24日 10:14:06 作者：simonsfan

这篇文章主要为大家详细介绍了java使用Feign实现声明式Restful风格调用，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

一、Feign简介

Feign是netflix开发的声明式、模板化的http客户端，在使用时就像调用本地(服务消费者自己)的方法一般，帮助我们更加优雅的调用服务提供者的API。Feign自身支持springMVC，还整合了Eureka、Ribbon，极大的简化了Feign的使用。就整合Euraka而言，只需和普通的服务配置Eureka server的信息即可。整合Ribbon，就意味着不再需要通过标注@LoadBalanced的实例化后的RestTemplate去调用服务提供者方法了。Feign只需通过简单的定义一个接口即可实现负载均衡。

二、在服务消费者中使用Feign

1、添加Feign依赖

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

2、创建一个feign接口，并在头部加上@FeignClient注解

import com.simons.cn.util.CommonResult;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
 
@FeignClient(name = "user-provider")
public interface UserFeignService {
 
  @RequestMapping(value = "/getuserinfo",method = RequestMethod.GET)
  CommonResult getUserByName(@RequestParam(required = false,value = "name") String name);
 
}

这里的name="user-provider" 会被解析为注册到Eureka server上的其中一个客户端，换句话说就是注册到Eureka中的其中一个服务，利用它可以实现负载均衡。也可以结合value来指定@FeignClient(name="user-provider",value = "http://localhost:8000/")

3、修改Controller，不再调用@LoadBalanced标注的RestTemplate，而是通过标注@FeignClient的自定义接口

import com.simons.cn.UserFeignService;
import com.simons.cn.util.CommonResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
@Slf4j
@RestController
public class TicketFeignController {
 
  @Autowired
  private UserFeignService userFeignService;
 
  @GetMapping("/ticketpurchase")
  public CommonResult purchaseTicket(@RequestParam(required = false,value = "name") String name){
    CommonResult result = userFeignService.getUserByName(name);
    return result;
  }
 
}

4、修改启动类，头部添加@EnableFeignClients注解

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.feign.EnableFeignClients;
 
@EnableFeignClients
@EnableDiscoveryClient
@SpringBootApplication
public class TicketConsumerFeignApplication {
 
  public static void main(String[] args) {
    SpringApplication.run(TicketConsumerFeignApplication.class, args);
  }
}

测试:

启动多个user-provider-eureka服务实例，其配置文件中的application.name=user-provider;

启动discovery-eureka服务实例;

启动ticket-consumer-feign服务实例

如上测试结果可以看到ticket-consumer-feign消费者顺利调用user-provider-eureka服务提供者的方法，并且实现了负载均衡。

三、使用Feign构造多参数请求

1、get请求:多个参数就用多个@RequestParam标注几个

@FeignClient(name = "user-provider")
public interface UserFeignService {
 
  @RequestMapping(value = "/getuserinfo",method = RequestMethod.GET)
  CommonResult getUserByName(@RequestParam(required = false,value = "name") String name);
 
}

或者用Map来封装参数

@FeignClient(name="user-provider")
public interface UserServiceFeign {
  @RequestMapping(value = "/getuserinfo",method = RequestMethod.GET)
  public CommonResult getUserByName(@RequestParam Map<String,Object> map);
}

@RestController
public class TicketController {
  @Autowired
  private UserServiceFeign userServiceFeign;
 
  @GetMapping("ticketpurchase")
  public CommonResult (Long id, String actId) {
    Map map = new HashMap<String, Object>();
    map.put("id", id);
    map.put("actId", actId);
    return this.userServiceFeign.getUserByName(map);
  }
}

2、post请求就相对简单的多

// 服务消费者方
@FeignClient(name="user-provider")
public interface UserServiceFeign {
 
  @RequestMapping(value="/getuserbyname",method = RequestMethod.POST)
  public COmmonResult getUserByName(@RequestBody User user);
 
}

//服务提供者
@Slf4j
@RestController
public class UserController {
 
  @Autowired
  private UserServiceImpl userService;
 
  @GetMapping(value = "/getuserinfo")
  public CommonResult getUserInfo(@RuquestBody User user){
    List<User> userList = userService.getUserByName(user.getName());
    return CommonResult.success(CommonEnum.SUCESS.getCode(), CommonEnum.SUCESS.getMessage(),userList);
  }
}

项目的github

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

java xml转为json的n种方法
本文给大家分享java xml转为json的两种方法，每种方法通过实例代码给大家介绍的非常详细，小编感觉第一种方法要比第二种方法好些，具体实现代码跟随小编一起看看吧
2021-08-08
Mybatis实体类和表映射问题(推荐)
在项目开发中我们经常会遇到表中的字段名和表对应实体类的属性名称不一定都是完全相同的。下面小编给大家介绍下这种情况下如何解决字段名与实体类属性名不相同的冲突问题。下面小编给大家带来了Mybatis实体类和表映射的解决方法，小伙伴们一起学习吧
2016-09-09
JavaWeb Spring开发入门深入学习
这篇文章主要为大家详细介绍了JavaWeb Spring开发入门学习教程,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-09-09
详解Java中类与对象的关系
这篇文章主要介绍了详解Java中类与对象的关系,类的关键字是class，在Java编程里，类的作用相当于机械师手中的构造图，如果没有构造图，就无法打造武器，同样如果没有类，就无法实例化,需要的朋友可以参考下
2023-05-05
IDEA创建Java Web项目的超详细图文教学
IDEA是程序员们常用的java集成开发环境,也是被公认为最好用的java开发工具,下面这篇文章主要给大家介绍了关于IDEA创建Java Web项目的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
2022-12-12
JavaMail入门教程之发送邮件（3）
这篇文章主要为大家详细介绍了JavaMail入门教程之发送邮件的相关资料,具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2016-11-11
Intellij idea远程debug连接tomcat实现单步调试
这篇文章主要介绍了Intellij idea远程debug连接tomcat实现单步调试，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-05-05
SpringBoot使用spring.config.import多种方式导入配置文件
本文主要介绍了SpringBoot使用spring.config.import多种方式导入配置文件，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-05-05
Java语法之 Java 的多态、抽象类和接口
上节介绍了 Java 基础语法之解析 Java 的包和继承，如果这类知识有点疑惑的小伙伴，可以去 Java 的包和继承这章看看，或许可以帮你解决一些疑惑哟！今天这篇文章我们将讲解的是 Java 的多态、抽象类和接口，感兴趣的小伙伴可以参考下面文章的具体内容
2021-09-09
SpringBoot结合FreeMarker视图渲染的实现
FreeMarker它允许开发人员使用模板和数据来生成输出文本,如HTML网页、电子邮件、配置文件和源代码等,本文主要介绍了SpringBoot结合FreeMarker视图渲染的实现,感兴趣的可以了解一下
2024-03-03