我有一个大型的后端API，用于在Sinatra中构建的本机应用程序，该API还可以提供一些管理网页。我正在尝试清理代码库，并将代码重构为lib目录中的类。
我的API客户端需要状态和消息，例如200 OK或404未找到配置文件。我通常会用halt 404, 'Profile Not Found'。
halt从类内部使用HTTP状态代码和消息的最简单方法是什么？
旧湿法
post '/api/process_something'
halt 403, 'missing profile_id' unless params[:profile_id].present?
halt 404, 'offer not found' unless params[:offer_id].present?
do_some_processing
200
end
新干码
post '/api/process_something'
offer_manager = OfferManager.new
offer_manager.process_offer(params: params)
end
offer_manager.rb
class OfferManager
def process_offer(params:)
# halt 403, 'missing profile_id' unless params[:profile_id].present?
# halt 404, 'offer not found' unless params[:offer_id].present?
# halt doesn't work from in here
do_some_processing
200
end
end
这个问题对于CodeReview可能更好，但是在OO设计中可以看到的一种方法是“停止”路径和“快乐”路径。您的班级只需要实现一些方法，以帮助您在所有sinatra路由和方法之间保持一致。
这是一种方法，使用继承在其他类中采用这种接口很容易。
post '/api/process_something' do
offer_manager = OfferManager.new(params)
# error guard clause
halt offer_manager.status, offer_manager.halt_message if offer_manager.halt?
# validations met, continue to process
offer_manager.process_offer
# return back 200
offer_manager.status
end
class OfferManager
attr_reader :status, :params, :halt_message
def initialize(params)
@params = params
validate_params
end
def process_offer
do_some_processing
end
def halt?
# right now we just know missing params is one error to halt on but this is where
# you could implement more business logic if need be
missing_params?
end
private
def validate_params
if missing_params?
@status = 404
@halt_message = "missing #{missing_keys.join(", ")} key(s)"
else
@status = 200
end
end
def do_some_processing
# go do other processing
end
def missing_params?
missing_keys.size > 0
end
def missing_keys
expected_keys = [:profile_id, :offer_id]
params.select { |k, _| !expected_keys.has_key?(k) }
end
end
本文收集自互联网，转载请注明来源。
如有侵权，请联系 [email protected] 删除。
我来说两句