Spring Cloud OpenFeign: декларативный вызов услуг на основе ленты и Hystrix

Java
Spring Cloud OpenFeign: декларативный вызов услуг на основе ленты и Hystrix

Адрес фактического проекта электронной коммерции SpringBoot (20k+star):GitHub.com/macro-positive/…

Резюме

Spring Cloud OpenFeign — это инструмент декларативного вызова службы. Он интегрирует Ribbon и Hystrix и имеет функции балансировки нагрузки и отказоустойчивости службы. В этой статье подробно описано его использование.

Введение в фейк

Feign — это инструмент декларативного вызова службы.Нам нужно только создать интерфейс и настроить его с помощью аннотаций, после чего мы можем реализовать вызов интерфейса службы, что упрощает разработку прямого использования RestTemplate для вызова интерфейса службы. Feign имеет подключаемую поддержку аннотаций и поддерживает аннотации Feign, аннотации JAX-RS и аннотации SpringMvc. При использовании Feign Spring Cloud интегрирует Ribbon и Eureka для обеспечения балансировки нагрузки вызовов службы и защиты отказоустойчивости службы на основе Hystrix.

Создайте модуль фиктивной службы

Здесь мы создаем модуль Feign-Service для демонстрации общих возможностей FeIGN.

Добавьте связанные зависимости в pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Настроить в application.yml

server:
  port: 8701
spring:
  application:
    name: feign-service
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8001/eureka/

Добавьте аннотацию @EnableFeignClients в класс запуска, чтобы включить клиентские функции Feign.

@EnableFeignClients
@EnableDiscoveryClient
@SpringBootApplication
public class FeignServiceApplication {

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

}

Добавьте интерфейс UserService, чтобы завершить привязку интерфейса к службе пользовательской службы.

Мы реализовали клиент Feign через аннотацию @FeignClient, где значение user-service указывает, что это клиент для вызова интерфейса сервиса user-service. Мы можем отозвать UserController в пользовательском сервисе, просто изменив его на интерфейс и сохранив исходную аннотацию SpringMvc.

/**
 * Created by macro on 2019/9/5.
 */
@FeignClient(value = "user-service")
public interface UserService {
    @PostMapping("/user/create")
    CommonResult create(@RequestBody User user);

    @GetMapping("/user/{id}")
    CommonResult<User> getUser(@PathVariable Long id);

    @GetMapping("/user/getByUsername")
    CommonResult<User> getByUsername(@RequestParam String username);

    @PostMapping("/user/update")
    CommonResult update(@RequestBody User user);

    @PostMapping("/user/delete/{id}")
    CommonResult delete(@PathVariable Long id);
}

Добавьте UserFeignController для вызова UserService для реализации вызова службы.

/**
 * Created by macro on 2019/8/29.
 */
@RestController
@RequestMapping("/user")
public class UserFeignController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public CommonResult getUser(@PathVariable Long id) {
        return userService.getUser(id);
    }

    @GetMapping("/getByUsername")
    public CommonResult getByUsername(@RequestParam String username) {
        return userService.getByUsername(username);
    }

    @PostMapping("/create")
    public CommonResult create(@RequestBody User user) {
        return userService.create(user);
    }

    @PostMapping("/update")
    public CommonResult update(@RequestBody User user) {
        return userService.update(user);
    }

    @PostMapping("/delete/{id}")
    public CommonResult delete(@PathVariable Long id) {
        return userService.delete(id);
    }
}

Демонстрация функции балансировки нагрузки

  • Запустите Eureka-Service, два пользовательских службы, сервис услуг Figage, после запуска реестра показано ниже:

  • Несколько вызововhttp://localhost:8701/user/1После тестирования можно обнаружить, что службы пользовательских служб, работающие на 8201 и 8202, поочередно выводят следующую информацию:
2019-10-04 15:15:34.829  INFO 9236 --- [nio-8201-exec-5] c.macro.cloud.controller.UserController  : 根据id获取用户信息,用户名称为:macro
2019-10-04 15:15:35.492  INFO 9236 --- [io-8201-exec-10] c.macro.cloud.controller.UserController  : 根据id获取用户信息,用户名称为:macro
2019-10-04 15:15:35.825  INFO 9236 --- [nio-8201-exec-9] c.macro.cloud.controller.UserController  : 根据id获取用户信息,用户名称为:macro

Понижение уровня сервиса в Feign

Даунгрейд сервиса в Feign очень удобен в использовании: нужно только добавить класс реализации для обработки даунгрейда сервиса в интерфейс, определенный клиентом Feign, а затем добавить класс реализации даунгрейда сервиса для интерфейса UserService.

Добавить класс реализации понижения службы UserFallbackService

Следует отметить, что он реализует интерфейс UserService и реализует логику деградации службы для каждого метода реализации в интерфейсе.

/**
 * Created by macro on 2019/9/5.
 */
@Component
public class UserFallbackService implements UserService {
    @Override
    public CommonResult create(User user) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult<User> getUser(Long id) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult<User> getByUsername(String username) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult update(User user) {
        return new CommonResult("调用失败,服务被降级",500);
    }

    @Override
    public CommonResult delete(Long id) {
        return new CommonResult("调用失败,服务被降级",500);
    }
}

USERSERVICE Изменить интерфейс, расположенный на понижение понижения службы UserFallService

Измените параметры в аннотации @FeignClient и задайте резервный вариант UserFallbackService.class.

@FeignClient(value = "user-service",fallback = UserFallbackService.class)
public interface UserService {
}

Измените application.yml, чтобы включить функцию Hystrix.

feign:
  hystrix:
    enabled: true #在Feign中开启Hystrix

Демонстрация функции понижения уровня обслуживания

  • Выключите две службы пользовательских служб и перезапустите фиктивную службу;

  • перечислитьhttp://localhost:8701/user/1После тестирования можно обнаружить, что возвращается информация о снижении качества обслуживания.

функция печати журнала

Feign предоставляет функцию печати журнала Мы можем настроить уровень журнала с помощью конфигурации, чтобы понять детали запросов Http в Feign.

уровень журнала

  • NONE: по умолчанию журналы не отображаются;
  • ОСНОВНОЙ: записывайте только метод запроса, URL-адрес, код состояния ответа и время выполнения;
  • ЗАГОЛОВКИ: В дополнение к информации, определенной в BASIC, существует информация заголовков для запросов и ответов;
  • FULL: в дополнение к информации, определенной в HEADERS, есть тело и метаданные запроса и ответа.

Открыть более подробные журналы

Мы используем конфигурацию Java, чтобы заставить Feign печатать наиболее подробную информацию журнала запросов Http.

/**
 * Created by macro on 2019/9/5.
 */
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

Настройте клиент Feign, который должен открывать журнал в application.yml

Настройте уровень журнала UserService для отладки.

logging:
  level:
    com.macro.cloud.service.UserService: debug

Просмотр журналов

перечислитьhttp://localhost:8701/user/1Тест, вы можете увидеть следующие журналы.

2019-10-04 15:44:03.248 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] ---> GET http://user-service/user/1 HTTP/1.1
2019-10-04 15:44:03.248 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] ---> END HTTP (0-byte body)
2019-10-04 15:44:03.257 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] <--- HTTP/1.1 200 (9ms)
2019-10-04 15:44:03.257 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] content-type: application/json;charset=UTF-8
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] date: Fri, 04 Oct 2019 07:44:03 GMT
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] transfer-encoding: chunked
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] 
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] {"data":{"id":1,"username":"macro","password":"123456"},"message":"操作成功","code":200}
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] <--- END HTTP (92-byte body)

Ведущая общая конфигурация

Смоделируйте собственную конфигурацию

feign:
  hystrix:
    enabled: true #在Feign中开启Hystrix
  compression:
    request:
      enabled: false #是否对请求进行GZIP压缩
      mime-types: text/xml,application/xml,application/json #指定压缩的请求数据类型
      min-request-size: 2048 #超过该大小的请求会被压缩
    response:
      enabled: false #是否对响应进行GZIP压缩
logging:
  level: #修改日志级别
    com.macro.cloud.service.UserService: debug

Конфигурация ленты в Feign

Чтобы настроить ленту в Feign, вы можете напрямую использовать конфигурацию ленты.Spring Cloud Ribbon: сервисные вызовы с балансировкой нагрузки.

Конфигурация Hystrix в Feign

Конфигурация Hystrix Hystrix может использоваться непосредственно в конфигурации Feign, в частности, может относиться кSpring Cloud Hystrix: отказоустойчивая защита сервисов.

используемые модули

springcloud-learning
├── eureka-server -- eureka注册中心
├── user-service -- 提供User对象CRUD接口的服务
└── feign-service -- feign服务调用测试服务

Адрес исходного кода проекта

GitHub.com/macro-positive/…

публика

проект торгового центраПолный набор учебных пособий сериализуется,Обратите внимание на публичный аккаунтПолучите это прямо сейчас.

公众号图片