文章目录
SpringCloud组件之Feign1. Feign简介2. Feign快速入门2.1. 导入依赖2.2. 开启Feign功能2.3. Feign的客户端
3. Feign的负载均衡4. Feign支持Hystrix4.1 在justweb-service-consumer工程添加配置内容4.2 我们要定义一个类UserClientFallback,实现刚才编写的UserClient,作为fallback的处理类4.3 然后在UserFeignClient中,指定刚才编写的实现类
5. 请求压缩(了解)6. 日志级别(了解)6.1 设置cn.justweb包下的日志级别都为debug6.2 编写配置类,定义日志级别6.3 在FeignClient中指定配置类
7. Feign应用-删除小节同时删除云端视频7.1 Feign7.2 删除课时的同时删除云端视频7.2.1 在service模块添加pom依赖7.2.2 在调用端的启动类添加注解7.2.3 包和接口7.2.4 调用微服务7.2.5 service_vod中的removeVideo方法
7.3 测试
☆
SpringCloud组件之Feign
在前面的学习中,我们使用了Ribbon的负载均衡功能,大大简化了远程调用时的代码:String user = this.restTemplate.getForObject("http://service-provider/user/" + id, String.class);
如果就学到这里,你可能以后需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更优雅的方式,来对这些代码再次优化呢?
学习完Feign之后就可以修改代码生成器的模板来生成我们需要的代码了
1. Feign简介
Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。项目主页:https://github.com/OpenFeign/feignFeign是Netflix开发的声明式、模板化的HTTP客户端,其灵感来自Retrofit、 JAXRS-2.0以及WebSocket。Feign 可帮助我们更加便捷、优雅地调用HTTP API。在Spring Cloud中,使用Feign非常简单-------创建一个接口,并在接口上添加一些注解, 代码就完成了。Feign 支持多种注解,例如Feign自带的注解或者JAX-RS 注解等。Spring Cloud对Feign进行了增强,使Feign支持了Spring MVC注解,并整合了Ribbon和Eureka,从而让Feign的使用更加方便。
2. Feign快速入门
改造justweb-service-consumer工程
2.1. 导入依赖
<dependency>
<groupId>org.springframework.cloud
</groupId>
<artifactId>spring-cloud-starter-openfeign
</artifactId>
</dependency>
2.2. 开启Feign功能
我们在启动类上,添加注解,开启Feign功能
@SpringCloudApplication
@EnableFeignClients
public class JustwebServiceConsumerApplication {
public static void main(String
[] args
) {
SpringApplication
.run(justwebServiceConsumerApplication
.class, args
);
}
}
2.3. Feign的客户端
在justweb-service-consumer工程中,添加UserClient接口
首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像。@FeignClient,声明这是一个Feign客户端,类似@Mapper注解。同时通过value属性指定服务名称。接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果。
@FeignClient(value
= "service-provider")
public interface UserClient {
@GetMapping("user/{id}")
User
queryById(@PathVariable("id") Long id
);
}
改造原来的调用逻辑,调用UserClient接口:
@RestController
@RequestMapping("/consumer/user")
public class UserController {
@Autowired
private UserClient userClient
;
@RequestMapping(produces
= {"application/json;charset=utf-8"})
public User
queryById(@RequestParam("id") Long id
){
User user
= userClient
.queryById(id
);
System
.out
.println(user
);
return user
;
}
}
3. Feign的负载均衡
Feign中本身已经集成了Ribbon依赖和自动配置:因此我们不需要额外引入依赖,也不需要再注册RestTemplate对象。
4. Feign支持Hystrix
Feign默认也有对Hystrix的集成:只不过,默认情况下是关闭的。我们需要通过下面的参数来开启。
4.1 在justweb-service-consumer工程添加配置内容
feign:
hystrix:
enabled: true
但是,Feign中的Fallback配置不像hystrix中那样简单了。
4.2 我们要定义一个类UserClientFallback,实现刚才编写的UserClient,作为fallback的处理类
@Component
public class UserClientFallback implements UserClient {
@Override
public User
queryById(Long id
) {
User user
= new User();
user
.setUserName("服务器繁忙,请稍后再试!");
return user
;
}
}
4.3 然后在UserFeignClient中,指定刚才编写的实现类
@FeignClient(value
= "service-provider", fallback
= UserClientFallback
.class)
public interface UserClient {
@GetMapping("user/{id}")
User
queryUserById(@PathVariable("id") Long id
);
}
5. 请求压缩(了解)
Spring Cloud Feign 支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗。通过下面的参数即可开启请求与响应的压缩功能:
feign:
compression:
request:
enabled: true
response:
enabled: true
同时,我们也可以对请求的数据类型,以及触发压缩的大小下限进行设置:
feign:
compression:
request:
enabled: true
mime-types: text/html
,application/xml
,application/json
min-request-size: 2048
注:上面的数据类型、压缩大小下限均为默认值。
6. 日志级别(了解)
前面讲过,通过logging.level.xx=debug来设置日志级别。然而这个对Fegin客户端而言不会产生效果。因为@FeignClient注解修改的客户端在被代理时,都会创建一个新的Fegin.Logger实例。我们需要额外指定这个日志的级别才可以。
6.1 设置cn.justweb包下的日志级别都为debug
logging:
level:
cn.justweb: debug
6.2 编写配置类,定义日志级别
内容:
@Configuration
public class FeignLogConfiguration {
@Bean
Logger
.Level
feignLoggerLevel(){
return Logger
.Level
.FULL
;
}
}
这里指定的Level级别是FULL,Feign支持4种级别:
NONE:不记录任何日志信息,这是默认值。BASIC:仅记录请求的方法,URL以及响应状态码和执行时间。HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息。FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
6.3 在FeignClient中指定配置类
@FeignClient(value
= "service-privider", fallback
= UserFeignClientFallback
.class, configuration
= FeignConfig
.class)
public interface UserFeignClient {
@GetMapping("/user/{id}")
User
queryUserById(@PathVariable("id") Long id
);
}
7. Feign应用-删除小节同时删除云端视频
7.1 Feign
本小节是项目中使用到微服务之间的调用。Spring Cloud Feign帮助我们定义和实现依赖服务接口的定义。在Spring Cloud feign的实现下,只需要创建一个接口并用注解方式配置它,即可完成服务提供方的接口绑定,简化了在使用Spring Cloud Ribbon时自行封装服务调用客户端的开发量。
7.2 删除课时的同时删除云端视频
7.2.1 在service模块添加pom依赖
<dependency>
<groupId>org.springframework.cloud
</groupId>
<artifactId>spring-cloud-starter-openfeign
</artifactId>
</dependency>
7.2.2 在调用端的启动类添加注解
@EnableFeignClients
7.2.3 包和接口
创建client包@FeignClient注解用于指定从哪个服务中调用功能 ,名称与被调用的服务名保持一致。@PathVariable注解一定要指定参数名称,否则出错。@Component注解防止,在其他位置注入VodClient时idea报错
@FeignClient("service-vod")
@Component
public interface VodClient {
@DeleteMapping("/vod/vod-operation/removeVideo/{videoId}")
R
removeVideo(@PathVariable("videoId") String videoId
);
}
7.2.4 调用微服务
在调用端的EduVideoServiceImpl中调用client中的方法。
@Service
public class EduVideoServiceImpl extends ServiceImpl<EduVideoMapper, EduVideo> implements EduVideoService {
@Autowired
private VodClient vodClient
;
@Override
public void deleteVideo(String id
) {
QueryWrapper queryWrapper
= new QueryWrapper();
queryWrapper
.eq("id",id
);
EduVideo eduVideo
= baseMapper
.selectOne(queryWrapper
);
String videoSourceId
= eduVideo
.getVideoSourceId();
if (!StringUtils
.isEmpty(videoSourceId
)) {
vodClient
.removeVideo(videoSourceId
);
}
int delete
= baseMapper
.delete(queryWrapper
);
if(delete
== 0){
throw new GuliException(20001,"删除小节失败!");
}
}
}
7.2.5 service_vod中的removeVideo方法
@Override
public void removeVideo(String videoId
) {
try {
DefaultAcsClient client
= AliYunVodSDKUtils
.initVodClient();
DeleteVideoRequest request
= new DeleteVideoRequest();
request
.setVideoIds(videoId
);
DeleteVideoResponse response
= client
.getAcsResponse(request
);
System
.out
.print("RequestId = " + response
.getRequestId() + "\n");
} catch (ClientException e
) {
throw new GuliException(20001, "视频删除失败");
}
}
7.3 测试
启动相关微服务,测试删除课时的功能能都连着视频删除。
☆