Iris VK API

Ещё одна библиотека по работе с VK API на Kotlin 💖

Гибкая система получения данных от VK. После обновления VK API вам не придётся ждать обновления в ваших прежних используемых библиотеках. Все данные будут доступны сразу после обновлений самого VK API.

Как скачать и установить?

Прямая ссылка:

• Вы можете скачать подготовленные релизы, чтобы скачать JAR файл напрямую.
• Также вам необходимо скачать зависимость — JAR файл Iris JSON Parser

Как это использовать

Простой VkApi

val vk = VkApi(token)
val res = vk.messages.send(userToId, "Привет. Это сообщение с Kotlin")
println(res?.obj())

VkApi методом Future

val vk = VkApiFuture(token)
vk.messages.send(userToId, "Привет. Это сообщение с Kotlin").thenAccept {
    println("Это сообщение появится вторым")
    println(it?.obj())
}
println("Это сообщение появится первым, т.к. метод Future неблокирующий")

// А можно сделать последовательное исполнение
val future = vk.messages.send(userToId, "Привет. Это сообщение с Kotlin")
val result = future.get() // дожидаемся ответа
println(result?.obj()) // выводим результат

VkApi, упаковывающий запросы в execute

val vk = VkApiPack(token)
val futuresList = vk.messages.sendMulti(listOf(
        Options("peer_id" to userToId, "message" to "Привет. Это сообщение с Kotlin\nОно почти работает!", "attachment" to "photo-181070115_457239553"),
        Options("peer_id" to 2, "message" to "Привет. Это сообщение с Kotlin\nОно почти работает!", "attachment" to "photo-181070115_457239553"),
)
)
println("Прошёл сюда без задержек")
val secondFutures = vk.execute(listOf(
        VkRequestData("messages.send", Options("peer_id" to userToId, "random_id" to (0..2_000_000).random(), "message" to "Привет. Это сообщение с Kotlin\nОно почти работает!", "attachment" to "photo-181070115_457239553"))
        , VkRequestData("messages.edit", Options("peer_id" to userToId, "conversation_message_id" to 1, "message" to "Привет. Это сообщение с Kotlin\nОно почти работает!", "attachment" to "photo-181070115_457239553"))
))

println("И сюда тоже без задержек. Но вот ниже нужно подождать\n")
println("Первый пакет:")
for (it in futuresList.futures)
    println(it.get()?.obj())

println()
println("Второй пакет скорее всего без задержек:")
for (it in secondFutures.futures)
    println(it.get()?.obj())
println()
println("Завершились")

VkPollingGroup — слушатель событий методом Long Poll

// Создаём класс для отправки сообщений
val vk = VkApiPack(token)

// Определяем простой обработчик событий
val simpleMessageHandler = object : VkEventHandlerAdapter() {

    override fun processMessage(message: Message) {
        // message содержит информацию о полученном JsonItem (message.source) и вспомогательную информацию, которую
        // добавит сам программист по мере продвижения события (message.options)

        // message.text — это метод, подготавливает текст для дальнейшей работы
        val text = message.text
        if (text.equals("пинг", true))
            vk.messages.send(message.peerId, "ПОНГ")
    }
}

// Передаём в параметрах слушателя событий токен и созданный обработчик событий
val listener = VkPollingGroup(token, simpleMessageHandler)
listener.startPolling() // Можно запустить неблокирующего слушателя
listener.join() // Даст дождаться завершения работы слушателя

VkPollingUser — слушатель событий пользовательского Long Poll

Всё то же самое, что и у VkPollingGroup, только вместо этого класса используется VkPollingUser

//...
val listener = VkPollingUser(token, simpleMessageHandler)
//...

VkCallbackGroup — слушатель событий методом VK Callback API

val api = VkApiPack(token)

val cbEngine = VkCallbackServer(
        gbSource = groupSource,
        path = "/kotlin/callback",
        addressTester = VkAddressTesterDefault(),
        vkTimeVsLocalTimeDiff = api.utils.getServerTime().get()!!["response"].asLong()*1000L - System.currentTimeMillis()
)

val messageHandler = object : VkEventHandlerAdapter() {
    override fun processMessage(message: Message) {
        println("Событие получено. Group ID: ${message.sourcePeerId} текст: ${message.text}")
        if (message.text == "пинг")
            api.messages.send(message.peerId, "ПОНГ!")
    }
}

val listener = VkCallbackGroup(cbEngine, VkCallbackGroup.defaultUpdateProcessor(messageHandler))
listener.run()

Также смотрите более развёрнутый пример использования VkPollingCallback iris.vk.test/group_cb_multibot.kt

VkCommandHandler

Возможность добавлять обработчики каждой текстовой команды отдельным обработчиком

val commandsHandler = VkCommandHandler()

commandsHandler += CommandMatcherSimple("пинг") {
    vk.messages.send(it.peerId, "ПОНГ!")
}

commandsHandler += CommandMatcherRegex("рандом (\\d+) (\\d+)") { vkMessage, params ->

    var first = params[1].toInt()
    var second = params[2].toInt()
    if (second < first)
        first = second.also { second = first }

    vk.messages.send(vkMessage.peerId, "🎲 Случайное значение в диапазоне [$first..$second] выпало на ${(first..second).random()}")
}

// Передаём в параметрах слушателя событий токен и созданный обработчик команд
val listener = VkPollingGroup(token, commandsHandler)
listener.run()

Настройка карты команд с помощью DSL

val commandsHandler = VkCommandHandler()

// Конфигурирование команд в стиле DSL
commandsHandler += commands {
    "пинг" runs {
        api.messages.send(it.peerId, "ПОНГ!")
    }

    "мой ид" runs {
        api.messages.send(it.peerId, "Ваш ID равен: ${it.fromId}")
    }

    regex("""рандом (\d+) (\d+)""") runs { vkMessage, params ->

        var first = params[1].toInt()
        var second = params[2].toInt()
        if (second < first)
            first = second.also { second = first }

        api.messages.send(vkMessage.peerId, "🎲 Случайное значение в диапазоне [$first..$second] выпало на ${(first..second).random()}")
    }
}

// Передаём в параметрах слушателя событий токен и созданный обработчик команд
val listener = VkPollingGroup(token, commandsHandler)
listener.run()

Настройка обработки событий методом onXxx

// Определяем обработчик триггеров
val triggerHandler = VkTriggerEventHandler()

// можно настраивать лямбдами
triggerHandler.onMessage {
    for (message in it)
        println("Получено сообщение от ${message.peerId}: ${message.text}")
}

triggerHandler.onMessageEdit {
    for (message in it)
        println("Сообщение исправлено ${message.id}: ${message.text}")
}

// можно настраивать классами триггеров
triggerHandler += VkCommandHandler(
    commands = listOf(
        CommandMatcherSimple("пинг") {
            vk.messages.send(it.peerId, "ПОНГ!")
        },

        CommandMatcherSimple("мой ид") {
            vk.messages.send(it.peerId, "Ваш ID равен: ${it.fromId}")
        },

        CommandMatcherRegex("""рандом (\d+) (\d+)""") { vkMessage, params ->

            var first = params[1].toInt()
            var second = params[2].toInt()
            if (second < first)
                first = second.also { second = first }

            vk.messages.send(vkMessage.peerId, "🎲 Случайное значение в диапазоне [$first..$second] выпало на ${(first..second).random()}")
        }
    )
)

Все приведённые выше примеры доступны в пакете iris.vk.test

Дополнительная информация

Iris VK API использует библиотеку Iris JSON Parser для обработки ответов от сервера VK. Загляните ознакомиться =)

Благодарности

Спасибо @markelovstyle за код-ревью, замечания и предложения

⭐ Не забывайте поставить звёзды, если этот инструмент оказался вам полезен