【実用編】【DB】discord.js v13 ユーザーごとにプロフィールを作成する

前書き

私がメインで開発している「ヒトリン」というボットにて、最近ユーザーごとにプロフィールを作成する機能を追加したため紹介します。

どのようなものか

MongoDBを使用し、ユーザーごとに様々な情報を格納したデータを作成し、プロフィールを作成する。
今回は、MongoDBの使用方法からプロフィールを作成しコマンドで表示させるところまでのフルフルバージョンを紹介する予定でござんす。

MongoDB

上記のリンクからMongoDBのサイトへリンクしサインインまたは新規登録を完了してください。
ほとんど英語ですが頑張ってどんどん次に進みましょう。

一番右の「FREE」となっているものを選択し、「CREATE」をクリックしてください。

ここら辺は任意で選択してください。（なんもいじんなくても良いかもです）
右下にある「Create Cluster」をクリック

ここら辺も適当でいいんですが、最後の「Where would you like to connect from?」は注意。（訳：あんちゃんはどっから接続するんや？）

特に理由がなければには右の「Add My Current IP Address」をクリックしてください。（意味：現在のIPアドレスを追加）

注意
IPアドレスを変更した場合、ここの設定から使用中のIPアドレスを追加してください。

完了したら「Finish and Close」をクリックしてください。

このような画面になれば設定は完了です。

npm

MongoDBをNode.jsで使用するために「mongoose」をインストールします。

cmd

npm install mongoose

コーディング

いよいよコーディングをしていきます。コーディングをしたくてしたくてたまらなく ☆禁断症状☆ が出ていた方もいらっしゃることかと存じます。ご安心ください。

ボットの核となるファイル「index.js」等に記述をしていきます。

index.js

const mongoose = require('mongoose');

~
~
~

mongoose //mongooseについて
	.connect(<接続するために必要>, {
		useNewUrlParser: true, //任意
	})
	.then(() => {
		console.log('データベースに接続したんだゾ');
	})
	.catch((error) => {
		console.log(error); //エラー出力
	});

<接続するために必要> のところに入れるものを説明します。

先ほどのこの画面に来ます。

「Connect」をクリックし、「Connect your application」をクリック。

「Node.js」で、バージョンを任意のものに選択したら以下のようなよくわからない文字列が出てきます。

今回の例

mongodb+srv://test:<password>@cluster0.3afev.mongodb.net/<myFirstDatabase>?retryWrites=true&w=majority

<password> には先ほど設定した「ユーザー」と「パスワード」の「パスワード」を入力
<myFirstDatabase> には任意のデータベースの名前を入力

そしたらその文字列を <接続するために必要> のところに入れます。

index.js

mongoose //mongooseについて
	.connect(mongodb+srv://test:<password>@cluster0.3afev.mongodb.net/<myFirstDatabase>?retryWrites=true&w=majority, {
		useNewUrlParser: true, //任意
	})
	.then(() => {
		console.log('データベースに接続したんだゾ');
	})
	.catch((error) => {
		console.log(error); //エラー出力
	});

そしたら次に任意のフォルダを作成し、そのフォルダの中に任意のJSファイルを作成します。今回は「models」というフォルダに「profileSchema.js」というJSファイルを作成します。
profileSchmea.js にはデータベースにどのようにどんな種類のデータを保存するのか、というものを書いていきます。
今回はユーザーのID、ユーザーネーム、アバターを保存していきます。

profileSchema.js

const mongoose = require('mongoose'); //mongoDBを使用するためのおまじない

const profileSchema = new mongoose.Schema({
	_id: { type: String }, //ユーザーID
	name: { type: String }, //ユーザーネーム
	avatar: { type: String }, //アバター
});

const model = mongoose.model('Profiles', profileSchema);

module.exports = model;

type: String 等の説明
type: の後には型が入ります。まぁプログラミング勉強してる方ならほぼ誰でもわかるかと思いますが一応紹介しておきます。

• String: 文字列（"あいうえお" "僕は天才、人生満喫中" 文字同士の計算はできない 例："2" + "3" = "23" )
• Number: 数字（1とか2とか。数字同士は計算できる 例：1+9=137193821738 ←嘘)
• Boolean: 真偽（「はい（True）」か「いいえ（False）」の二択）

などがあります。
ちな「False」の読み方は「ファルス」ではなく「フォールス（フォルス）」です。
「NULL」は「ヌル」ではなく「ナル」です。だって「ヌル」だと「NULL NULL」の読み「ヌルヌル」じゃないですか...w
読み方を間違えると意外と恥ずかしいので一応勉強しておいて損はないかもです。そんなことよりコードの勉強した方がいいんですけどね。羞恥心にはかなわねぇや。

ところで「ユーザーID」って言ってんのになんで文字列の「String」を使ってんだ？おめぇーって思った方。
(???) 良い質問ですね
IDってなんか番号っぽいから数字の「Number」使えよってお思いでしょう。
実は以下の理由があります。

• Stringのほうが情報量多め
• どんなフォーマットで対応できるように
• 文字列にする！って決めたほうが楽

（ 引用：https://qiita.com/sato-shin/items/0ec486d9c1bf98d9bf4c ）

このようにすることでユーザープロフィールをどのようにデータベースに保存するかを決められました。

次に、このデータベースを実際に保存・使用していきたいと思います。

基本的にいつ保存するかというのは自由なんですが、私はコマンドを実行する「index.js」のinteractionCreate内の上部に書いています。
※ちなみにinteractionCreate内の上部に書いても、実際に動作するのはコマンドを実行するときのみです。

index.js

const profileModel = require('./models/profileSchema'); //先ほど作成したスキーマを参照
~
~
~
client.on('interactionCreate', async interaction => { //メッセージを受け取ったら
	const profileData = await profileModel.findOne({ _id: interaction.user.id });
	if (!profileData) {
		const profile = await profileModel.create({
			_id: interaction.user.id, //ユーザーID
			name: interaction.user.username, //ユーザーネーム
			avatar: interaction.user.displayAvatarURL({ format: 'png' }), //アバター
		});
		profile.save();
		console.log('データベースに保存したよ: ' + interaction.user.tag); //一応ログとしてコンソールに出力
	}
	if (!interaction.isCommand()) return;

	const command = client.commands.get(interaction.commandName);

	if (!command) return; //コマンド以外無視
});

ガチ気を付けてマジンコマジマジ
async / await の非同期処理で行わないとエラーが発生せず、正常に動作しない可能性があります。これで僕は何度も苦しめられたんです！！！皆さんは気をつけましょうね！！！！！！絶対にな！！！絶対にﾀﾞｿﾞ！！！！

<任意モデル>.create({ ﾅﾝﾁｬﾗｰ }) で新しく作成できます。（設定によっては重複エラー発生するときありますので注意）
<任意モデル>.findOne({ 検索 }) でその検索に当てはまるものを一つ取り出します。
<任意モデル>.findOneAndUpdate({ 検索 }, { ﾅﾝﾁｬﾗｰ }) で検索に当てはまるものを取り出し、それにﾅﾝﾁｬﾗｰします。はい。
思ったより割と簡単でしょ？

ということでこれで作成とかは完了しました。そしたら今度はコマンドで表示してみましょう。
今回は「profile.js」というJSファイルを作成し表示させてみます。

profile.js

const profileModel = require('../models/profileSchema');
const { SlashCommandBuilder } = require('@discordjs/builders');
require('dotenv').config();

module.exports = {
	data: new SlashCommandBuilder()
		.setName('profile')
		.setDescription('指定したユーザーのプロフィールを表示します。')
        .addUserOption(option => option.setName('対象').setDescription('ユーザーを選択')),
	async execute(interaction) {
        const user = interaction.options.getUser('対象'); //コマンドオプションのユーザー選択から
        const profileData = await profileModel.findOne({ _id: user.id }); //ユーザーのIDでデータベースから合うものを一つ取り出す。

		await interaction.reply(`ID: ${profileData.id}\nユーザーネーム: ${profileData.name}\nアバター: ${profileData.avatar}`);
	},
};

上記のようなコードを記述することでプロフィールを表示するコマンドが作成できます。
これだけではまだ「ユーザーの情報を表示する」みたいなコマンドだけで充分ですが先ほどのスキーマをいろいろといじれば標準機能よりもはるかに便利で交流的なプロフィールを作成できるはずです！
ぜひみなさんもプロフィール機能を自分なりに作ってみてください！

宣伝

私がメインで開発しているBOT「ヒトリン」。
...使用してみませんか？
開発中でまだまだ「くそ便利すぎマジワロタ」とまではいかないですが、ぜひみなさんと成長していけるようなBOTを作成したいと思っています。
ぜひご検討ください。