微服务开发手册Word格式.docx
《微服务开发手册Word格式.docx》由会员分享，可在线阅读，更多相关《微服务开发手册Word格式.docx（15页珍藏版）》请在冰豆网上搜索。
2restapi接口规范接口规范springboot接口设计需符合restful风格。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。
而客户端要执行某种类型的操作，需要根据http的操作协议来决定。
HTTP提供了常用的几种操作，如下表：
动作说明GET（SELECT）从服务器取出资源（一项或多项）POST（CREATE）在服务器新建一个资源。
PUT（UPDATE）在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）从服务器删除资源。
对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP动作。
对于更新动作，参数通过requestbody来传递，格式为json。
服务端返回数据格式也均为json。
服务端返回数据对象约定：
publicclassUnifyInfoprivateintcode;
/返回代码，1：
成功，0：
失败privateStringmessage;
/返回信息提示privateStringprompt;
/privateStringpath;
/一般用于错误时的跳转路径privateHashMapattribute;
/一般用于查询时的返回数据内容Springboot会自动将符合javabean格式的对象转换为json格式数据返回。
示例：
客户端请求请求参数服务端返回数据说明GET/userscode:
1,message:
查询成功,prompt:
path:
users:
查询所有用户GET/users/IDcode:
查询指定ID的用户POST/users创建一个用户PUT/users/IDcode:
创建用户成功,prompt:
result:
更新某用户信息PATCH/users/IDcode:
更新成功,prompt:
更新某用户指定字段DELETE/users/IDcode:
删除成功,prompt:
删除指定用户而对于登录、登出操作，可以理解为登录是创建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中通常配置该服务的启动端口、数据库连接参数等信息。
当该文件有更新并push到gitlab后，配置服务会自动通知客户端服务更新配置信息。
关键配置：
在主程序中需要访问配置文件的类名上加上注解：
RefreshScope，如果没有该注解，配置服务将不能主动通知客户端服务更新配置。
如下：
RefreshScopeRestControllerpublicclassMessageRestControllerValue（$message:
Hellodefault）privateStringmessage;
RequestMapping（/message）StringgetMessage（）returnthis.message;
当spring-boot-demo.properties文件里的message变量发生变化后，请求/message时返回的message值将是更新后的message内容。
pom.xml关键依赖项：
spring-cloud-config-clientspring-boot-starter-actuator同时需要引入springcloud的依赖项spring-cloud-dependenciesCamden.SR5pomimport在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关键依赖项：
spring-cloud-starter-eureka-server同时需要引入springcloud的依赖项spring-cloud-dependenciesCamden.SR5pomimport主程序加上注解：
EnableEurekaServer如下：
EnableEurekaServerSpringBootApplicationpublicclassRegisterServiceApplicationpublicstaticvoidmain（Stringargs）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的规范定义接口，以方便对某一类资源的请求做统一的权限配置。
同时在应用端，某用户登录进来后能够访问的菜单也是通过授权服务控制。
菜单资源包括菜单的名称，图标，跳转路径等属性。
应用端通过授权得到的菜单属性，并决定菜单界面的布局。
菜单对象定义如下：
publicclassMenuprivateIntegerid;
privateStringmenuname;
privateIntegerparentid;
privateStringmenucode;
privateStringmenuurl;
privateStringmenuicon;
privateStringurltarget;
privateIntegerisactive;
privateIntegernavmenu;
privateIntegerisleaf;
privateIntegerviewtype;
privateIntegersort;
privateStringremark;
privateStringcreator;
privateStringmodified;
privateDatecreatetime;
privateDatelastupdate;
7持续集成持续集成项目开发完成后，通过jenkins持续集成，打包成docker镜像后上传到服务器上的dockerrepository后运行，所以需要在pom.xml文件里配置mavendocker插件。
Pom.xml关键配置：
src/main/resources*/*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会通知远程服务下载该镜像并重新运行。
8集成集成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内容：
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（intcity_id）;
voidinsertCity（Citycity）;
voiddeleteCityById（intcity_id）;
附录一：
完整附录一：
完整pom.xml4.0.0com.drhtspring-boot-demospring-boot-demospring-boot-starter-parentUTF-81.8spring-boot-starter-webmybatis-spring-boot-starter1.3.0mybatis-spring-boot-starter-test1.3.0mysqlmysql-connector-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-demo源码（略）源码（略）
升级会员 