在 class 定義里使用一致的結(jié)構(gòu)。
class Person # extend and include go first extend SomeModule include AnotherModule # constants are next SOME_CONSTANT = 20 # afterwards we have attribute macros attr_reader :name # followed by other macros (if any) validates :name # public class methods are next in line def self.some_method end # followed by public instance methods def some_method end # protected and private methods are grouped near the end protected def some_protected_method end private def some_private_method end end
傾向使用 module，而不是只有類(lèi)方法的 class。類(lèi)別應(yīng)該只在創(chuàng)建實(shí)例是合理的時(shí)候使用。
# bad class SomeClass def self.some_method # body omitted end def self.some_other_method end end # good module SomeClass module_function def some_method # body omitted end def some_other_method end end
當(dāng)你希望將模塊的實(shí)例方法變成 class 方法時(shí)，偏愛(ài)使用 module_function 勝過(guò) extend self。
# bad module Utilities extend self def parse_something(string) # do stuff here end def other_utility_method(number, string) # do some more stuff end end # good module Utilities module_function def parse_something(string) # do stuff here end def other_utility_method(number, string) # do some more stuff end end
When designing class hierarchies make sure that they conform to the
Liskov Substitution Principle.
在設(shè)計(jì)類(lèi)層次的時(shí)候確保他們符合 Liskov Substitution Principle 原則。(譯者注: LSP原則大概含義為: 如果一個(gè)函數(shù)中引用了 父類(lèi)的實(shí)例, 則一定可以使用其子類(lèi)的實(shí)例替代, 并且函數(shù)的基本功能不變. (雖然功能允許被擴(kuò)展))
Liskov替換原則：子類(lèi)型必須能夠替換它們的基類(lèi)型 <br/>
1. 如果每一個(gè)類(lèi)型為T(mén)1的對(duì)象o1，都有類(lèi)型為T(mén)2的對(duì)象o2，使得以T1定義的所有程序P在所有的對(duì)象o1都代換為o2時(shí),程序P的行為沒(méi)有變化，那么類(lèi)型T2是類(lèi)型T1的子類(lèi)型。 <br/>
2. 換言之，一個(gè)軟件實(shí)體如果使用的是一個(gè)基類(lèi)的話，那么一定適用于其子類(lèi)，而且它根本不能察覺(jué)出基類(lèi)對(duì)象和子類(lèi)對(duì)象的區(qū)別。只有衍生類(lèi)替換基類(lèi)的同時(shí)軟件實(shí)體的功能沒(méi)有發(fā)生變化，基類(lèi)才能真正被復(fù)用。 <br/>
3. 里氏代換原則由Barbar Liskov(芭芭拉.里氏)提出，是繼承復(fù)用的基石。 <br/>
4. 一個(gè)繼承是否符合里氏代換原則，可以判斷該繼承是否合理（是否隱藏有缺陷）。
努力使你的類(lèi)盡可能的健壯 [SOLID](http://en.wikipedia.org/wiki/SOLID_object-oriented_design/))。(
總是為你自己的類(lèi)提供 to_s 方法, 用來(lái)表現(xiàn)這個(gè)類(lèi)（實(shí)例）對(duì)象包含的對(duì)象.
class Person attr_reader :first_name, :last_name def initialize(first_name, last_name) @first_name = first_name @last_name = last_name end def to_s "#@first_name #@last_name" end end
使用 attr 功能成員來(lái)定義各個(gè)實(shí)例變量的訪問(wèn)器或者修改器方法。
# bad class Person def initialize(first_name, last_name) @first_name = first_name @last_name = last_name end def first_name @first_name end def last_name @last_name end end # good class Person attr_reader :first_name, :last_name def initialize(first_name, last_name) @first_name = first_name @last_name = last_name end end
避免使用 attr。使用 attr_reader 和 attr_accessor 作為替代。
# bad - creates a single attribute accessor (deprecated in 1.9) attr :something, true attr :one, :two, :three # behaves as attr_reader # good attr_accessor :something attr_reader :one, :two, :three
考慮使用 Struct.new, 它可以定義一些瑣碎的 accessors,
constructor（構(gòu)造函數(shù)） 和 comparison（比較） 操作。
# good class Person attr_reader :first_name, :last_name def initialize(first_name, last_name) @first_name = first_name @last_name = last_name end end # better class Person < Struct.new(:first_name, :last_name) end
考慮使用 Struct.new，它替你定義了那些瑣碎的存取器（accessors），構(gòu)造器（constructor）以及比較操作符（comparison operators）。
# good class Person attr_accessor :first_name, :last_name def initialize(first_name, last_name) @first_name = first_name @last_name = last_name end end # better Person = Struct.new(:first_name, :last_name) do end
不要去 extend 一個(gè) Struct.new - 它已經(jīng)是一個(gè)新的 class。擴(kuò)展它會(huì)產(chǎn)生一個(gè)多余的 class 層級(jí)
并且可能會(huì)產(chǎn)生怪異的錯(cuò)誤如果文件被加載多次。
考慮添加工廠方法來(lái)提供靈活的方法來(lái)創(chuàng)建特定類(lèi)實(shí)例。
class Person def self.create(potions_hash) # body omitted end end
鴨子類(lèi)型（duck-typing）優(yōu)于繼承。
# bad class Animal # abstract method def speak end end # extend superclass class Duck < Animal def speak puts 'Quack! Quack' end end # extend superclass class Dog < Animal def speak puts 'Bau! Bau!' end end # good class Duck def speak puts 'Quack! Quack' end end class Dog def speak puts 'Bau! Bau!' end end
Avoid the usage of class (@@) variables due to their "nasty" behavior
in inheritance.
避免使用類(lèi)變量（@@）因?yàn)樗麄冇憛挼睦^承習(xí)慣（在子類(lèi)中也可以修改父類(lèi)的類(lèi)變量）。
class Parent @@class_var = 'parent' def self.print_class_var puts @@class_var end end class Child < Parent @@class_var = 'child' end Parent.print_class_var # => will print "child"
正如上例看到的, 所有的子類(lèi)共享類(lèi)變量, 并且可以直接修改類(lèi)變量,此時(shí)使用類(lèi)實(shí)例變量是更好的主意.
根據(jù)方法的用途為他們分配合適的可見(jiàn)度( private, protected )，不要讓所有的方法都是 public (這是默認(rèn)設(shè)定)。這是 Ruby 不是 Python。
public, protected, 和 private 等可見(jiàn)性關(guān)鍵字應(yīng)該和其（指定）的方法具有相同的縮進(jìn)。并且不同的可見(jiàn)性關(guān)鍵字之間留一個(gè)空格。
class SomeClass def public_method # ... end private def private_method # ... end def another_private_method # ... end end
使用 def self.method 來(lái)定義單例方法. 當(dāng)代碼重構(gòu)時(shí), 這將使得代碼更加容易因?yàn)轭?lèi)名是不重復(fù)的.
class TestClass # bad def TestClass.some_method # body omitted end # good def self.some_other_method # body omitted end # Also possible and convenient when you # have to define many singleton methods. class << self def first_method # body omitted end def second_method_etc # body omitted end end end class SingletonTest def size 25 end end test1 = SingletonTest.new test2 = SingletonTest.new def test2.size 10 end test1.size # => 25 test2.size # => 10
本例中，test1 主站蜘蛛池模板： 焦作市| 濮阳市| 花莲县| 祁阳县| 辉南县| 乐陵市| 奉贤区| 合水县| 博客| 丹江口市| 长泰县| 扎鲁特旗| 绥江县| 保定市| 南昌市| 黄石市| 大英县| 临漳县| 吉林市| 卓尼县| 肇州县| 建昌县| 河曲县| 溧阳市| 共和县| 大姚县| 米林县| 大英县| 梨树县| 渑池县| 灵台县| 湘乡市| 忻州市| 安远县| 安宁市| 彭阳县| 宣武区| 乌鲁木齐县| 正阳县| 抚顺县| 邓州市|