Python、Django、webhookを使用してVKontakteのチャットボットを作成する方法

チャットボットの作成に関する別の記事が必要な理由

検索が不十分だったのかもしれませんが、ロシアの会社がホストしているDjangoフレームワークとwebhookアプローチを使用したpythonボットの作成に関する詳細なガイドが見つかりませんでした。 ほとんどの資料では、Flaskフレームワークの使用と、HerokuおよびPythonAnywhereの無料ホスティングの使用について説明しています。 Habrコミュニティの経験は私を助けてくれるので、感謝のしるしとして、この記事の執筆に時間を費やすことにしました。 これに興味のあるすべての人が時間を節約し、webhookアプローチを使用してホスティングでDjangoフレームワークを使用してPythonボットを作成する方法をよりよく理解できるようにするために得られた実際の経験について説明します。

なぜホスティングを支払ったのですか？

私の意見では、実行可能なバージョンのボットは、ローカルコンピューターから独立しており、24時間365日利用可能です。 これを行うには、Webサーバー、データベース管理システム（ボットの機能を開発するため）、ドメイン名の登録、SSL証明書の取得、およびこのすべての経済に対する技術サポートがあるホスティングが必要です。 このようなサービスにはお金がかかります。 ボットが機能するためのインフラストラクチャを維持するために、1か月あたり138ルーブルを支払います。Python+ Djangoのサポート、MySQL DBMS 25 GB、SSHのサポートです。

ほとんどのレッスンで、パーソナルコンピューターが勤務時間などに制限のあるサーバーまたは無料ホスティングとして使用されることを確認しました。例では、ボットはユーザーからの新しいメッセージがないかメッセンジャーサーバーを定期的にポーリングします。 これはメッセンジャーサーバーに余分な負荷がかかるため、しばらくの間ボットを「禁止」できます。 私の意見では、これはすべて生産的な使用には不可欠ではありません。 しかし、テストとトレーニングについては非常に可能です。

webhookとは何ですか、なぜですか？

製品については、ウェブフックを使用する正しい決定、つまり、メッセンジャーサーバーからのメッセージをボットが期待し、定期的な要求で「ハンマー」をかけないアプローチを検討します。新しいメッセージがあるかどうか。 ウェブフックを使用すると、次のようになります。ユーザーがメッセージを作成し、メッセンジャーサーバーがそれをボットに送信し、メッセージを受信して​​処理し、応答しました。

なぜジャンゴ

pythonでボットを作成することにしたので、ホスティングでpythonサポートを接続しました。 しかし、フレームワークを選択することはできませんでした。ホスティングにはDjangoしかありません。 彼らは、Instagram、Pinterest、Bitbucket、Mozillaで機能すると言っています。 おそらくそれがホスティングがそれを提供する理由です。

なぜTelegramやViberではなくVKontakteなのですか？

単純なものから複雑なものに移行するために、ウェブフックをセットアップする最も簡単で直感的な方法を見つけることが重要でした。 VKontakteは、「管理-APIの操作」セクションのコミュニティコントロールパネルで明確なヘルプとwebhookの接続が簡単だったため、私にとって最も理解しやすいことがわかりました。 すべてをどのように構成して接続したかについての説明はさらに続きます。 将来的には、Viberでボットを利用できるようにします。 そして、私のホスティングはロシアにあり、テレグラムはロシアからブロックされているので、Telegramはまだ進行中です。 Telegramの問題を回避するために、海外でホスティングを購入できます。

VKボットにwebhookをインストールする方法は？

ドメイン名https：// 。 最初に、サイトのドメイン名を登録し、そのSSL証明書を取得する必要があります。



チャットボットにルートドメインを使用したくなかったため、ドメインを登録した後、サブドメインを作成し、SSL証明書を受け取りました。



これらすべての操作は、個人アカウントのホスティングサイトで行いました。

その結果、サイトmybot.mysite.ruのアドレスとSSL証明書を受け取りました。



ボットVKontakteのアクセスキー（トークン）を取得します。 最初に閉じたグループを作成し、次に「APIの操作」セクションでグループの「管理」に入りました。 [アクセスキー]タブにはトークンがあり、[コールバックAPI]タブにはWebhook設定があります。







Djangoをインストールして設定します 。 pythonスクリプトを実行するのにDjangoは必要ないかもしれませんが、それ以外の方法はわかりません。



PuTTYを使用して、SSH経由でサーバーに接続し、仮想環境を構成してアクティブ化しました。



SSH：

virtualenv-2.7 virtualenv/myEnv . virtualenv/myEnv/bin/activate
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

最初の行のコマンドは仮想環境を作成し、2行目のコマンドはそれをアクティブにします（ピリオドの後のスペースに注意してください）。 バージョン2.7はホスティング事業者によって決定され、場合によっては異なる場合があります。 したがって、ホスティングヘルプをお読みください。



次にインストールされたDjango

SSH：

 pip install 'django<2'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ホスティングではpython 2.7が使用されており、2未満のバージョンのDjangoのみが動作するため、Djangoバージョンを2番目よりも前にインストールしました。



VK APIで動作するようにPythonモジュールをインストールしました

SSH：

 pip install vk
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

FTP：

ホスティングのルートディレクトリにdjango-projectsのフォルダーを作成しました。 彼は彼女のジャンゴを呼んだ。



SSH：

新しいプロジェクトを作成しました。

 cd django/ django-admin.py startproject mybot
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その結果、/ djangoフォルダーにプロジェクトの名前のフォルダー（この場合は「mybot」）が作成されます。 自動的に作成された初期プロジェクトファイルが含まれます。

/ジャンゴ

/ mybot-プロジェクトフォルダー

/ mybot-プロジェクトの設定を含むモジュール

__init__.py

settings.py

urls.py

wsgi.py

manage.py



Djangoのプロジェクトは、アプリケーションのグループです。 Djangoのアプリケーションは、開発者が作成したアクションを実行するプログラムです。



SSH：

アプリケーションを作成しました。

 cd mybot python manage.py startapp vk_bot
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

/ django / mybotフォルダーに移動して 、「vk_bot」という新しいアプリケーションを作成しました。

アプリケーションの名前を持つフォルダーが、自動的に作成されたアプリケーションファイルを含むプロジェクトフォルダーに作成されました。



/ジャンゴ

/ mybot-プロジェクトフォルダー

/ mybot-プロジェクトの設定を含むモジュール

__init__.py

settings.py

urls.py

wsgi.py

manage.py

/ vk_bot-アプリケーションフォルダー

__init__.py

admin.py

apps.py

models.py

tests.py

views.py



FTP：

コードを操作するために、すべてのプロジェクトファイルをラップトップにダウンロードしました。

プロジェクトファイルとプログラミングを操作するために、Atomアプリケーションを使用しました。



原子：

/django/mybot/mybot/settings.pyファイルのプロジェクト設定を編集しました

 ... DEBUG = False ... ALLOWED_HOSTS = [ u'mybot.mysite.ru', ] ...
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

原子：

ファイル/django/mybot/mybot/urls.pyの URLルーティング設定を編集しました

 ... urlpatterns = [ url(r'^vk_bot/', include('vk_bot.urls')), ] ...
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

FTP：

次の内容で/django/mybot/vk_bot/urls.pyファイルを作成しました：

 from django.conf.urls import url from . import views app_name = 'vk_bot' urlpatterns = [ url(r'^$', views.index, name='index'), ]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

原子：

ファイル/django/mybot/vk_bot/views.pyを編集しました-ブラウザーでアドレスが要求されたときに実行されるindexという関数を追加しました

  https://mybot.mysite.ru/vk_bot/ 

views.py

 # -*- coding: utf-8 -*- from __future__ import unicode_literals from django.views.decorators.csrf import csrf_exempt from django.shortcuts import render from django.http import HttpResponse from bot_config import * # import token, confirmation_token and over constants from bot_config.py import json, vk # vk is library from VK """ Using VK Callback API version 5.5 For more ditalies visit https://vk.com/dev/callback_api """ """ From Django documentation (https://docs.djangoproject.com/en/1.11/ref/request-response/) When a page is requested, Django automatically creates an HttpRequest object that contains metadata about the request. Then Django loads the appropriate view, passing the HttpRequest as the first argument to the view function. This argiment is <request> in def index(request): Decorator <@csrf_exempt> marks a view as being exempt from the protection ensured by the Django middleware. For cross site request protection will be used secret key from VK """ @csrf_exempt #exempt index() function from built-in Django protection def index(request): #url: https://mybot.mysite.ru/vk_bot/ if (request.method == "POST"): data = json.loads(request.body)# take POST request from auto-generated variable <request.body> in json format if (data['secret'] == secret_key):# if json request contain secret key and it's equal my secret key if (data['type'] == 'confirmation'):# if VK server request confirmation """ For confirmation my server (webhook) it must return confirmation token, whitch issuing in administration web-panel your public group in vk.com. Using <content_type="text/plain"> in HttpResponse function allows you response only plain text, without any format symbols. Parametr <status=200> response to VK server as VK want. """ # confirmation_token from bot_config.py return HttpResponse(confirmation_token, content_type="text/plain", status=200) if (data['type'] == 'message_new'):# if VK server send a message session = vk.Session() api = vk.API(session, v=5.5) user_id = data['object']['user_id'] # token from bot_config.py api.messages.send(access_token = token, user_id = str(user_id), message = "Hello, I'm bot!") return HttpResponse('ok', content_type="text/plain", status=200) else: return HttpResponse('see you :)')
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

views.pyスクリプトのインデックス（要求）関数で、Django CSRFに組み込まれている保護を無効にする必要がありました。 「403 Forbidden」エラーが表示されました。 CSRF-クロスサイトリクエストフォージェリ保護-クロスサイトリクエストフォージェリに対する保護。 CSRFの仕組みについては、この記事を参照してください 。

保護を無効にするために、 @ csrf_exemptデコレーターを使用しました 。 しかし、この保護をすべて同じように、より簡単な方法で提供するために、VKontakte Webサイトのグループ管理セクションに登録されている秘密キーを使用しました。



このコードは、イベント処理のためにwebhookを接続するために送信するサーバーからのリクエストを処理します。 Webhookの「確認」と言ってみましょう。

 if (data['type'] == 'confirmation'):# if VK server request confirmation """ For confirmation my server (webhook) it must return confirmation token, whitch issuing in administration web-panel your public group in vk.com. Using <content_type="text/plain"> in HttpResponse function allows you response only plain text, without any format symbols. Parametr <status=200> response to VK server as VK want. """ # confirmation_token from bot_config.py return HttpResponse(confirmation_token, content_type="text/plain", status=200)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

すべての構成設定を個別のボット構成ファイルbot_config.pyに保持しているため、スクリプトの最初に接続することに注意してください。

 from bot_config import * # import token, confirmation_token and over constants from bot_config.py
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

bot_config.py

 # -*- coding: utf-8 -*- """ Configuration file for VK bot """ # token issued on the VK group web-administration page token = '...' # confirmation token issued on the VK group web-administration page in "Callback API" section confirmation_token = '...' # secret key for cross site request forgery protection. It will be in each VK server request secret_key = '...'
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコードの一部では、ユーザーメッセージを処理します。

 if (data['type'] == 'message_new'):# if VK server send a message session = vk.Session() api = vk.API(session, v=5.5) user_id = data['object']['user_id'] # token from bot_config.py api.messages.send(access_token = token, user_id = str(user_id), message = "Hello, I'm bot!") return HttpResponse('ok', content_type="text/plain", status=200)
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

何かが理解できないと思われる場合は、最初のDjangoセットアップに関する記事をさらに読むことができます 。



Webサーバーの魔法 。 Webサーバーへの要求のアドレス指定を構成するには、FTPクライアントFileZillaを介してドメインのあるフォルダー内のサーバーに移動し、そこにフォルダー「 mybot.mysite.ru 」を作成し、その中に3つのファイルを入れます。



.htaccess

 AddHandler wsgi-script .wsgi RewriteEngine on RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^(.*)$ /django.wsgi/$1 [QSA,PT,L] RewriteCond %{HTTP:X-Forwarded-Protocol} !=https RewriteRule .* https://%{SERVER_NAME}%{REQUEST_URI} [R=301,L]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

django.wsgi

 import os, sys virtual_env = os.path.expanduser('~/virtualenv/myEnv') activate_this = os.path.join(virtual_env, 'bin/activate_this.py') execfile(activate_this, dict(__file__=activate_this)) sys.path.insert(0, os.path.join(os.path.expanduser('~'), 'django/mybot')) os.environ['DJANGO_SETTINGS_MODULE'] = 'mybot.settings' from django.core.wsgi import get_wsgi_application application = get_wsgi_application()
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、「myEnv」は作成した仮想環境の名前、「django」は​​ホスティング上のファイルシステムのルートセクションのフォルダー、「mybot」はDjangoを使用して作成したプロジェクトの名前です。



index.html

作成されたVKontakteグループで、Webhookをメッセージ処理に「バインド」します。

これを行うには、VKontakte Webサイトのグループの管理セクションに戻ります（上のスクリーンショットを参照）。 「アドレス」フィールドにwebhookアドレスを入力しましょう

  https://mybot.mysite.ru/vk_bot/ 

[確認]ボタンをクリックします。 /django/mybot/vk_bot/views.pyファイルに記述されたインデックス（リクエスト）関数が正しく機能する場合、つまりタイプミスやエラーが含まれていない場合、すべてが正常であることを示す緑色のチェックマークが表示されます。



WebhookがVKontakteサーバーから新しいユーザーメッセージに関するメッセージを受信するには、VKontakte Webサイトのグループを管理するセクションの[イベントタイプ]タブで、[受信メッセージ]ボックスをオンにします。



その結果、スクリプトはこれらのメッセージをjson形式で受け取ります。

 {"type":"message_new","object":{"id":891,"date":1541599508,"out":0,"user_id":1...1,"read_state":0,"title":"","body":"  "},"group_id":1...4,"secret":"uxSBw"}
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

jsonメッセージには「秘密」フィールドがあることに注意してください。 これは、無効にする必要があったDjango CSRFに組み込まれている保護の代わりに、VKontakteのグループ管理セクションで登録したのと同じ秘密キーです。

ボットをより賢く、より良くする方法は？

ユーザーへの回答を含むデータベースを作成し、ユーザーの質問に最も意味のある回答を選択するようボットに教えることができます。 これについては別の記事で説明します。

会話を維持するために、いわばユーザーインタラクションシナリオをプログラムすることが可能であり、必要です。



あなたの創造的な仕事で頑張ってください！