微服务开发手册
微服务开发手册
1．开发说明
●所有服务均基于spring boot框架开发。Spring boot内嵌了tomcat服务器，无需生成war 包，并简化了maven配置，能够让开发者快速入手spring的开发。
●服务的接口定义需严格符合restful 规范。rest规范参考第2节rest api 接口规范
●所有服务都需要在注册服务上注册，否则不能被其他服务所调用。同时平台也能够实时监测服务的状态，能够及时预警及调度资源。
●所有服务的配置信息统一保存于gitlab上，并通过配置服务获取配置。
●对数据库的操作统一采用MyBatis 框架。MyBatis 是个支持普通SQL查询，存储过程和高级映射的优秀持久层框架。Spring boot也提供了mybatis的集成方案，可以很快捷地整合mybatis到项目中。
●包名约定：所有包均以com.drht. 服务名为父包名，如com.drht.auth，后面再跟具体模块名称作为子包名。
●所有项目基于jdk1.8来开发。项目的管理与构建采用maven，代码统一托管于gitlab仓库。
2．rest api接口规范
spring boot接口设计需符合restful风格。在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。
而客户端要执行某种类型的操作，需要根据http的操作协议来决定。HTTP提供了常用的几种操作，如下表：
对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP 动作。
对于更新动作，参数通过requestbody来传递，格式为json。服务端返回数据格式也均为json。
服务端返回数据对象约定：
public class UnifyInfo {
private int code; //返回代码，1：成功，0：失败
private String message;//返回信息提示
private String prompt;//
private String path;//一般用于错误时的跳转路径
private HashMap
}
Spring boot 会自动将符合javabean格式的对象转换为json格式数据返回。
示例：
而对于登录、登出操作，可以理解为登录是创建token,登出是删除token,所以可以用POST和DELETE来定义这两种接口。刷新token是更新操作所以用PUT。
3．配置文件管理
所有服务的配置文档均保存于gitlab上，并通过配置服务config-service来获取配置。每个服务在gitlab均保存一份以服务id命名的properties文件。
以服务spring-boot-demo为例，其在gitlab上的配置文件为
spring-boot-demo.properties ，文件名对应于该服务的bootstrap.properties中配置的https://www.360docs.net/doc/f08808468.html,的value值。如果名称不一致，配置服务将拿不到正确的配置信息。
在spring-boot-demo.properties中通常配置该服务的启动端口、数据库连接参数等信息。当该文件有更新并push到gitlab后，配置服务会自动通知客户端服务更新配置信息。
关键配置：
在主程序中需要访问配置文件的类名上加上注解：@RefreshScope，如果没有该注解，配置服务将不能主动通知客户端服务更新配置。如下：
@RefreshScope
@RestController
public class MessageRestController {
@Value("${message:Hello default}")
private String message;
@RequestMapping("/message")
String getMessage() {
return this.message;