# xiaomayi-nacos

**Repository Path**: xiaomayiteam/xiaomayi-nacos

## Basic Information

- **Project Name**: xiaomayi-nacos
- **Description**: 小蚂蚁云 Nacos 是一款基于 Alibaba Nacos 轻量级类库，提供更简单、更强大的微服务配置管理、服务发现及动态路由能力。实现工程化启用与管理，帮助开发者快速构建云原生应用。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2025-06-24
- **Last Updated**: 2025-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
	<img alt="logo" src="document/docs/v2/images/logo.svg">
</p>
<h2 align="center">Nacos服务搭建文档</h4>

1、技术方案

Nacos注册配置中心服务部署有多种模式，如源码部署、Docker容器化部署等等，每种部署方案都有各自的优缺点，此处不去深入探讨；

本案例主要实现 `nacos` 工程化部署的方式，通过应用服务的方式搭建，源码部署实现方案在上个章节《源码部署》已经做了详细的
说明，原理很好理解，将源码包中最核心的 `nacos-console` 工程单独剥离出来单独成立一个服务，此外将整体 `nacos` 打包后
将JAR包作为依赖打包进入即可；当然也可以将模块依赖JAR包上传至 `nexus` 私服，做Maven依赖下载也可以；本章节以直接引入
JAR包的方式进行实现；私服部署后续再做详细介绍；

2、核心模块

将 `nacos` 核心工程单独剥离出来，如下图：

<p align="center">
	<img alt="logo" src="document/docs/v2/images/1.png">
</p>

> 需要将 nacos-console 模块核心部件全部剥离至独立的应用中；

3、新建应用

新建一个 `springboot` 应用工程，如如下：

<p align="center">
	<img alt="logo" src="document/docs/v2/images/2.png">
</p>

4、导入JAR包

<p align="center">
	<img alt="logo" src="document/docs/v2/images/3.png">
</p>

JAR来源于 `nacos` 源码工程打包后生成的包，如下图：

<p align="center">
	<img alt="logo" src="document/docs/v2/images/4.png">
</p>

5、配置文件

从源码包 `nacos-console` 模块中拷贝 `application.properties` 配置文件，通过第三方工具转换为 `application.yml` 文件，具体内容如下：

```
# 特别说明，此文件由 nacos v2.3.2 原生配置文件application.properties直接格式化转换而来
server:
  error:
    include-message: ALWAYS
  # 访问端口
  port: 8848
  servlet:
    # 访问上下文前缀
    contextPath: /nacos
  tomcat:
    accesslog:
      enabled: true
      max-days: 30
      pattern: '%h %l %u %t "%r" %s %b %D %{User-Agent}i %{Request-Source}i'
    basedir: file:.
spring:
  # 数据源类型：MySQL
  datasource:
    platform: mysql

# 数据库配置
db:
  num: 1
  url:
    0: jdbc:mysql://${MYSQL_HOST:127.0.0.1}:${MYSQL_PORT:3306}/${MYSQL_DB:nacos_config}?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC
  user: root
  password: 123456

management:
  metrics:
    export:
      elastic:
        enabled: false
      influx:
        enabled: false

# nacos配置
nacos:
  config:
    push:
      maxRetryTime: 50
  core:
    auth:
      caching:
        enabled: true
      enable:
        userAgentAuthWhite: false
      # 开启鉴权 登录账号和密码在数据库中users表
      enabled: true
      # 插件配置
      plugin:
        nacos:
          token:
            cache:
              enable: false
            expire:
              seconds: 18000
            # 设置秘钥,随意Base64编码,长度至少32字节
            secret:
              key: SecretKey012345678901234567890123456789012345678901234567890123456789
      server:
        # 随意配置下面两个属性,不配置启动报错
        identity:
          key: serverIdentity
          value: security
      system:
        type: nacos
  istio:
    mcp:
      server:
        enabled: false
  naming:
    empty-service:
      auto-clean: true
      clean:
        initial-delay-ms: 50000
        period-time-ms: 30000
  # 安全认证配置
  security:
    # 忽略URL
    ignore:
      # URL地址，多个逗号分隔
      urls: /,/error,/**/*.css,/**/*.js,/**/*.html,/**/*.map,/**/*.svg,/**/*.png,/**/*.ico,/console-ui/public/**,/v1/auth/**,/v1/console/health/**,/actuator/**,/v1/console/server/**
```

6、POM文件

在根POM文件中需要引入依赖关系JAR包，具体文件内容如下：

```
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.alibaba</groupId>
    <artifactId>xiaomayi-nacos</artifactId>
    <version>1.0.0</version>
    <name>xiaomayi-nacos</name>
    <url>https://nacos.io</url>
    <description>小蚂蚁nacos注册配置中心</description>

    <!-- 依赖版本号 -->
    <properties>
        <version>1.0.0</version>
        <nacos.version>2.3.2</nacos.version>
        <java.version>1.8</java.version>
        <mysql-connector-j.version>8.2.0</mysql-connector-j.version>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring-boot-dependencies.version>2.7.18</spring-boot-dependencies.version>
        <nacos.lib.path>${project.basedir}/src/main/resources/lib</nacos.lib.path>
    </properties>

    <!-- 依赖管理 -->
    <dependencyManagement>
        <dependencies>
            <!-- nacos 根依赖 -->
            <dependency>
                <groupId>com.alibaba.nacos</groupId>
                <artifactId>nacos-all</artifactId>
                <version>${nacos.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!-- 依赖声明 -->
    <dependencies>
        <!-- springboot 起始依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring-boot-dependencies.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-config</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-config-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-naming</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-naming-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-default-plugin-all</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-default-plugin-all-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-istio</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-istio-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-prometheus</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-prometheus-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-auth</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-auth-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-config-plugin</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-config-plugin-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-consistency</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-consistency-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-control-plugin</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-control-plugin-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-core</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-core-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>default-auth-plugin</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/default-auth-plugin-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-sys</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-sys-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-persistence</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-persistence-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-datasource-plugin</artifactId>
            <version>${nacos.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-trace-plugin</artifactId>
            <version>${nacos.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-common</artifactId>
            <version>${nacos.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
        <!-- 以下依赖按需引入开始 -->
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-cmdb</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-cmdb-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-auth-plugin</artifactId>
            <version>${nacos.version}</version>
            <scope>system</scope>
            <systemPath>${nacos.lib.path}/nacos-auth-plugin-${nacos.version}.jar</systemPath>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-custom-environment-plugin</artifactId>
            <version>${nacos.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-encryption-plugin</artifactId>
            <version>${nacos.version}</version>
        </dependency>
        <!-- 以下依赖按需引入结束 -->

        <dependency>
            <groupId>com.caucho</groupId>
            <artifactId>hessian</artifactId>
        </dependency>
        <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.derby</groupId>
            <artifactId>derby</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>jraft-core</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alipay.sofa</groupId>
            <artifactId>rpc-grpc-impl</artifactId>
        </dependency>

        <!-- log -->
        <!-- log4j通过slf4j来代理 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
        </dependency>
        <!-- apache commons logging通过slf4j来代理 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
        </dependency>
        <!-- java.util.logging 通过slf4j来代理 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jul-to-slf4j</artifactId>
        </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>${mysql-connector-j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-test-autoconfigure</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.apache.logging.log4j</groupId>
                    <artifactId>*</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.ldap</groupId>
            <artifactId>spring-ldap-core</artifactId>
        </dependency>
    </dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <excludes>
                    <exclude>static/console-ui/.vscode/**</exclude>
                </excludes>
            </resource>
        </resources>
    </build>

    <reporting>
        <plugins>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>findbugs-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </reporting>

    <profiles>
        <profile>
            <id>release-nacos</id>
            <build>
                <finalName>xiaomayi-nacos</finalName>
                <plugins>
                    <plugin>
                        <artifactId>maven-jar-plugin</artifactId>
                        <configuration>
                            <archive>
                                <manifest>
                                    <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                                    <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
                                </manifest>
                            </archive>
                        </configuration>
                    </plugin>
                    <plugin>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-maven-plugin</artifactId>
                        <executions>
                            <execution>
                                <goals>
                                    <goal>repackage</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

</project>
```

> 文件主体内容从源码包 `nacos-console` 模块中直接拷贝而来，JAR依赖需要自行编写；

7、启动项目

<p align="center">
	<img alt="logo" src="document/docs/v2/images/5.png">
</p>

登录界面：

<p align="center">
	<img alt="logo" src="document/docs/v2/images/6.png">
</p>

服务主页：

<p align="center">
	<img alt="logo" src="document/docs/v2/images/7.png">
</p>