使用Alibaba Nacos体验第一个Spring Cloud微服务应用

5 篇文章 1 订阅
3 篇文章 0 订阅

下载并启动Nacos Server

下载Nacos Server

访问 https://github.com/alibaba/nacos/releases
因为写教程,我这里直接下载的是最新版2.1.1,不过不想打开github看,也可以直接点击下载链接
https://github.com/alibaba/nacos/releases/download/2.1.1/nacos-server-2.1.1.zip

安装Nacos Server

将nacos-server-2.1.1.zip解压,打开解压后的nacos目录,分别有bin/conf/target三个目录,LICENSE/NOTICE两个文件。
其中:

  • LICENSE 标识开源协议,Nacos使用的是Apache-2.0 协议
  • NOTICE 标识注意点,包含Nacos开发团队所使用的款原协议、使用了第三方的一些类库等信息。
  • bin 目录中是一些可执行文件,比如,startup、shutdown 标识启动/关闭脚本,后缀.sh表示unix系统,cmd表示Windows系统文件
  • conf 目录存放配置文件,包含Nacos日志级别、数据库相关配置、集群等相关配置、启动端口等。
  • target 目录存放Nacos生成的一些可执行文件,比如nacos-server.jar。startup.sh文件内部就会执行nacos-server.jar

启动服务

为了方便,我在自己电脑Windows平台执行运行的Nacos-server。那么就是执行/bin 目录下的startup.cmd文件,默认双击启动的是集群模式,我们这里按单机模式去启动。以管理员身份运行CMD窗口,进入bin目录,使用以下指令

startup.cmd -m standalone

如果是linux则使用以下命令

startup.sh -m standalone

standalone是单机模式,关于这个指令在startup.cmd中有说明

set MODE="cluster"

...
 
rem if nacos startup mode is standalone
if %MODE% == "standalone" (
    echo "nacos is starting with standalone"
	  set "NACOS_OPTS=-Dnacos.standalone=true"
    set "NACOS_JVM_OPTS=-Xms512m -Xmx512m -Xmn256m"
)

rem if nacos startup mode is cluster
if %MODE% == "cluster" (
    echo "nacos is starting with cluster"
	  if %EMBEDDED_STORAGE% == "embedded" (
	      set "NACOS_OPTS=-DembeddedStorage=true"
	  )

    set "NACOS_JVM_OPTS=-server -Xms2g -Xmx2g -Xmn1g -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=320m -XX:-OmitStackTraceInFastThrow -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=%BASE_DIR%\logs\java_heapdump.hprof -XX:-UseLargePages"
)

你也可以通过修改startup脚本的默认启动模式来运行单机模式。

运行成功后会出现以下界面

"nacos is starting with standalone"

         ,--.
       ,--.'|
   ,--,:  : |                                           Nacos 2.1.1
,`--.'`|  ' :                       ,---.               Running in stand alone mode, All function modules
|   :  :  | |                      '   ,'\   .--.--.    Port: 8848
:   |   \ | :  ,--.--.     ,---.  /   /   | /  /    '   Pid: 9756
|   : '  '; | /       \   /     \.   ; ,. :|  :  /`./   Console: http://172.16.86.19:8848/nacos/index.html
'   ' ;.    ;.--.  .-. | /    / ''   | |: :|  :  ;_
|   | | \   | \__\/: . ..    ' / '   | .; : \  \    `.      https://nacos.io
'   : |  ; .' ," .--.; |'   ; :__|   :    |  `----.   \
|   | '`--'  /  /  ,.  |'   | '.'|\   \  /  /  /`--'  /
'   : |     ;  :   .'   \   :    : `----'  '--'.     /
;   |.'     |  ,     .-./\   \  /            `--'---'
'---'        `--`---'     `----'

2022-09-20 11:36:13,131 INFO Tomcat initialized with port(s): 8848 (http)

2022-09-20 11:36:13,268 INFO Root WebApplicationContext: initialization completed in 2509 ms

2022-09-20 11:36:16,760 INFO Adding welcome page: class path resource [static/index.html]

2022-09-20 11:36:17,024 WARN You are asking Spring Security to ignore Ant [pattern='/**']. This is not recommended -- please use permitAll via HttpSecurity#authorizeHttpRequests instead.

2022-09-20 11:36:17,025 INFO Will not secure Ant [pattern='/**']

2022-09-20 11:36:17,046 INFO Will secure any request with [org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter@47874b25, org.springframework.security.web.context.SecurityContextPersistenceFilter@37ebc9d8, org.springframework.security.web.header.HeaderWriterFilter@549621f3, org.springframework.security.web.csrf.CsrfFilter@664a9613, org.springframework.security.web.authentication.logout.LogoutFilter@1fc0053e, org.springframework.security.web.savedrequest.RequestCacheAwareFilter@2416a51, org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter@6e9319f, org.springframework.security.web.authentication.AnonymousAuthenticationFilter@33617539, org.springframework.security.web.session.SessionManagementFilter@32232e55, org.springframework.security.web.access.ExceptionTranslationFilter@3c9168dc]

2022-09-20 11:36:17,063 INFO Exposing 1 endpoint(s) beneath base path '/actuator'

2022-09-20 11:36:17,102 INFO Tomcat started on port(s): 8848 (http) with context path '/nacos'

2022-09-20 11:36:17,128 INFO Nacos started successfully in stand alone mode. use embedded storage

2022-09-20 11:37:12,852 INFO Initializing Servlet 'dispatcherServlet'

2022-09-20 11:37:12,853 INFO Completed initialization in 1 ms

访问Nacos

启动成功后就可以访问Nacos管理界面了,默认帐号密码都是nacos
访问地址: http://localhost:8848/nacos

在这里插入图片描述

意外情况

我在解压Nacos后运行startup脚本的时候触发了一些意外情况导致启动失败,并且在查找资料的时候也发现了一些其他原因导致的启动失败,在这里罗列一下

  • Mac M1 笔记本的arm架构不兼容
  • Nacos安装目录存在中文
  • JDK版本过高(看到一个问题是jdk17启动不了)
  • JDK是x86的启动不了

其中,需要注意的是,如果重装了jdk并且配置了JAVA_HOME后,需要重启电脑,否则启动脚本获取不到JAVA_HOME环境变量。

启动Nacos Discovery Provider 进行服务注册

创建服务提供者NaocsProvider

本文使用的idea,操作步骤如下
注意下图最上方的Server URL,默认的start.spring.io因为是外网,经常连接超时,我改成了https://start.aliyun.com
在这里插入图片描述

点击下一步,通过搜索功能添加Nacos Service Discovery和Spring Web依赖,点击Finish
在这里插入图片描述
社区版idea不支持这个功能,这里我直接把pom.xml贴出来

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.wpx</groupId>
    <artifactId>NacosProvider</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>NacosProvider</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
        <spring-cloud-alibaba.version>2.2.2.RELEASE</spring-cloud-alibaba.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.3.7.RELEASE</version>
                <configuration>
                    <mainClass>com.wpx.nacosprovider.NacosProviderApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

编辑启动类,这里我直接贴代码,社区办的idea生成的项目可能不包含启动类,我把项目结构也贴出来

NacosProviderApplication

package com.wpx.nacosprovider;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

@SpringBootApplication // 启动一个Spring Boot应用。
public class NacosProviderApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosProviderApplication.class, args);
    }


    @RestController // 定义一个EchoController。
    class EchoController{

        @GetMapping("/echo") // /echo是EchoController对外暴露的访问路径。
        public String echo(HttpServletRequest request){
            return  "echo:" + request.getParameter("name"); // echo返回“echo:#{name 参数}”。
        }

    }

}

application.properties

# 应用名称
spring.application.name=NacosProvider
# Nacos帮助文档: https://nacos.io/zh-cn/docs/concepts.html
# Nacos认证信息
# spring.cloud.nacos.discovery.username=nacos
# spring.cloud.nacos.discovery.password=nacos
# Nacos 服务发现与注册配置,其中子属性 server-addr 指定 Nacos 服务器主机和端口
spring.cloud.nacos.discovery.server-addr=localhost:8848
# 注册到 nacos 的指定 namespace,默认为 public
spring.cloud.nacos.discovery.namespace=public
# 应用服务 WEB 访问端口
server.port=8080

项目结构
在这里插入图片描述

启动服务提供者Provider

在文件NacosProviderApplication上右键 Run 'NacosProviderApplication’启动服务,控制台打印以下内容即为启动成功
在这里插入图片描述
控制台中输出了一行日志表示服务成功注册到Nacos

nacos registry, DEFAULT_GROUP NacosProvider 172.16.86.2:8080 register finished

检查注册情况

访问nacos管理控制台,服务管理 ——> 服务列表 发现NacosProvider服务已经注册到Nacos上了
在这里插入图片描述

启动Nacos Discovery Consumer 进行服务发现

创建服务消费者Consumer

如上创建服务提供者,这里我们也选择Nacos Service Discovery和Spring Web依赖,点击Finish
在这里插入图片描述

在这里插入图片描述
同样,我把类、pom.xml、配置文件贴出来
NacosConsumerApplication

package com.wpx.nacosconsumer;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import javax.annotation.Resource;
import java.util.List;

@EnableDiscoveryClient(autoRegister = false) // 设置不自动注册到注册中心Nacos,因为这个项目本身是消费者,不向外暴露服务
@SpringBootApplication
public class NacosConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(NacosConsumerApplication.class, args);
    }

    @Bean  // 构建一个RestTemplate,后续用于访问HTTP服务
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

    @RestController
    class HelloController {

        @Resource   // 在HelloController中注入DiscoveryClient,这是Spring Cloud Commons模块提供的一个服务发现接口,
        // Spring Cloud Alibaba Nacos Discovery 模块内部会初始化一个它的实现类————NacosDiscoveryClient,
        // 用于后续的服务发现操作
        private DiscoveryClient discoveryClient;

        @Resource   // 在HelloController中注入前面构造的RestTemplate
        private RestTemplate restTemplate;

        private final String serviceName = "NacosProvider";

        @GetMapping("/info")
        public String info() {
            // 使用 DiscoveryClient 获取NacosProvider 服务对应的所有实例
            List<ServiceInstance> serviceInstances = discoveryClient.getInstances(serviceName);
            StringBuilder sb = new StringBuilder();
            sb.append("all service:").append(discoveryClient.getServices()).append(" <br/>");
            sb.append("NacosConsumer instance list:<br/>");
            // 遍历拿到的所有服务实例,获取对应的host和port
            serviceInstances.forEach(instance -> {
                sb.append("[ serviceId: ")
                        .append(instance.getServiceId())
                        .append(", host: ")
                        .append(instance.getHost())
                        .append(", port: ")
                        .append(instance.getPort())
                        .append(" ]<br/>");
            });
            return sb.toString();
        }

        @GetMapping("/hello")
        public String hello() {
            List<ServiceInstance> serviceInstances = discoveryClient.getInstances(serviceName);
            // 从服务实例中任意取出一个,没有则抛异常
            ServiceInstance serviceInstance = serviceInstances.stream()
                    .findAny()
                    .orElseThrow(() -> new IllegalStateException("no " + serviceName + " instance available"));
            // 使用RestTemplate调用服务实例对应的节点信息中的“/echo”方法
            return restTemplate.getForObject(
                    "http://" + serviceInstance.getHost() + ":" + serviceInstance.getPort() + "/echo?name=nacos", String.class);
        }

    }

}

application.properties

# 应用名称
spring.application.name=NacosConsumer
# 应用服务 WEB 访问端口
server.port=8081
# Nacos帮助文档: https://nacos.io/zh-cn/docs/concepts.html
# Nacos认证信息
# spring.cloud.nacos.discovery.username=nacos
# spring.cloud.nacos.discovery.password=nacos
# Nacos 服务发现与注册配置,其中子属性 server-addr 指定 Nacos 服务器主机和端口
spring.cloud.nacos.discovery.server-addr=localhost:8848
# 注册到 nacos 的指定 namespace,默认为 public
spring.cloud.nacos.discovery.namespace=public

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.wpx</groupId>
    <artifactId>NacosConsumer</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>NacosConsumer</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
        <spring-cloud-alibaba.version>2.2.2.RELEASE</spring-cloud-alibaba.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <version>2.3.7.RELEASE</version>
                <configuration>
                    <mainClass>com.wpx.nacosconsumer.NacosConsumerApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <id>repackage</id>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

启动服务消费者Consumer

在文件NacosConsumerApplication上右键 Run 'NacosConsumerApplication’启动服务,控制台打印以下内容即为启动成功
在这里插入图片描述
因为我们关闭了自动注册,所以控制台不会再输出像Provider中那一行注册成功的日志

通过服务消费者Consumer调用服务提供者Provider

启动NacosConsumer后访问 http://127.0.0.1:8081/hello 返回内容如下

echo:nacos

访问 http://127.0.0.1:8081/info 返回内容如下

all service:[NacosProvider]
NacosConsumer instance list:
[ serviceId: NacosProvider, host: 172.16.86.2, port: 8080 ]

github 链接

如果master分支代码不对,看一下其他分支

provide 服务提供者
https://github.com/wangpengxiang1996/NacosProvider

consumer 服务消费者
https://github.com/wangpengxiang1996/NacosConsumer

本文结束

下一篇
使用Netflix Eureka替换Alibaba Nacos注册中心

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值