微服务开发手册

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

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

3、取出资源（一项或多项）post （create ）在服务器新建一个资源。put （update ）在服务器更新资源 （客户端提供改变后的完整资源）。patch （update ）在服务器更新资源 （客户端提供改变的属性）。delete （delete ）从服务器删除资源。对数据库的增删改查操作，应该严格遵守上面定义的五种http动作。对于更新动作，参数通过requestbody来传递，格式为json 。服务端返回数据格式也均为 json 。服务端返回数据对象约定：publicclassunifyinfoprivateintcode;/返回代码， 1：成功， 0：失败privatestringm

4、essage;/返回信息提示privatestringprompt;/privatestringpath;/一般用于错误时的跳转路径privatehashmapattribute;/一般用于查询时的返回数据内容springboot会自动将符合javabean 格式的对象转换为json 格式数据返回。示例：客 户 端 请求请求参数服务端返回数据说明get/users code:1,message:查 询成功,prompt:,path:,users: 查 询所 有用户get/users/id code:1,message:查 询成功,prompt:,path:,users: 查 询指 定id 的用

5、户post/users 创 建一 个用户put/userscode:1,message:创 建更 新/id 用户成功,prompt:,path:,result: 某 用户 信息patch/users/id code:1,message:更 新成功,prompt:,path:,result: 更 新某 用户 指定 字段delete/users/id code:1,message:删 除成功,prompt:,path:,result: 删 除指 定用户而对于登录、登出操作，可以理解为登录是创建token, 登出是删除 token, 所以可以用 post 和 delete 来定义这两种接口。刷新to

6、ken 是更新操作所以用put 。3配置文件管理所有服务的配置文档均保存于gitlab上，并通过配置服务config-service来获取配置。每个服务在gitlab均保存一份以服务id 命名的 properties文件。以服务 spring-boot-demo为例，其在 gitlab上的配置文件为perties 在 perties中通常配置该服务的启动端口、数据库连接参数等信息。当该文件有更新并push 到 gitlab后，配置服务会自动通知客户端服务更新配置信息。关键配置：在主程序中需要访问配置文件的类名上加上

7、注解：refreshscope，如果没有该注解，配置服务将不能主动通知客户端服务更新配置。如下：refreshscoperestcontrollerpublicclassmessagerestcontrollervalue($message:hellodefault)privatestringmessage;requestmapping(/message)stringgetmessage()returnthis.message;当perties文 件 里的message 变 量 发 生变 化 后 ，请 求/message 时返回的 message值将是更

8、新后的message内容。pom.xml 关键依赖项：spring-cloud-config-clientspring-boot-starter-actuator同时需要引入springcloud的依赖项spring-cloud-dependenciescamden.sr5pomimport在 src/main/resouce目录建立 perties文件，设置配置服务url与perties文件内容：#配置服务地址#servicenamespring-boot-demo注 ： 不 能 在pert

9、ies设 置 配 置 服 务 的url,因 为perties的启动优先级最低， 不能在程序启动之前读取到配置服务url,从而不能加载配置服务上相应的配置。4服务注册register-service提 供 服 务 的 注 册 与 发 现 。 所 有 的 服 务 都 需 要 注 册 到register-service中，否则不能够被其他服务发现与调用，比如路由服务。关键配置pom.xml 关键依赖项：spring-cloud-starter-eureka-server同时需要引入springcloud的依赖项spring-cloud-dependenciescamde

10、n.sr5pomimport主程序加上注解：enableeurekaserver 如下：enableeurekaserverspringbootapplicationpublicclassregisterserviceapplicationpublicstaticvoidmain(stringargs)springapplication.run(registerserviceapplication.class,args);对应配置服务器上的perties中添加注册服务的地址。perties配置如下：#服务启动端口s

11、erver.port=8082#注册服务地址5统一网关路由所有 rest 请求均需要通过网关来路由到具体的服务。网关服务能起到负载均衡、动态路由、统一认证等功能。使用代理服务能够避免必须的跨域资源共享（cross-originresourcesharing） 。当一个 ui 应用调用一个或更多的后端服务的时候，通过网关服务来做统一的代理。前端应用不再需要关心后台业务服务的具体地址，因此当业务服务的地址变更后也不需要修改应用端的配置。所有的请求都在网关做了统一的认证授权，因此业务服务也不再需要考虑与授权有关的问题。按照约定 , 一个 serviceid为userservice的服务会收到 /us

12、erservice请求路径的代理请求 ( 前缀会被剥离 ) 。因此要查询用户id 是 590d38b064328b1aac828ae6的信息，完整的请求路径是其中 userservice是 userservice的 sericeid,users/id是该服务提供的对外访问接口。网关服务会自动根据请求路径里的serviceid（本例中是 userservice）找到 userservice的请求地址， 并路由给该服务的users/id接口，其最终的路由地址是注： url不包括 /userservice。而网关服务能够正确路由的前提是userservice已经在注册服务上注册。6认证授权对于某用户

13、的授权分为两类，一类是该用户是否能够访问某些url,一类是它在界面上所能看到哪些功能（即菜单）。应用端访问后台服务时均需要经过授权服务auth-service认证才能访问服务的资源。授权服务对资源的访问控制通过uri+serviceid+httpmethod 来控制，如角色 role_user 的资源权限为服务名为userservice的 user/*,请求方式为all,则其对所有 userservice服务的 uri 为 user/ 形式的资源均有权访问。如post所以在设计api 接口时，需严格按照第一节中restapi的规范定义接口，以方便对某一类资源的请求做统一的权限配置。同时在应用端

14、，某用户登录进来后能够访问的菜单也是通过授权服务控制。菜单资源包括菜单的名称，图标，跳转路径等属性。 应用端通过授权得到的菜单属性，并决定菜单界面的布局。菜单对象定义如下：publicclassmenuprivateintegerid;privatestringmenuname;privateintegerparentid;privatestringmenucode;privatestringmenuurl;privatestringmenuicon;privatestringurltarget;privateintegerisactive;privateintegernavmenu;priv

15、ateintegerisleaf;privateintegerviewtype;privateintegersort;privatestringremark;privatestringcreator;privatestringmodified;privatedatecreatetime;privatedatelastupdate;7持续集成项目开发完成后，通过jenkins持续集成，打包成docker 镜像后上传到服务器上的 dockerrepository后运行，所以需要在pom.xml 文件里配置mavendocker 插件。pom.xml 关键配置：src/main/resources*

16、/*falsesrc/main/java*/*.properties*/*.xmlfalsespring-boot-maven-plugintruecom.spotifydocker-maven-pluginsrc/main/dockertrue/在 src/main/下建立 docker 目录，并新建dockerfile，内容如下：fromjava:8volume/tmpaddapp.jarexpose8080cmdjava-jarapp.jar当程序经过测试并提交到gitlab后， jenkins将自动构建并打包成docker 镜像发布到远程 docker 仓库。同时 jenkins会通知

17、远程服务下载该镜像并重新运行。8集成 mybatis所有数据库操作采用mybatis 来管理。集成mybatis 关键配置如下：添加 pom.xm依赖mybatis-spring-boot-starter1.3.0 mybatis-spring-boot-starter-test1.3.0 mysqlmysql-connector-javasperties(托管于gitlab上, 由配置服务统一管理) 主要配置如下：mybatis.config-location=classpath:mybatis-config.xml 资源的配置结构如下图：其中 myba

18、tis-config.xml内容：cittymapper.xml内容如下：select*fromcitywhereid=#iddeletefromcitywhereid=#idinsertintocity(id,name,state,country)values(#id,jdbctype=integer,#name,jdbctype=varchar,#state,jdbctype=varchar,#country,jdbctype=varchar)该配置文件定义了三种数据库操作，对应了citymapper 这个接口中的三种方法mapperpublicinterfacecitymappercityselectcitybyid(int city_id);void insertcity(citycity );void deletecitybyid(int city_id);附录一：