微服务开发手册

微服务开发手册
1．开发说明
●所有服务均基于springboot框架开发。

Springboot内嵌了tomcat服务器，无需生成war包，并简化了maven配置，能够让开发者快速入手spring的开发。

●服务的接口定义需严格符合restful规范。

rest规范参考第2节restapi接口规范
●所有服务都需要在注册服务上注册，否则不能被其他服务所调用。

同时平台也能够实时监测服务的状态，能够及时预警及调度资源。

●所有服务的配置信息统一保存于gitlab上，并通过配置服务获取配置。

●对数据库的操作统一采用MyBatis?框架。

MyBatis是个支持普通SQL查询，存储过程和高级映射的优秀持久层框架。

Springboot也提供了mybatis的集成方案，可以很快捷地整合mybatis到项目中。

●包名约定：所有包均以.服务名为父包名
●所有项目基于来开发。

项目的管理与构建采用maven，代码统一托管于gitlab仓库。

2．restapi接口规范
springboot接口设计需符合restful风格。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。

而客户端要执行某种类型的操作，需要根据http的操作协议来决定。

HTTP提供
了常用的几种操作，如下表：
对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP动作。

对于更新动作，参数通过requestbody来传递，格式为json。

服务端返回数据格式也均为json。

服务端返回数据对象约定：
publicclassUnifyInfo{
privateintcode;
roperties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
<plugins>
<plugin>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
</configuration>
</plugin>
<plugin>
<groupId></groupId>
<artifactId>docker-maven-plugin</artifactId>
<configuration>
<dockerDirectory>src/main/docker</dockerDirectory>
<pushImage>true</pushImage>
<resources>
<resource>
<targetPath>/</targetPath>
</resource>
</resources>
</configuration>
</plugin>
</plugins>
在src/main/下建立docker目录，并新建Dockerfile，内容如下：
FROMjava:8
VOLUME/tmp
EXPOSE8080
当程序经过测试并提交到gitlab后，jenkins将自动构建并打包成docker镜像发布到远程docker仓库。

同时jenkins会通知远程服务下载该镜像并重新运行。

3．集成mybatis
所有数据库操作采用Mybatis来管理。

集成Mybatis关键配置如下：
添加依赖
<dependency>
<groupId></groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version></dependency>
<dependency>
<groupId></groupId>
<artifactId>mybatis-spring-boot-starter-test</artifactId>
<version></dependency>
<!--以mysql数据库为例-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version></version>
</dependency>
(托管于gitlab上,由配置服务统一管理)主要配置如下：
=classpath:
资源的配置结构如下图：
其中内容：
<!DOCTYPE configuration
PUBLIC"-roperties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId></groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<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>
<include></include>
</resource>
</resources>
</configuration>
</plugin>
</plugins>
</build>
</project>
附录二：spring-boot-demo源码（略）。