微服务开发手册Word格式.docx

1、2restapi 接口规范接口规范 springboot 接口设计需符合 restful 风格。在 RESTful 架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。而客户端要执行某种类型的操作，需要根据 http 的操作协议来决定。HTTP 提供了常用的几种操作，如下表：动作 说明 GET（SELECT）从服务器取出资源（一项或多项）POST（CREATE）在服务器新建一个资源。PUT（UPDATE）在服务器更新资源（客户端提供改变后的完整资源）。PATCH（UPDATE）在服务器更新资源（客户端提供改变的属性）。DE

2、LETE（DELETE）从服务器删除资源。对数据库的增删改查操作，应该严格遵守上面定义的五种 HTTP 动作。对于更新动作，参数通过 requestbody来传递，格式为 json。服务端返回数据格式也均为 json。服务端返回数据对象约定：publicclassUnifyInfo privateintcode;/返回代码，1：成功，0：失败 privateStringmessage;/返回信息提示 privateStringprompt;/privateStringpath;/一般用于错误时的跳转路径 privateHashMapattribute;/一般用于查询时的返回数据内容 Sprin

3、gboot 会自动将符合 javabean格式的对象转换为 json 格式数据返回。示例：客户端请求 请求参数 服务端返回数据 说明 GET/users code:1,message:查询成功,prompt:,path:,users:查询所有用户 GET/users/ID code:查询指定 ID的用户 POST/users 创建一个用户 PUT/users/ID code:创建用户成功,prompt:,result:更新某用户信息 PATCH/users/ID code:更新成功,prompt:更新某用户指定字段 DELETE/users/ID code:删除成功,prompt:删除指定用户

4、 而对于登录、登出操作，可以理解为登录是创建 token,登出是删除 token,所以可以用 POST 和 DELETE来定义这两种接口。刷新 token是更新操作所以用 PUT。3配置文件管理配置文件管理 所有服务的配置文档均保存于 gitlab上，并通过配置服务 config-service来获取配置。每个服务在 gitlab 均保存一份以服务 id命名的 properties 文件。以服务 spring-boot-demo 为例，其在 gitlab 上的配置文件为 spring-boot-demo.properties 在 spring-boot-demo.properties 中通常配

5、置该服务的启动端口、数据库连接参数等信息。当该文件有更新并 push 到 gitlab后，配置服务会自动通知客户端服务更新配置信息。关键配置：在主程序中需要访问配置文件的类名上加上注解：RefreshScope，如果没有该注解，配置服务将不能主动通知客户端服务更新配置。如下：RefreshScope RestController publicclassMessageRestController Value（$message:Hellodefault）privateStringmessage;RequestMapping（/message）StringgetMessage（）returnthis

6、.message;当 spring-boot-demo.properties 文件里的 message变量发生变化后，请求/message时返回的 message值将是更新后的 message内容。pom.xml 关键依赖项：spring-cloud-config-client spring-boot-starter-actuator 同时需要引入 springcloud 的依赖项 spring-cloud-dependencies Camden.SR5 pom import 在 src/main/resouce 目录建立 bootstrap.properties 文件，设置配置服务 url与

7、serviceid。bootstrap.properties 文件内容：#配置服务地址#servicename spring-boot-demo 注：不能在 application.properties 设置配置服务的 url,因为 application.properties 的启动优先级最低，不能在程序启动之前读取到配置服务 url,从而不能加载配置服务上相应的配置。4服务注册服务注册 register-service提供服务的注册与发现。所有的服务都需要注册到 register-service中，否则不能够被其他服务发现与调用，比如路由服务。关键配置 pom.xml 关键依赖项：spri

8、ng-cloud-starter-eureka-server 同时需要引入 springcloud 的依赖项 spring-cloud-dependencies Camden.SR5 pom import 主程序加上注解：EnableEurekaServer如下：EnableEurekaServer SpringBootApplication publicclassRegisterServiceApplication publicstaticvoidmain（Stringargs）SpringApplication.run（RegisterServiceApplication.class,ar

9、gs）;对应配置服务器上的 spring-boot-demo.properties 中添加注册服务的地址。spring-boot-demo.properties 配置如下：#服务启动端口 server.port=8082#注册服务地址 5统一网关路由统一网关路由 所有 rest 请求均需要通过网关来路由到具体的服务。网关服务能起到负载均衡、动态路由、统一认证等功能。使用代理服务能够避免必须的跨域资源共享（Cross-OriginResourceSharing）。当一个 UI应用调用一个或更多的后端服务的时候，通过网关服务来做统一的代理。前端应用不再需要关心后台业务服务的具体地址，因此当业务服务

10、的地址变更后也不需要修改应用端的配置。所有的请求都在网关做了统一的认证授权，因此业务服务也不再需要考虑与授权有关的问题。按照约定,一个 serviceid 为userservice的服务会收到/userservice请求路径的代理请求（前缀会被剥离）。因此要查询用户 ID是 590d38b064328b1aac828ae6 的信息，完整的请求路径是 其中 userservice是 userservice的 sericeid,users/id是该服务提供的对外访问接口。网关服务会自动根据请求路径里的 serviceid（本例中是 userservice）找到 userservice的请求地址，并

11、路由给该服务的 users/id接口，其最终的路由地址是 注：url不包括/userservice。而网关服务能够正确路由的前提是 userservice 已经在注册服务上注册。6认证授权认证授权 对于某用户的授权分为两类，一类是该用户是否能够访问某些 url,一类是它在界面上所能看到哪些功能（即菜单）。应用端访问后台服务时均需要经过授权服务 auth-service认证才能访问服务的资源。授权服务对资源的访问控制通过 uri+serviceid+HTTPMETHOD来控制，如角色 ROLE_USER 的资源权限为服务名为 userservice的 user/*,请求方式为 ALL,则其对所有

12、 userservice 服务的 uri为 user/形式的资源均有权访问。如 POST 所以在设计 api 接口时，需严格按照第一节中 restapi 的规范定义接口，以方便对某一类资源的请求做统一的权限配置。同时在应用端，某用户登录进来后能够访问的菜单也是通过授权服务控制。菜单资源包括菜单的名称，图标，跳转路径等属性。应用端通过授权得到的菜单属性，并决定菜单界面的布局。菜单对象定义如下：publicclassMenu privateIntegerid;privateStringmenuname;privateIntegerparentid;privateStringmenucode;pri

13、vateStringmenuurl;privateStringmenuicon;privateStringurltarget;privateIntegerisactive;privateIntegernavmenu;privateIntegerisleaf;privateIntegerviewtype;privateIntegersort;privateStringremark;privateStringcreator;privateStringmodified;privateDatecreatetime;privateDatelastupdate;7持续集成持续集成 项目开发完成后，通过 j

14、enkins 持续集成，打包成 docker镜像后上传到服务器上的dockerrepository后运行，所以需要在 pom.xml文件里配置 mavendocker 插件。Pom.xml 关键配置：src/main/resources */*false src/main/java */*.properties */*.xml false spring-boot-maven-plugin true com.spotify docker-maven-plugin src/main/docker true /在 src/main/下建立 docker目录，并新建 Dockerfile，内容如下：F

15、ROMjava:8 VOLUME/tmp ADDapp.jar EXPOSE8080 CMDjava-jarapp.jar 当程序经过测试并提交到 gitlab后，jenkins 将自动构建并打包成 docker镜像发布到远程 docker仓库。同时 jenkins 会通知远程服务下载该镜像并重新运行。8集成集成 mybatis 所有数据库操作采用 Mybatis 来管理。集成 Mybatis 关键配置如下：添加 pom.xm 依赖 mybatis-spring-boot-starter 1.3.0 mybatis-spring-boot-starter-test 1.3.0 mysql my

16、sql-connector-java Spring-boot-demo.properties（托管于 gitlab上,由配置服务统一管理）主要配置如下：mybatis.config-location=classpath:mybatis-config.xml 资源的配置结构如下图：其中 mybatis-config.xml 内容：CittyMapper.xml 内容如下：select*fromcitywhereid=#id deletefromcitywhereid=#id insertintoCity（id,name,state,country）values（#id,jdbcType=INTE

17、GER,#name,jdbcType=VARCHAR,#state,jdbcType=VARCHAR,#country,jdbcType=VARCHAR）该配置文件定义了三种数据库操作，对应了 CityMapper 这个接口中的三种方法 Mapper publicinterfaceCityMapper CityselectCityById（intcity_id）;voidinsertCity（Citycity）;voiddeleteCityById（intcity_id）;附录一：完整附录一：完整 pom.xml 4.0.0 com.drht spring-boot-demo spring-b

18、oot-demo spring-boot-starter-parent UTF-8 1.8 spring-boot-starter-web mybatis-spring-boot-starter 1.3.0 mybatis-spring-boot-starter-test 1.3.0 mysql mysql-connector-java !-com.h2database h2 runtime -spring-boot-starter-test test spring-cloud-starter-config spring-boot-starter-actuator spring-cloud-starter-eureka spring-cloud-starter-eureka-server test spring-cloud-dependencies Camden.SR5 pom import src/main/resources */*false src/main/java */*.properties */*.xml false spring-boot-maven-plugin true com.spotify docker-maven-plugin src/main/docker true /附录二：附录二：spring-boot-demo 源码（略）源码（略）