api网关设计

刺骨的言语ヽ痛彻心扉 2022-06-01 12:22 297阅读 0赞

# 1.什么是API网关？ #

API网关是一个轻量的java http 接口组件，可无缝将普通的 Serive 方法转换成 http 接口。并从已下几点来达到提高开发效率与接口质量的目的。

1.  去掉mvc控制器，将http请求直接无缝接入JAVA服务接口
2.  统一出入参格式
3.  统一异常规范
4.  自动检测服务接口规范

# 2.API网关 与普通Http接口实现流程对比 #

## **2.1 普通Http 接口实现** ##

![19104902_MIGH.jpg][]

## 2.2 API网关接口实现 ##

![19104902_qnhR.jpg][]

# 3.网关实现流程与技术 #

![19104902_fFmp.jpg][]

**请求参数说明：**

** 实现技术：**

1.  java servlet
2.  spring Ioc
3.  Json 转换工具的使用

# **4.接口安全的业务需求** #

## ** 4.1 接口安全级别分组** ##

1.  白名单组（首页等）
2.  黑名单组（购物车，订单等）
3.  黑白名单组（可以有userid也可以没有userid但是显示效果不一致）

## **4.2 基于Token安全机制认证需求** ##

1.  登陆鉴权
2.  防止业务参数串改
3.  保护用户敏感信息
4.  防签名伪造

## 4.3 T**oken 认证机制整体架构** ##

整体架构分为Token生成与认证两部分：

1.  Token生成指在登陆成功之后生成 Token 和密钥，并其与用户隐私信息、客户端信息一起存储至Token表,同时返回Token 与Secret 至客户端。
2.  Token认证指客户端请求黑名单接口时，认证中心基于Token生成签名

![19104902_efsH.jpg][]

### 4.3.1 Token表结构说明: ###

<table> 
 <tbody> 
  <tr> 
   <td>名称</td> 
   <td>类别</td> 
   <td>说明</td> 
   <td>约束</td> 
  </tr> 
  <tr> 
   <td>id</td> 
   <td>number</td> 
   <td>id主键</td> 
   <td>主键，自增长</td> 
  </tr> 
  <tr> 
   <td>memberId</td> 
   <td>number</td> 
   <td>会员ID</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>accessToken</td> 
   <td>varchar(50)</td> 
   <td>Token</td> 
   <td>索引</td> 
  </tr> 
  <tr> 
   <td>secret</td> 
   <td>varchar(50)</td> 
   <td>密钥</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>createdTime</td> 
   <td>datetime</td> 
   <td>创建时间</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>expiresTime</td> 
   <td>datetime</td> 
   <td>有效期至</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>clientIp</td> 
   <td>varchar(50)</td> 
   <td>客户端IP</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>clientType</td> 
   <td>varchar(50)</td> 
   <td>客户端类别</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>eCode</td> 
   <td>varchar(50)</td> 
   <td>设备标识</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>uCode</td> 
   <td>varchar(50)</td> 
   <td>设备用户标识</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

### 4.3.2 业务请求具体参数： ###

<table> 
 <tbody> 
  <tr> 
   <td>名称</td> 
   <td>类型</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>method</td> 
   <td>string</td> 
   <td>方法名称</td> 
  </tr> 
  <tr> 
   <td>params</td> 
   <td>json</td> 
   <td>业务参数</td> 
  </tr> 
  <tr> 
   <td>token</td> 
   <td>string</td> 
   <td>token值</td> 
  </tr> 
  <tr> 
   <td>sign</td> 
   <td>string</td> 
   <td>签名规则:md5(secret+method+params+token+timestamp+secret)</td> 
  </tr> 
  <tr> 
   <td>timestamp</td> 
   <td>long</td> 
   <td>请求时间搓，允许与服务端10分钟误差</td> 
  </tr> 
 </tbody> 
</table>

**签名规则：**

1.  已指定顺序拼接字符串 secret+method+params+token+timestamp+secret
2.  使用MD5进行加密，在转化成大写

**签名的目的：**

1.  防串改
2.  防伪造 
3.  防重复使用签名

**服务端签名验证的具体流程：**

![19104902_2Ek0.jpg][]

# **5.基于API网关实现安全机制** #

## **5.1 签名认证与API网关的整体认证流程** ##

![19104902_Dly8.jpg][]

# ***自己实现的简单流程代码地址：*** #

[https://gitee.com/itmyx/apitest][https_gitee.com_itmyx_apitest] （基于springboot实现）

[19104902_MIGH.jpg]: https://static.oschina.net/uploads/img/201801/19104902_MIGH.jpg
[19104902_qnhR.jpg]: https://static.oschina.net/uploads/img/201801/19104902_qnhR.jpg
[19104902_fFmp.jpg]: https://static.oschina.net/uploads/img/201801/19104902_fFmp.jpg
[19104902_efsH.jpg]: https://static.oschina.net/uploads/img/201801/19104902_efsH.jpg
[19104902_2Ek0.jpg]: https://static.oschina.net/uploads/img/201801/19104902_2Ek0.jpg
[19104902_Dly8.jpg]: https://static.oschina.net/uploads/img/201801/19104902_Dly8.jpg
[https_gitee.com_itmyx_apitest]: https://gitee.com/itmyx/apitest