springcloud入门系列（2）－Feign、Ribbon

前面我们介绍了通过springcloud的eureka服务注册组件实现，并且实现了多机互备的HA，同时也将之前写的springboot的服务注册到了eureka上，今天我们主要来介绍下作为服务使用者如何去使用这些服务接口并且实现基于服务化的软负载均衡。对于之前实现的springboot的rest接口服务，一般来说进行restful接口的接收和拆组包，可以通过apache的httpclient、jdk的URLConnection、okhttp等http请求库，也可以通过spring提供的resttemplate，这里我们使用springcloud推荐的feign来进行报文解析来体会下它的优势，为什么spring会大力推荐一个新的rest请求组件，比传统的使用httpclient等有什么优势。

1. POM增加Feign和Ribbon相关依赖库

新建一个springboot工程，并添加cloud的依赖，本文中使用的是1.4.7版本，具体的代码可以参见文后的源码，这里需要在pom中添加对ribbon和feign的依赖。还需要加入对Zuul网关组件的依赖，如果没有网关组件，在启动的时候会报Hystrix的错误，“Caused by: java.lang.ClassNotFoundException: com.netflix.hystrix.contrib.javanica.aop.aspectj.HystrixCommandAspect。“

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

2. Application启动类增加Feign依赖

在application类中需要增加在类名前面增加@EnableFeignClients的注解，这个注解的意思就是在该应用被启动的时候，会去所有类中搜索定义为FeignClient的接口，并自动注册到spring ioc容器中，然后会对所有使用client实现类的对象进行自动依赖注入。这里还有EurekaClient的注解是因为后面定义FeignClient的时候需要定义接口的服务名而不是ip地址，需要定义EurekaClient才能发现相关服务，并且实现软负载。

@SpringCloudApplication
@EnableFeignClients
@EnableEurekaClient

public class Application {

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

}

3. 创建Feign Client接口

下面来到最重要的一步，就是定义Feign的Client接口，这里Client接口其实就是对提供服务的restful接口的本地定义，定义好后，在其他类中就可以像使用RPC本地接口类一样使用远程服务接口了，想想我们用httpclient、okhttp是怎么实现报文接收的功能的，首先我们需要定义httpclient对象，按照服务端的接口要求组合json报文，然后定义是get还是post，不同的传输方法还需要调用不同的方法（doGet、doPost），这才将一个请求发出去，然后从inputstream中循环读取字节流或者从Reader中读取字符流，再将字符流反序列化成对象，全部需要编码实现，整个过程虽然结构很清晰但是很繁琐，为什么之前RPC很火，就是因为使用RPC会让client端调用远程服务接口简单化，就好像使用本地对象一样简单，但是使用RPC的最大的弊端就是每个client都需要维护一个服务端的client jar包，这个jar包中其实就是定义了接口，一旦服务端接口有变化，服务使用方就需要更新jar包，这就使得客户端对服务端产生了强依赖，feign就很好的解决了这个问题，在client和server端没有依赖的情况下，让client使用服务就像使用本地接口一样简单，废话不多少，下面来定义feign client的接口，这里服务端的接口就使用之前定义的getUser接口。

@FeignClient("usercenter-provider")

public interface UserFeignClient {
    //Feign定义服务提供者接口
    @RequestMapping(value = "/getUser", method = RequestMethod.POST, produces = {"application/json;charset=UTF-8"})
    String getUser(@RequestBody String data);

}

@FeignClient("usercenter-provider")注解的意思是该接口里定义的方法全部是“usercenter-provider”这个serviceid提供的方法，注意这里的serviceid需要和eureka server里定义的服务提供方的名字一致，不然feign是无法找到相关服务的，feign内部集成了Ribbon所以通过serviceid找到服务后，会通过ribbon自动实现服务访问的负载均衡，可以通过定义ribbon的负载均衡方法来实现自己想要的，默认得是随机访问方法也可以定义成顺序、访问权重或者自定义负载算法，这里就使用了默认的负载，默认负载已经能够满足大部分需求了。在接口的方法前面需要定义该方法访问路径和访问方法和编码格式等信息，对于请求参数也可以通过@requestBody或者@RequestParameter的value方法进行设置，这里就使用和入参名同名的参数设定。是不是很简单，这样就定义好了远程服务端接口。

4. 远程服务接口使用

上面定义好了Feign Client接口，后面使用就很简单了，这里按照日常项目结构定义了service层和controller，将feign的接口调用放在了service的实现类中，在controller类中进行service的调用，这里需要注意一个问题，之前在测试的过程中自己遇到了，因为不小心写错了，犯了一个很低级的错误，找了1个小时才找到原因。。因为feign的client是通过@AutoWired启动的时候自动注入的，这就使得如果client的调用是在service里的时候需要将service也放在spring的ioc中进行托管，不然就会报你的Service没有定义，并且在Controller使用这个Service的时候也要通过ioc容器自动注入Service实现，不然会报client空指针的错误，如果调试过程中发现FeignClient调用的时候报nullpoint，基本就是由于ioc bean托管导致的问题，我就是因为写错了一行代码导致了这个问题。
UserServiceImpl.java

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserFeignClient userFeignClient;
    @Override
    public String getUSer(String data) {
        return "Feign: " + userFeignClient.getUser(data);
    }
}

UserController.java

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping(value = "/getUser", method = RequestMethod.POST, produces = {"application/json;charset=UTF-8"})
    public String getUser(@RequestBody String data){
        return userService.getUSer(data);
    }
}

5. application.yml参数设置

在配置中主要是要配置eureka server集群的地址，因为需要定义在哪个eureka集群中找到feign使用的serviceid。

spring:
  application:
    name: springcloud-feign-ribbon

server:
  port: 8080

eureka:
  client:
    serviceUrl:
      defaultZone: http://node1:8761/eureka/,http://node2:8762/eureka/

小结

最后我们启动eureka server、usercenter－provider的服务，再启动本次写的应用。

image
下面通过httprequester来发起请求，地址栏输入http://node1:8080/getUser，body栏输入{"name":"feiweiwei"},可以看到返回了Feign ｛"name"："feiweiwei"｝
image

源码Git地址：https://github.com/feiweiwei/springcloud-feign