微服务开发手册

1、微 服 务 开 发 手 册1 .开发说明 所有服务均基于 spring boot框架开发。Spring boot内嵌了 tomcat服务器，无需生成war 包，并简化了 maven配置，能够让开发者快速入手 spring的开发。 服务的接口定义需严格符合restful规范。rest规范参考第2节 所有服务都需要在注册服务上注册，否则不能被其他服务所调用。同时平台也能够实时监测服务的状态，能够及时预警及调度资源。 所有服务的配置信息统一保存于gitlab上，并通过配置服务获取配置。 对数据库的操彳统一采用 MyBatis?框架。MyBatis是个支持普通 SQL查询，和高级映射 的优秀框架。Sp

2、ring boot也提供了 mybatis的集成方案，可以很快捷地整合 mybatis到项 目中。 包名约定：所有包均以.服务名为父包名 所有项目基于来开发。项目的管理与构建采用maven,代码统一托管于 gitlab仓库。2 . rest api 接口规范spring boot接口设计需符合 restful风格。在RESTful架构中，每个网址代表一种资源 （resource）,所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对 应。而客户端要执行某种类型的操作，需要根据http的操作协议来决定。HTTP提供了常用的几种操作，如下表：动作说明GET (SELECT )从服

3、务器取出资源（一项或多项）POST (CREATE )在服务器新建一个资源。PUT ( UPDATE )在服务器更新资源（客户端提供改变后的完整 资源）。PATCH (UPDATE)在服务器更新资源（客户端提供改变的属性）。DELETE ( DELETE )从服务器删除资源。对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP动作对于更新动作，参数通过requestbody来传递，格式为json。服务端返回数据格式也均为json服务端返回数据对象约定: public class UnifyInfo private int code;roperties</include><

4、;include>*/*.xml</include>/includes<filtering>false</filtering>/resource</resources><plugins><plugin><artifactId>spring-boot-maven-plugin</artifactId><configuration><fork>true</fork>/configuration)</plugin> <plugin><

5、groupId></groupId><artifactId>docker-maven-plugin</artifactId><configuration><dockerDirectory>src/main/docker</dockerDirectory><pushImage>true</pushImage><resources><resource><targetPath>/</targetPath></resource></re

6、sources></configuration></plugin></plugins>在src/main/下建立docker目录，并新建 Dockefile ,内容如下：FROM java:8VOLUME /tmpEXPOSE 8080CMD java -jar当程序经过测试并提交到gitlab 后， jenkins 将自动构建并打包成docker 镜像发布到远程docker 仓库。同时jenkins 会通知远程服务下载该镜像并重新运行。3集成mybatis所有数据库操作采用Mybatis 来管理。集成Mybatis 关键配置如下：添加依赖<de

7、pendency ><groupId ></ groupId ><artifactId>mybatis-spring-boot-starter</ artifactIdversion ></ dependency >dependency >groupId ></ groupId >artifactId >mybatis-spring-boot-starter-test</ artifactId >version ></ dependency >!-以mysql数据库为例

8、->dependency ><groupId >mysql/ groupId >artifactId>mysql-connector-java</ artifactId ><version >/ version ></ dependency >（托管于gitlab上,由配置服务统一管理）主要配置如下：=classpath:资源的配置结构如下图：其中内容：<! DOCTYPE configurationPUBLIC "- roperties </ include ><include &

9、gt;*/*xml</ include ></ includes ><filtering >false </ filtering ></ resource ></ resources ><plugins ><plugin ></ build ><groupId ></ groupId ><artifactId > spring-boot-maven-plugin</ artifactId ><configuration ><

10、;fork >true </ fork ></ configuration ></ plugin ><plugin ><groupId ></ groupId ><artifactId >docker-maven-plugin </ artifactId ><version ></ version ><configuration ><imageName ></ imageName ><dockerDirectory >src/main/docker </ dockerDirectory ><pushImage >true </ pushImage ><resources ><resource ><targetPath >/ </ targetPath ><directory ></ directory ><incl