Что такое apollo graphql
Apollo graphql client — разработка приложений на react.js без redux
Apollo graphql client представляет удобный лаконичный спсоб работы с данными в приложениях react. В большинстве случаев все то, что мы привыкли делать с помощью redux, гораздо проще сделать при помощи Apollo graphql client. То, о чем я хотел бы рассказать в этой статье — это что связка react + apollo client + graphql существенно (на порядок) упрощает разработку приложений react.
Для работы мы будем использовать тестовый сервер graphql по адресу. graphql из коробки предлагает, кроме всего прочего, консоль для выполнения запросов, и в ней же интегрированную документацию. Предлагаю раскрыть эту панель. В левой панели можно вводить запрос, в правой будет выводиться ответ. Попробуйте ввести самый простой запрос:
allUsers это имя запроса, а внутри фигурных скобок — имена полей которые будут возвращены. Более сложные запросы могут содержать список параметров и содержать поля вложенных объектов:
В данном случае параметры orderBy и limit не следует воспринимать как в SQL. Это просто имена параметров которые сами по себе без реализации не делают сортировку или ограничение выборки.
Другие параметры и выходные поля этих запросов можно посмотреть из интерфейса консоли.
В качестве основы для приложения возьмем react-create-app. Дополнительно установим apollo-client и react-router-dom:
Изменим основной компонент приложения App.js:
AploolProvider и ApolloClient — это все что нужно для того чтобы во всех компонентах можно было использовать graphql.
Проще всего передать данные в компонент с использованием тэга Query. Давайте выведем в компоненте список пользователей (сам запрос мы уже опробовали в консоли раньше):
Для добавления или изменения состояния на сервере используются Mutation:
Когда я знакомился с примерами компонетов react с использованием apollo graphql client я чувствовал себя не совсем уютно. А все дело в том что разработчик веб-приложения мыслит скорее императивно, чем декларативно. Нам хочется действия. «Установить фильтр», «сохранить запись» и т.п. И когда мы переходим к тому что нам нет необходимости думать о том как данные грузятся с сервера мы вместо того чтобы принять такой подход и использоватьего преимущества задумываемся над тем как мы будем контролировать store.
Дополняю текст еще одним примером, в котором в запросе graphql используется параметр принятый от охватывающего компонента (роута).
Также Apollo client работает и в условиях серверного рендеринга и универсальных приложений. Предзагрузка данных для серверного рендеринга (включая и все вложенные компоненты) реализована «из коробки». Парадокс в том что соединив несколько технологий которые часто критикуют за усложненность получили в результате существенное упрощение приложения.
Apollo 3.0 для работы с GraphQL в многомодульном Android приложении
Давайте рассмотрим, каким образом настроить и использовать последнюю на данный момент версию клиента apollo в многомодульном приложении под android.
Что такое Apollo и когда он используется?
Создаем проект подключаем плагин и зависимости
Создаем новый проект на основе Empty Activity, я назову его ApolloConfig_Example
Создание нового проекта
Создадим несколько модулей, я назову их ‘common’, и ‘modules’,последний в свою очередь будет содержать ‘module_1’ и ‘module_2’
Подключаем плагин Apollo 3.0 во всех gradle файлах наших модулях
После добавления apollo плагина появится сообщение о необходимости синхронизации проекта, но перед этим необходимо добавить настройки для плагина
Для gradle файла модуля ‘app’
Для gradle файла модуля ‘common’
Для gradle файла модуля ‘module_1’ и ‘module_2’
Нажимаем кнопку ‘Sync Now’
Добавляем зависимости в модули ‘common’, ‘module_1’ и ‘module_2’
В Gradle файлах ‘app’, ‘module_1’ и ‘module_2’ добавляем в зависимости модуль ‘common’. Он станет видим для этих модулей.
Создаем необходимые классы
Начнем с файла scheme.graphqls, это файл описывает, какие данные могут быть запрошены, разместить его нужно в корне проекта, на одном уровне с папками ‘app’, ‘common’, ‘modules’.
В модуле ‘common’ создадим класс ‘ApolloClient’, в нем напишем клиент, поскольку он находится в общем модуле, он будет виден всем другим модулям.
В этом же модуле создадим класс ‘GraphqlAdapters’, в нем напишем скалярный адаптер для типа DateTime, который присутствует в схеме, данные которые будут приходить с этим типом, будут автоматически преобразованы в привычный класс Date.
Перейдем к module_1 и module_2, следующие файлы и классы будут почти идентичны для обоих модулей, и сделано для примера.
Создадим файл ‘GetEmployee.graphql’, он будет на основе scheme.graphqls описывать наш запрос, а apollo на основе ‘GetEmployee.graphql’ сгенерирует все необходимые классы.
Далее создадим класс ApiService и cоответствующий ему интерфейс IApiService, там будем описывать наши запросы.
Все готово для написания самого запроса, создадим класс фрагмента, а в нем запрос
Why adopt GraphQL?
GraphQL and Apollo help you ship features faster
Managing data in modern applications is challenging. Most applications require:
By adopting GraphQL and Apollo, you can reduce these challenges considerably. GraphQL’s declarative model helps you create a consistent, predictable API you can use across all of your clients. As you add, remove, and migrate back-end data stores, that API doesn’t change from the client’s perspective.
Even with many other advantages, GraphQL’s single greatest benefit is the developer experience it provides. It’s straightforward to add new types and fields to your API, and similarly straightforward for your clients to begin using those fields. This helps you design, develop, and deploy features quickly.
Combined with the Apollo platform, complex considerations like caching, data normalization, and optimistic UI rendering become straightforward as well.
GraphQL provides declarative, efficient data fetching
GraphQL’s declarative approach to data fetching provides significant performance and quality-of-life improvements over a REST API.
Consider a webpage that displays a list of adorable pets that are available for adoption at local animal shelters. 🐶
Using REST, the page might need to:
This solution requires multiple dependent network requests, which can result in slower page loads and additional battery consumption on mobile devices. This logic is also difficult to reuse on other pages that display slightly different data.
Using GraphQL, the page can obtain all of this data with a single query to a single endpoint. That query looks like this:
This query describes the shape of the data we want to receive from the GraphQL server. The server takes care of combining and filtering back-end data to return exactly what we ask for. This keeps payload sizes small, especially compared to a REST endpoint that might return hundreds of unnecessary fields.
To execute a query like the one above, the page uses a GraphQL client such as Apollo Client, with code that resembles the following (in the case of a React app):
Apollo Client’s useQuery hook takes care of the request lifecycle from start to finish, including tracking loading and error states for you. There’s no middleware to set up or boilerplate to write before making your first request. All you need to do is describe the data your component needs and let Apollo Client do the heavy lifting. 💪
GraphQL enables powerful tooling
Thanks to GraphQL’s strong typing and built-in support for introspection, developer tools for GraphQL are extremely powerful. These tools let you do things like:
What is Apollo Studio?
Apollo provides a cloud-hosted collection of tools that help you measure your graph’s performance and grow it safely. These tools are together known as Apollo Studio.
After registering your GraphQL schema, you can use Studio’s Explorer tab to inspect all of its types and fields. You can also build and run queries against your running server:
Apollo Client DevTools
The Apollo Client DevTools extension for Chrome and Firefox enables you to inspect your Apollo Client cache, track active queries, and view mutations. It also includes GraphiQL, an IDE that helps you test queries while you’re working on front-end code.
GraphQL is production-ready
GraphQL’s adoption has risen steadily since Facebook published the original specification in 2015. For more and more organizations, the benefits of GraphQL are taking it from a curious engineer’s hack-week experiment to the heart of the application data layer.
GraphQL scales with the requirements of even the largest organizations, largely because of its powerful tooling and its compatibility with a federated architecture.
In a federated architecture, a single GraphQL schema is split across multiple back-end services. Each team in an organization can then own exactly the services (and the corresponding parts of the schema) that they should.
Organizations using GraphQL
Here are a few blog posts from organizations that have benefited from adopting GraphQL in their production environment:
GraphQL trade-offs
When deciding whether to adopt a technology, it’s just as important to understand the technology’s limitations as it is to understand its benefits.
Consider the following trade-offs when using GraphQL:
Change management
GraphQL introduces a new conceptual model for representing and interacting with data. An organization that’s comfortable with this model can design, implement, and ship features quickly. However, the process of becoming comfortable with this model takes time.
The Apollo docs, blog, and forums are all here to help your organization adopt GraphQL and take full advantage of it.
Potential for slow operations
Your GraphQL schema defines which types and fields your clients can query. Your GraphQL server’s resolvers define how those types and fields are populated from your data stores.
Depending on your schema and your resolver definitions, your server might inadvertently support GraphQL operations that execute very slowly, or even max out your server’s resources.
Consequently, it’s important to design your schema such that it supports the operations your clients need, without supporting unnecessary operations that affect performance. It’s also helpful to set up trace reporting for your GraphQL server, enabling you to identify and improve slow operations.
Incompatibility with web browser caching
Although Apollo Client provides useful client-side caching features, the automatic caching provided by your web browser does not interact well with GraphQL.
Web browsers cache fetched data according to its URL. With GraphQL, you fetch all data from the same URL (the URL of your GraphQL server). Consequently, you can’t rely on the cached value for this URL.
Введение в Apollo Client с React на GraphQL
Недавно GraphQL набрал популярность и, скорее всего, заменит Rest API. В этом уроке мы будем использовать Apollo Client для связи с API-интерфейсом GitHub. Мы объединим Apollo Client с ReactJS, но вы можете использовать его и с несколькими другими клиентскими платформами.
В этом руководстве не рассматривается процесс запуска проекта React, но вы можете использовать приложение create-response-app чтобы начать работать.
После того, как у нас появится готовое приложение react, необходимо установить необходимые модули.
Установка модулей
Следующая строка устанавливает все необходимые модули.
Теперь мы можем предоставить наш компонент клиенту.
Предоставление клиенту компонента
Вы можете предоставить клиента в любой точке иерархии компонентов React. Тем не менее, всегда рекомендуется использовать компонент, обертывающий все ваше приложение, клиентом.
В этом примере мы определили маркер API на стороне клиента. Однако вы не должны публиковать свой API токен. Поэтому всегда полезно хранить его на сервере, отделенном от клиентской стороны.
Приложение GraphiQL
Прежде чем погрузиться в запросы, я хочу отметить, что есть очень удобный инструмент под названием GraphiQL для тестирования ваших запросов GraphQL. Прежде чем продолжить, убедитесь, что вы скачали его.
Как только вы откроете GraphiQL, вам нужно установить GraphQL Endpoint и HTTP Headers.
GraphQL Endpoint: https://api.github.com/graphql
Header Name: Authorization
Header Value: Bearer YOUR_TOKEN
Конечно, вам нужно заменить YOUR_TOKEN на свой токен. Не забудьте включить Bearer перед токеном при определении Header Value.
Если вы не хотите загружать приложение, вы также можете использовать онлайн-интерфейс GraphQL API Explorer для GitHub.
Запросы GraphQL
В отличие от REST API с несколькими API ендпоинтами, GraphQL имеет только один ендпоинт, и вы получаете только то, что определено вашим запросом.
Документация GigHub’s GraphQL API даcт вам больше информации.
Начнем с простейшего запроса:
В этом уроке я не буду приводить подробную информацию о запросах. Вы всегда можете обратиться к документации и попробовать запросы в инструментах GraphQL, чтобы узнать, получаете ли вы правильные данные.
Давайте используем следующий запрос для остальной части учебника.
Этот запрос ищет последние 10 репозиториев, соответствующих определенной строке ввода, которые мы определим в нашем приложении.
Он возвращает id, name, description и url для каждого результата.
Использование запроса GraphQL в компоненте React
Нам нужно импортировать два модуля ниже в наш компонент React, чтобы иметь возможность определять запрос в компоненте, а затем передавать результаты компоненту в качестве props.
Теперь мы завершаем наш компонент с graphql HOC (Higher Order Component), чтобы определить параметры запроса, выполнить запрос и затем передать результат в качестве props для нашего компонента.
Ниже приведен финальный вариант нашего компонента.
Проверка данных в консоли
Давайте продолжим и добавим
Когда вы проверите консоль своего браузера, вы увидите два лога с объектами.
Отображение данных
Давайте напишем JSX для отображения извлеченных данных.
Поскольку объект search изначально не существует, мы не можем напрямую попытаться его отобразить. Поэтому сначала нам нужно проверить, были ли получены данные, и объект search готов к использованию.
Это всего лишь базовый пример. Вы можете использовать обычную инструкцию if-else и возвращать разные результаты для вашего метода render.
Вы можете проверить репозиторий Apollo-Client-with-React, клонировать его на свой компьютере и поиграть с ним.
P.S. Не забудьте заменить переменную token на свой собственный токен API для GitHub.
Заключение
Мы рассказали о том, как начать работу с Apollo Client для React. Мы установили необходимые модули, настроили клиент, а затем предоставили его нашему компоненту в верхней части иерархии компонентов. Мы научились быстро тестировать запросы GraphQL, прежде чем внедрять их в нашем реальном приложении. Наконец, мы интегрировали запрос в компонент React и отобразили извлеченные данные.
Introduction
Start here to learn how to build full-stack apps with Apollo
Getting started with Apollo? Check out Odyssey, Apollo’s learning platform! Our introductory course, Lift-off, introduces many of the same concepts as this tutorial with helpful videos and interactive code challenges.
Welcome! This tutorial guides you through building a full-stack, GraphQL-powered app with the Apollo platform.
We want you to feel empowered to build your own production-ready app with Apollo, so we’re skipping «Hello World» in favor of an example that’s closer to «Real World», complete with authentication, pagination, testing, and more.
Each section should take about 10-15 minutes (except the final section, which is closer to 20).
Ready? Let’s dive in!
What we’ll build
In this tutorial, we’ll build an interactive app for reserving a seat on an upcoming SpaceX launch. Think of it as an Airbnb for space travel! All of the data is real, thanks to the SpaceX-API.
Here’s what the finished app will look like:
The app includes the following views:
To populate these views, our graph will connect to two data sources: a REST API and a SQLite database. (Don’t worry, you don’t need to be familiar with either of those technologies to complete the tutorial.)
As mentioned, we want this example to resemble a real-world Apollo app, so we’ll also add common useful features like authentication, pagination, and state management.
Prerequisites
This tutorial assumes the following:
You’re familiar with both JavaScript/ES6 and React.
You’re interested in implementing both a back-end GraphQL API and a front-end client that consumes it. If you’re only interested in one or the other, see one of the following:
Building your frontend with React is not a requirement for using the Apollo platform, but it is the primary view layer supported by Apollo. If you use another view layer (such as Angular or Vue), you can still apply this tutorial’s concepts to it.
System requirements
Before we begin, make sure you have the following installed:
Although it isn’t required, we also recommend using VS Code as your editor so you can use Apollo’s helpful VS Code extension.
Clone the example app
Now the fun begins! From your preferred development directory, clone this repository:
Need help?
Learning a new technology can be overwhelming sometimes, and it’s common to get stuck! If that happens, we recommend joining the Apollo community and posting there for assistance from friendly fellow developers.
If anything in the documentation seems confusing or contains an error, we want to know! On the right side of any page, click Rate article to submit feedback, or click Edit on GitHub to create a pull request.