fb botmill
v2.0.0-RC2
FB-BotMill soll den Prozess der Entwicklung, Gestaltung und Ausführung von Bots, die in Facebook vorhanden sind, vereinfachen.
Es bietet eine semantische Java-API, die in Ihr Java EE-Projekt importiert werden kann, um Nachrichten von Facebook zu senden und zu empfangen, sodass sich Entwickler auf die Entwicklung der eigentlichen Anwendung konzentrieren können, anstatt sich mit Facebook-API-Endpunkten zu befassen.
<dependency>
<groupId>co.aurasphere.botmill</groupId>
<artifactId>fb-botmill</artifactId>
<version>2.0.0-RC3</version>
</dependency>
Gradle
compile 'co.aurasphere.botmill:fb-botmill:2.0.0-RC3'
Groovig
@Grapes(
@Grab(group='co.aurasphere.botmill', module='fb-botmill', version='2.0.0-RC3')
)
Weitere Importmöglichkeiten finden Sie auf der zentralen Repo-Site von Maven
< 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 >Beachten Sie die URL-Zuordnung , da diese in Ihrer Webhook-Konfiguration in Facebook verwendet wird.
1.: Richten Sie das Seitentoken und das Validierungstoken ein. Erstellen Sie die Datei botmill.properties in Ihrem Klassenpfad und fügen Sie Ihre Token hinzu.
fb.page.token =<PAGE_TOKEN>
fb.validation.token =<VALIDATION_TOKEN>Beachten Sie, dass Sie die Eigenschaftendatei mit unserer integrierten Jaspyt-basierten Verschlüsselung verschlüsseln können. Hier erfahren Sie in unserem Wiki, wie Sie Ihre verschlüsselte botmill.properties- Datei einrichten.
2.: Richten Sie Ihre Verschlüsselungsklasse ein. Wir drängen strikt auf die Verwendung von Jaspyt zum Verschlüsseln der Token. Dazu müssen wir sicherstellen, dass Sie Ihre eigene Jaspyt-Verschlüsselungsklasse erstellen. Erstellen Sie dazu Folgendes in Ihrem Projekt.
@ BotEncryption
public class DefaultEncryption {
public DefaultEncryption () {
StandardPBEStringEncryptor enc = new StandardPBEStringEncryptor ();
enc . setPassword ( "password" ); // can be sourced out
ConfigurationUtils . loadEncryptedConfigurationFile ( enc , "botmill.properties" );
}
}Das Passwort liegt bei Ihnen und kann überall bezogen werden (über https oder ftp). Das Wichtigste dabei ist, dass Jaspyt diesen Text zum Entschlüsseln Ihrer botmill.properties-Datei verwendet.
...
enc . setPassword ( "https://mydomain.com/encryptionpassword/password.txt" ); // can be sourced out
..Sobald Sie dies getan haben, müssen wir das Projekt botmill-crypto-util verwenden, um die verschlüsselte Version Ihres Seitentokens und Validierungstokens zu erstellen. Laden Sie das botmill-crypto-util [hier] herunter (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-dependencies.jar) und führen Sie den folgenden Befehl aus:
java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependencies.jar enc <page_token> java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependencies .jar enc <validation_token>
Dadurch wird die verschlüsselte Version Ihrer Textdatei ausgespuckt. Ändern Sie Ihre botmill.properties mit diesen Werten, aber stellen Sie sicher, dass sie in die ENC(***) eingefügt werden.
fb.page.token =ENC(<ENCRYPTED_PAGE_TOKEN>)
fb.validation.token =ENC(<ENCRYPTED_VALIDATION_TOKEN>)Führen Sie eine erneute Bereitstellung durch und schon kann es losgehen.
3.: Richten Sie Ihre BotConfiguration ein. Die BotConfiguration-Klasse kümmert sich um die einmaligen Prozesse, die ausgeführt werden müssen (persistente Menüs, Facebook-API-Authentifizierung usw.). Erstellen Sie unten eine FbBotConfiguration und fügen Sie Ihre gesamte Anfangskonfiguration (einmalige Konfiguration) in den Konstruktor ein. Dadurch wird auch die fb-Authentifizierung initialisiert.
@ 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 );
}
}4.: Richten Sie die FbBot-Klasse(n) ein. Unser Framework macht es einfach und unkompliziert, ein Facebook-Bot-Verhalten zu definieren, indem Klassen als Verhaltensobjekte markiert werden.
@ 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" ));
}
}Erfassen Sie ein Muster und antworten Sie mit einer schnellen Antwort
@ 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 );
}
});
}oder per Knopfdruck antworten
@ 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 );
}
});
}Besuchen Sie unsere Dokumente für eine vollständige Liste der Ereignistypen und Antworten.
Schlüsselkomponenten beim Aufbau Ihres ChatBots
Copyright (c) 2016-2017 BotMill.io
