SpringCloud - 声明式服务调用组件Feign使用详解3（继承特性）

    从之前文章的样例中可以发现，当使用 Spring MVC 的注解来绑定服务接口时，我们几乎完全可以从服务提供方的 Conroller 中依靠复制操作，构建出相应的服务客户端绑定接口。但每次都要进行这些复制操作略显麻烦。

三、继承特性

1，创建基础 Maven 工程

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.hangge</groupId>
    <artifactId>hello-service-api</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>hello-service-api</name>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.6</version>
        </dependency>
    </dependencies>

</project>

（3）编写实体类 User：

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class User {
    private String name;
    private Integer age;
}

（4）编写 HelloService 接口：

@RequestMapping("/refactor")
public interface HelloService {

    // 带有Request参数的请求
    @GetMapping("/hello1")
    String hello1(@RequestParam("name") String name) ;

    // 带有Header信息的请求
    @GetMapping("/hello2")
    User hello2(@RequestHeader("name") String name, @RequestHeader("age") Integer age);

    // 带有Header信息的请求
    @PostMapping("/hello3")
    String hello3(@RequestBody User user);
}

（5）使用 maven 命令 install 在本地仓库创建 jar 包：

2，改造服务提供者

<dependency>
    <groupId>com.hangge</groupId>
    <artifactId>hello-service-api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

（2）创建 HelloController 类继承 hello-service-api 中定义的 HelloService 接口，并实现这三个接口：

@RestController
public class HelloController implements HelloService {

    // 带有Request参数的请求
    @Override
    public String hello1(@RequestParam String name) {
        return "hello1 " + name;
    }

    // 带有Header信息的请求
    @Override
    public User hello2(@RequestHeader String name, @RequestHeader Integer age) {
        return new User(name, age);
    }

    // 带有Header信息的请求
    @Override
    public String hello3(@RequestBody User user) {
        return "hello3 " + user.getName() + ", " + user.getAge();
    }
}

3，改造服务消费者

<dependency>
    <groupId>com.hangge</groupId>
    <artifactId>hello-service-api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

（2）创建 RefactorHelloService 接口并继承 hello-service-api 中定义的 HelloService 接口，然后添加 @FeignClient 注解来绑定服务即可：

@FeignClient("hello-service")
public interface RefactorHelloService extends HelloService {
}

（3）最后在 ConsumerController 中，注入 RefactorHelloService 实例并调用即可：

@RestController
public class ConsumerController {

    @Autowired
    RefactorHelloService refactorHelloService;

    @GetMapping(value = "/feign-consumer")
    public String helloConsumer() {
        String result1 = refactorHelloService.hello1("hangge1");
        User result2 = refactorHelloService.hello2("hangge2", 100);
        String result3 = refactorHelloService.hello3(new User("hangge3",0));
        return result1 + "<br>" + result2 + "<br>" +result3;
    }
}

4，验证测试

    我们启动服务中心、HELLO-SERVICE、FEIGN-CONSUMER，访问 http://localhost:9001/feign-consumer 触发对 HELLO-SERVICE 接口的调用，最终会获得如下输出，代表接口绑定和调用成功。

附：使用继承特性的优缺点

1，优点

    可以将接口的定义从 Controller 中剥离，同时配合 Maven 私有仓库就可以轻易地实现接口定义的共享，不用再复制粘贴接口进行绑定，而是实现在构建期的接口绑定，从而有效减少服务客户端的绑定配置。