ObjectIdで検索する

CoddyのNode.jsジャーニー「MongoDBによるデータベース」セクションの一部。レッスン 7/29。

1冊の本を返すには、サーバーは_idで検索しますが、IDはURL内ではテキストとして渡されます。

MongoDBが作成する_idはObjectIdです。これは12バイトの値で、24個の16進文字、つまり数字の0から9と文字のaからfで表されます。JSONでは文字列として表示されますが、データベース内では文字列ではないため、通常のテキストを使ったフィルターでは何も一致しません。まずテキストをObjectIdに変換してください。ObjectId.isValidは、そのテキストをObjectIdにできるかどうかを判定します。それ以外の値を渡すとnew ObjectIdが例外をスローするためです。

import { ObjectId } from 'mongodb';

const text = '66f1c2a9e4b0a1b2c3d4e5f6';
await orders.findOne({ _id: new ObjectId(text) }); // 注文、または null
await orders.findOne({ _id: text });               // null: text は ObjectId ではない
ObjectId.isValid('42');                            // false

findOneは最初に一致したドキュメントを返します。一致するものがない場合はnullを返します。

チャレンジ

簡単

このステップでは、ドキュメントの挿入のプロジェクトファイル（server.jsを含む）ではなく、コースで用意された書棚 API プロジェクトを開きます。これまでの作業は、前のレッスンにそのまま残っています。server.jsを編集する前に、提供されたファイルを読んでください。このコピーには、書棚の一覧表示ルートと挿入ルートが含まれています。

クライアントは、_idで指定した本を1冊取得したいと考えています。

server.jsにGET /books/:idルートを追加します。
URL内のIDはテキストです。ObjectIdになり得ないテキストもあります。ObjectIdは、数字とaからfまでの文字で構成される24文字です。そのようなテキストに対しては、sendErrorを使って、ステータス400とエラーを返します。例：{ "error": "Not a valid id" }不正なテキストからObjectIdを作成するとエラーが発生するため、ObjectIdを作成する前に確認してください。
それ以外の場合は、_idで本を検索します。本が見つかったら、ステータス200と本の情報を返します：{ "_id": "6720a1f4c2b9e81d3a5f0c11", "title": "Dune", "author": "Frank Herbert", "year": 1965, "isbn": "9780441013593", "genre": "scifi" }。
その_idを持つ本がない場合は、ステータス404とエラーを返します。例：{ "error": "No such book" }。試してみましょう：GET /booksを送信し、Duneの_idをコピーします。"_id":の後にある24文字です。実行するたびに本のIDが新しくなるため、実行後に毎回コピーし直してください。GET /books/の後にコピーしたIDを続けて送信すると、ステータス200とDuneが返されます。GET /books/42を送信すると、ステータス400が返されます。GET /books/000000000000000000000000を送信すると、有効なIDですが該当する本がないため、ステータス404が返されます。

自分で試してみよう

import express from 'express';
import { MongoClient } from 'mongodb';

const client = new MongoClient('mongodb://localhost:27017');
const db = client.db('shelf');
const books = db.collection('books');

await books.insertMany([
    { title: 'Dune', author: 'Frank Herbert', year: 1965, isbn: '9780441013593', genre: 'scifi' },
    { title: 'Kindred', author: 'Octavia E. Butler', year: 1979, isbn: '9780807083697', genre: 'scifi' },
    { title: 'Emma', author: 'Jane Austen', year: 1815, isbn: '9780141439587', genre: 'classic' },
]);

const app = express();
app.use(express.json());

// すべてのエラーは { error: message } を返します。
function sendError(res, status, message) {
    res.status(status).json({ error: message });
}

app.get('/', (req, res) => {
    res.send('Bookshelf API');
});

app.get('/books', async (req, res) => {
    const list = await books.find().toArray();
    res.json(list);
});

app.post('/books', async (req, res) => {
    const book = req.body;
    await books.insertOne(book);
    res.status(201).json(book);
});

app.listen(3000, () => {
    console.log('Bookshelf is running on port 3000');
});