JAVA feign 调用 transaction feign调用接口

转载

西门吹雪 2023-10-14 07:52:06

文章标签 java spring cloud 分布式客户端 HTTP 文章分类 Java 后端开发

使用 Feign 调用服务接口

集成 Feign

使用 Feign 调用接口

使用 Feign 调用服务接口

Feign 是一个声明式的 REST 客户端，它能让 REST 调用更加简单。Feign 供了 HTTP 请求的模板，通过编写简单的接口和插入注解，就可以定义好 HTTP 请求的参数、格式、地址等信息。

而 Feign 则会完全代理 HTTP 请求，我们只需要像调用方法一样调用它就可以完成服务请求及相关处理。

Spring Cloud 对 Feign 进行了封装，使其支持 SpringMVC 标准注解和 HttpMessageConverters。Feign 可以与 Eureka 和 Ribbon 组合使用以支持负载均衡。

集成 Feign

在 Spring Cloud 中集成 Feign 的步骤相当简单，首先还是加入 Feign 的依赖，代码如下所示：

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

在启动类上加 @EnableFeignClients 注解，如果你的 Feign 接口定义跟你的启动类不在同一个包名下，还需要制定扫描的包名 @EnableFeignClients(basePackages = "cn.com.stary1993.blog.client")，代码如下所示：

SpringBootApplication
@EnableDiscoveryClient
@EnableEurekaClient
@EnableFeignClients(basePackages = "cn.com.stary1993.blog.client")
public class BlogUserWebApplication {

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

}

使用 Feign 调用接口

定义一个 Feign 的客户端，以接口形式存在，代码如下所示：

@FeignClient(value = "blog-user-service")
@RequestMapping("/user")
public interface UserFeignClient {

    @GetMapping("/{id}")
    String findById(@PathVariable(value = "id") Integer id);

}

首先我们来看接口上加的 @FeignClient 注解。这个注解标识当前是一个 Feign 的客户端，value 属性是对应的服务名称，也就是你需要调用哪个服务中的接口。

定义方法时直接复制接口的定义即可，当然还有另一种做法，就是将接口单独抽出来定义，然后在 Controller 中实现接口。

在调用的客户端中也实现了接口，从而达到接口共用的目的。我这里的做法是不共用的，即单独创建一个 API Client 的公共项目，基于约定的模式，每写一个接口就要对应写一个调用的 Client，后面打成公共的 jar，这样无论是哪个项目需要调用接口，只要引入公共的接口 SDK jar 即可，不用重新定义一遍了。

定义之后可以直接通过注入 UserFeignClient 来调用，这对于开发人员来说就像调用本地方法一样。

接下来采用 Feign 来调用 /user/{id} 接口，代码如下所示：

@Autowired
    private UserFeignClient userFeignClient;
    
    @GetMapping("/query/{id}")
    public String queryById(@PathVariable Integer id) {
       // return restTemplate.getForObject("http://localhost:8081/user/" + id, String.class);
       // return restTemplate.getForObject("http://blog-user-service/user/" + id, String.class);
        return userFeignClient.findById(id);
    }

通过跟注释掉的代码相比可以发现，我们的调用方式变得越来越简单了，从最开始的指定地址，到后面通过 Eureka 中的服务名称来调用，再到现在直接通过定义接口来调用。