草庐IT

rest - 如何在现实世界的 Go 项目中分离路由、处理程序、第 3 方接口(interface)和业务逻辑

coder 2024-07-08 原文

看完official guide关于如何构建项目和经历各种(1、2、3 仅举几例)示例和项目我不禁想知道我构建 REST-API 服务器应用程序的方法是否结构化 正确地。

API 的用途是什么？

POST /auth/sign-in

接受用户名和密码并发出JWT (JSON 网络 token )。

GET /auth/sign-out

将 JWT 添加到黑名单以使身份验证 session 无效。

获取/资源

检索所有资源的列表。

POST /resources(需要有效的 JWT 身份验证)

接受 JSON 正文，创建新资源并向所有人发送有关新资源的电子邮件和通知。

我的项目是什么样的

目前我没有创建任何库。一切都在主包中，带有路由的总体服务器设置等都在 main.go 中完成。我没有选择在 Rails 或 Django 中找到的 MVC 模式，以避免仅仅为了它而使事情过于复杂。另外我的印象是它并不真正符合 guide 中描述的命令和库的推荐结构。上面已经提到了。

auth.go # generates, validates JWT, etc
auth-handler.go # Handles sign-in/out requests; includes middleware for required authentication
mailer.go # Provides methods to send out transactional email, loads correct template etc.
main.go # set up routes, runs server; inits mailer and notification instance for the request context
models.go # struct definition for User, Resource
notifications.go # Provides methods to publish push notifications
resource-handler.go # Handles request for resources, uses mailer and notifications instances for the POST request

它应该是什么样子的？

路由应该分开吗？中间件呢？以及您如何处理与第 3 方代码的接口(interface)——想象一下概述的示例应用程序中的 mailer.go 与 Mandrill 对话以及 notifications.go 与 Amazon AWS SNS 对话？

最佳答案

我可以分享一些我自己的经验。

  1. 在应用程序代码中:

    • 与库代码相反，分成包和子包不太重要 - 只要您的代码没有太复杂。我主要将应用程序设计为集成自包含库，因此应用程序代码本身通常很小。一般来说，如果你真的不需要它，尽量避免包分离。但不要只是在一个包中塞入大量代码 - 这也很糟糕。

    • 但没有像“util”这样的通用包，它们很快就会开始积累包袱并变得糟糕。我有一个单独的 repo，用于跨项目可重用的通用实用程序，在它下面，每个实用程序 API 都是一个子包。例如github.com/me/myutils/countrycodes，github.com/me/myutils/set，github.com/me/myutils/whatevs .

  2. 无论包结构如何，最重要的是将内部 API 与处理程序代码分开。处理程序代码应该是一个非常薄的层来处理输入，并调用一个内部的、自包含的 API，可以在没有处理程序的情况下进行测试，或者绑定(bind)到其他处理程序。看起来你正在这样做。然后您可以将您的内部 API 分离到另一个包中，这并不重要。

  3. 当您决定应将代码的哪些部分分离到库中时，请从代码重用的角度考虑。如果此代码仅供您的应用使用，则没有任何意义。

  4. 我喜欢将与第三方 API 的集成封装在一个定义在二级包中的接口(interface)中。例如，如果你有类似使用 AWS SES 发送电子邮件的东西，我会创建一个名为 github.com/my_org/mailer 的包，它有一个抽象接口(interface)，在它下面有一个 github.com/my_org/mailer/ses 实现 SES 集成的包。应用程序代码导入了 mailer 包及其接口(interface)，只有在 main 中我才以某种方式注入(inject) SES 的用法并将它们集成在一起。

  5. re 中间件 - 我通常将它与 API 本身放在同一个包中。

关于rest - 如何在现实世界的 Go 项目中分离路由、处理程序、第 3 方接口(interface)和业务逻辑，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/32329444/

中分何在codenoreferrersectionrestgocoding-style

有关rest - 如何在现实世界的 Go 项目中分离路由、处理程序、第 3 方接口(interface)和业务逻辑的更多相关文章

  1. ruby - 如何在 Ruby 中顺序创建 PI - 2

    出于纯粹的兴趣，我很好奇如何按顺序创建PI，而不是在过程结果之后生成数字，而是让数字在过程本身生成时显示。如果是这种情况，那么数字可以自行产生，我可以对以前看到的数字实现垃圾收集，从而创建一个无限系列。结果只是在Pi系列之后每秒生成一个数字。这是我通过互联网筛选的结果:这是流行的计算机友好算法，类机器算法:defarccot(x,unity)xpow=unity/xn=1sign=1sum=0loopdoterm=xpow/nbreakifterm==0sum+=sign*(xpow/n)xpow/=x*xn+=2sign=-signendsumenddefcalc_pi(digits

  2. ruby - 如何在 buildr 项目中使用 Ruby 代码？ - 2

    如何在buildr项目中使用Ruby？我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序，我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/)，但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻，因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  3. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们？ - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  4. 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

  5. ruby-on-rails - 如何在 ruby​​ 中使用两个参数异步运行 exe？ - 2

    exe应该在我打开页面时运行。异步进程需要运行。有什么方法可以在ruby​​中使用两个参数异步运行exe吗？我已经尝试过ruby​​命令-system()、exec()但它正在等待过程完成。我需要用参数启动exe，无需等待进程完成是否有任何ruby​​gems会支持我的问题？ 最佳答案 您可以使用Process.spawn和Process.wait2:pid=Process.spawn'your.exe','--option'#Later...pid,status=Process.wait2pid您的程序将作为解释器的子进程执行。除

  6. ruby - 如何在续集中重新加载表模式？ - 2

    鉴于我有以下迁移:Sequel.migrationdoupdoalter_table:usersdoadd_column:is_admin,:default=>falseend#SequelrunsaDESCRIBEtablestatement,whenthemodelisloaded.#Atthispoint,itdoesnotknowthatusershaveais_adminflag.#Soitfails.@user=User.find(:email=>"admin@fancy-startup.example")@user.is_admin=true@user.save!ende

  7. ruby - 如何在 Ruby 中拆分参数字符串 Bash 样式？ - 2

    我正在为一个项目制作一个简单的shell，我希望像在Bash中一样解析参数字符串。foobar"helloworld"fooz应该变成:["foo","bar","helloworld","fooz"]等等。到目前为止，我一直在使用CSV::parse_line，将列分隔符设置为""和.compact输出。问题是我现在必须选择是要支持单引号还是双引号。CSV不支持超过一个分隔符。Python有一个名为shlex的模块:>>>shlex.split("Test'helloworld'foo")['Test','helloworld','foo']>>>shlex.split('Test"

  8. ruby - 如何在 Lion 上安装 Xcode 4.6，需要用 RVM 升级 ruby - 2

    我实际上是在尝试使用RVM在我的OSX10.7.5上更新ruby，并在输入以下命令后:rvminstallruby我得到了以下回复:Searchingforbinaryrubies,thismighttakesometime.Checkingrequirementsforosx.Installingrequirementsforosx.Updatingsystem.......Errorrunning'requirements_osx_brew_update_systemruby-2.0.0-p247',pleaseread/Users/username/.rvm/log/138121

  9. ruby-on-rails - 如何在 ruby​​ 交互式 shell 中有多行？ - 2

    这可能是个愚蠢的问题。但是，我是一个新手......你怎么能在交互式ruby​​shell中有多行代码？好像你只能有一条长线。按回车键运行代码。无论如何我可以在不运行代码的情况下跳到下一行吗？再次抱歉，如果这是一个愚蠢的问题。谢谢。 最佳答案 这是一个例子:2.1.2:053>a=1=>12.1.2:054>b=2=>22.1.2:055>a+b=>32.1.2:056>ifa>b#Thecode‘if..."startsthedefinitionoftheconditionalstatement.2.1.2:057?>puts"f

  10. ruby-on-rails - 如何在我的 Rails 应用程序 View 中打印 ruby​​ 变量的内容？ - 2

    我是一个Rails初学者，但我想从我的RailsView(html.haml文件)中查看Ruby变量的内容。我试图在ruby​​中打印出变量(认为它会在终端中出现)，但没有得到任何结果。有什么建议吗？我知道Rails调试器，但更喜欢使用inspect来打印我的变量。 最佳答案 您可以在View中使用puts方法将信息输出到服务器控制台。您应该能够在View中的任何位置使用Haml执行以下操作:-puts@my_variable.inspect 关于ruby-on-rails-如何在我的R

随机推荐