(ts/js) findXXX系メソッドで対象データが見つからない場合、例外を投げるのか / undefinedを返すのか 関数名で表現する慣習はありますか?

Question

Rubyの例

たとえば ruby であれば 関数名に ! が使えるので 以下のように該当データが見つからない場合 「例外を投げる」のか「nilを返すのか」を明示できると思います。

User = Struct.new(:id, :name, :is_admin)

class UserRepository
  def initialize
    @users = ....
  end

  def find_admin_user!
    u = @users.find(&:is_admin)
    raise "..." unless u
    u
  end

  def find_admin_user
    users.find(&:is_admin)
  end
end

Javascript/Typescript の例

前提) 一般的に見ると例外返す方式 or undefinedを返す方式 どっちが良い、という話ではないと思っています。

この例では findAdminUserは データが見つからない場合 undefined を返します。

interface User {
  id: number;
  name: string;
  isAdmin: boolean;
}

const users: User[] = ...

export function findAdminUser() { // return type は User | undefined
  return users.find(u => u.isAdmin);
}

便宜的に、あるアプリーケーション内のコードを "データアクセスレイヤー", "プレゼンテーションレイヤー" と呼ぶとすると、
"プレゼンテーションレイヤー" 側で if( !findAdminUser() ) { Show("Admin user not found" } みたいに ハンドリングしたい場合もあります。 その場合例外ではなく undefined を返してくれた方がプレゼンテーションレイヤーにとって都合がよいわけです。

一方、型レベルの話として

function findAdminUser(): User | undefined { ... }

ではなく

function findAdminUser(): User { ... if (..) throw "xxx"; ...  }

の方が嬉しい場合もあります。
例えばデータ仕様として、"adminUserが必ず存在する" というアプリーケーションだとこう書きたいと思います。
余計なpossibly undefined のチェック処理(分岐処理)のコードを書かなくて済むので呼び出し箇所が多いとこの関数の方が嬉しいです。

ということで何かいい命名規則はないですか？

1例

findAdminUser(): User | undefined
findAdminUserOrThrow(): User

??? んー、まあ、意味は伝わるかもしれないんですが、もっとよい表現ないですかね

Comments

[think49]

> ということで何かいい命名規則はないですか？

急に命名規則が出てきましたが、"interface User" の名前がふさわしくないと認識されているのでしょうか。
名前は要求仕様を確立してから、決めるものです。

[tomlla_92]

いえinterface Userの名前に関してはこの質問の対象ではありません。

タイトルにあるように関数名についての質問です。

[think49]

関数名の命名規則でしたか。
本文だけ読むと、「命名規則」が唐突なので戸惑ってしまいました。

いずれにしても、要求仕様を決めるのが先だと思います。
名前は後から決めるものです。

[ozwk]

.NETでいうところのParse/TryParseみたいに名前で区別したいって話ですよね?
(Parse/TryParseは例外なげるか返り値で成功判断するかって違いなんで少し違いますけど)

[tomlla_92]

@ozwk yes! そういう話です！

Answer 1

ビルトイン関数

私の知る限り、下記性質を関数名に反映したビルトイン関数はありません。

• 返り値となるデータが存在しなかったら、例外を投げる
• 返り値となるデータが存在しなかったら、非存在値を返す

ES2019, DOM, Fetch等、JavaScriptを構成するWeb標準仕様は数多くある為、ご自身でも調査してみて下さい。

コーディング規約

同性質を含めたコーディング規約も私は知りません。
全てを知っているわけではないので、こちらもご自身でも調査する事をお勧めします。

https://www.google.com/search?q=JavaScript+%E3%82%B3%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E8%A6%8F%E7%B4%84

ES/JavaScript APIの慣習

ES2019では、可能な限り、処理を実行し、実行不可能な状況でのみ例外を投げるのが基本的な慣習です。

(null).toString();
[].forEach();
(1),toString(1000);

データ取得系は私の知る限りでは、例外を投げません。

({}).foo;
new Map().get('foo');
[...new Set().keys()].
document.body.getAttribute('foo');
document.getElementById('foo');

未定義変数の参照は例外を投げますが、これはどうしようもありません。

foo;

従って、言語仕様の慣習に倣うのであれば、データ取得時に例外を投げる実装が誤りです。
取得したデータを扱う際に、どうしようもない状況があります。

document.getElementById('foo').classList.add('bar');

いわゆるNullPointerExceptionですが、これは例外を投げる為の有効な手段になります。

Re: tomlla_92 さん