Spring Cloud Netflix Feign简介

前言

• 一个成熟的微服务解决方案，内部调用必然依赖一个好的RPC框架，比如：基于Http协议的Feign，基于TCP协议的Dubbo。
• 如果不使用RPC框架，那么调用服务需要走Http的话，配置请求head、body，然后才能发起请求。获得响应体后，还需解析等操作，十分繁琐。

Feign是什么

• Feign是Spring Cloud组件中一个轻量级RESTful的Http服务客户端，以Java接口注解的方式调用Http请求。
• Feign通过处理注解，将请求模板化，当实际调用的时候，传入参数，根据参数再应用到请求上，进而转化成真正的请求，封装了Http调用流程。
• Feign内置了Ribbon，可以与Eureka组合使用以支持负载均衡。用来做客户端负载均衡，去调用服务注册中心的服务。
• Feign是一个声明式、模板化的HTTP客户端，它让微服务之间的调用变得更简单了。

OpenFeign组件和Spring Cloud OpenFeign

OpenFeign组件

• 由于 Netflix 公司不再维护Feign组件，Feign组件由社区维护，Feign更名为 OpenFeign，并且项目迁移到新的仓库。

Spring Cloud OpenFeign

• Spring Cloud OpenFeign是在Spring Cloud Feign组件的基础上进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。
• Spring Cloud OpenFeign的@FeigenClient注解可以解析SpringMvc的@RequestMapping注解下的接口，通过动态代理的方式产生实现类，在实现类中进行负载均衡的微服务远程调用！
• 咱们把注册中心中每一个服务都以一个接口的形式体现，我们服务的消费者只需要调用这个接口中的方法，配合Ribbon使用，那么底层就会自动的调用远方的服务。

OpenFeign-微服务接口调用

需求说明

• 启动两个微服务项目，并将其都注册到需要用户认证的Eureka Server
• 实现两个微服务间的接口调用(最简单的方法调用，不用传参)。

1. 启动Eureka Server服务

2.创建两个项目，将其注册到Eureka Server

• 项目一： demo-user-consumer
• 项目二： demo-user-provider

3.在服务提供者中添加业务处理代码

3.1在demo-user-provider 中添加UserService接口，提供checkuser()方法

public interface UserService {
    boolean checkUser() throws Exception;
}

3.2在demo-user-provider 中添加UserServiceImpl类，实现接口中的方法

@Service
public class UserServiceImpl implements UserService {
    @Override
    public boolean checkUser() throws Exception {
        return true;
    }
}

3.3在demo-user-provider 中添加UserController类

@RestController
public class UserController {
    @Resource
    private UserService userService;
    @PostMapping("/provider/checkUser")
    public boolean checkUser() throws Exception{
        return userService.checkUser();
    }
}

3.4启动demo-user-provider，测试是否成功

4.在服务消费者中调用服务提供者的接口

4.1在demo-user-consumer中添加OpenFeign依赖

        <!--OpenFeign组件-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

4.2在demo-user-consumer中创建UserFeignClient 接口

4.3为接口添加@FeignClient注解并指定name属性值

//通过name属性指定访问注册中心的服务提供者的名字
@FeignClient(name = "DEMO-USER-PROVIDER")
public interface UserFeignClient {
    /**
     * 远程调用DEMO-USER-PROVIDER中的/provider/checkUser服务
     * 调用的路径名称必须和服务提供者保证高度一致
     * @return
     * @throws Exception
     */
    @PostMapping("/provider/checkUser")
    boolean checkUser() throws Exception;
}

4.4启动类添加注解@EnableFeignClients

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class DemoUserConsumerApplication {

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

}

4.5在demo-user-consumer中创建LocalUserService接口，定义login()方法，并创建实现类LocalUserServiceImpl。

public interface LocalUserService {
    boolean doLogin() throws Exception;
}

@Service
public class LocalUserServiceImpl implements LocalUserService {
    @Resource
    private UserFeignClient userFeignClient;
    @Override
    public boolean doLogin() throws Exception {
        //通过http协议调用的服务
        return userFeignClient.checkUser();
    }
}

4.6在demo-user-consumer中创建UserController类。

@RestController
public class UserController {
    @Resource
    private LocalUserService localUserService;
    @PostMapping("/consumer/doLogin")
    public String doLogin() throws Exception{
        boolean result=localUserService.doLogin();
        if(result){
            return "登录成功";
        }else {
            return "登录失败";
        }
    }
}

5.测试是否成功

OpenFeign-接口调用传递参数

1.修改提供服务方法

1.1demo-user-provider的checkUser()方法，添加参数

public interface UserService {
    boolean checkUser(String phone,String password) throws Exception;
}

@Service
public class UserServiceImpl implements UserService {
    @Override
    public boolean checkUser(String phone,String password) throws Exception {
        return "admin".equals(phone) && "123456".equals(password);
    }
}

1.2UserController中的请求处理

@RestController
public class UserController {
    @Resource
    private UserService userService;
    @PostMapping("/provider/checkUser")
    public boolean checkUser(String phone,String password) throws Exception{
        return userService.checkUser(phone,password);
    }
}

2.在服务消费者中传递参数

修改上个示例中demo-user-consumer的UserFeignClient 接口，和提供服务方法保持一致

//通过name属性指定访问注册中心的服务提供者的名字
@FeignClient(name = "DEMO-USER-PROVIDER")
public interface UserFeignClient {
    /**
     * 远程调用DEMO-USER-PROVIDER中的/provider/checkUser服务
     * 调用的路径名称必须和服务提供者保证高度一致
     * @return
     * @throws Exception
     */
    @PostMapping("/provider/checkUser")
    boolean checkUser(@RequestParam String phone,@RequestParam String password) throws Exception;
}

3.修改调用服务方法

修改上个示例中demo-user-consumer的login()方法，调用服务时传入参数

public interface LocalUserService {
    boolean doLogin(String phone,String password) throws Exception;
}

@Service
public class LocalUserServiceImpl implements LocalUserService {
    @Resource
    private UserFeignClient userFeignClient;
    @Override
    public boolean doLogin(String phone,String password) throws Exception {
        //通过http协议调用的服务
        return userFeignClient.checkUser(phone,password);
    }
}

@RestController
public class UserController {
    @Resource
    private LocalUserService localUserService;
    @PostMapping("/consumer/doLogin")
    public String doLogin(String phone,String password) throws Exception{
        boolean result=localUserService.doLogin(phone,password);
        if(result){
            return "登录成功";
        }else {
            return "登录失败";
        }
    }
}

小结：OpenFeign-接口调用传递参数

• 单个参数：添加@RequestParam

• 多个参数：添加@RequestParam

• Map参数：添加@RequestBody

• 自定义对象参数：添加@RequestBody

• 自定义对象参数可以将需要传递的对象抽离到公共组件中