微服务开发手册
1.开发说明
● 所有服务均基于 spring boot 框架开发。Spring boot 内嵌了 tomcat 服务器,无需生成 war
包,并简化了 maven 配置,能够让开发者快速入手 spring 的开发。
● 服务的接口定义需严格符合 restful 规范。rest 规范参考第 2 节 rest api 接口规范
● 所有服务都需要在注册服务上注册, 否则不能被其他服务所调用。 同时平台也能够实
时监测服务的状态,能够及时预警及调度资源。
● 所有服务的配置信息统一保存于 gitlab 上,并通过配置服务获取配置。
● 对数据库的操作统一采用 MyBatis 框架。MyBatis 是个支持普通 SQL 查询,存储过程
和高级映射的优秀持久层框架。Spring boot 也提供了 mybatis 的集成方案,可以很快捷地
整合 mybatis 到项目中。
● 包名约定:所有包均以 com.drht. 服务名 为父包名,如 com.drht.auth,后面再跟具体
模块名称作为子包名。
● 所有项目基于 jdk1.8 来开发。项目的管理与构建采用 maven,代码统一托管于 gitlab 仓
库。
2.rest api 接口规范
spring boot 接口设计需符合 restful 风格。在 RESTful 架构中,每个网址代表一种资源
(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格
名对应。
而客户端要执行某种类型的操作,需要根据 http 的操作协议来决定。HTTP 提供了常用
的几种操作,如下表:
动作
说明
GET(SELECT)
从服务器取出资源(一项或多项)
POST(CREATE)
在服务器新建一个资源。
PUT(UPDATE)
在服务器更新资源(客户端提供改变后的完
整资源)。
PATCH(UPDATE)
在服务器更新资源(客户端提供改变的属