1 / 11
文档名称:

微服务开发手册.docx

格式:docx   大小:27KB   页数:11页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

微服务开发手册.docx

上传人:maritime_4 2020/12/10 文件大小:27 KB

下载得到文件列表

微服务开发手册.docx

文档介绍

文档介绍:微服务开发手册
1•开发说明
•所有服务均基于 springboot框架开发。Springboot内嵌了 tomcat服务器,无需生成 war 包,并简化了 maven配置,能够让开发者快速入手 spring的开发。
•服务的接口定义需严格符合 restful规范。rest规范参考第2节rest api接口规范
•所有服务都需要在注册服务上注册, 否则不能被其他服务所调用。同时平台也能够实时监
测服务的状态,能够及时预警及调度资源。
•所有服务的配置信息统一保存于 gitlab上,并通过配置服务获取配置。
•对数据库的操作统一采用 MRBatis框架。MRBatis是个支持普通 SQL查询,存储过程和
高级映射的优秀持久层框架。 Springboot也提供了 mRbatis的集成方案,可以很快捷地整
合mRbatis到项目中。
•包名约定:所有包均以 ,如 ,后面再跟具体模块
名称作为子包名。
•。项目的管理与构建采用 maven,代码统一托管于 gitlab仓库。
2 • restapi 接口规范
springboot接口设计需符合 restful风格。在 RESTful架构中,每个网址代表一种资源
(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格 名对应。
而客户端要执行某种类型的操作,需要根据 http的操作协议来决定。HTTP提供了常用
的几种操作,如下表:
动作
说明
GET( SELECT
从服务器取出资源(一项或多项)
POST( CREATE
在服务器新建一个资源。
PUT( UPDATE
在服务器更新资源(客户端提供改变后的完 整资源)。
PATCH(UPDATE
在服务器更新资源(客户端提供改变的属 性)。
DELETE( DELETE
从服务器删除资源。
对数据库的增删改查操作,应该严格遵守上面定义的五种 HTTP动作。
对于更新动作,参数通过 requestbodR来传递,格式为json。服务端返回数据格式也均
丿为json。
服务端返回数据对象约定:
publicclass Un ifRI nfo{
privatei ntcode;// 返回代码,1 :成功,0:失败
privateStri ngmessage;// 返回信息提示
privateStri ngprompt;//
privateStri ngpath;// 一般用于错误时的跳转路径
privateHashMap<Stri ng,?>attribute;〃 一般用于查询时的返回数据内容
}
Springboot会自动将符合javabean格式的对象转换为json格式数据返回。
示例:
客户端请求
请求参数
服务端返回数据
说明
GET/users
{"code":"1","message":"查询成功
","prompt":"","path":"","users":[]}
查询所 有用户
GET/users/ID
{"code":"1","message":"查询成功
","prompt":"","path":"","users":[]}
查询指 定ID
的用户
POST/users
{"username":"user2","e mail":"******@qq. com"}
{"code":"0","message":"创建用户失败 "‘"prompt":" 该用户已经存在 ","path":"http://localhost:8080/users","res ult":{}}
创建一 个用户
PUT/users/ID
{"username":"user2","e mail":"******@qq. com"}
{"code":"1","message":"创建用户成功
","prompt":"","path":"","result":{}}
更新某 用户信 息
PATCH/users/I
D
{"username":"user2","e mail":"******@qq. com"}
{"code":"1","message":"更新成功
","prompt":"","path":"","result":{}}
更新某 用户指 定字段
DELETE/users/
ID
{"code":"1","message":"删除成功
","prompt":"","path":"","result":{}}
删除指 定用户
而对于