前言
目前很多的企业都开始使用SpringCloud全家桶的组件来搭建自己公司微服务架构,因为SpringCloud来源Spring,可以利用SpringBoot进行快捷开发,很多的组件都是对已有的开源框架的集成,社区也越来越强大,对于考虑使用成本和落地成本的中小企业非常合适。
搭建微服务框架使用的组件
组件 | 作用 |
---|---|
Eureka | 服务发现 |
Hystrix | 熔断器 |
Zuul | 动态路由 |
Spring Cloud config | 远程配置服务 |
Ribbon | 负载均衡 |
Feign | HTTP客户端 |
-
微服务架构下各个组件之间的交互流程图
一:搭建Eureka服务 ms-test-eureka
- 1:创建一个ms-eureka-server的SpringBoot项目,加入依赖,springboot版本要和springcloud版本能兼容,不然会启动报错
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
- 2:修改配置文件application.yml (将properties文件转为yml文件,这样看起来更有层次感)
server:
port: 8761 # 8761是eureka server的默认端口
eureka:
server:
enable-self-preservation: true
client:
service-url:
defaultZone: http://localhost:8761/eureka/ #这便是此eureka server的应用注册地址
register-with-eureka: false #默认设置下,eureka服务注册中心也会将自己做为客户端尝试注册自己,所以要禁止服务端的注册行为
fetchRegistry: false #注册中心的职责是维护实例,不需要去检索服务
spring:
application:
name: ms-eureka-server
- 3:Application主类加入 @EnableDiscoveryClient 注解
-
4:启动主类main方法,运行看到的效果如下就代表我们注册中心搭建成功
二:搭建配置中心服务 ms-config-server
1:创建一个ms-config-server的SpringBoot项目
2:pom文件加入EurekaClient和spring-config-server的依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-commons</artifactId>
</dependency>
3:修改配置文件,加入注入eureka的服务配置和要拉去的配置文件服务的地址,配置文件用户名和密码要用自己的数据
server:
port: 9002
spring:
application:
name: ms-config-server
cloud:
config:
server:
git:
uri: https://github.com/aixinjian/ms-test-config-file.git
username: ********
password: ********
default-label: master
search-paths: config
security:
user:
name: admin
password: admin
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/
instance:
prefer-ip-address: true
instance-id: ${spring.application.name}:${spring.cloud.client.ip-address}:${spring.application.instance_id:${server.port}}
appname: ms-eureka-server
- 4:application主类加入@EnableEurekaClient和@EnableConfigServer注解
-
5:启动,看注册中心注册列表里有实例的展示
三:测试配置服务中心正常运作
- 1:创建一个ms-config-client的springboot应用
- 2:加入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-commons</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
- 3:修改bootstartp.yml的配置
server:
port: 9003
spring:
application:
name: ms-config-client
cloud:
config:
discovery:
enabled: true
serviceId: ms-config-server
lable: master
profile: prod
eureka:
client:
serverUrl:
defaultZone: http://localhost:8761/eureka/
instance:
prefer-ip-address: true
instance-id: ${spring.application.name}:${spring.cloud.client.ip-address}:${spring.application.instance_id:${server.port}}
appname: ms-config-client
- 4:创建controller测试类
@RefreshScope
@RestController
@RequestMapping("/test")
public class TestController {
@Value("${data.name}")
private String name;
@GetMapping
public String test() {
System.out.println(name);
return name;
}
}
- 5:测试结果,把配置库的文件ms-config-client-prod.yml文件中的data.name的属性值读取出来
四:搭建消费者服务,使用Feign组件进行内部服务之间调用
- 1:为了省事,我们将已经搭好的ms-config-client当做一个服务提供者,提供所有的人员信息,人员信息必须通过ms-config-client服务获取,我们用Feign组件进行内部服务系统的调用
- 引入Feign组件依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 2:ms-config-client代码如下,为了方便直接定义几个用户实例返回:
@GetMapping
public List<UserVo> test() {
List<UserVo> userVos = Lists.newArrayList();
userVos.add(new UserVo("aixinjian",30));
userVos.add(new UserVo("lisi",22));
userVos.add(new UserVo("zhangshan",23));
return userVos;
}
- 3:创建一个ms-consumer-client的springboot应用,按照前面的创建项目工程的步骤加入到eureka注册中心
- 4:加入测试代码UserController类获取用户列表方法
@RestController
@Slf4j
@RequestMapping("/users")
public class UserController {
@Autowired
UserClient userClient;
@GetMapping
public List<UserVo> users() {
List<UserVo> users = userClient.getUserList();
return users;
}
}
-
5:用postman测试查看返回结果,能看到我们消费方从服务提供方获取的数据
五:使用zuul做API做网关服务
- 1:和上面类似创建一个ms-api-gateway的springboot项目,加入spring-cloud-starter-netflix-zuul依赖,该依赖包含了负载均衡组件依赖spring-cloud-starter-netflix-ribbon和熔断组件依赖spring-cloud-starter-netflix-hystrix
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
- 2:主类加入@EnableZuulProxy注解开启zuul的api网关功能
@EnableZuulProxy
@EnableDiscoveryClient
@SpringBootApplication
public class MsApiGatewayApplication {
public static void main(String[] args) {
SpringApplication.run(MsApiGatewayApplication.class, args);
}
}
- 3:在application.yml加入路由转发配置规则
zuul:
routes:
tms:
path: /consumer/**
serviceId: ms-consumer-client
-
4:通过psotman测试,可以通过网关服务(设置的端口9005)请求ms-consumer-client的接口,看到的返回结果
六:使用spring cloud Sleuth+zipkin实现服务链路跟踪
- 在企业应用中,随着公司的业务的发展,各种业务和服务越来越多,带来的服务之间的关系也越来越复杂,每一个前端的接口请求都会形成一条复杂的分布式服务调用链路,如果出现了问题,快速能定位问题就显得尤为重要,这就对整条的链路跟踪有个解决性的方案,我们可以使用spring cloud Sleuth+zipkin实现服务链路跟踪的需求
- 1:创建一个ms-zipkin-server的springboot服务
- 2:加入maven依赖(这里要注意springboot版本要和springcloud版本对应,不然会报很多的jar报冲突,我这里springboot用的版本2.1.11.RELEASE,springcloud用的Greenwich.SR4版本)
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.zipkin.java</groupId>
<artifactId>zipkin-server</artifactId>
<version>2.12.3</version>
</dependency>
<dependency>
<groupId>io.zipkin.java</groupId>
<artifactId>zipkin-autoconfigure-ui</artifactId>
<version>2.12.3</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-sleuth-zipkin</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-context</artifactId>
</dependency>
</dependencies>
- 3:bootstrap.yml加入配置文件
management:
metrics:
web:
server:
auto-time-requests: false
- 4:主类加入注解@EnableZipkinServer
- 5:启动,我们可以看到页面展示效果
- 6:在我们的其他服务上加入zipkin的发现依赖包
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zipkin</artifactId>
</dependency>
- 7:其他的服务加入zipkin服务的配置
spring:
zipkin:
base-url: http://localhost:9007
sleuth:
sampler:
percentage: 1.0
-
8:请求接口服务,我们就会发现zipkin的控制台的服务就加入了刚才产生请求消费请求的服务名称
-
9:可以查看具体接口请求的链路信息(具体里面的内容我们后面会开专题讲解)
七:结尾
这是一个简单的基于springcloud搭建的微服务框架,里面还有很多可以改造的地方,我们如果入手可以借鉴,代码地址在我github上:https://github.com/aixinjian,欢迎指教
参考资料
- SpringCloud官网: https://spring.io/projects/spring-cloud
- 《深入理解Spring Cloud与微服务构建》
- 《Spring Cloud微服务实战》
- https://github.com/cloudframeworks-springcloud/user-guide-springcloud