springboot单独使用feign简化接口调用方式

目录

• 单独使用feign简化接口调用
• 1.引入maven
• 2.启动类添加@EnableFeignClients注解
• 3.像平常一样写一个service接口
• 4.调用接口
• springbootfeign调用方式比较
• 1.事发原因
• 2.方式1介绍
• 3.方式2介绍
• 4.调用结果测试
• 5.两种方式对比　　
• 6.小结一下

单独使用feign简化接口调用

与HttpClient和RestTemplate相比，使用springcloud的feign调用远程接口更为简便，可以通过配置的方式实现远程接口调用。但是有时我们并不想使用springcloud，而只是想在springboot中使用feign,我在网上搜了很多springboot单独集成feign的文章,但都不能用。在通过学习、开发后简单整理了一个教程。详细介绍如何在springboot中单独集成feign，以简便的方式调用远程接口。

1.引入maven

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <properties>
        <java.version>1.8</java.version>
        <maven.compiler.target>1.8</maven.compiler.target>
        <maven.compiler.source>1.8</maven.compiler.source>
        <!--添加springcloud版本-->
        <spring-cloud.version>Hoxton.SR1</spring-cloud.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        
        <!--lombok可自动生成getter、setter-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--feign远程接口调用-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>
    <!--管理springcloud版本，引入openfeign时不用添加version-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2.启动类添加@EnableFeignClients注解

开启feign

@EnableFeignClients //开启feign
@SpringBootApplication
public class SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }
}

3.像平常一样写一个service接口

在此基础上添加一些feign注解

@FeignClient(name = "userService",url = "${ip}:${port}/${base_url}")
public interface UserService {
    /**
     * 根据条件查询用户
     * @param user查询参数
     * @return 用户列表
     */
    @PostMapping("searchUsers")
    List<User> searchUsers(@RequestBody User user);
}

在service接口上添加@FeignClient注解，name为springbean的id,用于注入service时使用，url为ip地址

最终调用的接口地址为url加上@PostMapping的value。

@FeignClient的url可以使用配置文件中的参数。使用${参数名}引入即可。

对应的接口：

@RestController("/user")
public class UserController{
    @PostMapping("searchUsers")
    List<User> searchUsers(@RequestBody User user);
}

由此可见，在使用feign时，service方法的调用方式(get、post)和参数、参数格式、返回值格式需要和对应的接口保持一致

4.调用接口

@Autowired
private UserService userService;
/**
*查询18岁的用户并打印到控制台
*/
public void printUsers(){
   User user = new User();
   user.setAge(18);
   List<User> userList = userService.searchUsers(user);
   System.out.println("userList = " + userList);
}

springboot feign调用方式比较

1.事发原因

两个东家都使用SpringCloud，巴拉巴拉用上了Spring全家桶，从eureka到ribbon，从ribbon到feign，从feign到hystrix，然后在使用feign的时候发现使用方式不同，仔细一看这种调用方式，唉，麻烦，我怎么要自己定义DTO，自己定义Fallback, 自己定义方法呢？用上之后，其实发现各有各的好处，来记录一下。

2.方式1介绍

我们在开发服务的时候，会把接口和实现分开， 即有一个API模块和一个Service模块，消费者依赖API的jar包，直接注入API中的Service，则可以直接通过Feign调用到对应的服务，

对应的项目结构如下：

我们在接口API中定义好方法，并加上Feign注解等（MICRO-PROVIDER2是服务名，注册到Eureka Server上的名称。

使用Feign还可以自己实现fallback，设置超时默认放回值。这里做测试，不写过多代码。）

具体的实现如下图所示。

接下来就是我们如何在consumer中去消费这个服务了，我们会在service服务中，依赖api的jar包，实现Provider2Service即可。

具体的实现如下图

代码中的实现逻辑：

3.方式2介绍

这中方式介绍起来比较简单。直接在消费者中定义新的service接口，通过Feign注解，定义方法，调用的url和被调用服务的url相同，实现逻辑如下。

4.调用结果测试

方式2：

方式1：

可以看到，两种方式都是可以消费到服务（本质是一样）。但是两种方式各有好处和坏处，我们要来比较下，看看究竟哪一种才是我们需要的呢？

5.两种方式对比　　

通过两种方式的对比，我们可以看到的优优劣势主要有：

方式一：

　优点：

　　1：服务消费者不用自己写接口。

　　2：可提供好Dto，Vo等直接给服务消费者。

　缺点：

　　1：service需要依赖jar包，如果依赖服务过多，jar也会过多。

　　2：给消费者暴露了过多的接口。部分与消费者无关的接口也暴露给对方。

方式二：

　优点：

　　1：无需依赖过多jar包。

　　2：消费者不要要过多接受消费者提供的方法。

　缺点：

　　1：需要消费者自己实现接口。

　　2：严重依赖文档。在实现接口时，对于所有信息都要有文档定义。如：请求方式，请求参数，返回值等。

　　3：自己完成Dto，Vo的编写。　　

6.小结一下

两种调用方式，我把知道的优缺点放在这了，欢迎大家提出自己的建议。关于如何选择，请根据需要自己抉择。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。