Быстрый доступ к VPN в iOS с помощью App Intents02.10.2024 10:45

Привет! Меня зовут Антон Долганов, я iOS-разработчик в компании Контур. Я работаю над инфраструктурными модулями и параллельно поддерживаю наше приложение Контур.Коннект, которое используется для подключения к внутреннему VPN и даёт доступ к корпоративным сервисам.

Недавно мы выпустили обновление Коннекта, добавив поддержку Быстрых команд (Shortcuts). Теперь можно включать и отключать VPN, даже не заходя в приложение. В этой статье я расскажу, как я это реализовал и почему это полезно.

Что такое быстрые команды и зачем они нужны?

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

Команды можно запускать не только через приложение «Команды», но и с главного экрана, через виджеты, Siri или даже на Apple Watch. И это не только удобно — своими командами можно делиться с другими пользователями, упрощая им жизнь. Например, в этой статье описаны 35 команд для работы на iPhone: от удобной настройки будильников с 5-ти минутным интервалом до быстрого поиска ссылки на песню на другой стриминговой платформе.

Главная польза быстрых команд — экономия времени и удобство. В случае с нашим приложением, теперь пользователям не нужно каждый раз заходить в приложение и нажимать несколько кнопок, чтобы подключиться к VPN. Можно сделать это буквально одной командой или даже настроить автоматическое подключение. Такое решение особенно полезно для тех, кто часто использует VPN и хочет автоматизировать процесс.

Чтобы добавить в наш Коннект поддержку быстрых команд, мы обратились к новому фреймворку App Intents.

Что такое App Intents?

App Intents — это представленный в iOS 16 фреймворк, который позволяет разработчикам создавать команды для работы с их приложениями через Siri, Spotlight и приложение «Команды». Он заменяет устаревший SiriKit Intents и предлагает более простую и производительную альтернативу.

Вот основные плюсы App Intents:

1. Простота интеграции. Внедрение команды требует минимальной настройки.

2. Повышенная производительность. Упрощенная структура фреймворка и поддержка асинхронных задач.

3. Гибкость пользовательского интерфейса. Возможность кастомизации диалогов и взаимодействия с пользователем.

4. Интеграция с Spotlight. Команды могут отображаться в результатах поиска Spotlight, что делает их более доступными для пользователя.

Пример реализации команды для управления VPN

Теперь рассмотрим поэтапный процесс, как была создана команда для управления VPN. В качестве первого шага создадим простую команду, которая по традиции выведет диалог с текстом «Hello, world!». Это позволит нам разобраться с основными принципами работы App Intents.

Шаг 1: Создание простой команды

Первым делом создаем структуру, которая наследуется от AppIntent. Для нашей команды достаточно указать заголовок (title) и реализовать метод perform(), который будет выводить сообщение «Hello, world!» в виде диалогового окна.

Пример кода:

import AppIntents

struct VPNIntent: AppIntent {
  static let title: LocalizedStringResource = "Hello, world!"

  func perform() async throws -> some ProvidesDialog {
    return .result(dialog: .init("Hello, world!"))
  }
}

⚠️ Если ваш проект поддерживает версии iOS ниже 16, то необходимо будет добавить аннотацию @available, так как данный функционал будет выполняться только на iOS 16 и выше.

@available(iOS 16, *)
struct VPNIntent: AppIntent {
// Остальной код команды
}

Необходимо скомпилировать проект, чтобы этот интент стал доступен в приложении «Команды».

Шаг 2: Настройка команды в приложении «Команды»

Теперь давайте посмотрим, как найти и запустить созданную команду:

1. Открываем приложение «Команды» на устройстве.

1. Нажимаем на кнопку »+» в правом верхнем углу для создания новой команды.

1. Пролистываем шторку с различными действиями и находим наше приложение.

1. Выбираем команду, которую мы создали ранее.

1. Подтверждаем создание команды. Она автоматически появится в приложении «Команды».

1. Теперь команда готова к использованию. 

1. Для её запуска достаточно нажать на созданную плашку, и вы увидите результат — диалог с текстом «Hello, world!»

Чуть позже мы рассмотрим другие способы запуска команды.

Шаг 3. Добавляем возможность включать и выключать VPN

Мы не будем вдаваться в детали реализации включения и отключения VPN, а сосредоточимся на текущей команде. В методе perform() вызовем функцию, которая будет управлять состоянием VPN.

На первый взгляд, можно было бы создать две отдельные команды: одну для включения VPN и другую для отключения. Однако такой подход неудобен: разработчику придется дублировать логику, а пользователям — переключаться между двумя командами, что снижает удобство использования.

Лучшее решение — создать одну команду, которая будет выполнять как включение, так и отключение VPN в зависимости от его текущего статуса.

Принцип работы будет следующим: при первом запуске команды происходит подключение к VPN, а при повторном — отключение. Таким образом, команда автоматически адаптируется к текущему состоянию VPN.

Для этого изменим метод perform:

func perform() async throws -> some ProvidesDialog {
    VPNManager.toggleVpnConnection()
    return .result(dialog: .init("Команда выполнена"))
}

Теперь при запуске команды, VPN будет включаться или выключаться, а также пользователю отобразится диалог с сообщением «Команда выполнена».

Однако здесь есть один нюанс: процесс подключения к VPN может занимать некоторое время, а в текущей реализации диалог с результатом вызывается без ожидания завершения процесса. В результате диалог «Команда выполнена» появится до фактического завершения работы с VPN.

Это легко исправить с помощью асинхронного программирования с использованием async/await, которое поддерживается в методе perform:

func perform() async throws -> some ProvidesDialog {
    await VPNManager.toggleVpnConnection()
    return .result(dialog: .init("Команда выполнена"))
}

⚠️ Чтобы это работало корректно, необходимо изменить метод toggleVpnConnection(), добавив поддержку async/await. 

Теперь диалог «Команда выполнена» будет отображаться только после завершения подключения или отключения VPN, что обеспечит более точную обратную связь для пользователя.

Шаг 4. Добавляем отображение статуса команды

На данный момент команда выводит результат в виде диалога с текстом «Команда выполнена», но это решение недостаточно информативно. Было бы лучше отображать различную информацию в зависимости от того, включен VPN или отключён. Также полезно предусмотреть вывод сообщения об ошибке, например, в случае отсутствия подключения к интернету.

Фреймворк AppIntents позволяет создавать кастомные представления (View) для более гибкого отображения результата команды. Давайте реализуем такую возможность.

Для начала подготовим перечисление, которое будет описывать возможные состояния VPN: активное, неактивное и состояние с ошибкой. Также для каждого состояния зададим соответствующее сообщение, иконку и цвет.

import SwiftUI

enum VPNIntentState {
  case inactive
  case active
  case error(VPNConfigurationError)
  var message: String {
    switch self {
    case .inactive:
      "Не подключено"
    case .active:
       "Подключено"
    case .error(let error):
      error.message
    }
  }
  var icon: String {
    switch self {
    case .inactive:
      "xmark.shield"
    case .active:
      "checkmark.shield"
    case .error:
      "exclamationmark.triangle"
    }
  }
  var color: Color {
    switch self {
    case .inactive:
      .gray
    case .active:
      .green
    case .error:
      .red
    }
  }
}

Теперь создадим кастомное представление (View) с помощью SwiftUI для отображения статуса VPN:

import SwiftUI

struct VPNStatusView: View {
  let state: VPNIntentState

  var body: some View {
    VStack(spacing: 16) {
      Image(systemName: state.icon)
        .resizable()
        .aspectRatio(contentMode: .fit)
        .frame(width: 68, height: 68)
        .foregroundColor(state.color)
      Text(state.message)
        .foregroundColor(.primary)
        .multilineTextAlignment(.center)
    }
    .padding()
  }
}

Осталось только доработать метод perform(), чтобы он возвращал ShowsSnippetView. Также изменим метод toggleVpnConnection, который теперь будет возвращать текущее состояние VPN:

func perform() async throws -> some ShowsSnippetView {
    let result = await VPNManager.toggleVpnConnection()
    return .result(view: VPNStatusView(state: result))
}

В результате, после выполнения команды, на экране будет отображаться более подробная информация о текущем статусе VPN. 

VPN успешно подключён

VPN успешно отключён

Ошибка при подключении VPN

Сообщения о подключении, отключении или ошибке значительно повысят информативность и удобство использования команды.

Шаг 5. Ограничение доступа к команде для пользователей

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

Мы добавим условие, которое проверяет, имеет ли текущий пользователь право на использование VPN. Если доступ запрещен, команда вернет статус ошибки.

Пример реализации:

func perform() async throws -> some ShowsSnippetView {
    guard VPNManager.isVPNAllowed
    else {
      return .result(
        view: VPNStatusView(
          state: VPNIntentState.error(.configurationIsNotAvailable)
        )
      )
    }
    let result = await appDelegate.toggleVpnConnection()
    return .result(view: VPNStatusView(state: result))
}

Если пользователю не разрешено использовать VPN, команда вернет сообщение об ошибке. В противном случае будет выполнено подключение или отключение VPN.

Шаг 6. Улучшаем описание команды

На завершающем этапе подготовим описание команды для пользователей. Это описание будет отображаться в интерфейсе приложения.

Мы подготовим title и description нашей команды. Эти строки можно вынести в файл Localizable.strings для удобной локализации приложения.

"vpn_intent_title" = "Коннект VPN";
"vpn_intent_description" = "Команда предназначена для удобного включения и выключения VPN на вашем устройстве.";

Теперь обновим описание команды в коде:

struct VPNIntent: AppIntent {
  static let title: LocalizedStringResource = "vpn_intent_title"
  static var description: IntentDescription? { "vpn_intent_description" }
  // Остальной код команды
}

Таким образом, команда будет иметь четкое и информативное описание, которое пользователи увидят при настройке и использовании команды. Это поможет сделать интерфейс более понятным и удобным.

Способы запуска команды

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

Control Center

Лого на рабочем столе

Виджет на экране блокировки

Action Button

Apple Watch

Автоматизация

В итоге

Функция быстрых команд в iOS открывает массу возможностей для автоматизации. И с помощью App Intents мы сделали процесс подключения к VPN в Контур.Коннект быстрее и проще. Это маленькая, но важная деталь, которая может заметно улучшить пользовательский опыт.

Так что если вы разрабатываете приложения и ещё не использовали App Intents, обязательно попробуйте! Вот список ресурсов, которые мне очень помогли при добавлении нового функционала в приложение:

© Habrahabr.ru