微服务开发手册
微服务开发手册
1.开发说明
? 所有服务均基于spring boot 框架开发。Spring boot内嵌了tomcat服务器,无需生成war包,并简化了maven配置,能够让开发者快速入手spring的开发。
?服务的接口定义需严格符合restful 规范。rest规范参考第2节rest api 接口规范
? 所有服务都需要在注册服务上注册,否则不能被其他服务所调用。同时平台也能够实时监测服务的状态,能够及时预警及调度资源。
?所有服务的配置信息统一保存于gitlab 上,并通过配置服务获取配置。
?对数据库的操作统一采用MyBatis 框架。MyBatis是个支持普通SQL查询,存储过程
和高级映射的优秀持久层框架。Spring boot也提供了mybatis的集成方案,可以很快捷地
整合mybatis到项目中。
?包名约定:所有包均以?服务名为父包名,如,后面再跟具体模块名称作为子包名。
? 所有项目基于来开发。项目的管理与构建采用maven,代码统一托管于gitlab 仓库。
2. rest api 接口规范
spring boot接口设计需符合restful 风格。在RESTful架构中,每个网址代表一种资源(resource ),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
而客户端要执行某种类型的操作,需要根据http的操作协议来决定。HTTP提供了常用
的几种操作,如下表:
对数据库的增删改查操作,应该严格遵守上面定义的五种HTTP动作。
对于更新动作,参数通过requestbody来传递,格式为json。服务端返回数据格式也
均为json。
服务端返回数据对象约定:
public class Unifylnfo {
private int code;
roperties
在src/main/下建立docker目录,并新建Dockerfile ,内容如下:
FROM java:8
VOLUME /tmp
ADD
EXPOSE 8080
CMD java -jar
当程序经过测试并提交到gitlab 后,jenkins 将自动构建并打包成docker docker仓库。同时jenkins 会通知远程服务下载该镜像并重新运行。
3.集成mybatis
所有数据库操作采用Mybatis来管理。集成Mybatis关键配置如下:
添加依赖
vgroupld >
vartifactld >mybatis-spri ng-boot-starter-test artifactld > vversion > dependency >
vgroupld >mysql groupld >
vartifactld >mysql-c onn ector-java artifactld >
vversion > dependency >
(托管于gitlab 上,由配置服务统一管理)主要配置如下:
=classpath:
&characterE ncod in g=utf-8
资源的配置结构如下图:
其中内容:
v! DOCTYPEconfiguration
PUBLlC "- roperties v/ include >
vinclude >**/*x _ v/ include >
v/ includes > vfiltering >false v/ filtering
${ 镜像发布到远程
resource >
resources >
vplugins >
vplugin >
vartifactld >spr in g-boot-mave n-plugi n v/artifactld >
vfork >true fork >
con figurati on >
plugin >
vdockerDirectory >src/ma in /docker dockerDirectory >
vpushlmage >true pushImage >
vresources >
vresource >
vtargetPath >/ targetPath >
vdirectory >${
resource >
resources >
con figurati on >
plugin >
plugins >
build >
project >
源码(略)附录二:spring-boot-
demo