控制器

控制器是业务功能的入口，通过控制器指定路由对应的各中间件及处理函数，并调用各服务实现完整的业务功能

下面的例子是一个用户功能的简单实现，包括注册、登录以及session的相关处理，

package controller

import (
	"crypto/sha256"
	"errors"
	"fmt"

	"github.com/vicanso/beginner/ent/user"
	"github.com/vicanso/beginner/helper"
	M "github.com/vicanso/beginner/middleware"
	"github.com/vicanso/beginner/router"
	"github.com/vicanso/beginner/util"
	"github.com/vicanso/beginner/validate"
	"github.com/vicanso/elton"
	session "github.com/vicanso/elton-session"
	"github.com/vicanso/hes"
)

// 对应的所有函数均实现在此struct中
type userCtrl struct{}

// 注册参数
type userRegisterParams struct {
	// 账号
	Account string `json:"account" validate:"required,xUserAccount"`
	// 密码
	Password string `json:"password" validate:"required,xUserPassword"`
}

const (
	sessionTokenKey   = "token"
	sessionAccountKey = "account"
)

// 登录参数
type userLoginParams struct {
	// 账号
	Account string `json:"account" validate:"required,xUserAccount"`
	// 密码
	Password string `json:"password" validate:"required,xUserPassword"`
}

func init() {
	ctrl := userCtrl{}
	g := router.NewGroup(
		"/users",
		// 添加当前组共用中间件
		M.NewSession(),
	)

	// 当前登录信息查询
	g.GET("/v1/me", ctrl.me)
	// 注册用户
	g.POST("/v1/me", ctrl.register)

	// 获取登录token
	g.GET("/v1/login", ctrl.getLoginToken)
	// 登录用户
	g.POST("/v1/login", ctrl.login)
}

func (*userCtrl) me(c *elton.Context) error {
	se := session.MustGet(c)
	account := se.GetString(sessionAccountKey)
	c.Body = &struct {
		Name string `json:"name"`
	}{
		Name: account,
	}
	return nil
}

func (*userCtrl) getLoginToken(c *elton.Context) error {
	se := session.MustGet(c)
	// 生成随机token
	token := util.GenXID()
	// 设置token至session中
	err := se.Set(c.Context(), sessionTokenKey, token)
	if err != nil {
		return err
	}

	c.Body = &struct {
		Token string `json:"token"`
	}{
		token,
	}
	return nil
}

func (*userCtrl) login(c *elton.Context) error {
	params := userLoginParams{}
	err := validate.Do(&params, c.RequestBody)
	if err != nil {
		return err
	}
	se := session.MustGet(c)
	user, err := helper.EntGetClient().User.Query().
		Where(user.AccountEQ(params.Account)).
		First(c.Context())
	if err != nil {
		return err
	}
	// 数据库中保存的密码已经是sha256
	token := se.GetString(sessionTokenKey)
	pwd := fmt.Sprintf("%x", sha256.Sum256([]byte(user.Password+token)))
	if params.Password != pwd {
		// 不直接提示密码错
		return hes.New("用户名或密码错误")
	}
	// 设置账号至session
	err = se.Set(c.Context(), sessionAccountKey, params.Account)
	if err != nil {
		return err
	}

	// 成功返回用户信息
	c.Body = user
	return nil
}

func (*userCtrl) list(c *elton.Context) error {
	return errors.New("仅允许管理员访问")
}

func (*userCtrl) register(c *elton.Context) error {
	params := userRegisterParams{}
	err := validate.Do(&params, c.RequestBody)
	if err != nil {
		return err
	}

	user, err := helper.EntGetClient().User.Create().
		SetAccount(params.Account).
		// 密码前端使用sha256(password)处理
		SetPassword(params.Password).
		Save(c.Context())

	if err != nil {
		return err
	}
	c.Created(user)
	return nil
}

如上面的代码所示，每个controller会实现其对应的一个struct，如userCtrl用于添加各路由的处理函数，一般命名时将功能名称作为前缀，避免多个功能的变量命名冲突。

路由的初始化均在init函数中处理，步骤一般如下：

创建ctrl，ctrl := userCtrl{}
初始化路由分组，g := router.NewGroup("/users")
对具体路由实现添加对应处理函数，g.GET("/v1/me", ctrl.me)

一般而已，当前同一个组中函数会共用相同的中间件，因此会在初始化组的时候，添加共用的中间件，如：

	g := router.NewGroup(
		"/users",
		// 添加当前组共用中间件
		M.NewSession(),
	)

响应数据

示例中响应客户信息时，仅将数据赋值至c.Body中则可，之后访问http://127.0.0.1:7001/users/v1/me接口并没有返回任何数据，非预期的返回对应的json。

elton默认的并没有对Body的数据转换为输出数据，此响应的转换应该由开发者自定义中间件来实现，对于json的转换可以使用已实现好的中间件body-parser，代码逻辑也简单，仅需要要elton实例中添加全局中间件即可。

// -- 略 --
	e.Use(middleware.NewDefaultResponder())
// -- 略 --

增加此中间件之后，响应数据以期望的json返回。

curl 'http://127.0.0.1:7001/users/v1/me' -v
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 7001 (#0)
> GET /users/v1/me HTTP/1.1
> Host: 127.0.0.1:7001
> User-Agent: curl/7.64.1
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Mon, 05 Jul 2021 10:33:42 GMT
< Content-Length: 15
<
* Connection #0 to host 127.0.0.1 left intact
{"name":"test"}* Closing connection 0

出错响应

elton中默认的出错响应仅是将出错信息返回，并设置状态码为500，实际使用中我们需要根据系统的需要，制定标准的出错类型。下面是使用error中间件的出错处理（可参考与实现定制自定义的出错）。

// -- 略 --
	// 出错处理
	e.Use(middleware.NewDefaultError())
	// 响应数据转换处理
	e.Use(middleware.NewDefaultResponder())
// -- 略 --

error中间件会根据客户端请求头是否指定Accept: application/json返回json数据，否则返回text数据，建议在实际项目中使用自定义的Error对象。此中间使用的error类型为hes，有不同自定义属性，可根据不同的场景返回不同的出错，主要属性有：

statusCode: 出错响应码，如果不设置则为400
code: 出错码，可用于定义不同的出错
category: 出错分类，用于将错误分类，如参数校验出错的可定义为validate
message: 出错信息
title: 出错标题

curl -H 'Accept:application/json' 'http://127.0.0.1:7001/users/v1' -v
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 7001 (#0)
> GET /users/v1 HTTP/1.1
> Host: 127.0.0.1:7001
> User-Agent: curl/7.64.1
> Accept:application/json
>
< HTTP/1.1 500 Internal Server Error
< Content-Type: application/json; charset=utf-8
< Date: Tue, 06 Jul 2021 00:20:27 GMT
< Content-Length: 97
<
* Connection #0 to host 127.0.0.1 left intact
{"statusCode":500,"category":"elton-error","message":"仅允许管理员访问","exception":true}

需要注意，响应数据中的"exception":true用于表示使用了非hes.Error的出错。在项目使用中，建议逻辑处理中的出错均使用自定义的Error(如hes.Error)返回，通过在Error中间件针对非自定义的出错可以收集相关未知出错（非主动抛出出错），便于后续程序优化。

Previous路由 Next中间件

Last updated 2 years ago