命名时请留意Rails下的关键字

前些天我在做一个支付集成的接口,对方返回的结果串里面有一个 errors 的字段,用来记录出错时候的错误代码,我需要对结果进行保存,当时我也没多想,直接建了一个model用来保存返回的结果,为了方便容易记,而且可以用一些动态的方法来对返回的串给model做一些动态的赋值,所以model的字段名直接跟返回的结果串中的字段同名.

就因为这个 errors ,又导致了一个杯具的发生.因为在ActiveRecord中有一个叫做 errors 的Hash用来保存 ActiveRecod 验证时的出错信息,很多方法都会对 errors.empty? 做判断来决定是否操作成功的,比如 save 方法.

就因为我用了一个关键字作为字段,结果这个model无论如何也是保存不了,总是报错,提示是String对象没有clear方法,后来跟踪代码,看到 ActiveRecord#valid方法里面的 errors 这才恍然大悟:

我定义的字段errors(String) 覆盖了ActiveRecord类的errors(Hash).

记得我初学rails的时候,做一个评论/回复功能的时候,回复对应的model 直接叫做response,又是一个杯具,可惜我前些天都忘记了这些血的教训.

rails的api中使用了很多常用的英语作为方法名,属性名,一方面我们非常容易使用,但是另一方面也会导致像我遇到的这中杯具的发生,所以在命名的时候要对关键字多留一个心眼.

对方法/变量的命名是一个永恒的话题,没有最好的,只有最合适的,当然还得守规矩,比如不要使用关键字.