Golang REST API 아키텍처의 우아한 구현

                                                        golang으로 작성된 API는 다른 언어만큼 간단하고 다재다능할 수 없다는 말이 있습니다. 그러나 실제로는 추상화가 많이 포함된 REST API 코드를 많이 접하게 되었고, 이로 인해 코드 기반이 혼란스럽고 복잡해졌으며 결과적으로 가독성과 유지 관리성이 손상되었습니다.

이 시리즈에서는 라우팅 및 코드 인터페이스부터 시작하여 Mongo 데이터베이스와 오소리 데이터 계층을 추가한 다음 인증 프로토콜을 추가하여 지속 가능한 확장 아키텍처인 제품 수준 REST API TODO 목록을 구축하는 방법을 살펴보겠습니다. 레이어(OAuth 2.0)

이 시리즈에서는 카이 라우팅을 사용하겠습니다.

라우팅을 위해 표준 라이브러리나 Gin 또는 router-x 대신 Chi를 사용하는 이유는 무엇입니까?

글쎄, 사실 무엇을 사용하든 상관없습니다. 라우팅에 무엇을 사용하든 이 시리즈에서 논의된 개념은 유용할 것입니다. 하지만 Chi-router가 대부분의 대안보다 우수하다고 생각하게 만드는 다음과 같은 장점이 있습니다.

net/http 표준 라이브러리와 100% 호환 --- Go 생태계에서 사용 가능 net/http 호환 http 또는 미들웨어 pkg

• 모듈식/구성 가능 API용으로 설계 - 미들웨어, 인라인 미들웨어, 경로 그룹 및 하위 라우터 설치

  net/http 标准库 100% 兼容---可以在 Go 生态系统中使用任何与net / http 兼容的 http 或中间件 pkg

• 专为模块化/可组合 API 设计 - 中间件，内联中间件，路由组和子路由器安装

• 没有外部依赖---纯粹的就是 Go 1.7+ stdlib + net / http

• 强悍 --- 有很多公司正在使用，比如：Pressly，CloudFlare，Heroku，99Designs

• 轻量级 --- cloc'd in ~1000 LOC for the chi router

• 速度很快

我最喜欢的是，你为其他 net / http 兼容路由器编写的旧的 http 处理程序和中间件也可以在正常运行。

让我们开始吧

首先，我们创建一个 main.go 。我们程序的基础（或者说中心元件 ?）

上面的代码是一些最佳实践的重点

1. 用一个单独的包来实现路由的逻辑，并将它们分好组，然后安装（mount） 它们：

r.Mount("/api/todo", todo.Routes())

2. 给 API 打上版本，这样你就可以对 api 进行更新时，不会破坏旧的客户端：

router.Route("/v1", ....)

3. 使用中间件作为扩展。使用了非常多路由的代码是非常笨重的，其实可以变成链接的中间件，像：授权，设置响应头部，压缩，请求日志，限速等。

笔者（基于 Ajinkya 在评论中提到的问题，我会更多的阐述 walk 方法）：

chi 路由有一个方法叫做 walk。这个方法接收的参数：

• A router

• A callback.

每个被定义的路由都会被回调，并且接收 4 个参数：

• 路由定义的方法

• 实际路由的字符串

• 处理器（函数），处理给定路由的请求

• 给定路由中，定义过的中间件列表（中间件是一个比较简单的函数，它会在处理器被调用前调用，所以它们才会被使用在请求处理之前，授权等）

以我为例，我将简单地轮询路由并且打印所有被定义的路由。从而让我对所有可用的路由一目了然。

接下来我们构建一个 todo 包，它实际上保存了我们 todo 逻辑。

注意事项

• todo 包有一个返回所有路由的方法。这些路由都是写在 main.go 文件中。 实际上我通常会把这些路由写在一个叫 routes.go 的文件中， 这样会很容易在包里找到.

• 处理程序具有 func (w http.ResponseWriter,r *http.Request) 

외부 종속성 없음 --- Purely Go 1.7+ stdlib + net/http
강력함 --- Pressly, CloudFlare, Heroku, 99Designs

🎜경량 --- Chi 라우터용 ~1000 LOC에 클로킹됨 🎜🎜🎜🎜이 빠릅니다 🎜 🎜🎜🎜 제가 가장 좋아하는 점은 다른 net/http 호환 라우터용으로 작성한 이전 http 핸들러와 미들웨어도 잘 작동한다는 것입니다. 🎜🎜시작합시다🎜🎜먼저 main.go를 생성합니다. 우리 프로그램의 기초(또는 중앙 구성요소?)🎜🎜🎜🎜위 코드는 몇 가지 모범 사례의 하이라이트입니다🎜

🎜별도의 패키지를 사용하여 라우팅 논리를 구현하고 함께 그룹화한 다음 마운트합니다. 🎜

🎜r .Mount("/api/ todo", todo.Routes())🎜

🎜이전 클라이언트를 손상시키지 않고 API를 업데이트할 수 있도록 API 버전을 지정하세요.🎜

🎜router.Route("/v1", .. ..)🎜

🎜미들웨어를 확장으로 사용하세요. 라우팅을 많이 사용하는 코드는 실제로 인증, 응답 헤더 설정, 압축, 요청 로그, 속도 제한 등과 같은 링크 미들웨어로 전환될 수 있습니다. 🎜

🎜저자(아진키아가 댓글에서 언급한 문제를 바탕으로 걷기 방법에 대해 좀 더 자세히 설명하겠습니다): 🎜🎜chi 라우팅에는 걷기라는 방법이 있습니다. 이 방법으로 수신된 매개변수: 🎜🎜🎜🎜A 라우터🎜🎜🎜🎜A 콜백.🎜🎜🎜🎜정의된 각 경로는 다시 호출되고 4개의 매개변수를 받습니다: 🎜🎜🎜🎜경로 정의 방법🎜🎜🎜 🎜의 문자열 실제 경로🎜🎜🎜🎜프로세서(함수)는 주어진 경로의 요청을 처리합니다🎜🎜🎜🎜지정된 경로에 정의된 미들웨어 목록(미들웨어는 비교적 간단한 기능입니다. 핸들러는 호출되기 전에 호출됩니다. 따라서 요청 처리, 승인 등 전에 사용됩니다.) 🎜🎜🎜🎜제 경우에는 단순히 경로를 폴링하고 정의된 모든 경로를 인쇄하겠습니다. 이를 통해 사용 가능한 모든 경로에 대한 개요를 볼 수 있습니다. 🎜🎜다음으로 할일 로직을 실제로 저장하는 할일 패키지를 구축합니다. 🎜🎜🎜🎜Notes🎜🎜🎜🎜todo 패키지 있음 모든 경로를 반환하는 메서드입니다. 이 경로는 main.go 파일에 기록됩니다. 사실 저는 보통 routes.go라는 파일에 이러한 경로를 작성합니다. 🎜 이렇게 하면 패키지에서 쉽게 찾을 수 있습니다.🎜🎜🎜🎜🎜핸들러에는 func(w http . ResponseWriter,r *http.Request) 함수 서명입니다. 이는 이 핸들러가 표준 라이브러리를 사용하는 net/http 작성 방법과 다르지 않음을 의미합니다. 🎜🎜🎜🎜JSON 응답의 모든 HTML을 자동으로 이스케이프 처리하고 콘텐츠 유형을 application/json으로 설정하는 인코딩/json 래퍼인 render.JSON을 사용하세요.🎜🎜🎜🎜이 방법이 얼마나 간단한지 보면 놀라실 것입니다. 이 프로젝트는 GitHub https://github.com/tonyalaribe/todoapi/tre에서 볼 수 있습니다....🎜

이 시리즈의 다음 기사에서는 구성 및 공유 상태에 대한 지원을 계속할 것입니다. 대부분의 프로젝트에는 일반적으로 데이터베이스 연결 등과 같은 추가 구성이 필요합니다. 다음 기사에서 이에 대해 논의하겠습니다.

추천 튜토리얼: "Go Tutorial"

위 내용은 Golang REST API 아키텍처의 우아한 구현의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!