草庐IT

rest - 如何确定我应该从 golang API 返回哪种错误消息?

coder 2023-06-27 原文

我有一个带有 SPA 的 GoLang API 来使用它。我对我的 API 中的错误所做的是返回它们,直到我测试是否存在以前函数的错误的处理程序。如果有错误,我将它放在响应主体中,将状态代码设置为 400 或 500,然后返回响应

在处理函数中,为了能够向客户端创建清晰的消息,我需要知道返回了什么样的错误,我该怎么做?

我知道错误类型,但我读到了 Dave Cheney 的建议,即只返回错误和消息(或换句话说将它们包装起来)。

但是如果API调用中可能会出现这么多错误,那是不是意味着在返回响应之前,我需要将它们都检查一遍才能知道我应该返回什么消息?

最佳答案

首先要说的错误就是因为有一个错误接口(interface)

type error interface {
    Error() string
}

并不意味着从任何给定方法返回的错误可以附加该方法/信息。

一种常见的方法是定义自己的错误接口(interface):

type myError interface {
    error // embeds the standard error interface
    OtherMethod() string // can define own methods here
}

在编写方法和函数时,返回错误而不是myError非常重要,否则您将该方法耦合到您的错误实现中,并且以后会给自己带来依赖性噩梦。

现在我们已经决定我们可以从错误中返回额外的信息,使用我们自己的错误接口(interface),您有 3 个主要选择。

  1. 哨兵错误
  2. 错误失败类型
  3. 行为错误

哨兵错误

哨兵错误是定义为包级变量的错误值,被导出并允许比较以检查错误。

package myPackage

var ErrConnectionFailed = errors.New("connection failed")

func Connect() error {
    // trimmed ...
    return ErrConnectionFailed
}

此示例的使用者可以使用连接功能:

if err := myPackage.Connect(); err == myPackage.ErrConnectionFailed {
    // handle connection failed state
}

你可以做一个比较来检查返回的错误是否等于包的哨兵错误。缺点是使用 errors.New("connection failed") 创建的任何错误都将是相等的,并且不仅仅是来自 myPackage 的错误。

错误失败类型

比哨兵错误稍微好一点的是错误失败类型。 我们已经看到您可以定义自己的错误接口(interface),如果我们现在说我们的错误接口(interface):

type MyError interface {
    error
    Failure() string
} 

type Err struct {
    failure string
}

func (e *Err) Error() string {
    // implement standard error
}

func (e *Err) Failure() string {
    return e.failure
}

const ConnFailed = "connection failed"

err := &Err{failure: ConnFailed}

在消费者代码中你可以得到一个错误,检查它是否实现了 MyError 然后用它做一些事情。

err := myPackage.Connect()

if myErr, ok := err.(myPackage.MyError); ok {
    // here you know err is a MyError
    if myErr.Failure() == myPackage.ConnFailed {
        // handle connection failed, could also use a switch instead of if
    }
}

现在您了解了导致错误的原因,这很好。但你真的关心原因是什么吗?或者你真的只关心你想做什么来处理那个错误。

这是行为错误的好地方。

行为错误

这类似于定义您自己的错误类型,但您定义的是报告有关该错误信息的方法。鉴于上面的示例,您真的关心连接失败,还是只关心是否可以重试或是否需要再次出错调用堆栈?

package myPackage

// this interface could report if the error
// is temporary and if you could retry it
type tempErr interface {
    Temporary() bool
}

func (e *Err) Temporary() bool {
    // return if the error is temporary or not
}

现在在消费者中(注意您不需要使用 myPackage.tempErr),如果错误是暂时的并处理重试情况,您可以使用类型断言进行测试:

err := myPackage.Connect()

if tmp, ok := err.(interface { Temporary() bool }); ok && tmp.Temporary() {
    // the error is temporary and you can retry the connection
}

要回答这个问题,如果没有您尝试实现的服务的具体细节,很难说清楚。但作为广泛的建议,我会尽可能多地尝试使用 3 个示例中的最后一个。

如果您的服务的消费者向您发送一些无效的输入:

err := doThing(...)

if inv, ok := err.(interface { Invalid() bool }); ok && inv.Invalid() {
    // input is invalid, return 400 bad request status code etc.
}

如果您想将特定消息返回给消费者,您可以将其作为您的错误类型的方法。警告:这会让您的包知道它们正在 web 服务等中使用。

err := doThing(...)

if msg, ok := err.(interface { ResponseMsg() string }); ok {
    // write the message to the http response
    io.WriteString(response, msg.ResponseMsg())
}

TL;DR 您需要处理所有情况,但您可以创建错误类型,使代码更易于使用!

关于rest - 如何确定我应该从 golang API 返回哪种错误消息?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/50898622/

有关rest - 如何确定我应该从 golang API 返回哪种错误消息?的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  6. ruby-on-rails - Rails 常用字符串(用于通知和错误信息等) - 2

    大约一年前,我决定确保每个包含非唯一文本的Flash通知都将从模块中的方法中获取文本。我这样做的最初原因是为了避免一遍又一遍地输入相同的字符串。如果我想更改措辞,我可以在一个地方轻松完成,而且一遍又一遍地重复同一件事而出现拼写错误的可能性也会降低。我最终得到的是这样的:moduleMessagesdefformat_error_messages(errors)errors.map{|attribute,message|"Error:#{attribute.to_s.titleize}#{message}."}enddeferror_message_could_not_find(obje

  7. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  8. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  9. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件? - 2

    在选择我想要运行操作的频率时,唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案,但您可以安排它每天运行,并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/8692687/

  10. ruby - 为什么 4.1%2 使用 Ruby 返回 0.0999999999999996?但是 4.2%2==0.2 - 2

    为什么4.1%2返回0.0999999999999996?但是4.2%2==0.2。 最佳答案 参见此处:WhatEveryProgrammerShouldKnowAboutFloating-PointArithmetic实数是无限的。计算机使用的位数有限(今天是32位、64位)。因此计算机进行的浮点运算不能代表所有的实数。0.1是这些数字之一。请注意,这不是与Ruby相关的问题,而是与所有编程语言相关的问题,因为它来自计算机表示实数的方式。 关于ruby-为什么4.1%2使用Ruby返

随机推荐