目录
当前位置: 首页 > 文档资料 > Ruby 风格指南 >

字符串

优质
小牛编辑
147浏览
2023-12-01

字符串


  • 倾向使用字符串插值或字符串格式化,而不是字符串拼接。

    1. # 差
    2. email_with_name = user.name + ' <' + user.email + '>'
    3. # 好
    4. email_with_name = "#{user.name} <#{user.email}>"
    5. # 好
    6. email_with_name = format('%s <%s>', user.name, user.email)

  • 使用统一的风格创建字符串字面量。在 Ruby 社区中存在两种流行的风格:默认单引号(风格 A)与默认双引号(风格 B)。

    • (风格 A) 当你不需要字符串插值或特殊字符(比如 \t\n')时,倾向使用单引号。

      1. # 差
      2. name = "Bozhidar"
      3. # 好
      4. name = 'Bozhidar'
    • (风格 B) 除非字符串中包含双引号,或是你希望抑制转义字符,否则倾向使用双引号。

      1. # 差
      2. name = 'Bozhidar'
      3. # 好
      4. name = "Bozhidar"

    本指南使用第一种风格。


  • 不要使用 ?x 字面量语法。在 Ruby 1.9 之后,?x'x'(只包含单个字符的字符串)是等价的。

    1. # 差
    2. char = ?c
    3. # 好
    4. char = 'c'

  • 不要忘记使用 {} 包裹字符串插值中的实例变量或全局变量。

    1. class Person
    2. attr_reader :first_name, :last_name
    3. def initialize(first_name, last_name)
    4. @first_name = first_name
    5. @last_name = last_name
    6. end
    7. # 差 - 语法正确,但略显笨拙
    8. def to_s
    9. "#@first_name #@last_name"
    10. end
    11. # 好
    12. def to_s
    13. "#{@first_name} #{@last_name}"
    14. end
    15. end
    16. $global = 0
    17. # 差
    18. puts "$global = #$global"
    19. # 好
    20. puts "$global = #{$global}"

  • 在字符串插值中,不要显式调用 Object#to_s 方法,Ruby 会自动调用它。

    1. # 差
    2. message = "This is the #{result.to_s}."
    3. # 好
    4. message = "This is the #{result}."

  • 当你需要构造巨大的数据块时,避免使用 String#+,使用 String#<< 来替代。String#<< 通过修改原始对象进行拼接工作,其比 String#+ 效率更高,因为后者需要产生一堆新的字符串对象。

    1. # 差
    2. html = ''
    3. html += '<h1>Page title</h1>'
    4. paragraphs.each do |paragraph|
    5. html += "<p>#{paragraph}</p>"
    6. end
    7. # 好 - 并且效率更高
    8. html = ''
    9. html << '<h1>Page title</h1>'
    10. paragraphs.each do |paragraph|
    11. html << "<p>#{paragraph}</p>"
    12. end

  • 当存在更快速、更专业的替代方案时,不要使用 String#gsub

    1. url = 'http://example.com'
    2. str = 'lisp-case-rules'
    3. # 差
    4. url.gsub('http://', 'https://')
    5. str.gsub('-', '_')
    6. # 好
    7. url.sub('http://', 'https://')
    8. str.tr('-', '_')

  • heredocs 中的多行文本会保留各行的前导空白。因此做好如何缩排的规划。

    1. code = <<-END.gsub(/^\s+\|/, '')
    2. |def test
    3. | some_method
    4. | other_method
    5. |end
    6. END
    7. # => "def test\n some_method\n other_method\nend\n"

  • 使用 Ruby 2.3 新增的 <<~ 操作符来缩排 heredocs 中的多行文本。

    1. # 差 - 使用 Powerpack 程序库的 String#strip_margin
    2. code = <<-END.strip_margin('|')
    3. |def test
    4. | some_method
    5. | other_method
    6. |end
    7. END
    8. # 差
    9. code = <<-END
    10. def test
    11. some_method
    12. other_method
    13. end
    14. END
    15. # 好
    16. code = <<~END
    17. def test
    18. some_method
    19. other_method
    20. end
    21. END