《微服务开发手册范本》由会员分享，可在线阅读，更多相关《微服务开发手册范本（25页珍藏版）》请在金锄头文库上搜索。
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. 服务名 为父包名，如com.drht.auth，后面再跟具体模块名称作为子包名。 所有项目基于jdk1.8来开发。项目的管理与构建采用maven，代码统一托管于gitlab仓库。2 rest api接口规范spring boot接口设计需符合restful风格。在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。 而客户端要执行某种类型的操作
3、，需要根据http的操作协议来决定。HTTP提供了常用的几种操作，如下表：动作说明GET（SELECT）从服务器取出资源（一项或多项）POST（CREATE）在服务器新建一个资源。PUT（UPDATE）在服务器更新资源（客户端提供改变后的完整资源）。PATCH（UPDATE）在服务器更新资源（客户端提供改变的属性）。DELETE（DELETE）从服务器删除资源。对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP 动作。对于更新动作，参数通过requestbody来传递，格式为json。服务端返回数据格式也均为json。服务端返回数据对象约定：public class UnifyInfo
4、 private int code; /返回代码，1：成功，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
5、:1,message:查询成功,prompt:,path:,users:查询指定ID的用户POST /usersusername:user2,email:code:0,message:创建用户失败,prompt:该用户已经存在,path:http:/localhost:8080/users,result:创建一个用户PUT /users/IDusername:user2,email:code:1,message:创建用户成功,prompt:,path:,result:更新某用户信息PATCH /users/IDusername:user2,email:code:1,message:更新成功,p
6、rompt:,path:,result:更新某用户指定字段DELETE /users/IDcode:1,message:删除成功,prompt:,path:,result:删除指定用户而对于登录、登出操作，可以理解为登录是创建token,登出是删除token,所以可以用POST和DELETE来定义这两种接口。刷新token是更新操作所以用PUT。3 配置文件管理所有服务的配置文档均保存于gitlab上，并通过配置服务config-service来获取配置。每个服务在gitlab均保存一份以服务id命名的properties文件。以服务spring-boot-demo为例 ，其在gitlab上的
7、配置文件为spring-boot-demo.properties ，文件名对应于该服务的bootstrap.properties中配置的spring.application.name的value值。如果名称不一致，配置服务将拿不到正确的配置信息。在spring-boot-demo.properties中通常配置该服务的启动端口、数据库连接参数等信息。 当该文件有更新并push到gitlab后，配置服务会自动通知客户端服务更新配置信息。关键配置：在主程序中需要访问配置文件的类名上加上注解：RefreshScope，如果没有该注解，配置服务将不能主动通知客户端服务更新配置。 如下：RefreshS
8、copeRestControllerpublic 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关键依赖项： org.springframework.cloud sp
9、ring-cloud-config-client org.springframework.bootspring-boot-starter-actuator同时需要引入spring cloud 的依赖项org.springframework.cloudspring-cloud-dependenciesCamden.SR5pomimport在src/main/resouce目录建立bootstrap.properties文件，设置配置服务url与service id。bootstrap.properties文件内容：#配置服务地址spring.cloud.config.uri =http:/172
10、.168.4.43:9999#service namespring.application.name=spring-boot-demo注：不能在application.properties设置配置服务的url,因为application.properties的启动优先级最低，不能在程序启动之前读取到配置服务url,从而不能加载配置服务上相应的配置。4 服务注册register-service提供服务的注册与发现。所有的服务都需要注册到register-service中，否则不能够被其他服务发现与调用，比如路由服务。关键配置pom.xml关键依赖项：org.springframework.clo
11、udspring-cloud-starter-eureka-server同时需要引入spring cloud 的依赖项org.springframework.cloudspring-cloud-dependenciesCamden.SR5pomimport主程序加上注解：EnableEurekaServer 如下：EnableEurekaServerSpringBootApplicationpublic class RegisterServiceApplication public static void main(String args) SpringApplication.run(RegisterServiceApplication.class, args); 对应配置服务器上的spring-boot-demo.properties中添加注册服务的地址。spring-boot-demo.properties配置如下：#服务启动端口server.port=8082#注册服务地址eureka.client.serviceUrl.defaultZone=http:/172.168.4.43:9998/eureka/5 统一网关路由所有rest请求均需要通过网关来路由到具体的服务。网关服务能起到负载均衡、动态路由、统一认证等功能。使用代理服务
