❗

【Ruby】メソッド名における「!」の意味と注意点

に公開
Ruby
tech

!の意味

Rubyにおいて、メソッド名の末尾に付けられた「!」は、そのメソッドが破壊的な変更を行うことを示す命名規則です。この命名規則は、Rubyの慣習的なルールの一部であり、開発者によって広く採用されています。

「!」をメソッド名に付けることによって、そのメソッドが一般的な動作とは異なり、より危険で予測できない操作を行う可能性があることを示します。具体的には、破壊的な変更を行ったり、例外を発生させたり、予期しない結果をもたらす可能性があります。

コード例

# ユーザーを表すモデルクラス
class User < ActiveRecord::Base
  # テーブルにはnameとemailのカラムがあると仮定

  # updateメソッドの使用例
  def update_user(name, email)
    user = User.find(1)  # IDが1のユーザーを取得

    # ユーザーの情報を更新
    user.name = name
    user.email = email
    user.save  # レコードの保存

    puts "ユーザー情報を更新しました。"
  end

  # update!メソッドの使用例
  def update_user!(name, email)
    user = User.find(1)  # IDが1のユーザーを取得

    # ユーザーの情報を更新
    user.name = name
    user.email = email
    user.save!  # レコードの保存（保存に失敗した場合は例外が発生）

    puts "ユーザー情報を更新しました。"
  end
end

# updateメソッドの呼び出し
user = User.new
user.update_user("John", "john@example.com")
# 出力: ユーザー情報を更新しました。

# update!メソッドの呼び出し（保存に成功する場合）
user.update_user!("Jane", "jane@example.com")
# 出力: ユーザー情報を更新しました。

# update!メソッドの呼び出し（保存に失敗する場合）
user.update_user!("Invalid Name", nil)
# 例外(RuntimeError)が発生し、エラーメッセージが表示される

update_userメソッドは、レコードを更新する際に使用されますが、更新に失敗した場合でも例外を発生させず、単純にfalseを返します。一方、update_user!メソッドは、同様にレコードを更新しますが、もし更新に失敗した場合は例外を発生させます。つまり、update_user!メソッドは破壊的な操作を行い、予期しない結果が起こる可能性があるため、注意が必要です。

このように、メソッド名に「!」が付いている場合は、そのメソッドが通常の動作とは異なることを意味しています。開発者はこのようなメソッドを使用する際には、ドキュメントやコメントを参照し、注意深く扱う必要があります。

まとめ

Rubyにおけるメソッド名の末尾に付けられた「!」は、そのメソッドが破壊的な変更を行うことを示す命名規則です。開発者はこの命名規則に従い、適切に「!」を使用することで、コードの意図を明確にし、予期しない結果を避けるための注意を払いましょう。

参考

https://docs.ruby-lang.org/ja/2.5.0/doc/symref.html

Discussion