Скачать fb botmill - скачать исходный код fb botmill

FB-BotMill — потрясающий фреймворк для создания ботов Facebook

FB-BotMill предназначен для упрощения процесса разработки, проектирования и запуска ботов, существующих в Facebook.

Он предоставляет семантический API Java, который можно импортировать в ваш проект Java EE для отправки и получения сообщений от Facebook, чтобы разработчики могли сосредоточиться на разработке реального приложения, а не на работе с конечными точками API Facebook.

Начиная

FB-BotMill можно импортировать как зависимость через Maven.

 <dependency>
  <groupId>co.aurasphere.botmill</groupId>
  <artifactId>fb-botmill</artifactId>
  <version>2.0.0-RC3</version>
</dependency>

Градл

 compile 'co.aurasphere.botmill:fb-botmill:2.0.0-RC3'

классный

 @Grapes( 
    @Grab(group='co.aurasphere.botmill', module='fb-botmill', version='2.0.0-RC3') 
)

Другие способы импорта: посетите центральный сайт репозитория Maven.

Создание вашего первого чат-бота Facebook с помощью Fb-BotMill

После того, как вы импортировали API. Вам необходимо зарегистрировать FbBotMillServlet. Для этого добавьте следующее в свой web.xml.

< servlet >
	< servlet-name >myFbBot</ servlet-name >
	< servlet-class >co.aurasphere.botmill.fb.FbBotMillServlet</ servlet-class >
</ servlet >
< servlet-mapping >
	< servlet-name >myFbBot</ servlet-name >
	< url-pattern >/myFbBot</ url-pattern >
</ servlet-mapping >

Обратите внимание на сопоставление URL-адресов , поскольку оно будет использоваться в конфигурации вашего веб-перехватчика в Facebook.

Создание определения бота.

Определение бота — это сердце вашего чат-бота Facebook. Сюда мы помещаем все остальные обработчики событий и ответы чат-бота.

1-й: настройте токен страницы и токен проверки. Создайте файл botmill.properties в своем пути к классам и добавьте свои токены.

 fb.page.token =<PAGE_TOKEN>
fb.validation.token =<VALIDATION_TOKEN>

Обратите внимание, что вы можете зашифровать файл свойств, используя встроенное шифрование на основе jaspyt. Посетите нашу Wiki здесь, чтобы узнать, как настроить зашифрованный файл botmill.properties .

2-й: настройте класс шифрования. Мы строго настаиваем на использовании Jaspyt для шифрования токенов, для этого нам нужно убедиться, что вы создали свой собственный класс шифрования Jaspyt. Для этого создайте в своем проекте следующее.

 @ BotEncryption
public class DefaultEncryption {
	public DefaultEncryption () {
		StandardPBEStringEncryptor enc = new StandardPBEStringEncryptor ();
		enc . setPassword ( "password" ); // can be sourced out
		ConfigurationUtils . loadEncryptedConfigurationFile ( enc , "botmill.properties" );
	}
}

Пароль зависит от вас и может быть получен где угодно (через https или ftp). Ключевым моментом здесь является то, что именно этот текст Jaspyt будет использовать для расшифровки вашего файла botmill.properties.

...
enc . setPassword ( "https://mydomain.com/encryptionpassword/password.txt" ); // can be sourced out
..

После того, как вы это сделаете, нам нужно будет использовать проект botmill-crypto-util для создания зашифрованной версии токена вашей страницы и токена проверки. Загрузите botmill-crypto-util [здесь] (https://oss.sonatype.org/content/repositories/snapshots/co/aurasphere/botmill/botmill-crypto-util/0.0.1-SNAPSHOT/botmill-crypto-util). -0.0.1-20170228.035750-1-jar-with-dependents.jar) и выполните следующую команду:

java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependents.jar enc <page_token> .jar enc <токен_валидации>

Это выдаст зашифрованную версию вашего текстового файла. Измените свой botmill.properties, указав эти значения, но обязательно поместите его в ENC(***).

 fb.page.token =ENC(<ENCRYPTED_PAGE_TOKEN>)
fb.validation.token =ENC(<ENCRYPTED_VALIDATION_TOKEN>)

Перераспределите, и все готово.

Третье: настройка BotConfiguration. Класс BotConfiguration позаботится об одноразовых процессах, которые должны произойти (постоянные меню, аутентификация API Facebook и т. д.). Создайте FbBotConfiguration ниже и поместите всю свою первоначальную конфигурацию (одноразовую конфигурацию) в конструктор. Это также инициализирует аутентификацию Facebook.

 @ BotConfiguration
public class MyBotConfiguration extends FbBotConfiguration {

    public MyBotConfiguration () {
    
		MessengerProfileApi . setGetStartedButton ( "get_started" );
		MessengerProfileApi . setGreetingMessage ( "Hello!" );
		
		List < PersistentMenu > persistentMenus = new ArrayList < PersistentMenu >();
		PersistentMenu persistentMenu = new PersistentMenu ( "default" , false );
		
		persistentMenu . addCallToAction ( ButtonFactory . createPostbackButton ( "Menu 1" , "menu1" ));
		persistentMenu . addCallToAction ( ButtonFactory . createPostbackButton ( "Menu 2" , "menu2" ));
		
		CallToActionNested theNestedMenu = new CallToActionNested ( "Menu 3 Nested" );
		theServices . addCallToActionButton ( ButtonFactory . createPostbackButton ( "Nested1" , "nested1" ));
		theServices . addCallToActionButton ( ButtonFactory . createPostbackButton ( "Nested2" , "nested2" ));
		theServices . addCallToActionButton ( ButtonFactory . createPostbackButton ( "Nested3" , "nested3" ));
		persistentMenu . addCallToAction ( theNestedMenu );
		
		persistentMenus . add ( persistentMenu );
		
		MessengerProfileApi . setPersistentMenus ( persistentMenus );
		
		HomeUrl homeUrl = new HomeUrl ();
		homeUrl . setInTest ( true );
		homeUrl . setUrl ( "https://extensionlink.co" );
		homeUrl . setWebviewHeightRatio ( WebViewHeightRatioType . TALL );
		homeUrl . setWebviewShareButton ( WebViewShareButton . SHOW );
		
		MessengerProfileApi . setHomeUrl ( homeUrl );
		
    }
    
}

Четвертый: Настройте класс/классы FbBot. Наша структура позволяет легко и просто определить поведение бота Facebook, помечая классы как объекты поведения.

 @ Bot
public class MyBotClass extends FbBot {
	
	@ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE , text = "Hi" , caseSensitive = true )
	public void sendMessage ( MessageEnvelope envelope ) {
		reply ( new MessageAutoReply ( "Hello World!" ));
	}
}

@ Bot ( state = BotBeanState . PROTOTYPE ) // creates a new instance per call
public class MyBotClass1 extends FbBot {
	
	@ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE , text = "Hi" , caseSensitive = true )
	public void sendMessage ( MessageEnvelope envelope ) {
		reply ( new MessageAutoReply ( "Hello World on BotClass1" ));
	}
}

@ Bot ( state = BotBeanState . SINGLETON ) // uses the same reference/instance (this is the default).
public class MyBotClass2 extends FbBot {
	
	@ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE , text = "Hi" , caseSensitive = true )
	public void sendMessage ( MessageEnvelope envelope ) {
		reply ( new MessageAutoReply ( "Hello World on BotClass2" ));
	}
}

поймать закономерность и ответить быстрым ответом

 @ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE_PATTERN , pattern = "(?i:hi)|(?i:hello)|(?i:hey)|(?i:good day)|(?i:home)" )
public void replyWithQuickReply ( MessageEnvelope envelope ) {
	reply ( new AutoReply () {
		@ Override
		public FbBotMillResponse createResponse ( MessageEnvelope envelope ) {
			return ReplyFactory . addTextMessageOnly ( "Text message with quick replies" )
					. addQuickReply ( "Quick reply 1" , "Payload for quick reply 1" ). build ( envelope );
		}
	});
}

или ответьте кнопкой

 @ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE_PATTERN , pattern = "(?i:hi)|(?i:hello)|(?i:hey)|(?i:good day)|(?i:home)" )
public void replyWithButtonTemplate ( MessageEnvelope envelope ) {
	reply ( new AutoReply () {
		@ Override
		public FbBotMillResponse createResponse ( MessageEnvelope envelope ) {
			return ReplyFactory . addButtonTemplate ( "Test button template" )
					. addPostbackButton ( "postback button" , "postback button payload" )
					. addPhoneNumberButton ( "phone number button" , "+123456789" )
					. addUrlButton ( "web url button" , "https://github.com/BotMill/fb-botmill" ). build ( envelope );
		}
	});
}

Посетите нашу документацию для получения полного списка типов событий и ответов.

Ключевые компоненты при создании вашего чат-бота

@Bot — аннотирование класса с помощью @Bot пометит класс как поведение Facebook ChatBot.
@BotEncryption — используйте для создания изолированного класса Java для шифрования.
@BotConfiguration — используйте для создания изолированного класса Java для обработки одноразовых процессов, которые должны произойти до создания ботов.
@FbBotMillInit — можно использовать для аннотации метода и вызова его перед любыми аннотированными методами @FbBotMillController.
@FbBotMillController — используйте для создания метода, который перехватывает определенные события, управляемые пользователем (например, ввод пользователем сообщения, выбор быстрого ответа и т. д.).
FbBot.reply() — позволяет разработчикам создать ответ на основе события @FbBotMillController. Список всех событий и ответы на них можно найти на нашей Wiki-странице здесь.
FbBot.botMillSession() — позволяет хранить данные и получать к ним доступ. Обратите внимание, что вам необходимо настроить соединение mongodb, чтобы это работало. Конфигурацию соединения mongodb также можно настроить через botmill.properties . Для получения дополнительной информации посетите наше [руководство по BotMillSession здесь] https://github.com/BotMill/fb-botmill/wiki/Developing-with-FB-BotMill).

Вклад

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

Расширять