Nacos極簡教程

Naylor發表於2022-02-12

簡介

Nacos是服務發現與註冊，服務配置中心。

Nacos 具有如下特性:

服務發現和服務健康監測：支援基於DNS和基於RPC的服務發現，支援對服務的實時的健康檢查，阻止向不健康的主機或服務例項傳送請求；

動態配置服務：動態配置服務可以讓您以中心化、外部化和動態化的方式管理所有環境的應用配置和服務配置；

動態 DNS 服務：動態 DNS 服務支援權重路由，讓您更容易地實現中間層負載均衡、更靈活的路由策略、流量控制以及資料中心內網的簡單DNS解析服務；

服務及其後設資料管理：支援從微服務平臺建設的視角管理資料中心的所有服務及後設資料。

Nacos 為 C/S 架構，服務端 NacosServer 是一個 jar 包，客戶端直接整合在業務微服務中，一個業務微服務就是一個 NacosClient。

NacosServer

安裝目錄


├── bin
│   ├── logs
│   ├── shutdown.sh
│   ├── startup.sh
│   └── work
├── conf
│   ├── 1.4.0-ipv6_support-update.sql
│   ├── application.properties
│   ├── application.properties.example
│   ├── cluster.conf
│   ├── cluster.conf.example
│   ├── nacos-logback.xml
│   ├── nacos-mysql.sql
│   └── schema.sql
├── data
│   ├── config-data
│   ├── loader
│   ├── naming
│   ├── protocol
│   ├── tps
│   └── upgrade.state
├── NOTICE
├── status
│   └── heartBeat.txt
├── target
│   └── nacos-server.jar

bin/startup.sh：啟動nacos
bin/shutdown.sh：停止nacos
bin/logs：執行日誌
conf/application.properties：節點配置檔案
conf/clutser.conf：叢集配置檔案
data：執行時候資料，持久化資料。
target/nacos-server.jar ：nacosServer主程式

配置參考

application.properties配置參考：
一般情況下，主要配置 mysql 資料來源；ip and port；開啟所有監控端點。


#*************** Spring Boot Related Configurations ***************#
### Default web context path:
server.servlet.contextPath=/nacos
### Default web server port:
server.port=8848


#*************** Network Related Configurations ***************#
### If prefer hostname over ip for Nacos server addresses in cluster.conf:
# nacos.inetutils.prefer-hostname-over-ip=false

### Specify local server's IP:
nacos.inetutils.ip-address=192.168.1.188



#*************** Config Module Related Configurations ***************#
### If use MySQL as datasource:
spring.datasource.platform=mysql

### Count of DB:
db.num=1

### Connect URL of DB:
db.url.0=jdbc:mysql://192.168.1.235:3306/ngh-nacos-cluster?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
db.user.0=root
db.password.0=Yj6vT8CZlI%15IxV

### Connection pool configuration: hikariCP
db.pool.config.connectionTimeout=30000
db.pool.config.validationTimeout=10000
db.pool.config.maximumPoolSize=20
db.pool.config.minimumIdle=2



#*************** Metrics Related Configurations ***************#
### Metrics for prometheus
management.endpoints.web.exposure.include=*

### Metrics for elastic search
management.metrics.export.elastic.enabled=false
#management.metrics.export.elastic.host=http://localhost:9200

### Metrics for influx
management.metrics.export.influx.enabled=false

cluster.conf 配置參考：

#2022-02-09T15:48:27.383025
192.168.1.124:8848
192.168.1.130:8848
192.168.1.137:8848

常用命令

命令	說明	示例
sh startup.sh	啟動nacos，預設為叢集模式啟動
sh startup.sh -m standalone	單例項啟動nacos

常用介面

介面	作用	備註
http://192.168.1.199:8848/nacos/v1/cs/configs?dataId=app-dev.yaml&group=DEFAULT_GROUP	獲取配置詳情	Get請求
http://192.168.1.124:8848/nacos/v1/ns/instance?serviceName=nacos-client-user-service&ip=192.168.3.169&port=8818	服務註冊	put請求，若註冊成功介面返回ok
http://192.168.1.124:8848/nacos/v1/ns/instance/list?serviceName=nacos-client-user-service	服務發現	Get請求，根據serviceName獲取服務例項詳情

埠

埠	與主埠的偏移量	描述
8848		主埠，webui訪問埠，客戶端註冊埠
9848	1000	客戶端gRPC請求服務端埠，用於客戶端向服務端發起連線和請求
9849	1001	服務端gRPC請求服務端埠，用於服務間同步等
7848		7848 是 Nacos 叢集通訊埠，用於Nacos 叢集間進行選舉，檢測等

叢集部署

Nacos 原生支援高可用，部署叢集非常簡單，僅僅需要修改每一個節點的 cluster.conf 配置檔案即可，將所有節點（包括自己）ip:port 按行寫入此檔案即可。

/conf/cluster.conf

192.168.1.124:8848
192.168.1.130:8848
192.168.1.137:8848

客戶端在連線 NacosServer 的時候配置叢集中所有節點。

spring:
  application:
    name: nacos-client-user-service
  profiles:
    active: dev
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.1.124:8848,192.168.1.130:8848,192.168.1.137:8848
      config:
        server-addr: 192.168.1.124:8848,192.168.1.130:8848,192.168.1.137:8848
        file-extension: yaml

官方推薦的叢集部署方式是在 NacosServer 叢集上面搭建一個代理層，並對外提供一個域名給客戶端訪問。這種部署方式要求代理層也是高可用的，可選的方案有域名+ Vip+Nginx，相關埠需要層層暴露。

官方推薦叢集部署架構

WebUI

預設訪問地址： http://ip:8848/nacos
配置管理->配置列表：nacos作為統一配置中心管理的微服務配置檔案，儲存在mysql中
服務管理->服務列表：已註冊的微服務列表
叢集管理->節點列表：nacosServer 叢集節點展示。

NacosClient

以 SpringBoot 2.5.3 為例

pom

主要引入spring-boot-starter-web，spring-cloud-starter-alibaba-nacos-discovery，spring-cloud-starter-alibaba-nacos-config，spring-cloud-starter-bootstrap

    <properties>
        <java.version>11</java.version>
        <spring.cloud.dependencies>2020.0.3</spring.cloud.dependencies>
        <spring.cloud.alibaba.dependencies>2021.1</spring.cloud.alibaba.dependencies>
    </properties>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring.cloud.dependencies}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring.cloud.alibaba.dependencies}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <!-- nacos-discovery -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- nacos-config -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
    </dependencies>

bootstrap.yml

server:
  port: 8818
spring:
  application:
    name: nacos-client-user-service
  profiles:
    active: dev
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.1.124:8848,192.168.1.130:8848,192.168.1.137:8848
      config:
        server-addr: 192.168.1.124:8848,192.168.1.130:8848,192.168.1.137:8848
        file-extension: yaml
logging:
  level:
    com.alibaba.nacos.common.http.client: debug

主啟動類

需要增加 @EnableDiscoveryClient 註解

客戶端整合

啟動測試

啟動客戶端之前需要確保 NacosServer 叢集正常執行，各個節點的 WebUI 可以正常開啟，叢集管理--->節點列表中各個節點狀態為 UP。

啟動 SpringBoot 客戶端程式，若沒有報錯，在每一個節點服務管理--->服務列表中可以看到服務已經註冊成功。

若啟動失敗，報異常了，或者服務未在所有節點完成註冊，可通過如下思路排查：

詳細閱讀控制檯輸出日誌
使用postman訪問服務端提供的獲取配置詳情介面，測試是否可以通過直連某節點獲取到配置資訊
斷點除錯 NacosRestTemplate ，客戶端獲取服務配置檔案是通過訪問服務端http介面完成的，而客戶端發起請求是使用的NacosRestTemplate
確保埠可以連通，7848，8848，9849，9848
詳細閱讀 Nacos.log 和 access_log.2022-02-09.log
叢集心跳日誌在 nacos-cluster.log 中

問題記錄

報錯資訊

NacosServer 啟動報錯

Error: Could not find or load main class Caused by: 

java.lang.ClassNotFoundException:

解決辦法

/bin/startup.sh 修改為如下內容


#!/bin/bash
# Copyright 1999-2018 Alibaba Group Holding Ltd.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
cygwin=false
darwin=false
os400=false
case "`uname`" in
CYGWIN*) cygwin=true;;
Darwin*) darwin=true;;
OS400*) os400=true;;
esac
error_exit ()
{
    echo "ERROR: $1 !!"
    exit 1
}
[ ! -e "$JAVA_HOME/bin/java" ] && JAVA_HOME=$HOME/jdk/java
[ ! -e "$JAVA_HOME/bin/java" ] && JAVA_HOME=/usr/java
[ ! -e "$JAVA_HOME/bin/java" ] && JAVA_HOME=/opt/taobao/java
[ ! -e "$JAVA_HOME/bin/java" ] && unset JAVA_HOME
if [ -z "$JAVA_HOME" ]; then
  if $darwin; then
    if [ -x '/usr/libexec/java_home' ] ; then
      export JAVA_HOME=`/usr/libexec/java_home`
    elif [ -d "/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home" ]; then
      export JAVA_HOME="/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home"
    fi
  else
    JAVA_PATH=`dirname $(readlink -f $(which javac))`
    if [ "x$JAVA_PATH" != "x" ]; then
      export JAVA_HOME=`dirname $JAVA_PATH 2>/dev/null`
    fi
  fi
  if [ -z "$JAVA_HOME" ]; then
        error_exit "Please set the JAVA_HOME variable in your environment, We need java(x64)! jdk8 or later is better!"
  fi
fi
export SERVER="nacos-server"
export MODE="cluster"
export FUNCTION_MODE="all"
export MEMBER_LIST=""
export EMBEDDED_STORAGE=""
while getopts ":m:f:s:c:p:" opt
do
    case $opt in
        m)
            MODE=$OPTARG;;
        f)
            FUNCTION_MODE=$OPTARG;;
        s)
            SERVER=$OPTARG;;
        c)
            MEMBER_LIST=$OPTARG;;
        p)
            EMBEDDED_STORAGE=$OPTARG;;
        ?)
        echo "Unknown parameter"
        exit 1;;
    esac
done
export JAVA_HOME
export JAVA="$JAVA_HOME/bin/java"
export BASE_DIR=`cd $(dirname $0)/..; pwd`
export CUSTOM_SEARCH_LOCATIONS=file:${BASE_DIR}/conf/
#===========================================================================================
# JVM Configuration
#===========================================================================================
if [[ "${MODE}" == "standalone" ]]; then
    JAVA_OPT="${JAVA_OPT} -Xms512m -Xmx512m -Xmn256m"
    JAVA_OPT="${JAVA_OPT} -Dnacos.standalone=true"
else
    if [[ "${EMBEDDED_STORAGE}" == "embedded" ]]; then
        JAVA_OPT="${JAVA_OPT} -DembeddedStorage=true"
    fi
    JAVA_OPT="${JAVA_OPT} -server -Xms2g -Xmx2g -Xmn1g -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=320m"
    JAVA_OPT="${JAVA_OPT} -XX:-OmitStackTraceInFastThrow -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=${BASE_DIR}/logs/java_heapdump.hprof"
    JAVA_OPT="${JAVA_OPT} -XX:-UseLargePages"
fi
if [[ "${FUNCTION_MODE}" == "config" ]]; then
    JAVA_OPT="${JAVA_OPT} -Dnacos.functionMode=config"
elif [[ "${FUNCTION_MODE}" == "naming" ]]; then
    JAVA_OPT="${JAVA_OPT} -Dnacos.functionMode=naming"
fi
JAVA_OPT="${JAVA_OPT} -Dnacos.member.list=${MEMBER_LIST}"
JAVA_MAJOR_VERSION=$($JAVA -version 2>&1 | sed -E -n 's/.* version "([0-9]*).*$/\1/p')
if [[ "$JAVA_MAJOR_VERSION" -ge "9" ]] ; then
  JAVA_OPT="${JAVA_OPT} -Xlog:gc*:file=${BASE_DIR}/logs/nacos_gc.log:time,tags:filecount=10,filesize=102400"
else
  JAVA_OPT_EXT_FIX="-Djava.ext.dirs=${JAVA_HOME}/jre/lib/ext:${JAVA_HOME}/lib/ext"
  JAVA_OPT="${JAVA_OPT} -Xloggc:${BASE_DIR}/logs/nacos_gc.log -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+PrintGCTimeStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=10 -XX:GCLogFileSize=100M"
fi
JAVA_OPT="${JAVA_OPT} -Dloader.path=${BASE_DIR}/plugins/health,${BASE_DIR}/plugins/cmdb"
JAVA_OPT="${JAVA_OPT} -Dnacos.home=${BASE_DIR}"
JAVA_OPT="${JAVA_OPT} -jar ${BASE_DIR}/target/${SERVER}.jar"
JAVA_OPT="${JAVA_OPT} ${JAVA_OPT_EXT}"
JAVA_OPT="${JAVA_OPT} --spring.config.additional-location=${CUSTOM_SEARCH_LOCATIONS}"
JAVA_OPT="${JAVA_OPT} --logging.config=${BASE_DIR}/conf/nacos-logback.xml"
JAVA_OPT="${JAVA_OPT} --server.max-http-header-size=524288"
if [ ! -d "${BASE_DIR}/logs" ]; then
  mkdir ${BASE_DIR}/logs
fi
echo "$JAVA $JAVA_OPT_EXT_FIX ${JAVA_OPT}"
if [[ "${MODE}" == "standalone" ]]; then
    echo "nacos is starting with standalone"
else
    echo "nacos is starting with cluster"
fi
# check the start.out log output file
if [ ! -f "${BASE_DIR}/logs/start.out" ]; then
  touch "${BASE_DIR}/logs/start.out"
fi
# start
echo "$JAVA $JAVA_OPT_EXT_FIX ${JAVA_OPT}" > ${BASE_DIR}/logs/start.out 2>&1 &
nohup $JAVA $JAVA_OPT_EXT_FIX ${JAVA_OPT} nacos.nacos >> ${BASE_DIR}/logs/start.out 2>&1 &
echo "nacos is starting，you can check the ${BASE_DIR}/logs/start.out"

報錯資訊

客戶端啟動時候報錯

 failed to req API:/nacos/v1/ns/instance after all servers([192.168.1.169:8848]) tried: ErrCode:400, ErrMsg:<html><body><h1>Whitelabel Error Page</h1><p>This application has no explicit mapping for /error, so you are seeing this as a fallback.</p><div id='created'>Tue Feb 08 21:19:48 CST 2022</div><div>There was an unexpected error (type=Bad Request, status=400).</div><div>receive invalid redirect request from peer 127.0.0.1</div></body></html>
	at com.alibaba.nacos.client.naming.net.NamingProxy.reqApi(NamingProxy.java:556) ~[nacos-client-1.4.1.jar:na]
	at com.alibaba.nacos.client.naming.net.NamingProxy.reqApi(NamingProxy.java:498) ~[nacos-client-1.4.1.jar:na]
	at com.alibaba.nacos.client.naming.net.NamingProxy.reqApi(NamingProxy.java:493) ~[nacos-client-1.4.1.jar:na]
	at com.alibaba.nacos.client.naming.net.NamingProxy.registerService(NamingProxy.java:246) ~[nacos-client-1.4.1.jar:na]

解決辦法

刪除data資料夾重啟

Nacos 非常佔資源，Windows11 下，啟動就能把CPU佔到56%（酷睿I5-11代），啟動成功之後佔了1.7G的記憶體。此解決方法是百度出來的，首先停止 SpringBoot 程式、Nacos叢集；然後刪除三個例項下面的 data 資料夾並重新啟動叢集；最後重新啟動 SpringBoot。此時可以正常註冊到 Nacos 叢集中，每一個例項中的服務列表中都有該 SpringBoot 服務。

修改cluster.conf檔案

本來以為上述方法已經可以解決此問題，畢竟【百度】出來的！可是過了一會之後又報400問題，中間（應該）沒有特別特殊的操作，無非（可能）就是重啟 SpringBoot 服務，修改 Nacos 的 application.properties 檔案和重啟叢集等等。

重新排查了一遍，發現NacosWebUI中的叢集管理—>節點列表中多了一個例項，變成了四個，重新檢視了叢集 cluster.conf，發現每一個例項此配置檔案中都多了一行【192.168.1.169:8858】。這行（好像）不是我加的，但是不管怎麼說，這行都是不必須的，所以我決定刪除這行。首先停止 SpringBoot 程式、Nacos叢集；然後刪除三個例項下面的 data 資料夾，刪除 cluster.conf 檔案中無故（手殘新增）增加的那行，並重新啟動叢集；最後重新啟動 SpringBoot。此時可以正常註冊到 Nacos 叢集中，每一個例項中的服務列表中都有該 SpringBoot 服務

Nginx 極簡教程
2019-03-14
Nginx
Rust極簡教程
2022-03-29
Rust
AI 繪畫極簡教程
2022-07-04
AI
Rust-Sqlx極簡教程
2022-03-28
RustSQL
React極簡教程:Hello,World!
2017-03-04
React
nacos、ribbon和feign的簡明教程
2020-11-06
dockerfile-maven-plugin極簡教程
2020-10-12
DockerMavenPlugin
Shell程式設計——極簡教程
2018-04-08
程式設計
極簡程式碼神器：Lombok使用教程
2019-10-10
Lombok
vue-router路由之路-極簡教程
2022-12-15
Vue路由
SpringBoot2.0極簡教程
2017-11-21
Spring Boot
python極簡教程08：物件的方法
2022-01-20
Python物件
極簡Typescript+Node.js 安裝教程
2018-12-25
TypeScriptNode.js
最強人工智慧 OpenAI 極簡教程
2022-07-12
人工智慧OpenAI
2.Nacos簡介
2024-04-21
Flink安裝極簡教程-單機版
2019-01-29
python極簡教程01：基礎變數
2021-12-31
Python變數
Java執行緒池ThreadPoolExecutor極簡教程
2022-05-25
Java執行緒thread
《React極簡教程》第二章ReactJSX
2017-03-19
ReactJS
《Kotlin極簡教程》第6章泛型
2017-06-16
Kotlin泛型
Android 極簡反射教程及應用示例
2016-07-14
Android反射
Docker下,兩分鐘極速體驗Nacos
2022-10-03
Docker
Python 從入門到爬蟲極簡教程
2019-02-16
Python爬蟲
python極簡教程06：生成式和裝飾器
2022-01-14
Python
Spring Boot 整合 Activiti 工作流引擎極簡教程
2021-06-24
Spring Boot
Docker下,兩分鐘極速體驗Nacos配置中心
2022-10-06
Docker
python極簡教程07：封裝、多型和繼承
2022-01-17
Python封裝多型繼承
python極簡教程05：生成器和匿名函式
2022-01-12
Python函式
內網穿透教程，簡單，便捷，極速穿透內網埠
2020-11-28
內網穿透
Java教程：nacos入門系列之配置中心
2020-07-07
Java
超實用的 Nginx 極簡教程，覆蓋了常用場景
2019-04-28
Nginx
配置中心之Nacos簡介,使用及Go簡單整合
2021-07-04
Go
Spring Cloud Gateway + Nacos（1）簡單配置
2021-05-12
SpringCloudGateway
保姆教程系列二、Nacos實現註冊中心
2022-03-30
Java JMS 極簡演示
2021-06-23
Java
Elasticsearch 極簡入門
2020-11-25
Elasticsearch
Photoshop：路徑終極教程
2007-08-23
極簡教程！教你快速將K3s與Cloud Controller整合
2020-04-20
CloudController

Nacos極簡教程

簡介

NacosServer

安裝目錄

配置參考

常用命令

常用介面

埠

叢集部署

WebUI

NacosClient

pom

bootstrap.yml

主啟動類

客戶端整合

啟動測試

問題記錄

報錯資訊

解決辦法

報錯資訊

解決辦法

刪除data資料夾重啟

修改cluster.conf檔案

相關文章