fb botmill
v2.0.0-RC2
FB-BotMill は、Facebook 内に存在するボットの開発、設計、実行のプロセスを容易にするように設計されています。
これは、Java EE プロジェクトにインポートして Facebook とメッセージを送受信できるセマンティック Java API を提供するため、開発者は Facebook API エンドポイントを扱う代わりに実際のアプリケーションの開発に集中できます。
<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 中央リポジトリ サイトにアクセスしてください。
< 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 の Webhook 設定で使用されるため、メモしてください。
1番目: ページトークンと検証トークンを設定します。クラスパスに botmill.properties ファイルを作成し、トークンを追加します。
fb.page.token =<PAGE_TOKEN>
fb.validation.token =<VALIDATION_TOKEN>組み込みの jaspyt ベースの暗号化を使用してプロパティ ファイルを暗号化できることに注意してください。暗号化されたbotmill.propertiesファイルをセットアップする方法については、こちらの Wiki にアクセスしてください。
2 番目: 暗号化クラスを設定します。私たちはトークンを暗号化するために Jaspyt の使用を厳密に推奨しています。そのためには、独自の Jaspyt Encryption クラスを必ず作成する必要があります。これを行うには、プロジェクトに次のものを作成します。
@ 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-dependency.jar) を実行します。次のコマンド:
java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependency.jar enc <page_token> java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependency .jar enc <検証トークン>
これにより、テキスト ファイルの暗号化されたバージョンが吐き出されます。これらの値を使用して botmill.properties を変更しますが、必ず ENC(***) 内に配置してください。
fb.page.token =ENC(<ENCRYPTED_PAGE_TOKEN>)
fb.validation.token =ENC(<ENCRYPTED_VALIDATION_TOKEN>)再デプロイすれば準備完了です。
3 番目: BotConfiguration をセットアップするBotConfiguration クラスは、必要な 1 回限りのプロセス (永続メニュー、Facebook API 認証など) を処理します。以下の FbBotConfiguration を作成し、すべての初期構成 (1 回限りの構成) をコンストラクターに配置します。これにより、FB 認証も初期化されます。
@ 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 番目: 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 );
}
});
}EventType と Response の完全なリストについては、ドキュメントを参照してください。
ChatBot 構築の主要コンポーネント
著作権 (c) 2016-2017 BotMill.io
