总结spring-cloud-alibaba的基础使用方法

版本说明

从官方版本说明可以看出来，目前孵化器版本支持SpringCloud Finchley版本的是0.2.2.RELEASE。根据阿里的消息，目前apache孵化版本还没有正式毕业，还不推荐生产使用，生产还是建议使用提交apache之前的版本。

Nacos

安装启动

从Nacos发布页面下载Nacos服务器安装包，这里下载最新1.1.3版本

tar -zxvf nacos-server-1.1.3.tar.gz
cd nacos
# 单机模式启动，使用嵌入式DB存储配置信息
sh ./bin/startup.sh -m standalone

访问http://192.168.255.138:8848/nacos/，默认用户名密码nacos/nacos。

nacos集群搭建

Nacos三种部署模式

配置信息持久化

单机模式启动的nacos，配置信息存储在嵌入DB里面的，多个机器同时启动的话每个机器上的配置都是隔离的。如果要搭一个nacos集群，需要配置集群使用共同的DB来存储配置信息。

在安装包下conf/nacos-mysql.sql文件中存储了mysql脚本，直接执行就可以了

然后在conf/application.properties中配置mysql的连接信息

spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://localhost:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=root
db.password=

集群配置

cd conf
cp cluster.conf.example cluster.conf
vim cluster.conf
--------------------------------------
127.0.0.1:8841
127.0.0.1:8842
127.0.0.1:8843
--------------------------------------

# 如果是本地部署伪集群，可以复制bin/startup.sh并修改其中的端口号来启动多个nacos实例
cd ../bin
cp startup.sh startup-8841.sh
cp startup.sh startup-8842.sh
cp startup.sh startup-8843.sh

# 然后修改每个脚本中的启动命令，添加-Dserver.port=8841，就可以实现不同端口启动

# 启动3个实例
sh startup-8841.sh
sh startup-8842.sh
sh startup-8843.sh

最后对集群的所有节点通过nginx等方式来做负载均衡就可以了，在springcloud的应用中使用统一的配置中心的地址就好。

密码修改

通过代码的方式生成新密码，更新nacons_config.user密码信息

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

String rawPwd = "nacos";

//根据明文密码生成密文
BCryptPasswordEncoder encoder = new BCryptPasswordEncoder();
String pwd = encoder.encode(rawPwd);
System.out.println(pwd);

//每次生成的密文都不一样，用matches方法判断密文是否匹配明文
boolean match = encoder.matches(rawPwd,pwd);
System.out.println(match);

use nacos_config;
update users set password = '$2a$10$hdcmYyrqfH.0EaMloegpzesoV1xWVH5Cs9QOuk1r0bRec/I7jV16W' where username = 'nacos';

nacos作为注册中心的代码示例

代码示例

服务

pom引用

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

入口类添加@EnableDiscoveryClient注解，向注册中心注册服务

服务controller代码很简单

@Slf4j
@RestController
public class HiController {
    @Value("${server.port}")
    String port;

    @GetMapping("/hi")
    public String hi(@RequestParam String name) {
        log.info("invoked name = " + name);
        return String.format("hi %s, i'm from port %s",name,port);
    }
}

配置文件中指定nacos注册中心地址

spring.application.name=service-hi
server.port=8001
spring.cloud.nacos.discovery.server-addr=192.168.255.138:8848

客户端

客户端调用服务端有4种方式，都可以实现负载均衡

pom引用

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>

    <!--使用WebClient.Builder的依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-webflux</artifactId>
    </dependency>

    <!--使用feign的依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

入口类添加@EnableDiscoveryClient来向nacos注册中心注册，如果使用feign客户端的话需要添加@EnableFeignClients注解扫描feign代理接口

@EnableDiscoveryClient
@SpringBootApplication
@EnableFeignClients
public class ServiceHiClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(ServiceHiClientApplication.class,args);
    }
}

controller中使用4种方式来调用服务端

@Slf4j
@RestController
public class HiController {
    @Autowired
    LoadBalancerClient loadBalancerClient;

    @GetMapping("/hi-1")
    public String hi1(){
        //1. 通过spring cloud负载均衡客户端来调用服务
        ServiceInstance serviceInstance = loadBalancerClient.choose("service-hi");
        String url = serviceInstance.getUri() + "/hi?name=john";
        RestTemplate restTemplate = new RestTemplate();
        return restTemplate.getForObject(url, String.class);
    }


    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
    @Autowired
    RestTemplate restTemplate;

    @GetMapping("/hi-2")
    public String hi2(){
        //2. 通过负载均衡RestTemplate来调用服务
        return restTemplate.getForObject("http://service-hi/hi?name=john",String.class);
    }


    @Bean
    @LoadBalanced
    public WebClient.Builder loadBalancedWebClientBuilder() {
        return WebClient.builder();
    }
    @Autowired
    private WebClient.Builder webClientBuilder;

    @GetMapping("/hi-3")
    public Mono<String> hi3(){
        //3. 通过spring5提供的webclient来调用服务
        // 需要引入spring-boot-starter-webflux依赖包
        return webClientBuilder.build().get().uri("http://service-hi/hi?name=john").retrieve().bodyToMono(String.class);
    }


    @Autowired
    ServiceHi serviceHi;

    @GetMapping("/hi-4")
    public String hi4(){
        //4. 通过Feign客户端来调用服务
        // 应用入口类添加@EnableFeignClients开启Feign客户端扫描
        // 定义一个service-hi服务的feign代理接口
        // @Autowired注入接口实例
        return serviceHi.hi("john");
    }
}

使用第4种方式feign客户端时定义的feign客户端接口如下

@FeignClient("service-hi")
public interface ServiceHi{
    @GetMapping("/hi")
    String hi(@RequestParam(name = "name") String name);
}

配置文件中同样指定nacos注册中心地址

spring.application.name=service-hi-client
server.port=8003
spring.cloud.nacos.discovery.server-addr=192.168.255.138:8848

测试

1.启动nacos服务器，使用nacos/nacos登录管理控制台http://192.168.255.138:8848/nacos/

2.分别用2个端口8001,8002启动服务service-hi，观察nacos管理控制台服务列表

3.启动客户端service-hi-client，观察nacos管理控制台服务列表

4.调用service-hi-client接口测试4种方式调用服务

curl http://localhost:8003/hi-1
curl http://localhost:8003/hi-2
curl http://localhost:8003/hi-3
curl http://localhost:8003/hi-4

nacos作为配置中心的代码示例

配置中心添加配置

在nacos管理控制台配置列表菜单页面，点击右侧加号添加配置项，Data ID填写一个名称（xxx.properties），这个名称xxx需要跟即将使用这个配置的应用的名称保持一致，这个应用会使用这个唯一的配置项；Group保持默认，配置格式选择properties，这样一个应用就可以使用这个配置项了，我们在里面随便写几个配置信息：

testKey1=testValue1
testKey2=testValue2

配置中心的几个概念：

  • Data ID

Data ID可以理解为就是一个Spring Cloud应用的配置文件名，服务本地配置文件中可以指定使用哪个配置项，不指定的话会使用默认的配置项（就是${spring.application.name}.properties）。完整的Data ID其实还包含环境信息，${spring.cloud.nacos.config.prefix}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}。

# 默认配置文件名称就是应用名称
spring.cloud.nacos.config.prefix=${spring.application.name}
# 默认配置文件扩展名为properties
spring.cloud.nacos.config.file-extension=properties
  • Group

可以指定配置分组，不指定的话使用默认值DEFAULT_GROUP

# 默认的配置分组是DEFAULT_GROUP
spring.cloud.nacos.config.group=DEFAULT_GROUP
  • Namespace

默认只有一个命名空间public，可以通过命名空间来进行配置隔离，不同的namespace下面可以出现相同的Group和Data ID

# 指定使用哪个配置命名空间，不指定则使用默认的public命名空间
# 这里使用命名空间的ID而不是名称
spring.cloud.nacos.config.namespace=3b4b0a9c-b249-439a-aedb-dbeda495dbd3

应用中使用配置

pom依赖中引入nacos-config组件

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!--nacos注册中心客户端依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>
    <!--nacos配置中心客户端依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

入口类很简单，仅启用服务发现

@EnableDiscoveryClient
@SpringBootApplication
public class ConfigClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigClientApplication.class,args);
    }
}

controller中直接通过@Value来注入配置信息，为了能够实现配置的实时刷新，还需要添加@RefreshScope注解

@RestController
@RefreshScope
public class ConfigController {
    @Value("${testKey1}")
    String testValue1;

    @GetMapping("/getTestKey1")
    public String getTestKey1(){
        return testValue1;
    }
}

配置文件中需要指定注册中心和配置中心地址，而且为了本地配置文件的加载顺序在最前，本地配置文件名称需要使用bootstrap.properties

spring.application.name=config-client
server.port=8004
spring.cloud.nacos.discovery.server-addr=192.168.255.138:8848
spring.cloud.nacos.config.server-addr=192.168.255.138:8848

多环境配置

配置的多环境有3种实现方式

  • 1.通过Data ID区分环境

在springcloud的应用中通过spring的方式指定环境spring.profiles.active=dev，默认会查找nacos配置中心public命名空间下面的${spring.application.name}-dev.properties。所以在nacos配置中心新增一个以对应环境命名Data ID的配置项即可。

完整的配置项Data ID格式为：${spring.cloud.nacos.config.prefix}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}

  • 2.通过Group来实现
# 不同的环境使用不同的group
spring.cloud.nacos.config.group=DEV_GROUP
  • 3.通过Namespace来实现（官方建议的方式）
# 不同的环境使用不同的namespace
# 如果多环境配置打成一个jar包通过`java -Dspring.profiles.active=dev -jar xxx.jar`方式来启动的话，需要在项目中创建每个环境的配置文件（bootstrap-dev.properties），里面设置对应环境的命名空间
spring.cloud.nacos.config.namespace=3b4b0a9c-b249-439a-aedb-dbeda495dbd3

不同应用共享配置

通过加载扩展配置的方式，不同的应用可以加载相同的配置项，也可以支持动态刷新，或者使用shared-dataids来实现

# 通过扩展配置来实现应用之间共享配置项
spring.cloud.nacos.config.ext-config[0].data-id=actuator.properties
spring.cloud.nacos.config.ext-config[0].group=DEFAULT_GROUP
spring.cloud.nacos.config.ext-config[0].refresh=true
spring.cloud.nacos.config.ext-config[1].data-id=log.properties
spring.cloud.nacos.config.ext-config[1].group=DEFAULT_GROUP
spring.cloud.nacos.config.ext-config[1].refresh=true

# 也可以通过下面这种更简便的方式实现共享
spring.cloud.nacos.config.shared-dataids=actuator.properties,log.properties
spring.cloud.nacos.config.refreshable-dataids=actuator.properties,log.properties

配置加载的优先级

  • A: 通过spring.cloud.nacos.config.shared-dataids定义的共享配置
  • B: 通过spring.cloud.nacos.config.ext-config[n]定义的加载配置
  • C: 通过内部规则（spring.cloud.nacos.config.prefix、spring.cloud.nacos.config.file-extension、spring.cloud.nacos.config.group这几个参数）拼接出来的配置

优先级关系为：A < B < C

参考

spring-cloud-alibaba-wiki

spring-cloud-alibaba-examples

使用Nacos实现服务注册与发现

nacos文档

Spring-Cloud-Alibaba 系列