ruby インスタンス変数について

Question

疑問　インスタン変数は@をつけるのかつけないのか。

railsのフレームワークを導入しコントローラ内で

index
  @item = Item.all
end

の@itemの様にインスタンス変数は変数の前に＠マークをつけると認識していました。

しかし復習としてプロゲートをやり直すと

class Menu
  # nameとpriceというインスタンス変数を用意してください
  attr_accessor :name
  attr_accessor :price
end

の様に:name、:priceの前には＠がついていません。
＠は着く場合ととつかない場合があるのでしょうか。
ご教示いただきたいです。
よろしくお願いいたします。

Answer 1

まずはこれを抑えてください

attr_accessorが何をしているかというと、

1. 外部からの値の参照を可能にしている
2. 外部からの値の設定を可能にしている

class Hoge
  attr_accessor :name
end

x = Hoge.new
x.name = 'hoge' # 外部から値の設定が可能

下記はエラーになる

class Hoge
  def initialize(name)
    @name = name
  end
end

hoge = Hoge.new
hoge.name = 'tee' # 外部からのアクセス不可なのでエラー

## attr_accessor :nameをつけると外部からの設定と参照が可能になる

---

ここから本題

インスタンス変数を用意するということは、値を入れる箱を用意すると同義である

# 下記の状態ですでにname属性(インスタンス変数)にアクセスできる
# 箱は完成していると言って良い
class Hoge
  attr_accessor :name
end

x = Hoge.new
p x.name # nill 値を何も設定していないため
x.name = 'hoge' # nameに外部から値を設定できる

attr_accessorを使って値の設定や参照が可能なら@は必要ないのではないか？
この疑問は最もですが、そうはいきません。インスタンス生成時に値を設定するには@が必要です。

class Hoge
  def initialize(name)
    @name = name
  end
end

x = Hoge.new('hoge') # 初期化時に値を設定できる

これは大きなメリットです。
例えば属性(インスタンス変数が) 4つある場合

# @を使わない場合
x = Hoge.new
x.name = 'tee'
x.age = 18
x.tall = 175
x.hobby = 'running'

# @を使う場合
x = Hoge.new('tee', 18, 175, 'running')

両者の運用方法は

このようにどちら使っても開発を進めることは可能ですが、使い勝手に差があります
下記のように併用する運用が一番堅実な使い方でしょう

1. インスタンス変数には@をつける
2. 外部からアクセスしたい場合にはattr_accessorを併用する

# nameは外部からのアクセスが可能
# 初期化時に一度に属性の中身を設定可能
class Person
  attr_accessor :name

  def initialize(name, age)
    @name = name
    @age = age
  end
  
end

@を推奨する理由は、初期化時に値を設定できるからですが、他にも理由があります。
attr_accessorは外部からの参照や設定ができるので、セキュリティ的に好ましくありません。
不要な場面で呼び出してしまう可能性もありバグにつながります。@を使えば外から直接読み書きされる心配がないのでセキュリティ上のメリットが多いです。

基本は@使用して初期化時に値を設定できるようにし、必要なものだけattr_accessorの併用で外部に露出させましょう

余談

attr_accessorの仕組みですが、自動でgetterメソッドとsetterメソッドを定義しているだけです。
attr_accessorを使わなくても手動でgetterメソッドとsetterメソッドをclass内に定義すれば、
attr_accessorが適応されているのと同じ状態にすることが可能です。
また、読み取り専用や書き取り専用のattr_accessorの親戚もいます。
興味があれば調べてみてください。

Answer 2

:nameはインスタンス変数ではありません。シンボルのリテラルです。

attr_accessorというメソッドは、引数に:nameというシンボルを与えることで、

def name
    @name
end
def name=(val)
    @name = val
end

という2つのメソッドが自動的に定義するという機能を持っています。

インスタンス変数@nameに代入したり参照したりすることと、そのインスタンス変数を扱う2つのメソッドを定義することは、関連はしていますが、概念としては別物です。

「インスタンス変数を用意」という日本語も意味が微妙ですね。具体的に何を言ってるのか。

class Menu
  # nameとpriceというインスタンス変数を用意してください
  attr_accessor :name
  attr_accessor :price
end

がテキストにそのまま書いてあったのなら、「インスタンス変数を用意」＝「インスタンス変数を扱う2つのメソッドを定義」という意味で使っているのかもしれませんが、一般的ではない気がします。

Comments

[otn]

> 「インスタンス変数を用意」＝「インスタンス変数を扱う2つのメソッドを定義」という意味で使っているのかもしれませんが、一般的ではない気がします。

と、一旦は柔らかく書きましたが、インスタンス変数を用意？する毎に、attr_accessor でアクセス用のメソッドを定義するのは、「カプセル化」というオブジェクト指向の重要な概念こ壊すことになるので、上記のような考えは非オブジェクト指向的発想です。まあ、Rubyを使うからと言って、オブジェクト指向で設計しないといけないという訳ではないですが。

Answer 3

:name、:priceの前には＠がついていません。

が、attr_accessor :nameは@nameというインスタンス変数をもとにして動きます。