Wx-connect

На основе Node.js и connect реализованная платформа для разработки интерфейсов к общедоступной платформе WeChat, которая может быть использована для быстрого создания приложений с интерфейсом к общедоступной платформе WeChat.

var wxConnect = require('wx-connect');
var app = wxConnect({appToken: ''})

app.text(function(req, res) {
  res.text('您好，欢迎使用微信公众平台！')
});

app.listen(80);

Установка

$ npm install wx-connect

Функциональные особенности

• Поддержка проверки безопасности сообщений WeChat;
• поддержка обработки текстовых сообщений, отправленных пользователями;
• поддержка обработки событий, таких как щелчок по географическому местоположению, нажатие на пользовательское меню, подписка и отмена подписки;
• поддерживает ответы в виде текста, изображений, аудио, видео и музыкальных сообщений;
• обработка сообщений и событий осуществляется через промежуточное ПО, структура ясна, а расширение гибкое;
• код прост, пользователи должны сосредоточиться только на бизнес-логике, все остальное — это JS;
• в полной мере использует асинхронные и событийные функции NodeJS, обеспечивая высокую производительность.

Быстрый старт После установки создайте файл app.js в каталоге проекта:

Загрузка зависимостей

var wxConnect = require('wx-connect');

Конфигурация

Здесь appToken должен соответствовать «token», установленному в режиме разработчика WeChat, остальные два параметра используются при получении accss_token от WeChat и могут быть проигнорированы.

var config = {
  appID: 'wxd59a79ed8e3fab89',
  appSecret: '',
  appToken: 'WXConnect'
};

Создание экземпляра приложения

var app = wxConnect(config);

Обработка текстовых сообщений

app.text определяет обработку текстовых сообщений, отправляемых пользователями в WeChat.

app.text = function(req, res, next) {
  res.text('Вы ввели: ' + req.message.content); // возвращает введенное пользователем содержимое
};

Функция (req, res, next){} в connect и express называется промежуточным программным обеспечением и представляет собой функцию обратного вызова с тремя параметрами.

req и res происходят из http.createServer(function(res, req){}), где wx-connect расширяет их.

req содержит информацию о запросе пользователя, а res.message содержит сообщение или событие, отправленное пользователем через WeChat.

res используется для ответа пользователю, метод res.reply() используется для возврата форматированного сообщения пользователю WeChat, методы res.text() и res.news() используются для отправки текстовых и графических сообщений пользователю, а метод res.debug() используется для печати отладочной информации, когда содержимое сообщения пользователя неизвестно.

Содержимое сообщения, содержащегося в req.message, выглядит следующим образом:

req.message = {
	fromUserName: 'xxoo', // Идентификатор пользователя WeChat отправителя сообщения
	toUserName: 'xxoo', // Идентификатор получателя общедоступного номера WeChat
	msgType: 'text', // тип сообщения text: текст, event: событие
	content: 'abc', // содержание текстового сообщения
	event: 'click', // тип события click: щелчок по пользовательскому меню, LOCATION: местоположение, subscribe: подписка, unsubscribe: отмена подписки
	eventKey: 'USER_KEY' // ключ события для нажатия на пользовательское меню
}

Формат параметров res.news([..]) для графических сообщений:

res.news([{title: 'Заголовок', description: 'Описание', picUrl: 'URL изображения', url: 'Ссылка перехода'}...])

Можно обратиться к формату ответа в документации разработчика общедоступной платформы WeChat (http://mp.weixin.qq.com/wiki/14/89b871b5466b19b3efa4ada8e577d45e.html), за исключением того, что имя ключа начинается со строчной буквы.

Обработка событий местоположения

app.location ＝ function(req, res, next) {}

Определение обработки событий меню

app.menu ＝ function(req, res, next) {}

Обработка события подписки

app.subscribe ＝ function(req, res, next) {}

Обработка события отмены подписки

app.unsubscribe ＝ function(req, res, next) {}

Запуск приложения

// Запуск сервера
app.listen(80, function() {
  console.log('Сервер работает на 80'); // Обратите внимание: общедоступный номер WeChat поддерживает только порт 80
});

Пример демонстрации WXWeather использует wx-connect для разработки интерфейса общедоступной платформы WeChat и реализует функцию поиска погоды в общедоступном номере WeChat.

Связанные документы

• NodeJS (http://www.nodejs.org/)
• connect (https://github.com/senchalabs/connect)
• Документация разработчика общедоступной платформы WeChat (http://mp.weixin.qq.com/wiki/home/index.html)

Запрос общедоступного номера платформы WeChat WeChat предоставляет общедоступные номера для тестирования тем, кто хочет испытать разработку интерфейса общедоступной платформы WeChat без регистрации общедоступного номера.

Адрес запроса: http://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login

Тестирование

$ npm test

Контакт Если у вас есть какие-либо вопросы, вы можете присоединиться к группе QQ для обсуждения, номер группы: 184191092

Лицензия MIT