您的当前位置：首页微服务开发手册

微服务开发手册

来源：华佗小知识

微服务开发手册

1．开发说明

● 所有服务均基于spring boot框架开发。Spring boot内嵌了tomcat服务器，无需生成war包，并简化了maven配置，能够让开发者快速入手spring的开发。

● 服务的接口定义需严格符合restful 规范。rest规范参考第2节

● 所有服务都需要在注册服务上注册，否则不能被其他服务所调用。同时平台也能够实时监测服务的状态，能够及时预警及调度资源。

● 所有服务的配置信息统一保存于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提供了常用的几种操作，如下表：动作 GET（SELECT） POST（CREATE） PUT（UPDATE）说明从服务器取出资源（一项或多项）在服务器新建一个资源。在服务器更新资源（客户端提供改变后的完整资源）。 PATCH（UPDATE）在服务器更新资源（客户端提供改变的属性）。 DELETE（DELETE）

对数据库的增删改查操作，应该严格遵守上面定义的五种HTTP 动作。

对于更新动作，参数通过requestbody来传递，格式为json。服务端返回数据格式也均为json。

服务端返回数据对象约定：

public class UnifyInfo { 21

private int code; //返回代码，1：成功，0：失败 private String message;//返回信息提示 private String prompt;//

private String path;//一般用于错误时的跳转路径

从服务器删除资源。 -

}

private HashMap attribute;//一般用于查询时的返回数据内容

Spring boot 会自动将符合javabean格式的对象转换为json格式数据返回。示例：客户端请求 GET /users 请求参数服务端返回数据 {\"code\":\"1\查询成功\ GET /users/ID {\"code\":\"1\查询成功\ 说明查询所有用户查询指定ID的用户 POST /users {\"username\":\"user2\mail\":\"666633433@qq.com\ {\"code\":\"0\创建用户失败\该用户已经存在\ult\":{}} PUT /users/ID {\"username\":\"user2\mail\":\"666633433@qq.com\ PATCH /users/ID {\"username\":\"user2\mail\":\"666633433@qq.com\ DELETE /users/ID

而对于登录、登出操作，可以理解为登录是创建token,登出是删除token,所以可以用POST和DELETE来定义这两种接口。刷新token是更新操作所以用PUT。

{\"code\":\"1\删除成功\ {\"code\":\"1\更新成功\ {\"code\":\"1\创建用户成功\ 更新某用户信息更新某用户指定字段删除指定用户创建一个用户 21

3．配置文件管理

所有服务的配置文档均保存于gitlab上，并通过配置服务config-service来获取配置。每个服务在gitlab均保存一份以服务id命名的properties文件。

以服务spring-boot-demo为例，其在gitlab上的配置文件为

spring-boot-demo.properties ，文件名对应于该服务的bootstrap.properties中配置的spring.application.name的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; } }

当spring-boot-demo.properties文件里的message变量发生变化后，请求/message时返回的message值将是更新后的message内容。

pom.xml关键依赖项：

org.springframework.cloud

spring-cloud-config-client

org.springframework.boot

spring-boot-starter-actuator

同时需要引入spring cloud 的依赖项

org.springframework.cloud spring-cloud-dependencies Camden.SR5 pom import

在src/main/resouce目录建立bootstrap.properties文件，设置配置服务url与service id。

bootstrap.properties文件内容： #配置服务地址

spring.cloud.config.uri =http://172.168.4.43:9999 #service name

spring.application.name=spring-boot-demo

注：不能在application.properties设置配置服务的url,因为application.properties的启动优先级最低，不能在程序启动之前读取到配置服务url,从而不能加载配置服务上相应的配置。

4．服务注册

关键配置 pom.xml关键依赖项： 21

org.springframework.cloud

spring-cloud-starter-eureka-server

同时需要引入spring cloud 的依赖项

org.springframework.cloud spring-cloud-dependencies Camden.SR5 pom import

主程序加上注解：@EnableEurekaServer 如下：

@EnableEurekaServer @SpringBootApplication

public class RegisterServiceApplication {

public static void main(String[] args) {

SpringApplication.run(RegisterServiceApplication.class, args); 21

} }

对应配置服务器上的spring-boot-demo.properties中添加注册服务的地址。 spring-boot-demo.properties配置如下：

#服务启动端口 server.port=8082 #注册服务地址

eureka.client.serviceUrl.defaultZone=http://172.168.4.43:9998/eureka/

5．统一网关路由

所有rest请求均需要通过网关来路由到具体的服务。网关服务能起到负载均衡、动态路由、统一认证等功能。

使用代理服务能够避免必须的跨域资源共享（Cross-Origin Resource Sharing）。当一个UI应用调用一个或更多的后端服务的时候，通过网关服务来做统一的代理。前端应用不再需要关心后台业务服务的具体地址，因此当业务服务的地址变更后也不需要修改应用端的配置。

所有的请求都在网关做了统一的认证授权，因此业务服务也不再需要考虑与授权有关的问题。

按照约定, 一个serviceid为\"userservice\"的服务会收到 /userservice请求路径的代理请求(前缀会被剥离)。因此要查询用户ID是590d38b0328b1aac828ae6的信息，完整的请求路径是

http://:/userservice/users/590d38b0328b1aac828ae6 21

其中userservice是user service的sericeid,users/{id}是该服务提供的对外访问接口。网关服务会自动根据请求路径里的serviceid（本例中是userservice）找到userservice的请求地址，并路由给该服务的users/{id}接口，其最终的路由地址是

注：url不包括/userservice。

而网关服务能够正确路由的前提是userservice已经在注册服务上注册。

6．认证授权

对于某用户的授权分为两类，一类是该用户是否能够访问某些url,一类是它在界面上所能看到哪些功能（即菜单）。

应用端访问后台服务时均需要经过授权服务auth-service 认证才能访问服务的资源。授权服务对资源的访问控制通过uri + serviceid + HTTP METHOD来控制，

如角色ROLE_USER的资源权限为服务名为userservice的user/*, 请求方式为ALL ,则其对所有userservice服务的uri为user/形式的资源均有权访问。如 POST

所以在设计api接口时，需严格按照第一节中rest api的规范定义接口，以方便对某一类资源的请求做统一的权限配置。

同时在应用端，某用户登录进来后能够访问的菜单也是通过授权服务控制。菜单资源包括菜单的名称，图标，跳转路径等属性。应用端通过授权得到的菜单属性，并决定菜单界面的布局。

菜单对象定义如下： public class Menu { private Integer id; private String menuname; 21

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 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

**/*

false

src/main/java

**/*.properties **/*.xml

false

org.springframework.boot spring-boot-maven-plugin

true

com.spotify

docker-maven-plugin

0.4.11

172.168.4.43:5000/${project.artifactId}

src/main/docker true

${project.build.directory}

${project.build.finalName}.jar

在src/main/下建立docker目录，并新建Dockerfile，内容如下：

FROM java:8 VOLUME /tmp

ADD spring-boot-demo-0.0.1-SNAPSHOT.jar app.jar EXPOSE 8080

CMD java -jar app.jar 21

当程序经过测试并提交到gitlab后，jenkins将自动构建并打包成docker镜像发布到远程docker仓库。同时jenkins会通知远程服务下载该镜像并重新运行。

8．集成mybatis

所有数据库操作采用Mybatis来管理。集成Mybatis关键配置如下：添加pom.xm依赖

org.mybatis.spring.boot

mybatis-spring-boot-starter 1.3.0

org.mybatis.spring.boot

mybatis-spring-boot-starter-test 1.3.0

mysql

mysql-connector-java 5.1.40

Spring-boot-demo.properties (托管于gitlab上,由配置服务统一管理)主要配置如下： mybatis.config-location=classpath:mybatis-config.xml logging.level.com.drht.demo.mapper=TRACE

spring.datasource.driverClass= com.mysql.jdbc.Driver spring.datasource.username=root spring.datasource.password=123456

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf-8

资源的配置结构如下图：

其中mybatis-config.xml内容：

PUBLIC \"-//mybatis.org//DTD Config 3.0//EN\" \"http://mybatis.org/dtd/mybatis-3-config.dtd\">

CittyMapper.xml内容如下：

PUBLIC \"-//mybatis.org//DTD Mapper 3.0//EN\" \"http://mybatis.org/dtd/mybatis-3-mapper.dtd\">

delete from city where id = #{id}

insert into City (id, name, state,country)

values (#{id,jdbcType=INTEGER}, #{name,jdbcType=VARCHAR}, #{state,jdbcType=VARCHAR}, #{country,jdbcType=VARCHAR})

该配置文件定义了三种数据库操作，对应了CityMapper这个接口中的三种方法

@Mapper

public interface CityMapper { }

City selectCityById(int city_id); void insertCity(City city); void deleteCityById(int city_id);

附录一：完整pom.xml

xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0

http://maven.apache.org/xsd/maven-4.0.0.xsd\">

4.0.0 com.drht

spring-boot-demo 0.0.1-SNAPSHOT spring-boot-demo

org.springframework.boot

spring-boot-starter-parent 1.5.1.RELEASE

UTF-8 1.8

org.springframework.boot spring-boot-starter-web

org.mybatis.spring.boot

mybatis-spring-boot-starter 1.3.0

org.mybatis.spring.boot

mybatis-spring-boot-starter-test 1.3.0

mysql

mysql-connector-java 5.1.40

org.springframework.boot spring-boot-starter-test test

org.springframework.cloud

spring-cloud-starter-config

org.springframework.boot

spring-boot-starter-actuator

org.springframework.cloud

spring-cloud-starter-eureka

org.springframework.cloud

spring-cloud-starter-eureka-server test

org.springframework.cloud spring-cloud-dependencies Camden.SR5 pom import

src/main/resources

**/*

false

src/main/java

**/*.properties **/*.xml

false

org.springframework.boot spring-boot-maven-plugin

true

com.spotify

docker-maven-plugin 0.4.11

172.168.4.43:5000/${project.artifactId}

src/main/docker true

${project.build.directory}

${project.build.finalName}.jar

附录二：spring-boot-demo源码（略）

因篇幅问题不能全部显示，请点此查看更多更全内容

查看全文