addメソッドで追加に失敗した場合の戻り値はnullでOKですか？

Question

検索して検索結果が空の場合はnullを返したりすると思うのですが、追加メソッドで追加に失敗した場合、どんな値を呼び出し元に返すと良いのでしょうか？

    getNote(title) {
        const notes = this._fetchNotes();
        const filteredNotes = notes.filter(note => note.title === title);
        return filteredNotes.length > 0 ? filteredNotes[0] : null;
    }

こちらの場合は、引数に与えられた文字列とマッチするオブジェクトが存在していたら最初のオブジェクトを返し、マッチしたものが見つからない場合はnullを返しています。

    addNote(title, body) {
        let notes = this._fetchNotes();
        const note = {title, body};

        const duplicatedNotes = notes.filter(note => note.title === title);
       
        if (duplicatedNotes.length > 0) { return null; }
      
        notes.push(note);
        this.saveNotes(notes);
        return note;
    }

こちらの場合は追加に成功した場合は追加したオブジェクトを呼び出し元に返して、追加に失敗した場合は検索メソッドに合わせて、nullを返してみました。

呼び出し元の方では追加出来たかどうかのチェックをする処理を書いているので、追加に失敗した場合、何も返さない場合、呼び出し元の方でundefinedかどうかのチェックをするかたちになります。ただ、他のところでは、nullかどうかのチェックをしているので、一貫性をもたせるためにaddメソッドで失敗した場合もnullを返した方が良いのかななんて思ったりもしました。

追加失敗時にfalseを呼び出し元に返すのは、追加成功時にオブジェクトを返しているので違うのかなと思いました。追加成功時にtrueを返しているのであれば、追加失敗時にfalseを返すので良いとは思うのですが。

追加したものは何もなかったことを表すのにnullを使うのって適切でしょうか？

ちなみに、呼び出し元で、
if(note === null){処理}ではなく、
if(!note){処理}みたいに書くことも出来ますが、個人的には明確に書きたいので、ざっくりとした判定の書き方はしていません。

Comments

[think49]

それは本当に `addNote()` ですか。 対象の `title` のノードを抽出しているように読めますが、既存のノードを編集しているのではないのでしょうか。

[退会済みユーザー]

読み書きしているjsonファイルがありまして、_fetchNotes()で対象のjsonファイルから既存のデータを読み込んでいます。saveNote()でaddNote()の引数に渡されたtitleとbodyをオブジェクトにして書き込んでいます。

[think49]

ノートを追加するなら、既存ノートを検索する必要はないと思うのですが、何の為に_fetchNotes() し、filter() で指定したtitleのノートの数を確認しているのでしょうか。 「既存ノートと同じtitleでなければ追加できない」ように読めますが、getNote() では指定したtitleの0番目のノートを参照しているので、getNote() においては index 1 以降は読み飛ばされます。何もノートが存在しなければ addNote() は失敗し、既存ノートが存在して追加したとしても getNote() で追加したノートを参照出来ない、と読めるのですが、この点についてはいかがでしょうか。

[退会済みユーザー]

「既存ノートと同じtitleでなければ追加できない」ではなくて、

[退会済みユーザー]

「既存ノートに同じtitleがあったら追加出来ない」ようになってます。

[think49]

ああ、なるほど…。理解しました。上書きする事は出来ないのですね。

[退会済みユーザー]

はい、男性は過去の恋愛を上書き保存出来ません。

Answer 1

状況がよくわからないのですがaddしたときに何か返す必要があるのですか？
addは追加するだけなので、チェックする必要はなく
getでnullが返ってくればわかるんじゃないでしょうか？
もしくは

if(addNote(・・・)){・・・

という追加が成功したときだけなにかをしたいのであれば
成功時にtrue、失敗時にfalseを返せばよいかと

Comments

[退会済みユーザー]

addNoteメソッドでは追加した１つのnoteを呼び出し元にリターンしています。（最後の行のreturn note;の部分）成功した時はnoteオブジェクトを返しているのですが、失敗したときにnullを返すのは適切なのかどうかというところで少し迷ってしまいました。あ、ちなみにコレはCLIツールです。呼び出し元で追加に成功していた場合は追加したnoteのタイトルとボディーをconsole.logで出力し、失敗した場合はエラーメッセージを出力しています。