Автозапуск

Автозапуск

app.Autostart регистрирует приложение для автоматического запуска при входе пользователя в систему. Для каждой платформы выбирается соответствующий нативный механизм, а пути установки с символическими ссылками (Homebrew, Scoop) разрешаются, чтобы регистрация не нарушалась после обновления исполняемого файла.

Регистрация вступает в силу при следующем входе в систему, а не сразу.

Краткое руководство

import "github.com/wailsapp/wails/v3/pkg/application"

// Register to launch at login
if err := app.Autostart.Enable(); err != nil {
    app.Logger.Error("autostart enable failed", "error", err)
}

// Stop launching at login
if err := app.Autostart.Disable(); err != nil {
    app.Logger.Error("autostart disable failed", "error", err)
}

// Check status
enabled, err := app.Autostart.IsEnabled()

API

Enable

Регистрирует приложение для запуска при входе в систему с параметрами по умолчанию.

func (m *AutostartManager) Enable() error

Многократный вызов Enable безопасен: регистрация каждый раз перезаписывается, поэтому этот метод можно вызывать при каждом запуске, если сохранена выбранная пользователем настройка.

EnableWithOptions

Регистрирует приложение с пользовательскими параметрами.

func (m *AutostartManager) EnableWithOptions(opts AutostartOptions) error

AutostartOptions:

Disable

Удаляет регистрацию автозапуска. Возвращает nil, если приложение не было зарегистрировано: отключение идемпотентно.

func (m *AutostartManager) Disable() error

IsEnabled

Сообщает, существует ли регистрация. Выполняется быстро, поскольку зарегистрированный путь не проверяется.

func (m *AutostartManager) IsEnabled() (bool, error)

Status

Возвращает полное состояние регистрации.

func (m *AutostartManager) Status() (AutostartStatus, error)

AutostartStatus:

Поведение на разных платформах

Type=Application
Hidden=false
X-GNOME-Autostart-enabled=true
Exec=<executable> <arguments>

if err := app.Autostart.Enable(); err != nil {
    if errors.Is(err, application.ErrAutostartNotSupported) {
        // hide the toggle in the UI
        return
    }
    // real failure — surface it
}

Идентификатор

Если Options.Identifier пуст, идентификатор по умолчанию формируется из имени приложения:

Идентификаторы должны соответствовать ^[A-Za-z0-9._-]+$ и содержать не более 200 символов. Для macOS рекомендуется формат обратного DNS (он соответствует принятому способу записи меток launchd).

Если значение AutostartOptions.Identifier переопределено, один и тот же идентификатор используется как имя параметра реестра в Windows и имя файла .desktop в Linux, поэтому одна строка идентифицирует регистрацию на всех платформах.

Обнаружение устаревшей регистрации

Disable() и Status() находят регистрацию, сопоставляя путь зарегистрированного исполняемого файла с os.Executable() (после разрешения всех символических ссылок), а не выполняя поиск по идентификатору. Это означает следующее:

• Идентификатор можно безопасно изменять между выпусками. Старую регистрацию по-прежнему можно обнаружить с помощью Status() и удалить с помощью Disable() — при условии, что путь к исполняемому файлу не изменился.
• Вторая копия приложения, расположенная по другому пути, не перезапишет регистрацию первой. Каждое расположение исполняемого файла отслеживается независимо.
• Установки через символические ссылки (Homebrew, Scoop) работают стабильно. Перед сопоставлением к os.Executable() применяется filepath.EvalSymlinks, поэтому обновление Homebrew, при котором меняется цель ссылки, не оставляет запись потерянной.

Что при этом не учитывается: если пользователь переместит или переименует исполняемый файл, указав не связанный с прежним путь, старая регистрация останется бесхозной (она будет указывать на уже отсутствующий файл). Приложениям, распространяемым с неизменным путём установки, об этом беспокоиться не нужно; приложениям, распространяемым как переносимые одиночные исполняемые файлы, следует вызывать Disable() перед собственным перемещением либо всегда запускаться через неизменную символическую ссылку.

Пример

package main

import (
    "errors"

    "github.com/wailsapp/wails/v3/pkg/application"
)

func main() {
    app := application.New(application.Options{
        Name: "My App",
    })

    // Restore the user's preference on startup
    if userPrefersAutostart() {
        if err := app.Autostart.Enable(); err != nil {
            if !errors.Is(err, application.ErrAutostartNotSupported) {
                app.Logger.Error("autostart", "error", err)
            }
        }
    }

    app.Run()
}

Полный готовый к запуску пример с кнопками проверки состояния, включения и отключения находится в examples/autostart/.