让你的Rails应用更加健壮的5种姿势『译』

原文链接: Five Practices for Robust Ruby on Rails Applications
转载请注明出处:http://tedyin.github.io/2016/03/06/five-practices-for-robust-ruby-on-rails-applications/

无论什么时候,当我发现项目里面存在 bug 或者数据不一致,但却又很难找到是哪里出了问题时,我总是会感叹:“他们(the developer)只需要再多敲几下键盘,这些事情就不会发生了。”

Brewhouse的工作中,我们会应用下面5种最佳实践,让我们的 Rails 应用更加健壮。因为这些方法可以让代码在遇到问题时,可以尽早地、明确地、快速地的抛出问题,告诉我们哪里出错了。我们可以通过捕捉这些错误信息来确保我们所有的数据和操作都是正确有效的。

使用 Hash#fetch 方法去处理‘有问题’的 hash 对象

unexpected method 'upcase' for nil… 这样的错误,我们经常会遇到。无论什么时候当你去遍历一个hash对象,如果你希望这个hash对象中所有的key都存在,你最好是使用fetch方法去代替[]方法。fetch()方法在遇到key不存在的情况时会抛出异常,因此你就无法再传入一个有问题的hash对象了,也就不可能出现一些奇怪的 bug 了。

使用 case … else raise 去捕获异常数据

最好是在所有的case条件选择语句中加入else raise语句,来处理一些你预想之外的情况。当你的方法接收到一些你预想之外的数据时,我想你肯定是想知道这些是什么数据,而不是说忽略这些数据,而让代码继续执行。因此建议使用case ... else raise!

使用 ActiveRecord 的 ‘!’ 方法,让失败的操作自己说话

对于每个公司来说,数据通常都是非常重要的资产。如果在对数据进行持久化或者其他错作时失败了,但是这些失败的操作是悄悄发生的我们并不知道,那么这会是一件很危险的事情,将会对我们的数据造成严重的危害。因此无论什么时候,当你不希望某些操作失败时你却不知道的话,建议是用create!update!destroy!方法,在操作失败的时候他们会抛出异常,来告诉你操作失败了。这额外的一个字符!将会让你避免去处理麻烦的数据不一致等奇奇怪怪的问题。

我们一般都会写测试代码,但是我们一定要确保测试代码在setup时是正确的,而且如果测试在setup时是错误的,那一定要抛出异常让我们知道,因为没有比使用一个错误的setup跑出正确的测试结果更让人蛋疼的事情了,这样的代码一旦上线,那后果你懂的…

除了上面说的,在执行的多个SQL调用时,使用事务将那些调用包起来处理,可以避免你的操作导致数据处于不一致的状态,或者是半吊子的状态。

译者注:确实如此,曾经有一次我在处理数据的时候,就是没有注意这些导致造成了数据破坏,幸亏当时的数据有备份,才没有导致大的问题。

使用 ActiveRecord 的 validate 相关方法来动态校验你的数据

使用 ActiveRecord 的 validate 相关的方法,并且使用带有!的方法来做校验方法,将会是一个很好的方式去确保你在持久化数据时不会出错。举个例子:

1
2
3
4
5
6
class Post < ActiveRecord::Model
validates :author, :blog, presence: true
validates :published_by, presence: true, if: :published?
validates :comment_count, numericality: { greater_or_equal_to: 0 }
# ...
end

使用数据库约束来确保你的数据的一致性

你的数据库是你最好的朋友,他能够帮你保存你的数据,并且确保你的数据不出现重复和“孤儿记录”的问题。

一般情况下,你应该为你的数据库中的大多数字段设置他们默认不为空,也就是null: false
你是否知道 Rails 中的 has_one 约束,在数据的创建时不会起到唯一性约束作用呢?

1
2
3
4
5
6
7
8
9
10
11
class Account
has_one :account_settings
end

account = Account.create!
account.create_account_settings!
account.create_account_settings!
account.create_account_settings!

account.account_settings
# => one of the three account settings you've created... -_-

如果想让你的数据不出现重复,最好的方式是给你的数据添加唯一索引。

1
add_index :account_settings, :account_id, unique: true

这样做之后,如果你尝试去创建重复的记录时,数据库就会抛出异常,去阻止你创建重复数据。

我们每一个人都不会想存储一些“孤儿记录”在数据库中。但是如何去解决这些“孤儿记录”呢?使用外键是可以很好的帮你解决这个问题,在这里我推荐大家使用schema_auto_foreign_keys这个 gem 去为你的相关的表自动添加外键约束。

总结

多写几个字母就可以帮我们避免处理数据不一致的麻烦问题,也会大大减少我们代码的 bug 率,提高我们的工作效率。记住,使用!raisevalidate数据库约束去强化你的代码,使你的代码更加强壮。你的同事会感谢你,说不定以后当你在次翻看你的代码的时,你会觉得当时做的真好,让你在后来避免了很多不必要的麻烦。