微服务开发手册

微服务开发手册Document serial number【KKGB-LBS98YT-BS8CB-BSUT-BST108】微服务开发手册1．开发说明●所有服务均基于springboot框架开发。

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

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

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

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

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

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

MyBatis是个支持普通SQL查询，和高级映射的优秀框架。

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

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

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

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

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

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

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

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

服务端返回数据对象约定：publicclassUnifyInfo{privateintcode;//返回代码，1：成功，0：失败privateStringmessage;//返回信息提示privateStringprompt;//privateStringpath;//一般用于错误时的跳转路径privateHashMap<String,>attribute;//一般用于查询时的返回数据内容}Springboot会自动将符合javabean格式的对象转换为json格式数据返回。

用POST和DELETE来定义这两种接口。

刷新token是更新操作所以用PUT。

3．配置文件管理所有服务的配置文档均保存于gitlab上，并通过配置服务config-service来获取配置。

每个服务在gitlab均保存一份以服务id命名的properties文件。

以服务spring-boot-demo为例，其在gitlab上的配置文件为spring-boot-demo.properties在spring-boot-demo.properties中通常配置该服务的启动端口、数据库连接参数等信息。

当该文件有更新并push到gitlab后，配置服务会自动通知客户端服务更新配置信息。

关键配置：在主程序中需要访问配置文件的类名上加上注解：@RefreshScope，如果没有该注解，配置服务将不能主动通知客户端服务更新配置。

如下：@RefreshScope@RestControllerpublicclassMessageRestController{@Value("${message:Hellodefault}")privateStringmessage;@RequestMapping("/message")StringgetMessage(){returnthis.message;}}当spring-boot-demo.properties文件里的message变量发生变化后，请求/message时返回的message值将是更新后的message内容。

pom.xml关键依赖项：<dependency><artifactId>spring-cloud-config-client</artifactId></dependency><dependency><artifactId>spring-boot-starter-actuator</artifactId></dependency>同时需要引入springcloud的依赖项<dependencyManagement><dependencies><dependency><artifactId>spring-cloud-dependencies</artifactId><version>Camden.SR5</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>在src/main/resouce目录建立bootstrap.properties文件，设置配置服务url与serviceid。

bootstrap.properties文件内容：#配置服务地址#servicenamespring-boot-demo注：不能在application.properties设置配置服务的url,因为application.properties的启动优先级最低，不能在程序启动之前读取到配置服务url,从而不能加载配置服务上相应的配置。

4．服务注册register-service提供服务的注册与发现。

所有的服务都需要注册到register-service 中，否则不能够被其他服务发现与调用，比如路由服务。

关键配置pom.xml关键依赖项：<dependency><groupId></groupId><artifactId>spring-cloud-starter-eureka-server</artifactId></dependency>同时需要引入springcloud的依赖项<dependencyManagement><dependencies><dependency><artifactId>spring-cloud-dependencies</artifactId><version>Camden.SR5</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>主程序加上注解：@EnableEurekaServer如下：@EnableEurekaServer@SpringBootApplicationpublicclassRegisterServiceApplication{publicstaticvoidmain(String[]args){SpringApplication.run(RegisterServiceApplication.class,args);}}对应配置服务器上的spring-boot-demo.properties中添加注册服务的地址。

spring-boot-demo.properties配置如下：#服务启动端口server.port=8082#注册服务地址5．统一网关路由所有rest请求均需要通过网关来路由到具体的服务。

网关服务能起到负载均衡、动态路由、统一认证等功能。

使用代理服务能够避免必须的跨域资源共享（Cross-OriginResourceSharing）。

当一个UI应用调用一个或更多的后端服务的时候，通过网关服务来做统一的代理。

前端应用不再需要关心后台业务服务的具体地址，因此当业务服务的地址变更后也不需要修改应用端的配置。

所有的请求都在网关做了统一的认证授权，因此业务服务也不再需要考虑与授权有关的问题。

按照约定,一个serviceid为"userservice"的服务会收到/userservice请求路径的代理请求(前缀会被剥离)。

因此要查询用户ID是590d38b064328b1aac828ae6的信息，完整的请求路径是其中userservice是userservice的sericeid,users/{id}是该服务提供的对外访问接口。

网关服务会自动根据请求路径里的serviceid（本例中是userservice）找到userservice的请求地址，并路由给该服务的users/{id}接口，其最终的路由地址是注：url不包括/userservice。

而网关服务能够正确路由的前提是userservice已经在注册服务上注册。

6．认证授权对于某用户的授权分为两类，一类是该用户是否能够访问某些url,一类是它在界面上所能看到哪些功能（即菜单）。

应用端访问后台服务时均需要经过授权服务auth-service认证才能访问服务的资源。

授权服务对资源的访问控制通过uri+serviceid+HTTPMETHOD来控制，如角色ROLE_USER的资源权限为服务名为userservice的user/*,请求方式为ALL,则其对所有userservice服务的uri为user/形式的资源均有权访问。

如POST所以在设计api接口时，需严格按照第一节中restapi的规范定义接口，以方便对某一类资源的请求做统一的权限配置。

同时在应用端，某用户登录进来后能够访问的菜单也是通过授权服务控制。

菜单资源包括菜单的名称，图标，跳转路径等属性。

应用端通过授权得到的菜单属性，并决定菜单界面的布局。

菜单对象定义如下：publicclassMenu{privateIntegerid;privateStringmenuname;privateIntegerparentid;privateStringmenucode;privateStringmenuurl;privateStringmenuicon;privateStringurltarget;privateIntegerisactive;privateIntegernavmenu;privateIntegerisleaf;privateIntegerviewtype;privateIntegersort;privateStringremark;privateStringcreator;privateStringmodified;privateDatecreatetime;privateDatelastupdate;}7．持续集成项目开发完成后，通过jenkins持续集成，打包成docker镜像后上传到服务器上的dockerrepository后运行，所以需要在pom.xml文件里配置mavendocker插件。