微服务开发手册.docx

螆微服务开发手册芃蚀开发说明葿●所有服务均基于springboot框架开发。Springboot内嵌了tomcat服务器,无需生成war包,并简化了maven配置,能够让开发者快速入手spring的开发。袄螂●服务的接口定义需严格符合restful规范。rest规范参考第2节restapi接口规范莀芆●所有服务都需要在注册服务上注册,否则不能被其他服务所调用。同时平台也能够实时监测服务的状态,能够及时预警及调度资源。芇膂●所有服务的配置信息统一保存于gitlab上,并通过配置服务获取配置。膁莈●对数据库的操作统一采用MyBatis 框架。MyBatis是个支持普通SQL查询,存储过程和高级映射的优秀持久层框架。Springboot也提供了mybatis的集成方案,可以很快捷地整合mybatis到项目中。莅薁●包名约定:.,,后面再跟具体模块名称作为子包名。袁荿●。项目的管理与构建采用maven,代码统一托管于gitlab仓库。蒄芄蚁restapi接口规范***springboot接口设计需符合restful风格。在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。袆而客户端要执行某种类型的操作,需要根据http的操作协议来决定。HTTP提供了常用的几种操作,如下表:蚄莂动作芈说明羄GET(SELECT)膃从服务器取出资源(一项或多项)袈POST(CREATE)艿在服务器新建一个资源。莇PUT(UPDATE)薂在服务器更新资源(客户端提供改变后的完整资源)。薈PATCH(UPDATE)肇在服务器更新资源(客户端提供改变的属性)。蒅DELETE(DELETE)羂从服务器删除资源。荿膈对数据库的增删改查操作,应该严格遵守上面定义的五种HTTP动作。薃对于更新动作,参数通过requestbody来传递,格式为json。服务端返回数据格式也均为json。莁服务端返回数据对象约定:lassUnifyInfo{羆 privateintcode;//返回代码,1:成功,0:失败袁 privateStringmessage;//返回信息提示袀 privateStringprompt;//肇 privateStringpath;//一般用于错误时的跳转路径肄 privateHashMap<String,?>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","email":""}螆{"code":"0","message":"创建用户失败","prompt":"该用户已经存在","path":"http://localhost:8080/users","result":{}}膄创建一个用户蚁PUT/users/ID节{"username":"user2","email":""}袇{"code":"1","message":"创建用户成功","prompt":"","path":"","result":{}}蒇更新某用户信息莄PATCH/users/ID螈{"username":"user2","email":""}袈{"code":"1","message":"更新成功","prompt":"","path":"","result":{}}薅更新某用户指定字段螄DELETE/users/ID葿蚆{"code":"1","message":"删除成功","prompt":"","path":"","result":{}}螃删除指定用户膃艿螇而对于登录、登出操作,可以理解为登录是创建token,登出是删除token,所以可以用POST和DELETE来定义这两种接口。刷新token是更新操作所以用PUT。肆蚂配置文件管理罿所有服务的配置文档均保存于gitlab上,并通过配置服务config-service来获取配置。每个服务在gitlab均保存一份以服务id命名的properties文件。衿以服务spring-boot-demo为例,其在gitlab上的