Spring-cloud 学习笔记
2021-03-17 11:17:24 31 举报
AI智能生成
springboot/cloud 学习笔记
作者其他创作
大纲/内容
POM中的SpringCloud依赖
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.6.RELEASE</version>
</parent>
<dependencyManagement>
<dependencies>
<!-- 导入Spring Cloud的依赖管理 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Finchley.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.6.RELEASE</version>
</parent>
<dependencyManagement>
<dependencies>
<!-- 导入Spring Cloud的依赖管理 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Finchley.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
eureka/zookeeper/consul
eureka
使用步骤
pom依赖
服务端
<dependencies>
<!--springboot 整合eureka服务端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
<!--springboot 整合eureka服务端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
客户端
<dependencies>
<!--springboot 整合eureka客户端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--springboot 整合eureka客户端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
启动类注解
服务端
@SpringBootApplication
@EnableEurekaServer //声明这是一个Eureka服务
@EnableEurekaServer //声明这是一个Eureka服务
客户端
@SpringBootApplication//申明这是一个Spring Boot项目
@EnableEurekaClient//开启Eureka客户端注解
@EnableEurekaClient//开启Eureka客户端注解
配置文件
服务端
###服务端口号
server.port=8100
###服务名称
spring.application.name=app-eureka-center
#注册中心地址
eureka.instance.hostname=eureka1
###客户端调用地址
eureka.client.serviceUrl.defaultZone=http://eureka2:8200/eureka/
###是否将自己注册到Eureka服务中(集群的时候为true)
eureka.client.register-with-eureka=true
###是否从Eureka中获取注册信息,因为自己为注册中心,不会在该应用中的检索服务信息
eureka.client.fetch-registry=true
###关闭自我保护
eureka.server.enableSelfPreservation=false
server.port=8100
###服务名称
spring.application.name=app-eureka-center
#注册中心地址
eureka.instance.hostname=eureka1
###客户端调用地址
eureka.client.serviceUrl.defaultZone=http://eureka2:8200/eureka/
###是否将自己注册到Eureka服务中(集群的时候为true)
eureka.client.register-with-eureka=true
###是否从Eureka中获取注册信息,因为自己为注册中心,不会在该应用中的检索服务信息
eureka.client.fetch-registry=true
###关闭自我保护
eureka.server.enableSelfPreservation=false
客户端
server:
port: 8081
###服务名-注册到Eureka
spring:
application:
name: service-item
###注册中心地址
eureka:
client:
service-url:
###注册中心地址,多个注册中心用逗号隔开
defaultZone: http://127.0.0.1:8100/eureka,http://127.0.0.1:8200/eureka
###注册到服务中心
register-with-eureka: true
###从eureka上检索服务
eureka.client.fetch-registry: true
port: 8081
###服务名-注册到Eureka
spring:
application:
name: service-item
###注册中心地址
eureka:
client:
service-url:
###注册中心地址,多个注册中心用逗号隔开
defaultZone: http://127.0.0.1:8100/eureka,http://127.0.0.1:8200/eureka
###注册到服务中心
register-with-eureka: true
###从eureka上检索服务
eureka.client.fetch-registry: true
zookeeper
使用步骤
consul
使用步骤
feign
使用步骤
pom依赖
<!--springboot 整合fegnin客户端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
启动类中提供restTemplate
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate(new OkHttp3ClientHttpRequestFactory());
//return new RestTemplate();
}
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate(new OkHttp3ClientHttpRequestFactory());
//return new RestTemplate();
}
启动类注解
@SpringBootApplication//申明这是一个Spring Boot项目
@EnableHystrix//开启断路器
@EnableEurekaClient//开启Eureka客户端注解
@EnableFeignClients(basePackages ="site.redstone.order.feign")
@EnableHystrix//开启断路器
@EnableEurekaClient//开启Eureka客户端注解
@EnableFeignClients(basePackages ="site.redstone.order.feign")
编写远程调用的服务本地接口类
public interface ItemFeignClient {
/**
* 这里定义了类似于SpringMVC用法的方法,就可以进行RESTful方式的调用了
* @param id
* @return
*/
@RequestMapping(value = "/item/{id}", method = RequestMethod.GET)
Item queryItemById(@PathVariable("id") Long id);
}
/**
* 这里定义了类似于SpringMVC用法的方法,就可以进行RESTful方式的调用了
* @param id
* @return
*/
@RequestMapping(value = "/item/{id}", method = RequestMethod.GET)
Item queryItemById(@PathVariable("id") Long id);
}
在上一步的接口类上打上注解
@FeignClient(value = "service-item",fallback = ItemServiceFallback.class)
//此处的value为远程服务在eureka中的注册名,fallback为远程服务调用失败后调用的降级方法的实现类
//使用降级需开启Hystrix并且在配置文件中加入
//###开启断路器
//feign.hystrix.enabled=true
eg:降级方法实现类
@Component
public class ItemServiceFallback implements ItemFeignClient {
@Override
public Item queryItemById(Long id) {
return new Item(null, "服务降级方法queryItemById", null, "服务降级方法queryItemById", null);
}
}
//此处的value为远程服务在eureka中的注册名,fallback为远程服务调用失败后调用的降级方法的实现类
//使用降级需开启Hystrix并且在配置文件中加入
//###开启断路器
//feign.hystrix.enabled=true
eg:降级方法实现类
@Component
public class ItemServiceFallback implements ItemFeignClient {
@Override
public Item queryItemById(Long id) {
return new Item(null, "服务降级方法queryItemById", null, "服务降级方法queryItemById", null);
}
}
ribbon
使用步骤
restTemplate注解
@LoadBalanced
zuul
使用步骤
pom依赖
<!--整合网关zuul-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
启动类注解
@EnableZuulProxy
@SpringBootApplication
@ComponentScan(basePackages = "site.redstone.gateway.filter") //扫描网关的过滤器包
@SpringBootApplication
@ComponentScan(basePackages = "site.redstone.gateway.filter") //扫描网关的过滤器包
编写过滤器(可选)
@Component
public class UserLoginFilter extends ZuulFilter {
/**
* filterType:返回字符串代表过滤器的类型
* a)pre:请求在被路由之前执行
* b)routing:在路由请求时调用
* c)post:在routing和error过滤器之后调用
* d)error:处理请求时发生错误调用
* @return
*/
@Override
public String filterType() {
return "pre";
}
/**
* 通过返回的int值来定义过滤器的执行顺序,数字越小优先级越高。
* @return
*/
@Override
public int filterOrder() {
return 0;
}
/**
*是否启动此过滤器
* @return
*/
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() throws ZuulException {
RequestContext requestContext = RequestContext.getCurrentContext();
HttpServletRequest request = requestContext.getRequest();
String token = request.getParameter("token");
if(StringUtils.isEmpty(token)){
requestContext.setSendZuulResponse(false); // 过滤该请求,不对其进行路由
requestContext.setResponseStatusCode(401); // 设置响应状态码
requestContext.setResponseBody(" please login first!!"); // 设置响应状态码
return null;
}
return null;
}
}
public class UserLoginFilter extends ZuulFilter {
/**
* filterType:返回字符串代表过滤器的类型
* a)pre:请求在被路由之前执行
* b)routing:在路由请求时调用
* c)post:在routing和error过滤器之后调用
* d)error:处理请求时发生错误调用
* @return
*/
@Override
public String filterType() {
return "pre";
}
/**
* 通过返回的int值来定义过滤器的执行顺序,数字越小优先级越高。
* @return
*/
@Override
public int filterOrder() {
return 0;
}
/**
*是否启动此过滤器
* @return
*/
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() throws ZuulException {
RequestContext requestContext = RequestContext.getCurrentContext();
HttpServletRequest request = requestContext.getRequest();
String token = request.getParameter("token");
if(StringUtils.isEmpty(token)){
requestContext.setSendZuulResponse(false); // 过滤该请求,不对其进行路由
requestContext.setResponseStatusCode(401); // 设置响应状态码
requestContext.setResponseBody(" please login first!!"); // 设置响应状态码
return null;
}
return null;
}
}
配置文件
路由规则
server:
port: 8087 #服务端口
spring:
application:
name: app-zuul-gateway #指定服务名
zuul:
routes: #定义服务转发规则
item-service: #item-service这个名字是任意写的
path: /service-item/** #匹配item-service的请求app-item服务
#url: http://127.0.0.1:8081 #真正的微服务地址
serviceid: service-item
order-service: #名字尽量和业务系统相关
path: /service-order/** #匹配order-service的请求app-order服务
serviceid: service-order
port: 8087 #服务端口
spring:
application:
name: app-zuul-gateway #指定服务名
zuul:
routes: #定义服务转发规则
item-service: #item-service这个名字是任意写的
path: /service-item/** #匹配item-service的请求app-item服务
#url: http://127.0.0.1:8081 #真正的微服务地址
serviceid: service-item
order-service: #名字尽量和业务系统相关
path: /service-order/** #匹配order-service的请求app-order服务
serviceid: service-order
eureka配置(可选)
###服务注册到eureka注册中心的地址
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8100/eureka/,http://127.0.0.1:8200/eureka/
###因为该应用为服务提供者,是eureka的一个客户端,需要注册到注册中心
register-with-eureka: true
###是否需要从eureka上检索服务
fetch-registry: true
instance:
prefer-ip-address: true #将自己的ip地址注册到Eureka服务中
ip-address: 127.0.0.1
instance-id: ${spring.application.name}###${server.port} #指定实例id
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8100/eureka/,http://127.0.0.1:8200/eureka/
###因为该应用为服务提供者,是eureka的一个客户端,需要注册到注册中心
register-with-eureka: true
###是否需要从eureka上检索服务
fetch-registry: true
instance:
prefer-ip-address: true #将自己的ip地址注册到Eureka服务中
ip-address: 127.0.0.1
instance-id: ${spring.application.name}###${server.port} #指定实例id
config
使用步骤
pom依赖
服务端
<!--整合配置中心-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
客户端
<!--spring cloud config-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-client</artifactId>
</dependency>
<!--引入actuator实现配置文件的动态更新-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
启动类注解
服务端
@EnableConfigServer
@SpringBootApplication
@EnableEurekaClient
public class ConfigApp {
public static void main(String[] args) {
SpringApplication.run(ConfigApp.class,args);
}
}
@SpringBootApplication
@EnableEurekaClient
public class ConfigApp {
public static void main(String[] args) {
SpringApplication.run(ConfigApp.class,args);
}
}
客户端
无
配置文件
服务端
server:
port: 7788 #服务端口
spring:
application:
name: service-config #指定服务名
cloud:
config:
server:
git: #配置git仓库地址
uri: https://gitee.com/redstone_hgw/spring-cloud-config.git
search-paths:
- service-item #配置文件目录地址
username: xxxxxxxxx@163.com#码云账号(公有项目不需要设置)
password: xxxxxxxxx #码云密码(公有项目不需要设置)
label: master #分支名称
port: 7788 #服务端口
spring:
application:
name: service-config #指定服务名
cloud:
config:
server:
git: #配置git仓库地址
uri: https://gitee.com/redstone_hgw/spring-cloud-config.git
search-paths:
- service-item #配置文件目录地址
username: xxxxxxxxx@163.com#码云账号(公有项目不需要设置)
password: xxxxxxxxx #码云密码(公有项目不需要设置)
label: master #分支名称
客户端
application.yml
server:
port: 8081
###服务名-注册到Eureka
spring:
application:
name: service-item
###注册中心地址
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8100/eureka,http://127.0.0.1:8200/eureka
###注册到服务中心
register-with-eureka: true
###从eureka上检索服务
eureka.client.fetch-registry: true
#开启所有端点 actuator配置
management:
endpoints:
web:
exposure:
include: "*"
port: 8081
###服务名-注册到Eureka
spring:
application:
name: service-item
###注册中心地址
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8100/eureka,http://127.0.0.1:8200/eureka
###注册到服务中心
register-with-eureka: true
###从eureka上检索服务
eureka.client.fetch-registry: true
#开启所有端点 actuator配置
management:
endpoints:
web:
exposure:
include: "*"
bootstrap.yml
###注册中心地址
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8100/eureka,http://127.0.0.1:8200/eureka
###注册到服务中心
register-with-eureka: true
###从eureka上检索服务
eureka.client.fetch-registry: true
###因为bootstrap文件在application.yml之前加载 因此此文件中也要配置eureka
spring:
cloud:
config:
#uri: http://127.0.0.1:7788/
name: config #对应配置中心的应用名称,默认是本应用名,即spring.application.name,该名称要和git中的配置一致
profile: dev #对应配置服务中的{profile}
label: master #对应的分支
discovery:
enabled: true #启用发现服务功能
service-id: service-config #指定配置中心工程的名称
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:8100/eureka,http://127.0.0.1:8200/eureka
###注册到服务中心
register-with-eureka: true
###从eureka上检索服务
eureka.client.fetch-registry: true
###因为bootstrap文件在application.yml之前加载 因此此文件中也要配置eureka
spring:
cloud:
config:
#uri: http://127.0.0.1:7788/
name: config #对应配置中心的应用名称,默认是本应用名,即spring.application.name,该名称要和git中的配置一致
profile: dev #对应配置服务中的{profile}
label: master #对应的分支
discovery:
enabled: true #启用发现服务功能
service-id: service-config #指定配置中心工程的名称
准备需要远程获取的配置
https://gitee.com/redstone_hgw/spring-cloud-config/raw/master/service-item/config-dev.properties
user.username=redstone
user.password=honggaowei
user.realname=redstone
user.age=26
user.welcome=welcome to spring cloud!
user.password=honggaowei
user.realname=redstone
user.age=26
user.welcome=welcome to spring cloud!
配置类注解
在需要获取的字段上使用@Value("${xxx}")注解
配置类也需要加上@Component注解加入到IOC的控制范围
eg:
@Value("${user.username}")
private String username;
如果此类需要在远程配置文件更改时自动更新,需要在类上同时加上@RefreshScope注解
配置类也需要加上@Component注解加入到IOC的控制范围
eg:
@Value("${user.username}")
private String username;
如果此类需要在远程配置文件更改时自动更新,需要在类上同时加上@RefreshScope注解
配置刷新
当更改了远程的配置文件时,如果希望当前系统中的使用@Value注解的类中的值相应更新的话
执行以下操作
Post http://127.0.0.1:8081/actuator/refresh
例如文件中的welcome更新了话,会收到以下返回
response:
[
"config.client.version",
"user.welcome"
]
执行以下操作
Post http://127.0.0.1:8081/actuator/refresh
例如文件中的welcome更新了话,会收到以下返回
response:
[
"config.client.version",
"user.welcome"
]
扩展:
Gitee提供hook:在仓库中的文件修改时,向指定的地址发送请求,因此可以在hook的url中配置上面的Post http://127.0.0.1:8081/actuator/refresh 以达到自动更新配置的需求
Gitee提供hook:在仓库中的文件修改时,向指定的地址发送请求,因此可以在hook的url中配置上面的Post http://127.0.0.1:8081/actuator/refresh 以达到自动更新配置的需求
hystrix
使用步骤
pom依赖
<!--整合hystrix-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
启动类注解
@SpringBootApplication//申明这是一个Spring Boot项目
@EnableHystrix//开启断路器
@EnableEurekaClient//开启Eureka客户端注解
@EnableFeignClients(basePackages ="site.redstone.order.feign")
@ComponentScan(basePackages = {"site.redstone.order.controller", "site.redstone.order.service"})
public class OrderApp {
public static void main(String[] args) {
SpringApplication.run(OrderApp.class, args);
}
/**
* 向Spring容器中定义RestTemplate对象
* @return
*/
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate(new OkHttp3ClientHttpRequestFactory());
//return new RestTemplate();
}
}
@EnableHystrix//开启断路器
@EnableEurekaClient//开启Eureka客户端注解
@EnableFeignClients(basePackages ="site.redstone.order.feign")
@ComponentScan(basePackages = {"site.redstone.order.controller", "site.redstone.order.service"})
public class OrderApp {
public static void main(String[] args) {
SpringApplication.run(OrderApp.class, args);
}
/**
* 向Spring容器中定义RestTemplate对象
* @return
*/
@Bean
@LoadBalanced
public RestTemplate restTemplate() {
return new RestTemplate(new OkHttp3ClientHttpRequestFactory());
//return new RestTemplate();
}
}
收藏
收藏
0 条评论
下一页