利用TDD理清思路

TDD 有助于理清思路。实践 TDD 的步骤如下:

  1. 明确功能
  2. 验证功能(写测试)
  3. 实现功能
  4. 运行测试
  5. 修改功能 (非必须)

其中第一步是理清思路,在纸上写写画画,细分功能,不需要写代码。大多程序员不管三七二十一,想到什么就写什么,尽快上手写代码,出现问题了再修补,思路不清晰。其实这一步才是最重要的。

拿修改密码功能举例,例子中使用后端语言为 Ruby,Web 框架是 RoR,测试框架 Rspec。不了解该语言可以把代码当伪代码看,毕竟 Ruby 很接近自然语言 :)

  1. 明确功能:
    该功能的效果:用户修改密码后,密码会变(废话),需要使用新密码登录。
    实现方法如下:
    验证旧密码与现在的密码是否一致 => 修改密码,该功能比较简单。

  2. 验证功能(写测试):
    创建用户 => 调用修改密码接口 => 检验密码是否改为新密码

# spec/controllers/api/users_controller_spec.rb
RSpec.describe Api::UsersController type: :controller do
  describe '#change_password' do
    old_pwd = 'adfslkj'
    new_pwd = '87234sd'
    user = create(:user, password: old_pwd)

    session[:user_id] = user.id # 通过会话标记登录状态
    post(:change_password, params: { old_pwd: old_pwd, new_pwd: new_pwd, confirmed_pwd: new_pwd } )
    expect(response.status).to eq(200) # 检验是否返回成功的响应
    
    user.reload # 成功调用接口后,密码应该变了,重新从数据库获取用户
    expect(user.valid_password?(old_pwd)).not_to be_truthy # 旧密码失效
    expect(user.valid_password?(new_pwd)).to be_truthy # 判断传到接口的新密码现在是否为有效的密码
  end
end

现在运行测试,还没写功能,测试肯定不通过。

$ rspec spec/controllers/api/users_controller_spec.rb
# 失败
  1. 实现功能:
    实现方法主要如步骤 1 所说。
    验证旧密码与现在的密码是否一致 => 修改密码
# app/controllers/api/users_controller.rb
...
def change_password
  old_pwd, new_pwd, confirmed_pwd = require_params!(:old_pwd, :new_pwd, :confirm_pwd)
  if !current_user.valid_password?(old_pwd)
    return fail_res(400, '无效的旧密码')
  end
  current_user.update!(password: new_pwd) # 修改密码
  res(200, '修改成功')
end
...

看吧,很简单,几行代码就搞定。不过有些异常情况没处理,我们稍后再讲。

  1. 运行测试、修改功能:
    接下来运行测试
$ rspec spec/controllers/api/users_controller_spec.rb
# 通过.

测试通过啦。然后我们还要改进一下代码,确认新密码和确认密码是否一致。

...
def change_password
  old_pwd, new_pwd, confirmed_pwd = require_params!(:old_pwd, :new_pwd, :confirm_pwd)
  if !current_user.valid_password?(old_pwd)
    return fail_res(400, '无效的旧密码')
  end
  if new_pwd != confirmed_pwd
    return fail_res(400, '新密码与确认密码不一致')
  end
  current_user.update!(password: new_pwd) # 修改密码
  res(200, '修改成功')
end
...

写好测试后,以后就可以放心修改这个接口,或者是重构跟用户密码有关的代码。只要重构后可以通过测试,就比较可靠了。
要是遇到没想到的异常情况,再补多一个测试就好了。

你可能感兴趣的:(利用TDD理清思路)