微服务开发手册

《微服务开发手册》由会员分享，可在线阅读，更多相关《微服务开发手册（17页珍藏版）》请在装配图网上搜索。

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

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

3、，如下表：动作说明GET （SELECT）从服务器取出资源（一项或多项）POST （CREATE）在服务器新建一个资源。PUT（UPDATE）在服务器更新资源（客户端提供改变后的完 整资源）。PATCH（UPDATE）在服务器更新资源（客户端提供改变的属 性）。DELETE (DELETE)从服务器删除资源。对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP动作。对于更新动作，参数通过requestbody来传递，格式为json。服务端返回数据格式也均 为 json。服务端返回数据对象约定：public class UnifyInfo private int code; /返回代码，1

4、：成功，0：失败private String message;/返回信息提示private String prompt;/private String path;/一般用于错误时的跳转路径private HashMap attribute;/一般用于查询时的返回数据内容Spring boot会自动将符合javabean格式的对象转换为json格式数据返回。示例：客户端请求请求参数服务端返回数据说明GET /userscode:1,message:查询成功 ,prompt:,path:,users:查询所有用户GET /users/IDcode:1,message:查询成功 ,prompt:,p

5、ath:,users:查询指 定ID 的用户POST /users创建一个用户PUT /users/IDcode:1,message:创建用 户成功 ,prompt:,path:,result:更新某用户信息PATCH /users/IDcode:1,message:更新成功 ,prompt:,path:,result:更新某用户指定字段DELETE /users/IDcode:1,message:删除成功 ,prompt:,path:,result:删除指定用户而对于登录、登出操作，可以理解为登录是创建token，登出是删除token，所以可以用 POST和DELETE来定义这两种接口。刷新

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

7、ontrollerpublic class MessageRestController Value($message:Hello default)private String message;RequestMapping(/message)String getMessage() return this.message;)当spring-boot-demo.properties文件里的message变量发生变化后，请求/message时返回的 message值将是更新后的message内容。pom.xml关键依赖项：spring-cloud-config-clientspring-boot-st

8、arter-actuator同时需要引入spring cloud的依赖项spring-cloud-dependenciesCamden.SR5pomimport在 src/main/resouce 目录建立 bootstrap.properties 文件，设置配置服务 url 与 service id。bootstrap.properties 文件内容：#配置服务地址#service namespring-boot-demo注：不能在 application.properties 设置配置服务的 url,因为 application.properties 的启动优先级最低，不能在程序启动之前读

9、取到配置服务url,从而不能加载配置服务上相 应的配置。4 .服务注册register-services服务的注册与发现。所有的服务都需要注册到register-service中，否则 不能够被其他服务发现与调用，比如路由服务。关键配置pom.xml关键依赖项：spring-cloud-starter-eureka-server同时需要引入spring cloud的依赖项spring-cloud-dependenciesCamden.SR5pomimport主程序加上注解：EnableEurekaServer如下：EnableEurekaServerSpringBootApplicationp

10、ublic class RegisterServiceApplication public static void main(String args) SpringApplication.run(RegisterServiceApplication.class, args);对应配置服务器上的spring-boot-demo.properties中添加注册服务的地址。spring-boot-demo.properties 配置如下：#服务启动端口 server.port=8082 #注册服务地址5 统一网关路由所有rest请求均需要通过网关来路由到具体的服务。网关服务能起到负载均衡、动态 路由

11、、统一认证等功能。使用代理服务能够避免必须的跨域资源共享（Cross-Origin Resource Sharing）。 当一个UI应用调用一个或更多的后端服务的时候，通过网关服务来做统一的代理。前端应 用不再需要关心后台业务服务的具体地址，因此当业务服务的地址变更后也不需要修改应用 端的配置。所有的请求都在网关做了统一的认证授权，因此业务服务也不再需要考虑与授权有关的 问题。? 按照约定，一个serviceid为userservice”的服务会收到？/userservice请求路 径的代理请求（前缀会被剥离）。因此要查询用户ID是590d38b064328b1aac828ae6的信 息，完整

12、的请求路径是其中userservice是user service的sericeid,users/id是该服务提供的对外访问 接口。网关服务会自动根据请求路径里的serviceid （本例中是userservice）找到 userservice的请求地址，并路由给该服务的users/id接口，其最终的路由地址是注：url 不包括/userservice。而网关服务能够正确路由的前提是userservice已经在注册服务上注册。6 .认证授权对于某用户的授权分为两类，一类是该用户是否能够访问某些url,一类是它在界面上所 能看到哪些功能（即菜单）。应用端访问后台服务时均需要经过授权服务auth-s

13、ervice认证才能访问服务的资源。授 权服务对资源的访问控制通过uri + serviceid + HTTP METHOD来控制，如角色ROLE_USER的资源权限为服务名为userservice的user/*,请求方式为ALL ,则其对所 有userservice服务的uri为user/形式的资源均有权访问。如POST所以在设计api接口时，需严格按照第一节中rest api的规范定义接口，以方便对某一 类资源的请求做统一的权限配置。同时在应用端，某用户登录进来后能够访问的菜单也是通过授权服务控制。菜单资源包 括菜单的名称，图标，跳转路径等属性。应用端通过授权得到的菜单属性，并决定菜单界面

14、 的布局。菜单对象定义如下：public class Menu private Integer id;private String menuname;private Integer parentid;private String menucode;private String menuurl;private String menuicon;private String urltarget;private Integer isactive;private Integer navmenu;private Integer isleaf;private Integer viewtype;private

15、 Integer sort;private String remark;private String creator;private String modified;private Date createtime;private Date lastupdate;7 .持续集成项目开发完成后，通过jenkins持续集成，打包成docker镜像后上传到服务器上的docker repository后运行，所以需要在pom.xml文件里配置maven docker插件。Pom.xml关键配置：src/main/resources*/*falsesrc/main/java*/*.properties*/

16、*.xmlfalsespring-boot-maven-pluginconfigurationtrue/configurationcom.spotifydocker-maven-pluginsrc/main/dockertrue/在src/main/下建立docker目录，并新建Dockerfile,内容如下：FROM java:8VOLUME /tmpEXPOSE 8080CMD java -jar app.jar 当程序经过测试并提交到gitlab后，jenkins将自动构建并打包成docker镜像发布到远程 docker仓库。同时jenkins会通知远程服务下载该镜像并重新运行。8 .集

17、成 mybatis所有数据库操作采用Mybatis来管理。集成Mybatis关键配置如下：添加pom.xm依赖mybatis-spring-boot-starter1.3.0mybatis-spring-boot-starter-test1.3.0mysqlmysql-connector-javaSpring-boot-demo.properties （托管于gitlab上，由配置服务统一管理）主要配置如下：mybatis.config-location=classpath:mybatis-config.xml资源的配置结构如下图： 其中 mybatis-config.xml 内容:Citty

18、Mapper.xml 内容如下：select * from city where id = #id delete from city where id = #idinsert into City (id, name, state,country)values (#id,jdbcType=INTEGER, #name,jdbcType=VARCHAR,#state,jdbcType=VARCHAR,#country,jdbcType=VARCHAR)该配置文件定义了三种数据库操作，对应了 CityMapper这个接口中的三种方法Mapperpublic interface CityMapper

19、City selectCityById(int city_id);void insertCity(City city);void deleteCityById(int city_id);附录一：完整 pom.xml4.0.0com.drhtspring-boot-demospring-boot-demospring-boot-starter-parent UTF-81.8spring-boot-starter-webmybatis-spring-boot-starter1.3.0mybatis-spring-boot-starter-test1.3.0mysqlmysql-connector-

20、java!- com.h2databaseh2runtime -spring-boot-starter-testtestspring-cloud-starter-configspring-boot-starter-actuatorspring-cloud-starter-eurekaspring-cloud-starter-eureka-servertestspring-cloud-dependenciesCamden.SR5pomimportsrc/main/resources*/*falsesrc/main/java*/*.properties*/*.xmlfalsespring-boot-maven-plugintruecom.spotifydocker-maven-pluginsrc/main/dockertrue/附录二：spring-boot-dem。源码（略）