Что такое feign java

Введение в Feign

1. Обзор

Feign стремится упростить клиентов HTTP API. Проще говоря, разработчику нужно только объявить и аннотировать интерфейс, в то время как фактическая реализация предоставляется во время выполнения.

2. Пример

В этом руководстве мы будем использовать пример приложения книжного магазина, которое предоставляет конечную точку REST API.

Мы можем легко клонировать проект и запускать его локально:

3. Настройка

Для начала добавим необходимые зависимости:

Помимо зависимости feign-core (которая также втягивается), мы будем использовать несколько плагинов, в частности: feign-okhttp для внутреннего использования клиента OkHttp Square для выполнения запросов, feign-gson для использования Google GSON в качестве процессора JSON и симулируйте- slf4j для использования Simple Logging Facade для регистрации запросов.

Чтобы получить какой-то вывод журнала, нам понадобится наша любимая реализация регистратора с поддержкой SLF4J в пути к классам.

Прежде чем мы приступим к созданию нашего клиентского интерфейса, сначала мы настроим модель Book для хранения данных:

ПРИМЕЧАНИЕ. Процессору JSON необходим как минимум «конструктор без аргументов».

4. На стороне сервера

Чтобы понять, как определить клиента Feign, мы сначала рассмотрим некоторые методы и ответы, поддерживаемые нашим поставщиком REST.

В результате мы получим полное хранилище книг в формате JSON:

5. Имитируйте клиента

Наконец, давайте определим нашего клиента Feign.

Мы будем использовать аннотацию @RequestLine, чтобы указать HTTP-команду и часть пути в качестве аргумента. Параметры будут смоделированы с использованием аннотации @Param :

ПРИМЕЧАНИЕ. Клиенты Feign могут использоваться только для использования текстовых HTTP API, что означает, что они не могут обрабатывать двоичные данные, например, выгрузку или скачивание файлов.

Это все! Теперь мы будем использовать Feign.builder () для настройки нашего клиента на основе интерфейса. Фактическая реализация будет предоставлена ​​во время выполнения:

Feign поддерживает различные плагины, такие как кодировщики и декодеры JSON / XML или базовый HTTP-клиент для выполнения запросов.

6. Модульный тест

Создадим три тестовых случая для тестирования нашего клиента. Обратите внимание, мы используем статический импорт для org.hamcrest.CoreMatchers. * И org.junit.Assert. * :

7. Дополнительная литература

Ознакомьтесь с этой специальной серией руководств, чтобы узнать больше о Hystrix.

Кроме того, если мы хотим интегрировать Spring Cloud Netflix Hystrix с Feign, здесь есть специальная статья.

Кроме того, к нашему клиенту также можно добавить балансировку нагрузки на стороне клиента и / или обнаружение служб.

Мы могли бы добиться этого, добавив Ribbon в наш путь к классам и используя конструктор следующим образом:

Для обнаружения сервисов мы должны создать наш сервис с включенной Spring Cloud Netflix Eureka. Затем просто интегрируйтесь с Spring Cloud Netflix Feign. В итоге получаем балансировку нагрузки Ribbon бесплатно. Подробнее об этом можно прочитать здесь.

8. Заключение

В этой статье мы объяснили, как создать декларативный HTTP-клиент с использованием Feign для использования текстовых API.

Как обычно, все примеры кода, показанные в этом руководстве, доступны на GitHub.

Источник

Русские Блоги

SpringCloud OpenFeign

Что такое притворство

Лента и сравнение Feign

(1) Прежде всего, нижний уровень отличается. Ribbon использует перехватчики для перехвата отправленных методов (RestTemplate.getForEntity и другие методы), а затем выполняет соответствующую обработку; в то время как Feign использует метод динамического прокси для его обработки.
(2) Нижний уровень Feign по-прежнему вызывается с помощью ленты.
(3) Метод вызова Feign проще, используя Интерфейс + аннотация Этот метод позволяет пользователю выполнить вызов HttpRestfulAPI без восприятия.

Построить проект Feign

1. Создайте поставщика услуг

2. Создайте проект API.
(1) Создайте новый проект feeng-api, Функция этого проекта состоит в том, что мы помещаем сюда все сервисы, которые использует feign. В этот раз, когда мы вызываем feign, нам нужно только унаследовать класс и написать к нему комментарии.
(2) Посмотрите на схему архитектуры.

(3) файл pom

(4) Основной стартовый класс

(6) Упакуйте его в форму jar и введите эту зависимость от вызывающего

3. Создайте потребительскую сторону услуги.
(1) Отображение архитектурной схемы.

(2) Зависимость файла POM

(3) Файл конфигурации

(4) Основной стартовый класс

(5) Интерфейс сервисного уровня

Другое использование Feign

Пользовательский уровень журнала Feign

1. Уровень журнала
(1) НЕТ: Лучшая производительность, используется для дней рождения, журналы не записываются.
(2) ЗАГОЛОВКИ: Запишите заголовки запроса и ответа на основе уровня BASIC.
(3) FULL: он больше подходит для заголовка, тела и метаданных среды разработки и тестирования для обнаружения проблем, записи и ответа.
(4) BASIC: Подходит для отслеживания проблем в производственной среде, регистрируя только метод запроса, URL, код состояния ответа и время выполнения.

2. Как реализовать в коде

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

Как поддержать аннотации Feign для замены аннотаций SpringMVC

1. Конфигурация кода

2. Конфигурация в файле yml (после конфигурации файла yml конфигурация в коде не нужна)

Создайте перехватчик для установки общедоступных параметров для достижения

1. Напишите перехватчик

2. Добавьте конфигурацию перехватчика.
(1) Реализовано в коде:

Независимо от того, настраиваем ли мы уровни журнала, перехватчики или заменяем аннотации SpringMVC, мы не добавляем @Configuration, чтобы он не вступил в силу глобально, и позволяем всем Feign использовать эту конфигурацию.

(2) Завершите настройку перехватчика в файле yml без написания кода конфигурации.

3. Токен, заключенный в этот перехватчик, можно получить напрямую у поставщика услуг.

Интеллектуальная рекомендация

Совместное использование сухих товаров GitHub (высокая степень интеграции страницы руководства APP-DHGuidePageHUD)

Каждое приложение будет использовать страницу руководства APP, которая не важна, но обязательна. Будь то первая установка приложения или обновление версии, это единственное, что будет показано пользов.

Организуйте некоторые элементы управления диаграммами, которые можно использовать в веб-разработке, в основном для клиентских реализаций, таких как Flash, JavaScript, Silverlight; если для создания ст.

Некоторые методы конфигурации Django_redis и сельдерея

Problem for Nazar

Vue следит за тем, чтобы браузер возвращал

Источник

7. Declarative REST Client: Feign

Feign is a declarative web service client. It makes writing web service clients easier. To use Feign create an interface and annotate it. It has pluggable annotation support including Feign annotations and JAX-RS annotations. Feign also supports pluggable encoders and decoders. Spring Cloud adds support for Spring MVC annotations and for using the same HttpMessageConverters used by default in Spring Web. Spring Cloud integrates Ribbon and Eureka to provide a load balanced http client when using Feign.

7.1 How to Include Feign

Example spring boot app

In the @FeignClient annotation the String value («stores» above) is an arbitrary client name, which is used to create a Ribbon load balancer (see below for details of Ribbon support). You can also specify a URL using the url attribute (absolute value or just a hostname). The name of the bean in the application context is the fully qualified name of the interface. To specify your own alias value you can use the qualifier value of the @FeignClient annotation.

The Ribbon client above will want to discover the physical addresses for the «stores» service. If your application is a Eureka client then it will resolve the service in the Eureka service registry. If you don’t want to use Eureka, you can simply configure a list of servers in your external configuration (see above for example).

7.2 Overriding Feign Defaults

In this case the client is composed from the components already in FeignClientsConfiguration together with any in FooConfiguration (where the latter will override the former).

The serviceId attribute is now deprecated in favor of the name attribute.

Previously, using the url attribute, did not require the name attribute. Using name is now required.

Placeholders are supported in the name and url attributes.

Spring Cloud Netflix provides the following beans by default for feign ( BeanType beanName: ClassName ):

Spring Cloud Netflix does not provide the following beans by default for feign, but still looks up beans of these types from the application context to create the feign client:

Creating a bean of one of those type and placing it in a @FeignClient configuration (such as FooConfiguration above) allows you to override each one of the beans described. Example:

@FeignClient also can be configured using configuration properties.

Default configurations can be specified in the @EnableFeignClients attribute defaultConfiguration in a similar manner as described above. The difference is that this configuration will apply to all feign clients.

If you need to use ThreadLocal bound variables in your RequestInterceptor`s you will need to either set the thread isolation strategy for Hystrix to `SEMAPHORE or disable Hystrix in Feign.

7.3 Creating Feign Clients Manually

In some cases it might be necessary to customize your Feign Clients in a way that is not possible using the methods above. In this case you can create Clients using the Feign Builder API. Below is an example which creates two Feign Clients with the same interface but configures each one with a separate request interceptor.

In the above example FeignClientsConfiguration.class is the default configuration provided by Spring Cloud Netflix.

PROD-SVC is the name of the service the Clients will be making requests to.

The Feign Contract object defines what annotations and values are valid on interfaces. The autowired Contract bean provides supports for SpringMVC annotations, instead of the default Feign native annotations.

7.4 Feign Hystrix Support

To disable Hystrix support on a per-client basis create a vanilla Feign.Builder with the «prototype» scope, e.g.:

Prior to the Spring Cloud Dalston release, if Hystrix was on the classpath Feign would have wrapped all methods in a circuit breaker by default. This default behavior was changed in Spring Cloud Dalston in favor for an opt-in approach.

7.5 Feign Hystrix Fallbacks

Hystrix supports the notion of a fallback: a default code path that is executed when they circuit is open or there is an error. To enable fallbacks for a given @FeignClient set the fallback attribute to the class name that implements the fallback. You also need to declare your implementation as a Spring bean.

7.6 Feign and @Primary

7.7 Feign Inheritance Support

Feign supports boilerplate apis via single-inheritance interfaces. This allows grouping common operations into convenient base interfaces.

It is generally not advisable to share an interface between a server and a client. It introduces tight coupling, and also actually doesn’t work with Spring MVC in its current form (method parameter mapping is not inherited).

7.8 Feign request/response compression

You may consider enabling the request or response GZIP compression for your Feign requests. You can do this by enabling one of the properties:

Feign request compression gives you settings similar to what you may set for your web server:

These properties allow you to be selective about the compressed media types and minimum request threshold length.

7.9 Feign logging

A logger is created for each Feign client created. By default the name of the logger is the full class name of the interface used to create the Feign client. Feign logging only responds to the DEBUG level.

Источник

Spring Cloud Netflix: Feign по-русски

Jun 4, 2019 · 4 min read

Я хочу продолжить серию из предыдущих статей по Netflix, а именно поговорить про Feign Client.

На русском языке очень мало информации по стеку Netflix.

И правильно, потому что надо читать официальную документацию, там вы найдете больше всего. Но я все же решил рассказать “своими словами” чтобы сложилась более ясная картина при изучении данного стека для тех, кто предпочитает русскоязычную литературу.

Планирую обновлять статьи по мере изучения нового материала. Если у вас есть предложения на этот счет, буду рад выслушать.

Другие реализации Feign Client я рассмотрел в другой статье:

Feign — простой и гибкий http-клиент, который нативно интегрирован с Ribbon (О нем в другой статье).
Feign использует интерфейсы аннотированные @FeignClient чтобы генерировать API запросы и мапить ответ на Java классы.
Он шлет http запросы другим сервисам.

Его особенность в том, что нам не нужно знать где и на каком по р ту находится какой-то сервис.
Мы просто говорим Feign клиенту, иди к “Джон Уику” и получи у него всех пользователей. Далее Feign обращается к Eureka Server и спрашивает где находится “Джон Уик”.
Если “Джон Уик” регистрировался в Eureka Server, то Eureka будет всё знать о “Джон Уик” (где он находится, на каком порту, его URL и т.д.)

Вам нужно только описать, как получить доступ к удаленной службе API, указав такие детали, как URL, тело запроса и ответа, принятые заголовки и т. д. Клиент Feign позаботится о деталях реализации.

Netflix предоставляет Feign в качестве абстракции для вызовов на основе REST, благодаря которым микросервисы могут связываться друг с другом, но разработчикам не нужно беспокоиться о внутренних деталях REST.

Нужно указать аннотацию @EnableFeignClients над основным классом

@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
public class FeignClientApplication <

public static void main(String[] args) <
SpringApplication.run(FeignClientApplication.class, args);
>

На интерфейс ставим аннотацию @FeignClient(name = “Джон Уик”) и указываем имя того сервиса, который нам нужен (в пояснении я описывал сервис под названием “Джон Уик”). В том сервисе будет выполняться некая логика по работе с базой и настройки коннекта к базе, или получение всех пользователей и т.д.

Feign — это первый шаг в реализации архитектуры микросервиса при помощи инструментов Netflix.
В реальности слабо связанных сервисов очень важно чтобы общение между ними было легковесным и простым для отладки.
Поэтому для этой цели зачастую используют REST, хотя для некоторых случаев это может быть не лучшим выбором.

Еще раз: для упрощения связи по REST мы и используем Feign: при помощи него мы будем поглощать сообщения от других сервисов и автоматически превращать их в Java объекты.

Рассмотрим небольшой и в то же время очень простой пример.

У нас есть сервис А и сервис B, которые оба зарегистрированы в Eureka. Мы хотим из сервиса А вызвать сервис B и получить какие-то данные.

Сервис B имеет следующий контроллер:

@RestController
@RequestMapping(“/users//statistic”)
public class StatisticsController <

@Autowired
StatisticsService statisticsService;

public List getStatistic(@PathVariable String id) <
List statisticsList = statisticsService.getAlbums(id);
return statisticsList;
>
>

public class UserStatisticModel <

private Long id;
private String userId;
private String username;
private String title;

Используем Lombok чтобы избавиться от ненужного кода геттеров и сеттеров.

Чтобы из сервиса А вызвать сервис B мы создадим в сервисе А feign client.

В аннотации @FeignClient мы указываем имя того сервиса, который хотим вызвать ( сервис B).

@FeignClient(name = “B”)
public interface ServiceFeignClient <

@GetMapping(“/users/$/statistic”)
public List getStatistic(@PathVariable String id);

Аннотация @GetMapping содержит путь, который отображается на тот же самый путь в аннотации @RequestMapping в микросервисе B и указывает, что это будет GET запрос.

Метод должен иметь такую-же сигнатуру что и метод в сервисе B. Это важно!

public class UserStatisticModel <

private Long id;
private String userId;
private String username;
private String title;

Теперь чтобы создать экземпляр клиента Feign, вам нужно будет автоматически подключить интерфейс клиента feign к вашему классу, в котором вызывается логика.

@Service
public class UsersServiceImpl implements UsersService <

@Autowired
ServiceFeignClient serviceFeignClient;

Теперь когда мы будем дергать URL “/users/$/statistic” из ServiceFeignClient сервиса А, он посмотрит на аннотацию @FeignClient(name = “B”) и увидит, что там указан сервис B, пойдет к нему и по этому же URL в StatisticsController вызовет метод getStatistic.

Также хочу добавить, если вам нужно использовать внешнюю веб-службу, которая не является частью вашей архитектуры микросервисов и не зарегистрирована в вашей службе Eureka, то используйте URL в качестве параметра аннотации @FeignClient.

@FeignClient(name = “B”, url = “http://lalalala»)
public interface ServiceFeignClient <

@GetMapping(“/users/$/statistic”)
public List getStatistic(@PathVariable String id);

Если вы нашли неточности в описании данной статьи, вы можете написать мне на email и я с радостью вам отвечу.

Источник

Spring Cloud OpenFeign

This project provides OpenFeign integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms.

1. Declarative REST Client: Feign

Feign is a declarative web service client. It makes writing web service clients easier. To use Feign create an interface and annotate it. It has pluggable annotation support including Feign annotations and JAX-RS annotations. Feign also supports pluggable encoders and decoders. Spring Cloud adds support for Spring MVC annotations and for using the same HttpMessageConverters used by default in Spring Web. Spring Cloud integrates Eureka, Spring Cloud CircuitBreaker, as well as Spring Cloud LoadBalancer to provide a load-balanced http client when using Feign.

1.1. How to Include Feign

Example spring boot app

In the @FeignClient annotation the String value («stores» above) is an arbitrary client name, which is used to create a Spring Cloud LoadBalancer client. You can also specify a URL using the url attribute (absolute value or just a hostname). The name of the bean in the application context is the fully qualified name of the interface. To specify your own alias value you can use the qualifiers value of the @FeignClient annotation.

Spring Cloud OpenFeign supports all the features available for the blocking mode of Spring Cloud LoadBalancer. You can read more about them in the project documentation.

1.2. Overriding Feign Defaults

In this case the client is composed from the components already in FeignClientsConfiguration together with any in FooConfiguration (where the latter will override the former).

Placeholders are supported in the name and url attributes.

Spring Cloud OpenFeign provides the following beans by default for feign ( BeanType beanName: ClassName ):

Decoder feignDecoder: ResponseEntityDecoder (which wraps a SpringDecoder )

Encoder feignEncoder: SpringEncoder

Logger feignLogger: Slf4jLogger

MicrometerCapability micrometerCapability: If feign-micrometer is on the classpath and MeterRegistry is available

Contract feignContract: SpringMvcContract

Feign.Builder feignBuilder: FeignCircuitBreaker.Builder

Client feignClient: If Spring Cloud LoadBalancer is on the classpath, FeignBlockingLoadBalancerClient is used. If none of them is on the classpath, the default feign client is used.

Spring Cloud OpenFeign does not provide the following beans by default for feign, but still looks up beans of these types from the application context to create the feign client:

Источник