《微服务开发手册》由会员分享，可在线阅读，更多相关《微服务开发手册（24页珍藏版）》请在金锄头文库上搜索。
1、微服务开发手册1 .开发说明所有服务均基于springboot框架开发。Springboot内嵌了 tomcat服务器，无需 生成war包，并简化了 maven配置，能够让开发者快速入手 spring的开发。服务的接口定义需严格符合restful规范。rest规范参考第2节所有服务都需要在注册服务上注册，否则不能被其他服务所调用。同时平台也能 够实时监测服务的状态，能够及时预警及调度资源。所有服务的配置信息统一保存于gitlab 上，并通过配置服务获取配置。对数据库的操作统一采用 MyBatis框架。MyBatis是个支持普通SQL查询，和高 级映射的优秀框架。Springboot也提供了 m
2、ybatis的集成方案，可以很快捷地整合 mybatis到项目中。包名约定：所有包均以 com.drht.服务名为父包名所有项目基于jdk1.8 来开发。项目的管理与构建采用maven,代码统一托管于gitlab 仓库。2 . restapi 接 口 规范springboot接口设计需符合 restful 风格。在 RESTful架构中，每个网址代表 一种资源(resource ),所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应而客户端要执行某种类型的操作，需要根据http的操作协议来决定。HTTP提供了常用的几种操作，如下表:动作说明GET(SELECT从服务器取出
3、资源（一项或多项）POST(CREATE在服务器新建个资源。PUT(UPDATE在服务器更新资源（客户端提供改变 后的完整资源）。PATCH (UPDATE在服务器更新资源（客户端提供改变 的属性）。DELETE( DELETE从服务器删除资源。对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP动作。对于更新动作，参数通过 requestbody来传递，格式为json。服务端返回数据 格式也均为json 。服务端返回数据对象约定:publicclassUnifyInfoprivateintcode;/返回代码，1：成功，0：失败privateStringmessage;/返回信息提示p
4、rivateStringprompt;/privateStringpath;般用于错误时的跳转路径般用于查询时的返回数据内容privateHashMapattribute;Springboot会自动将符合javabean格式的对象转换为json格式数据返回示例:客户端请求请求参数服务端返回数据说明GET/userscode:1,message:查 询查询成功所有,prompt:,path:,use用户rs:出GET/userscode:1,message:查 询查询/ID成功指定,prompt:,path:,useID的rs:出用户POST/user创建s一个用户PUT/userscode:1
5、,message:创 建更新/ID用户成功,prompt:,path:,result:某用户信息PATCH/users/IDcode:1,message:更 新成功,prompt:,path:,result:更新某用户指定字段DELETE/users/IDcode:1,message:删 除成功,prompt:,path:,result:删除指定用户而对于登录、登出操作，可以理解为登录是创建token,登出是删除token,所以可以用POS评口 DELET陈定义这两种接口。刷新 token是更新操作所以用 PUT3 .配置文件管理所有服务的配置文档均保存于gitlab 上，并通过配置服务con
6、fig-service 来获取配置。每个服务在 gitlab均保存一份以服务id命名的properties 文件。以服务spring-boot-demo 为例，其在gitlab 上的配置文件为spring-boot-demo.properties在 spring-boot-demo.properties中通常配置该服务的启动端口、数据库连接参数等信息。当该文件有更新并push到gitlab后，配置服务会自动通知客户端服务更新配置信息。关键配置：在主程序中需要访问配置文件的类名上加上注解：RefreshScope,如果没有该注解，配置服务将不能主动通知客户端服务更新配置。如下：RefreshSc
7、opeRestControllerpublicclassMessageRestControllerValue($message:Hellodefault)privateStringmessage;RequestMapping(/message)StringgetMessage()returnthis.message;当 spring-boot-demo.properties 文件里的 message变量 发生变 化后，请求/message 时返回的 message值将是更新后的 message内容。pom.xml关键依赖项:spring-cloud-config-clientspring-bo
8、ot-starter-actuator同时需要引入springcloud 的依赖项spring-cloud-dependenciesCamden.SR5pomimport 在 src/main/resouce 目 录建立 bootstrap.properties 文件， 设置配置月艮务 url 与 serviceid 。bootstrap.properties 文件 内容：#配置服务地址#servicenamespring-boot-demo注：不能在 application.properties 设置配置服务的 url,因为 application.properties的启动优先级最低，不能
9、在程序启动之前读取到配置服务url,从而不能加载配置服务上相应的配置。4.服务注册register-service 提供服务的注册与发现。所有的服务都需要注册到 register-service 中，否则不能够被其他服务发现与调用，比如路由服务。关键配置pom.xml关键依赖项：spring-cloud-starter-eureka-server / dependency同时需要引入springcloud 的依赖项spring-cloud-dependenciesCamden.SR5pomimport主程序加上注解：EnableEurekaServer如下：EnableEurekaServer
10、SpringBootApplicationpublicclassRegisterServiceApplicationpublicstaticvoidmain(Stringargs)SpringApplication.run(RegisterServiceApplication.class,args);对应配置服务器上的 spring-boot-demo.properties 中添加注册服务的地址。spring-boot-demo.properties 配置如下：#服务启动端口server.port=8082#注册服务地址5 统一网关路由所有 rest 请求均需要通过网关来路由到具体的服务。 网
11、关服务能起到负载均衡、动态路由、统一认证等功能。使用代理服务能够避免必须的跨域资源共享 ( Cross-OriginResourceSharing ) 。当一个 UI 应用调用一个或更多的后端服务的时候，通过网关服务来做统一的代理。前端应用不再需要关心后台业务服务的具体地址，因此当业务服务的地址变更后也不需要修改应用端的配置。所有的请求都在网关做了统一的认证授权，因此业务服务也不再需要考虑与授权有关的问题。按照约定,一个serviceid 为userservice 的服务会收到/userservice 请求路径的代理请求( 前缀会被剥离) 。因此要查询用户 ID 是 590d38b064328
12、b1aac828ae6的信息，完整的请求路径是其中 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 的规范定义接口，以方便对某一类资源的请求做统一的权限配置。同时在应用端，某用户登
