PHP转Go系列 | ThinkPHP与Gin框架之API接口签名设计实践

决不胡扯

大家好，我是码农先森。
回想起以前用模版渲染数据的岁月，那时都没有 API 接口开发的概念。PHP 服务端和前端 HTML、CSS、JS 代码混合式开发，也不分前端、后端程序员，大家都是全干工程师。随着前后端分离、移动端开发的兴起，用后端渲染数据的开发方式效率低下，已经不能满足业务对需求快速上线的要求了。于是为了前后端的高效协同开发引入了 API 接口，只要在开发需求之前约定好数据传参，之后便可以开始启动自己的开发任务且互不干涉，最后再进行统一的接口联调。

根据熵增原则，如果任何事情不加以规则来限制，则都会朝着泛滥的方式发展。同样 API 接口开发也会出现这样的情况，由于每个人的开发习惯不同，导致 API 接口的开发格式五花八门，联调过程困难重重。无规矩不成方圆，因此为了规范 API 接口开发的形式，同时也结合我平时的项目开发经验。总结了一些 API 接口开发的实践经验，希望对大家能有所帮助。
话不多说，开整！
这次主要的实践内容是 API 接口签名设计，以下是一些关键的步骤：

• 给前端分配一个 AppKey，这个 AppKey 需要带在 HTTP Header 头中进行传输。
  
• 在前端的传参中需要额外增加 时间戳 timestamp、随机字符串 nonce 参数。
  
• 将前端的所有参数排序后拼接成一个字符串，再使用 MD5 加密函数生成 sign 签名字符串。
  
• 服务端接收到参数后，先验证 AppKey 是否一致。
  
• 再验证前端所传的时间戳参数是否还在有效期。
  
• 之后在服务端使用同样的加密算法生成 sign 签名串，再与前端的 sign 签名串比对。
  
• 最后判断前端所传的随机字符串是否已被使用，一次请求有效。
  

接下来开始在 ThinkPHP 和 Gin 框架中进行实现，文中只展示了核心的代码，完整代码的获取方式放在了文章末尾。
我们先熟悉一下项目结构核心的目录，有助于理解文中的内容。一个正常的请求首先要经过路由 route 再到中间件 middleware 最后到控制器 controller，API 接口的签名验证是在中间件 middleware 中实现，作为一个中间层在整个请求链路中起着承上启下的重要作用。

1. [manongsen@root php_to_go]$ tree -L 2
2. .
3. ├── go_sign
4. │   ├── app
5. │   │   ├── controller
6. │   │   │   └── user.go
7. │   │   ├── middleware
8. │   │   │   └── api_sign.go
9. │   │   ├── config.go
10. │   │   └── route.go
11. │   ├── go.mod
12. │   ├── go.sum
13. │   └── main.go
14. └── php_sign
15. │   ├── app
16. │   │   ├── controller
17. │   │   │   └── User.php
18. │   │   ├── middleware
19. │   │   │   └── ApiSign.php
20. │   │   └── middleware.php
21. │   ├── composer.json
22. │   ├── composer.lock
23. │   ├── config
24. │   ├── route
25. │   │   └── app.php
26. │   ├── think
27. │   ├── vendor
28. │   └── .env

复制代码

ThinkPHP

使用 composer 创建基于 ThinkPHP 框架的 php_sign 项目。

1. [manongsen@root ~]$ pwd
2. /home/manongsen/workspace/php_to_go/php_sign
3. [manongsen@root php_sign]$ composer create-project topthink/think php_sign

复制代码

随机字符串需要用到 Redis 进行存储，所以这里需要安装 Redis 扩展包，便于操作 Redis。

1. [manongsen@root php_sign]$ composer require predis/predis

复制代码

在项目 php_sign 下创建 ApiSign 中间件。

1. [manongsen@root php_sign]$ php think make:middleware ApiSign
2. Middleware:app\middleware\ApiSign created successfully.

复制代码

在项目 php_sign 下复制一个 env 配置文件，并且定义好 AppKey。

1. [manongsen@root php_sign]$ cp .example.env .env

复制代码

API 接口签名的验证是放在框架的中间件中进行实现的，其中时间戳的有效时间设置的是 2 秒，有些朋友会有疑惑为什么是 2 秒？3 秒、5 秒不行吗？这里的有效时间是基于网络通信的延时考虑的，根据普遍情况延时大概是 2 秒。如果你的服务延时比较长，也可以设置长一些，并没有一个定量的值，话说到这里也提醒一下如果你的接口延时超过 2 秒，大概率需要优化一下代码了。此外，还有一个随机字符串参数，这个参数的目的是为了防止接口被重放，如果做过爬虫的朋友可能对这个会深有感触，这也是防范爬虫的一种手段。
[code]